Overflow safe template for integers, i.e. More...

#include <overflowsafe_type.hpp>

Public Types
using	BaseType = T

Public Member Functions
constexpr	OverflowSafeInt (const OverflowSafeInt &other)
constexpr	OverflowSafeInt (const T int_)
constexpr OverflowSafeInt &	operator= (const OverflowSafeInt &other)
constexpr OverflowSafeInt &	operator= (T other)
constexpr OverflowSafeInt	operator- () const
constexpr OverflowSafeInt &	operator+= (const OverflowSafeInt &other)
	Safe implementation of addition.
constexpr OverflowSafeInt &	operator-= (const OverflowSafeInt &other)
	Safe implementation of subtraction.
constexpr OverflowSafeInt	operator+ (const OverflowSafeInt &other) const
constexpr OverflowSafeInt	operator+ (const int other) const
constexpr OverflowSafeInt	operator+ (const uint other) const
constexpr OverflowSafeInt	operator- (const OverflowSafeInt &other) const
constexpr OverflowSafeInt	operator- (const int other) const
constexpr OverflowSafeInt	operator- (const uint other) const
constexpr OverflowSafeInt &	operator++ ()
constexpr OverflowSafeInt &	operator-- ()
constexpr OverflowSafeInt	operator++ (int)
constexpr OverflowSafeInt	operator-- (int)
constexpr OverflowSafeInt &	operator*= (const int factor)
	Safe implementation of multiplication.
constexpr OverflowSafeInt	operator* (const int64_t factor) const
constexpr OverflowSafeInt	operator* (const int factor) const
constexpr OverflowSafeInt	operator* (const uint factor) const
constexpr OverflowSafeInt	operator* (const uint16_t factor) const
constexpr OverflowSafeInt	operator* (const uint8_t factor) const
constexpr OverflowSafeInt &	operator/= (const int64_t divisor)
constexpr OverflowSafeInt	operator/ (const OverflowSafeInt &divisor) const
constexpr OverflowSafeInt	operator/ (const int divisor) const
constexpr OverflowSafeInt	operator/ (const uint divisor) const
constexpr OverflowSafeInt &	operator%= (const int divisor)
constexpr OverflowSafeInt	operator% (const int divisor) const
constexpr OverflowSafeInt &	operator<<= (const int shift)
constexpr OverflowSafeInt	operator<< (const int shift) const
constexpr OverflowSafeInt &	operator>>= (const int shift)
constexpr OverflowSafeInt	operator>> (const int shift) const
constexpr bool	operator== (const OverflowSafeInt &other) const
constexpr auto	operator<=> (const OverflowSafeInt &other) const
constexpr bool	operator== (const int other) const
constexpr auto	operator<=> (const int other) const
constexpr	operator T () const
BaseType	base () const noexcept

Static Public Member Functions
static constexpr OverflowSafeInt< T >	max ()
static constexpr OverflowSafeInt< T >	min ()

Private Attributes
T	m_value
	The non-overflow safe backend to store the value in.

Static Private Attributes
static constexpr T	T_MAX = std::numeric_limits<T>::max()
static constexpr T	T_MIN = std::numeric_limits<T>::min()

Detailed Description

template<class T>
class OverflowSafeInt< T >

Overflow safe template for integers, i.e.

integers that will never overflow when you multiply the maximum value with 2, or add 2, or subtract something from the minimum value, etc.

Parameters

T	the type these integers are stored with.

Definition at line 29 of file overflowsafe_type.hpp.

Member Typedef Documentation

◆ BaseType

template<class T>

using OverflowSafeInt< T >::BaseType = T

Definition at line 38 of file overflowsafe_type.hpp.

Constructor & Destructor Documentation

◆ OverflowSafeInt() [1/3]

template<class T>

OverflowSafeInt< T >::OverflowSafeInt ( )

inlineconstexpr

Definition at line 40 of file overflowsafe_type.hpp.

◆ OverflowSafeInt() [2/3]

template<class T>

OverflowSafeInt< T >::OverflowSafeInt ( const OverflowSafeInt< T > & other )

inlineconstexpr

Definition at line 42 of file overflowsafe_type.hpp.

◆ OverflowSafeInt() [3/3]

template<class T>

OverflowSafeInt< T >::OverflowSafeInt ( const T int_ )

inlineconstexpr

Definition at line 43 of file overflowsafe_type.hpp.

Member Function Documentation

◆ base()

template<class T>

