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

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

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

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

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

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

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

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

template<typename TEnum >
constexpr TEnum	operator++ (TEnum &arg, typename std::underlying_type< TEnum >::type) noexcept

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

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

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

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

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

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

template<typename TEnum >
constexpr TEnum	operator-- (TEnum &arg, typename std::underlying_type< TEnum >::type) noexcept

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

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

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

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

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

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

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

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

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

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

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

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

Function Details:

◆ operator%()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 622 of file arithmetical.hpp.

◆ operator%=()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out]	lhs	Reference to the first operand. Receives the result.
	rhs	Second operand.

Returns: The resulting enum element.

Definition at line 645 of file arithmetical.hpp.

◆ operator*()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 531 of file arithmetical.hpp.

◆ operator*=()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out]	lhs	Reference to the first operand. Receives the result.
	rhs	Second operand.

Returns: The resulting enum element.

Definition at line 554 of file arithmetical.hpp.

◆ operator+() [1/3]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

arg Operand.

Returns: Parameter arg (identical value).

Definition at line 488 of file arithmetical.hpp.

◆ operator+() [2/3]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 222 of file arithmetical.hpp.

◆ operator+() [3/3]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 244 of file arithmetical.hpp.

◆ operator++() [1/2]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out] arg Reference to the enum value to be incremented.

Returns: The new value of lhs which is set the resulting enum element.

Definition at line 310 of file arithmetical.hpp.

◆ operator++() [2/2]

template<typename TEnum >

TEnum operator++	(	TEnum &	arg,
		typename std::underlying_type< TEnum >::type	)

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

TEnum Enumeration type.

Parameters

[in,out] arg Reference to the enum value to be incremented.

Returns: The old value of arg.

Definition at line 331 of file arithmetical.hpp.

◆ operator+=() [1/2]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The new value of lhs which is set the resulting enum element.

Definition at line 267 of file arithmetical.hpp.

◆ operator+=() [2/2]

template<typename TEnum >

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] lhs Reference to the first operand. Receives the result.

Template Parameters

TEnum Enumeration type.

Parameters

rhs	Second operand.

Returns: The new value of lhs which is set the resulting enum element.

Definition at line 289 of file arithmetical.hpp.

◆ operator-() [1/3]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

arg Operand.

Returns: The resulting enum element.

Definition at line 508 of file arithmetical.hpp.

◆ operator-() [2/3]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 355 of file arithmetical.hpp.

◆ operator-() [3/3]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 378 of file arithmetical.hpp.

◆ operator--() [1/2]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out] arg Reference to the enum value to be decremented.

Returns: The new value of lhs which is set the resulting enum element.

Definition at line 443 of file arithmetical.hpp.

◆ operator--() [2/2]

template<typename TEnum >

TEnum operator--	(	TEnum &	arg,
		typename std::underlying_type< TEnum >::type	)

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

TEnum Enumeration type.

Parameters

[in,out] arg Reference to the enum value to be decremented.

Returns: The old value of arg.

Definition at line 465 of file arithmetical.hpp.

◆ operator-=() [1/2]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The new value of lhs which is set the resulting enum element.

Definition at line 400 of file arithmetical.hpp.

◆ operator-=() [2/2]

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out]	lhs	Reference to the first operand. Receives the result.
	rhs	Second operand.

Returns: The new value of lhs which is set the resulting enum element.

Definition at line 422 of file arithmetical.hpp.

◆ operator/()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 576 of file arithmetical.hpp.

◆ operator/=()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out]	lhs	Reference to the first operand. Receives the result.
	rhs	Second operand.

Returns: The resulting enum element.

Definition at line 599 of file arithmetical.hpp.

◆ operator<()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The result of the comparison.

Definition at line 124 of file arithmetical.hpp.

◆ operator<<()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 664 of file arithmetical.hpp.

◆ operator<<=()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out]	lhs	Reference to the first operand. Receives the result.
	rhs	Second operand.

Returns: The resulting enum element.

Definition at line 686 of file arithmetical.hpp.

◆ operator<=()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The result of the comparison.

Definition at line 147 of file arithmetical.hpp.

◆ operator>()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The result of the comparison.

Definition at line 174 of file arithmetical.hpp.

◆ operator>=()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The result of the comparison.

Definition at line 199 of file arithmetical.hpp.

◆ operator>>()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

lhs	First operand.
rhs	Second operand.

Returns: The resulting enum element.

Definition at line 713 of file arithmetical.hpp.

◆ operator>>=()

template<typename TEnum >

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

TEnum Enumeration type.

Parameters

[in,out]	lhs	Reference to the first operand. Receives the result.
	rhs	Second operand.

Returns: The resulting enum element.

Definition at line 735 of file arithmetical.hpp.

Description:

Function Index:

Function Details:

◆ operator%()

◆ operator%=()

◆ operator*()

◆ operator*=()

◆ operator+() [1/3]

◆ operator+() [2/3]

◆ operator+() [3/3]

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/3]

◆ operator-() [2/3]

◆ operator-() [3/3]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator<<()

◆ operator<<=()

◆ operator<=()

◆ operator>()

◆ operator>=()

◆ operator>>()

◆ operator>>=()