Catch::Detail::Approx Class Reference

#include <catch.hpp>

Public Member Functions
	Approx (double value)
	Approx (Approx const &other)
Approx	operator() (double value)
Approx &	epsilon (double newEpsilon)
Approx &	scale (double newScale)
std::string	toString () const

Static Public Member Functions
static Approx	custom ()

Private Attributes
double	m_epsilon
double	m_scale
double	m_value

Friends
bool	operator== (double lhs, Approx const &rhs)
bool	operator== (Approx const &lhs, double rhs)
bool	operator!= (double lhs, Approx const &rhs)
bool	operator!= (Approx const &lhs, double rhs)

Detailed Description

Definition at line 2627 of file catch.hpp.

Constructor & Destructor Documentation

Approx() [1/2]

Catch::Detail::Approx::Approx ( double  value )

inlineexplicit

Definition at line 2629 of file catch.hpp.

        :   m_epsilon( std::numeric_limits<float>::epsilon()*100 ),
            m_scale( 1.0 ),
            m_value( value )
        {}

Approx() [2/2]

Catch::Detail::Approx::Approx ( Approx const &  other )

inline

Definition at line 2635 of file catch.hpp.

        :   m_epsilon( other.m_epsilon ),
            m_scale( other.m_scale ),
            m_value( other.m_value )
        {}

Member Function Documentation

custom()

static Approx Catch::Detail::Approx::custom ( )

inlinestatic

Definition at line 2641 of file catch.hpp.

                               {
            return Approx( 0 );
        }

epsilon()

Approx& Catch::Detail::Approx::epsilon ( double  newEpsilon )

inline

Definition at line 2669 of file catch.hpp.

                                             {
            m_epsilon = newEpsilon;
            return *this;
        }

Referenced by operator()().

operator()()

Approx Catch::Detail::Approx::operator() ( double  value )

inline

Definition at line 2645 of file catch.hpp.

                                          {
            Approx approx( value );
            approx.epsilon( m_epsilon );
            approx.scale( m_scale );
            return approx;
        }

References epsilon(), and scale().

scale()

Approx& Catch::Detail::Approx::scale ( double  newScale )

inline

Definition at line 2674 of file catch.hpp.

                                         {
            m_scale = newScale;
            return *this;
        }

Referenced by operator()().

toString()

std::string Catch::Detail::Approx::toString ( ) const

inline

Definition at line 2679 of file catch.hpp.

                                   {
            std::ostringstream oss;
            oss << "Approx( " << Catch::toString( m_value ) << " )";
            return oss.str();
        }

References Catch::toString().

Referenced by Catch::toString< Detail::Approx >().

Friends And Related Function Documentation

operator!= [1/2]

bool operator!= ( Approx const &  lhs, double  rhs  )

friend

Definition at line 2665 of file catch.hpp.

                                                                  {
            return !operator==( rhs, lhs );
        }

operator!= [2/2]

bool operator!= ( double  lhs, Approx const &  rhs  )

friend

Definition at line 2661 of file catch.hpp.

                                                                  {
            return !operator==( lhs, rhs );
        }

operator== [1/2]

bool operator== ( Approx const &  lhs, double  rhs  )

friend

Definition at line 2657 of file catch.hpp.

                                                                  {
            return operator==( rhs, lhs );
        }

operator== [2/2]

bool operator== ( double  lhs, Approx const &  rhs  )

friend

Definition at line 2652 of file catch.hpp.

                                                                  {
            // Thanks to Richard Harris for his help refining this formula
            return fabs( lhs - rhs.m_value ) < rhs.m_epsilon * (rhs.m_scale + (std::max)( fabs(lhs), fabs(rhs.m_value) ) );
        }

Field Documentation

m_epsilon

double Catch::Detail::Approx::m_epsilon

private

Definition at line 2686 of file catch.hpp.

m_scale

double Catch::Detail::Approx::m_scale

private

Definition at line 2687 of file catch.hpp.

m_value

double Catch::Detail::Approx::m_value

private

Definition at line 2688 of file catch.hpp.

---

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

• src/unittests/catch.hpp (986a3bf)