BaseType OverflowSafeInt< T >::base ( ) const

inlinenoexcept

Definition at line 179 of file overflowsafe_type.hpp.

◆ max()

template<class T>

constexpr OverflowSafeInt< T > OverflowSafeInt< T >::max ( )

inlinestaticconstexpr

Definition at line 176 of file overflowsafe_type.hpp.

◆ min()

template<class T>

constexpr OverflowSafeInt< T > OverflowSafeInt< T >::min ( )

inlinestaticconstexpr

Definition at line 177 of file overflowsafe_type.hpp.

◆ operator T()

template<class T>

OverflowSafeInt< T >::operator T ( ) const

inlineconstexpr

Definition at line 174 of file overflowsafe_type.hpp.

◆ operator%()

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator% ( const int divisor ) const

inlineconstexpr

Definition at line 158 of file overflowsafe_type.hpp.

◆ operator%=()

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator%= ( const int divisor )

inlineconstexpr

Definition at line 157 of file overflowsafe_type.hpp.

◆ operator*() [1/5]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator* ( const int factor ) const

inlineconstexpr

Definition at line 145 of file overflowsafe_type.hpp.

◆ operator*() [2/5]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator* ( const int64_t factor ) const

inlineconstexpr

Definition at line 144 of file overflowsafe_type.hpp.

◆ operator*() [3/5]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator* ( const uint factor ) const

inlineconstexpr

Definition at line 146 of file overflowsafe_type.hpp.

◆ operator*() [4/5]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator* ( const uint16_t factor ) const

inlineconstexpr

Definition at line 147 of file overflowsafe_type.hpp.

◆ operator*() [5/5]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator* ( const uint8_t factor ) const

inlineconstexpr

Definition at line 148 of file overflowsafe_type.hpp.

◆ operator*=()

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator*= ( const int factor )

inlineconstexpr

Safe implementation of multiplication.

Parameters

factor the factor to multiply this with.

Returns: Reference to this instance.

Note: when the multiplication would yield more than T_MAX (or less than T_MIN), it will be T_MAX (respectively T_MIN).

Definition at line 118 of file overflowsafe_type.hpp.

◆ operator+() [1/3]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator+ ( const int other ) const

inlineconstexpr

Definition at line 100 of file overflowsafe_type.hpp.

◆ operator+() [2/3]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator+ ( const OverflowSafeInt< T > & other ) const

inlineconstexpr

Definition at line 99 of file overflowsafe_type.hpp.

◆ operator+() [3/3]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator+ ( const uint other ) const

inlineconstexpr

Definition at line 101 of file overflowsafe_type.hpp.

◆ operator++() [1/2]

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator++ ( )

inlineconstexpr

Definition at line 106 of file overflowsafe_type.hpp.

◆ operator++() [2/2]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator++ ( int )

inlineconstexpr

Definition at line 108 of file overflowsafe_type.hpp.

◆ operator+=()

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator+= ( const OverflowSafeInt< T > & other )

inlineconstexpr

Safe implementation of addition.

Parameters

other the amount to add

Returns: Reference to this instance.

Note: when the addition would yield more than T_MAX, it will be T_MAX.

Definition at line 56 of file overflowsafe_type.hpp.

◆ operator-() [1/4]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator- ( ) const

inlineconstexpr

Definition at line 48 of file overflowsafe_type.hpp.

◆ operator-() [2/4]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator- ( const int other ) const

inlineconstexpr

Definition at line 103 of file overflowsafe_type.hpp.

◆ operator-() [3/4]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator- ( const OverflowSafeInt< T > & other ) const

inlineconstexpr

Definition at line 102 of file overflowsafe_type.hpp.

◆ operator-() [4/4]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator- ( const uint other ) const

inlineconstexpr

Definition at line 104 of file overflowsafe_type.hpp.

◆ operator--() [1/2]

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator-- ( )

inlineconstexpr

Definition at line 107 of file overflowsafe_type.hpp.

◆ operator--() [2/2]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator-- ( int )

inlineconstexpr

Definition at line 109 of file overflowsafe_type.hpp.

◆ operator-=()

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator-= ( const OverflowSafeInt< T > & other )

inlineconstexpr

Safe implementation of subtraction.

Parameters

other the amount to subtract

Returns: Reference to this instance.

Note: when the subtraction would yield less than T_MIN, it will be T_MIN.

Definition at line 80 of file overflowsafe_type.hpp.

