ALib C++ Library
Library Version: 2402 R1
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::enums::arithmetical Namespace Reference

Description:

Operators available to elements of enumerations if T_EnumIsArithmetical is specialized.

Note
This namespace exits only in the documentation to collect the operators. When parsed by a C++ compiler, the operators reside in the global namespace.

Function Index:

template<typename TEnum >
constexpr TEnum operator% (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator%= (TEnum &lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator* (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator*= (TEnum &lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator+ (TEnum arg) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator+ (TEnum lhs, TEnum rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator+ (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator++ (TEnum &arg) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator++ (TEnum &arg, int) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator+= (TEnum &lhs, TEnum rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator+= (TEnum &lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator- (TEnum arg) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator- (TEnum lhs, TEnum rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator- (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator-- (TEnum &arg) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator-- (TEnum &arg, int) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator-= (TEnum &lhs, TEnum rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator-= (TEnum &lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator/ (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator/= (TEnum &lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr bool operator< (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator<< (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator<<= (TEnum &lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr bool operator<= (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr bool operator> (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr bool operator>= (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator>> (TEnum lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 
template<typename TEnum >
constexpr TEnum operator>>= (TEnum &lhs, typename std::underlying_type< TEnum >::type rhs) noexcept(true)
 

Function Details:

◆ operator%()

template<typename TEnum >
constexpr TEnum operator% ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Modulo operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 672 of file arithmetical.hpp.

◆ operator%=()

template<typename TEnum >
constexpr TEnum operator%= ( TEnum & lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Modulo assignment operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]lhsReference to the first operand. Receives the result.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 697 of file arithmetical.hpp.

◆ operator*()

template<typename TEnum >
constexpr TEnum operator* ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Multiplication operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 573 of file arithmetical.hpp.

◆ operator*=()

template<typename TEnum >
constexpr TEnum operator*= ( TEnum & lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Multiplication assignment operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]lhsReference to the first operand. Receives the result.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 598 of file arithmetical.hpp.

◆ operator+() [1/3]

template<typename TEnum >
constexpr TEnum operator+ ( TEnum arg)
constexprnoexcept

Unary plus operator for enum elements.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
argOperand.
Returns
Parameter arg (identical value).

Definition at line 526 of file arithmetical.hpp.

◆ operator+() [2/3]

template<typename TEnum >
constexpr TEnum operator+ ( TEnum lhs,
TEnum rhs )
constexprnoexcept

Add operator between two enum elements.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 236 of file arithmetical.hpp.

◆ operator+() [3/3]

template<typename TEnum >
constexpr TEnum operator+ ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Add operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 260 of file arithmetical.hpp.

◆ operator++() [1/2]

template<typename TEnum >
constexpr TEnum operator++ ( TEnum & arg)
constexprnoexcept

Prefix increment operator.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]argReference to the enum value to be incremented.
Returns
The new value of lhs which is set the resulting enum element.

Definition at line 332 of file arithmetical.hpp.

◆ operator++() [2/2]

template<typename TEnum >
constexpr TEnum operator++ ( TEnum & arg,
int  )
constexprnoexcept

Postfix increment operator.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]argReference to the enum value to be incremented.
Returns
The old value of arg .

Definition at line 355 of file arithmetical.hpp.

◆ operator+=() [1/2]

template<typename TEnum >
constexpr TEnum operator+= ( TEnum & lhs,
TEnum rhs )
constexprnoexcept

Add assignment operator between two enum elements.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The new value of lhs which is set the resulting enum element.

Definition at line 285 of file arithmetical.hpp.

◆ operator+=() [2/2]

template<typename TEnum >
constexpr TEnum operator+= ( TEnum & lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Add assignment operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Parameters
[in,out]lhsReference to the first operand. Receives the result.
Template Parameters
TEnumEnumeration type.
Parameters
rhsSecond operand.
Returns
The new value of lhs which is set the resulting enum element.

Definition at line 309 of file arithmetical.hpp.

◆ operator-() [1/3]

template<typename TEnum >
constexpr TEnum operator- ( TEnum arg)
constexprnoexcept

Unary minus operator for enum elements.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
argOperand.
Returns
The resulting enum element.

Definition at line 548 of file arithmetical.hpp.

◆ operator-() [2/3]

template<typename TEnum >
constexpr TEnum operator- ( TEnum lhs,
TEnum rhs )
constexprnoexcept

Subtract operator between two enum elements.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 381 of file arithmetical.hpp.

◆ operator-() [3/3]

template<typename TEnum >
constexpr TEnum operator- ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Subtract operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 406 of file arithmetical.hpp.

◆ operator--() [1/2]

template<typename TEnum >
constexpr TEnum operator-- ( TEnum & arg)
constexprnoexcept

Prefix decrement operator.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]argReference to the enum value to be decremented.
Returns
The new value of lhs which is set the resulting enum element.

Definition at line 477 of file arithmetical.hpp.

◆ operator--() [2/2]

template<typename TEnum >
constexpr TEnum operator-- ( TEnum & arg,
int  )
constexprnoexcept

Postfix decrement operator.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]argReference to the enum value to be decremented.
Returns
The old value of arg .

Definition at line 501 of file arithmetical.hpp.

◆ operator-=() [1/2]

template<typename TEnum >
constexpr TEnum operator-= ( TEnum & lhs,
TEnum rhs )
constexprnoexcept

Subtract assignment operator between two enum elements.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The new value of lhs which is set the resulting enum element.

Definition at line 430 of file arithmetical.hpp.

◆ operator-=() [2/2]

template<typename TEnum >
constexpr TEnum operator-= ( TEnum & lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Subtract assignment operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]lhsReference to the first operand. Receives the result.
rhsSecond operand.
Returns
The new value of lhs which is set the resulting enum element.

Definition at line 454 of file arithmetical.hpp.

◆ operator/()

template<typename TEnum >
constexpr TEnum operator/ ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Division operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 622 of file arithmetical.hpp.

◆ operator/=()

template<typename TEnum >
constexpr TEnum operator/= ( TEnum & lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Division assignment operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]lhsReference to the first operand. Receives the result.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 647 of file arithmetical.hpp.

◆ operator<()

template<typename TEnum >
constexpr bool operator< ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Comparison operator less between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The result of the comparison.

Definition at line 130 of file arithmetical.hpp.

◆ operator<<()

template<typename TEnum >
constexpr TEnum operator<< ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Shift-left operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 718 of file arithmetical.hpp.

◆ operator<<=()

template<typename TEnum >
constexpr TEnum operator<<= ( TEnum & lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Shift-left assignment operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]lhsReference to the first operand. Receives the result.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 742 of file arithmetical.hpp.

◆ operator<=()

template<typename TEnum >
constexpr bool operator<= ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Comparison operator less or equal between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The result of the comparison.

Definition at line 155 of file arithmetical.hpp.

◆ operator>()

template<typename TEnum >
constexpr bool operator> ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Comparison operator greater between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The result of the comparison.

Definition at line 184 of file arithmetical.hpp.

◆ operator>=()

template<typename TEnum >
constexpr bool operator>= ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Comparison operator greater or equal between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The result of the comparison.

Definition at line 211 of file arithmetical.hpp.

◆ operator>>()

template<typename TEnum >
constexpr TEnum operator>> ( TEnum lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Shift-right operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
lhsFirst operand.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 771 of file arithmetical.hpp.

◆ operator>>=()

template<typename TEnum >
constexpr TEnum operator>>= ( TEnum & lhs,
typename std::underlying_type< TEnum >::type rhs )
constexprnoexcept

Shift-right assignment operator between an enum element and an integral value of underlying type.

Selected by the compiler only if T_EnumIsArithmetical is specialized for template enum type TEnum to inherit std::true_type.

Template Parameters
TEnumEnumeration type.
Parameters
[in,out]lhsReference to the first operand. Receives the result.
rhsSecond operand.
Returns
The resulting enum element.

Definition at line 795 of file arithmetical.hpp.