alib::enumops::ArithmeticalTraits< TEnum > Struct Template Reference

Description:

template<typename TEnum>
requires std::is_enum<TEnum>::value
struct alib::enumops::ArithmeticalTraits< TEnum >

A simple type trait 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::enumops::arithmetical::operator++(TEnum& "std::underlying_type<TEnum>::type)"
• operator--
• alib::enumops::arithmetical::operator--(TEnum& "std::underlying_type<TEnum>::type)"
• operator+=
• operator-=

Attention

Likewise with the operators introduced with the type trait BitwiseTraits, this documentation "fakes" the operators into namespace alib::enumops, 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 type trait 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 the module ALib EnumOps.

Template Parameters

TEnum

The enum type to enable arithmetical operators for.

Definition at line 53 of file arithmetical.inl.

Inheritance diagram for alib::enumops::ArithmeticalTraits< TEnum >:

Collaboration diagram for alib::enumops::ArithmeticalTraits< TEnum >:

---

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

• arithmetical.inl