◆ operator/() [1/3]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator/ ( const int divisor ) const

inlineconstexpr

Definition at line 153 of file overflowsafe_type.hpp.

◆ operator/() [2/3]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator/ ( const OverflowSafeInt< T > & divisor ) const

inlineconstexpr

Definition at line 152 of file overflowsafe_type.hpp.

◆ operator/() [3/3]

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator/ ( const uint divisor ) const

inlineconstexpr

Definition at line 154 of file overflowsafe_type.hpp.

◆ operator/=()

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator/= ( const int64_t divisor )

inlineconstexpr

Definition at line 151 of file overflowsafe_type.hpp.

◆ operator<<()

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator<< ( const int shift ) const

inlineconstexpr

Definition at line 162 of file overflowsafe_type.hpp.

◆ operator<<=()

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator<<= ( const int shift )

inlineconstexpr

Definition at line 161 of file overflowsafe_type.hpp.

◆ operator<=>() [1/2]

template<class T>

auto OverflowSafeInt< T >::operator<=> ( const int other ) const

inlineconstexpr

Definition at line 172 of file overflowsafe_type.hpp.

◆ operator<=>() [2/2]

template<class T>

auto OverflowSafeInt< T >::operator<=> ( const OverflowSafeInt< T > & other ) const

inlineconstexpr

Definition at line 168 of file overflowsafe_type.hpp.

◆ operator=() [1/2]

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator= ( const OverflowSafeInt< T > & other )

inlineconstexpr

Definition at line 45 of file overflowsafe_type.hpp.

◆ operator=() [2/2]

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator= ( T other )

inlineconstexpr

Definition at line 46 of file overflowsafe_type.hpp.

◆ operator==() [1/2]

template<class T>

bool OverflowSafeInt< T >::operator== ( const int other ) const

inlineconstexpr

Definition at line 171 of file overflowsafe_type.hpp.

◆ operator==() [2/2]

template<class T>

bool OverflowSafeInt< T >::operator== ( const OverflowSafeInt< T > & other ) const

inlineconstexpr

Definition at line 167 of file overflowsafe_type.hpp.

◆ operator>>()

template<class T>

OverflowSafeInt OverflowSafeInt< T >::operator>> ( const int shift ) const

inlineconstexpr

Definition at line 164 of file overflowsafe_type.hpp.

◆ operator>>=()

template<class T>

OverflowSafeInt & OverflowSafeInt< T >::operator>>= ( const int shift )

inlineconstexpr

Definition at line 163 of file overflowsafe_type.hpp.

Field Documentation

◆ m_value

template<class T>

T OverflowSafeInt< T >::m_value

private

The non-overflow safe backend to store the value in.

Definition at line 36 of file overflowsafe_type.hpp.

Referenced by OverflowSafeInt< int64_t >::operator+=(), and OverflowSafeInt< int64_t >::operator-=().

◆ T_MAX

template<class T>

T OverflowSafeInt< T >::T_MAX = std::numeric_limits<T>::max()

staticconstexprprivate

Definition at line 32 of file overflowsafe_type.hpp.

◆ T_MIN

template<class T>

T OverflowSafeInt< T >::T_MIN = std::numeric_limits<T>::min()

staticconstexprprivate

Definition at line 33 of file overflowsafe_type.hpp.

The documentation for this class was generated from the following file:

src/core/overflowsafe_type.hpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ BaseType

Constructor & Destructor Documentation

◆ OverflowSafeInt() [1/3]

◆ OverflowSafeInt() [2/3]

◆ OverflowSafeInt() [3/3]

Member Function Documentation

◆ base()

◆ max()

◆ min()

◆ operator T()

◆ operator%()

◆ operator%=()

◆ operator*() [1/5]

◆ operator*() [2/5]

◆ operator*() [3/5]

◆ operator*() [4/5]

◆ operator*() [5/5]

◆ operator*=()

◆ operator+() [1/3]

◆ operator+() [2/3]

◆ operator+() [3/3]

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-() [1/4]

◆ operator-() [2/4]

◆ operator-() [3/4]

◆ operator-() [4/4]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator/() [1/3]

◆ operator/() [2/3]

◆ operator/() [3/3]

◆ operator/=()

◆ operator<<()

◆ operator<<=()

◆ operator<=>() [1/2]

◆ operator<=>() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>>()

◆ operator>>=()

Field Documentation

◆ m_value

◆ T_MAX

◆ T_MIN