The le_ Struct Template Reference

Less than or equal comparator struct template. More...

Declaration

template <class Lhs_T, class Rhs_T> struct micro_os_plus::micro_test_plus::detail::le_<Lhs_T, Rhs_T> { ... }

Included Headers

#include <micro-os-plus/micro-test-plus.h>

Base struct

struct	op
	Empty base struct for all operator types. More...

Public Constructors Index

template <class Lhs_T, class Rhs_T>
constexpr	le_ (const Lhs_T &lhs={}, const Rhs_T &rhs={})
	Constructs a less than or equal comparator for the given operands. More...

Public Operators Index

template <class Lhs_T, class Rhs_T>
constexpr	operator bool () const
	Conversion operator to boolean. More...

Public Member Functions Index

template <class Lhs_T, class Rhs_T>
constexpr auto	lhs (void) const
	Retrieves the left-hand operand. More...
template <class Lhs_T, class Rhs_T>
constexpr auto	rhs (void) const
	Retrieves the right-hand operand. More...

Public Member Attributes Index

template <class Lhs_T, class Rhs_T>
const Lhs_T	lhs_ {}
	Stores the left-hand operand. More...
template <class Lhs_T, class Rhs_T>
const Rhs_T	rhs_ {}
	Stores the right-hand operand. More...
template <class Lhs_T, class Rhs_T>
const bool	value_ {}
	Stores the result of the less than or equal comparison. More...

Description

Less than or equal comparator struct template.

Template Parameters

Lhs_T	The type of the left-hand operand.
Rhs_T	The type of the right-hand operand.

The le_ struct template provides a type-safe mechanism for evaluating whether the left-hand operand is less than or equal to the right-hand operand within the framework.

This comparator supports a variety of operand types, including those with static values and generic types. For types with static values, the comparison is performed directly. For all other types, the generic getter is used to retrieve and compare the values.

The implementation is optimised for use in embedded environments and supports both compile-time and run-time evaluation.

All definitions are intended for internal use within the framework and are implemented in the include/micro-os-plus/micro-test-plus folder to maintain a structured and modular codebase.

Definition at line 1030 of file detail.h.

Public Constructors

le_()

template <class Lhs_T, class Rhs_T>

micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::le_ (const Lhs_T & lhs={}, const Rhs_T & rhs={})

inline constexpr

Constructs a less than or equal comparator for the given operands.

Parameters

lhs	The left-hand operand.
rhs	The right-hand operand.

Evaluates whether the left-hand operand is less than or equal to the right-hand operand at construction, supporting static values and generic types. The result is stored in the value_ member for efficient access.

Definition at line 1045 of file detail.h.

1045 constexpr le_ (const Lhs_T& lhs = {}, const Rhs_T& rhs = {})

1046 : lhs_{ lhs }, rhs_{ rhs }, value_{ [&] {

1047 using std::operator<=;

1048

1049#if defined(__GNUC__)

1050#pragma GCC diagnostic push

1051#pragma GCC diagnostic ignored "-Wconversion"

1052#pragma GCC diagnostic ignored "-Wdouble-promotion"

1053#pragma GCC diagnostic ignored "-Wsign-compare"

1054#if defined(__clang__)

1055#pragma clang diagnostic ignored "-Wimplicit-int-float-conversion"

1056#pragma clang diagnostic ignored "-Wpedantic"

1057#endif

1058#endif

1059 if constexpr (type_traits::has_value_v<Lhs_T>

1060 and type_traits::has_value_v<Rhs_T>)

1061 {

1062 return Lhs_T::value <= Rhs_T::value;

1063 }

1064 else

1065 {

1066 return get (lhs_) <= get (rhs_);

1067 }

1068#if defined(__GNUC__)

1069#pragma GCC diagnostic pop

1070#endif

1071 }() }

1072 {

1073 }

Reference micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::lhs.

Public Operators

operator bool()

template <class Lhs_T, class Rhs_T>

micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::operator bool ()

inline nodiscard constexpr

Conversion operator to boolean.

Parameters

None.

Return Values

true	The left-hand operand is less than or equal to the right-hand operand.
false	Otherwise.

Returns the result of the less than or equal comparison.

Definition at line 1088 of file detail.h.

1088 operator bool () const

1089 {

1090 return value_;

1091 }

Reference micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::value_.

Public Member Functions

lhs()

template <class Lhs_T, class Rhs_T>

auto micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::lhs (void)

inline nodiscard constexpr

Retrieves the left-hand operand.

Parameters

None.

Returns

The extracted left-hand operand.

Returns the value of the left-hand operand, applying the generic getter to ensure correct extraction for both custom and standard types.

Definition at line 1107 of file detail.h.

1107 lhs (void) const

1108 {

1109 return get (lhs_);

1110 }

References micro_os_plus::micro_test_plus::detail::get and micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::lhs_.

Referenced by micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::le_ and micro_os_plus::micro_test_plus::test_reporter::operator<<.

rhs()

template <class Lhs_T, class Rhs_T>

auto micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::rhs (void)

inline nodiscard constexpr

Retrieves the right-hand operand.

Parameters

None.

Returns

The extracted right-hand operand.

Returns the value of the right-hand operand, applying the generic getter to ensure correct extraction for both custom and standard types.

Definition at line 1125 of file detail.h.

1125 rhs (void) const

1126 {

1127 return get (rhs_);

1128 }

References micro_os_plus::micro_test_plus::detail::get and micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::rhs_.

Referenced by micro_os_plus::micro_test_plus::test_reporter::operator<<.

Public Member Attributes

lhs_

template <class Lhs_T, class Rhs_T>

const Lhs_T micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::lhs_ {}

Stores the left-hand operand.

Definition at line 1133 of file detail.h.

1133 const Lhs_T lhs_{};

Referenced by micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::lhs.

rhs_

template <class Lhs_T, class Rhs_T>

const Rhs_T micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::rhs_ {}

Stores the right-hand operand.

Definition at line 1138 of file detail.h.

1138 const Rhs_T rhs_{};

Referenced by micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::rhs.

value_

template <class Lhs_T, class Rhs_T>

const bool micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::value_ {}

Stores the result of the less than or equal comparison.

Definition at line 1143 of file detail.h.

1143 const bool value_{};

Referenced by micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::operator bool.

---

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

• detail.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.