micro_os_plus::micro_test_plus::detail::eq_< Lhs_T, Rhs_T > Struct Template Reference

Equality comparator struct template. More...

#include "micro-os-plus/micro-test-plus.h"

Inheritance diagram for micro_os_plus::micro_test_plus::detail::eq_< Lhs_T, Rhs_T >:

Public Member Functions
constexpr	eq_ (const Lhs_T &lhs={}, const Rhs_T &rhs={})
	Constructs an equality comparator for the given operands.
constexpr auto	lhs (void) const
	Retrieves the left-hand operand.
constexpr	operator bool () const
	Conversion operator to boolean.
constexpr auto	rhs (void) const
	Retrieves the right-hand operand.

Private Attributes
const Lhs_T	lhs_ {}
	Stores the left-hand operand.
const Rhs_T	rhs_ {}
	Stores the right-hand operand.
const bool	value_ {}
	Stores the result of the comparison.

Detailed Description

template<class Lhs_T, class Rhs_T>
struct micro_os_plus::micro_test_plus::detail::eq_< Lhs_T, Rhs_T >

Derived from binary_op_, this struct checks whether the left-hand operand is equal to the right-hand operand. It is used within test expressions to provide human-readable equality assertions with enhanced reporting of the actual and expected values upon failure.

Template Parameters

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

Definition at line 314 of file detail.h.

Constructor & Destructor Documentation

eq_()

template<class Lhs_T, class Rhs_T>

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

constexpr

Parameters

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

Evaluates the equality of lhs and rhs inside an immediately invoked lambda and passes the boolean result to the binary_op_ base class constructor. Supports types with static value members, types with an epsilon precision member, and generic types.

Definition at line 191 of file detail-inlines.h.

        : binary_op_<Lhs_T, Rhs_T>{ lhs, rhs, [&]
      {
        // This lambda is called in the constructor to evaluate the
        // comparison. Its result is implicitly converted to bool via
        // the operator bool() of whatever type the branch returns.
        // This is intentional: all result types (integral_constant,
        // comparator objects, plain bool) define operator bool().
        using std::operator==;
        using std::operator<;
 
#if defined(__GNUC__)
#pragma GCC diagnostic push
 
#pragma GCC diagnostic ignored "-Wfloat-equal"
#pragma GCC diagnostic ignored "-Wconversion"
#pragma GCC diagnostic ignored "-Wdouble-promotion"
#pragma GCC diagnostic ignored "-Wsign-compare"
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wimplicit-int-float-conversion"
#pragma clang diagnostic ignored "-Wpedantic"
#endif // defined(__clang__)
#endif // defined(__GNUC__)
 
        if constexpr (type_traits::has_value<Lhs_T>
                      and type_traits::has_value<Rhs_T>)
          {
            // If both types have values (like numeric constants),
            // compare them directly.
            return Lhs_T::value == Rhs_T::value;
          }
        else if constexpr (type_traits::has_epsilon<Lhs_T>
                           and type_traits::has_epsilon<Rhs_T>)
          {
            // If both values have precision, compare them using
            // the smallest precision.
            return math::abs (get (lhs) - get (rhs))
                   < math::min_value (lhs.epsilon, rhs.epsilon);
          }
        else if constexpr (type_traits::has_epsilon<Lhs_T>)
          {
            // If only the left operand has precision, use it.
            return math::abs (get (lhs) - get (rhs)) < lhs.epsilon;
          }
        else if constexpr (type_traits::has_epsilon<Rhs_T>)
          {
            // If only the right operand has precision, use it.
            return math::abs (get (lhs) - get (rhs)) < rhs.epsilon;
          }
        else
          {
            // Call the generic getters, which might
            // either call the type get() or return the value.
            return get (lhs) == get (rhs);
          }
 
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif // defined(__GNUC__)
      }() }
    {
    }

References micro_os_plus::micro_test_plus::detail::binary_op_< Lhs_T, Rhs_T >::binary_op_(), micro_os_plus::micro_test_plus::math::abs(), micro_os_plus::micro_test_plus::detail::get(), micro_os_plus::micro_test_plus::detail::binary_op_< Lhs_T, Rhs_T >::lhs(), micro_os_plus::micro_test_plus::math::min_value(), and micro_os_plus::micro_test_plus::detail::binary_op_< Lhs_T, Rhs_T >::rhs().

Member Function Documentation

lhs()

template<class Lhs_T, class Rhs_T>

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

nodiscardconstexprinherited

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 163 of file detail-inlines.h.

    {
      return get (lhs_);
    }

References micro_os_plus::micro_test_plus::detail::get(), and lhs_.

Referenced by micro_os_plus::micro_test_plus::detail::and_< Lhs_T, Rhs_T >::and_(), binary_op_(), micro_os_plus::micro_test_plus::detail::eq_< Lhs_T, Rhs_T >::eq_(), micro_os_plus::micro_test_plus::detail::ge_< Lhs_T, Rhs_T >::ge_(), micro_os_plus::micro_test_plus::detail::gt_< Lhs_T, Rhs_T >::gt_(), micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::le_(), micro_os_plus::micro_test_plus::detail::lt_< Lhs_T, Rhs_T >::lt_(), micro_os_plus::micro_test_plus::detail::ne_< Lhs_T, Rhs_T >::ne_(), micro_os_plus::micro_test_plus::detail::or_< Lhs_T, Rhs_T >::or_(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), and micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<().

operator bool()

template<class Lhs_T, class Rhs_T>

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

nodiscardconstexprinherited

Parameters

None.

Returns

The result of the comparison.

Returns the pre-computed boolean result stored by the derived comparator's constructor.

Definition at line 149 of file detail-inlines.h.

    {
      return value_;
    }

References binary_op_(), and value_.

rhs()

template<class Lhs_T, class Rhs_T>

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

nodiscardconstexprinherited

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 176 of file detail-inlines.h.

    {
      return get (rhs_);
    }

References micro_os_plus::micro_test_plus::detail::get(), and rhs_.

Referenced by micro_os_plus::micro_test_plus::detail::and_< Lhs_T, Rhs_T >::and_(), binary_op_(), micro_os_plus::micro_test_plus::detail::eq_< Lhs_T, Rhs_T >::eq_(), micro_os_plus::micro_test_plus::detail::ge_< Lhs_T, Rhs_T >::ge_(), micro_os_plus::micro_test_plus::detail::gt_< Lhs_T, Rhs_T >::gt_(), micro_os_plus::micro_test_plus::detail::le_< Lhs_T, Rhs_T >::le_(), micro_os_plus::micro_test_plus::detail::lt_< Lhs_T, Rhs_T >::lt_(), micro_os_plus::micro_test_plus::detail::ne_< Lhs_T, Rhs_T >::ne_(), micro_os_plus::micro_test_plus::detail::or_< Lhs_T, Rhs_T >::or_(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<(), and micro_os_plus::micro_test_plus::detail::expression_formatter::operator<<().

Member Data Documentation

lhs_

template<class Lhs_T, class Rhs_T>

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

privateinherited

Note

Operands are stored by value; passing a large container will copy it into this member.

Definition at line 281 of file detail.h.

{};

Referenced by binary_op_(), and lhs().

rhs_

template<class Lhs_T, class Rhs_T>

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

privateinherited

Note

Operands are stored by value; passing a large container will copy it into this member.

Definition at line 289 of file detail.h.

{};

Referenced by binary_op_(), and rhs().

value_

template<class Lhs_T, class Rhs_T>

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

privateinherited

Definition at line 294 of file detail.h.

{};

Referenced by binary_op_(), and operator bool().

---

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

• detail.h
• detail-inlines.h