T_EnumIsArithmetical< TEnum, TEnableIf > Struct Template Reference

Description:

template<typename TEnum, typename TEnableIf>
struct alib::enums::T_EnumIsArithmetical< TEnum, TEnableIf >

Simple TMP struct that inherits std::false_type by default. If specialized for an enumeration type TEnum to inherit std::true_type, the following operators set of ALib operators become applicable to elements of TEnum:

• operator<
• operator<=
• operator>
• operator>=
• operator+
• operator-
• operator++
• alib::enums::arithmetical::operator++(TEnum& "std::underlying_type<TEnum>::type)"
• operator--
• alib::enums::arithmetical::operator--(TEnum& "std::underlying_type<TEnum>::type)"
• operator+=
• operator-=

Attention

Likewise with the operators introduced with TMP struct T_EnumIsBitwise, this documentation "fakes" the operators into namespace alib::enums, while in fact they are defined in the global namespace!
See corresponding note in the Programmer's Manual for details.

Restrictions
For technical reasons, this concept is not applicable to enum types that are defined as private or protected inner types of structs or classes.

See also

• Macro ALIB_ENUMS_MAKE_ARITHMETICAL, which specializes this TMP struct for a given enumeration type.
• For details and a source code sample see chapter 2.1 Standard Arithmetical Operators of the Programmer's Manual of module ALib Enums.

Template Parameters

TEnum	The enum type to enable arithmetical operators for.
TEnableIf	This parameter has a default expressions and must not be provided with specializations of this struct. It is used to ensure that template parameter TEnum is an enumeration type.

Definition at line 68 of file arithmetical.hpp.

#include <arithmetical.hpp>

Inheritance diagram for T_EnumIsArithmetical< TEnum, TEnableIf >:

Collaboration diagram for T_EnumIsArithmetical< TEnum, TEnableIf >:

---

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

• arithmetical.hpp