NumLib::Time Struct Reference

Detailed Description

Definition at line 33 of file Time.h.

#include <Time.h>

Collaboration diagram for NumLib::Time:

Public Member Functions
constexpr	Time (double const time)
constexpr double	operator() () const
constexpr Time &	operator+= (double const increment)
constexpr Time	operator+ (double const increment) const
constexpr Time &	operator-= (double const decrement)
constexpr Time	operator- (double const decrement) const
constexpr std::weak_ordering	operator<=> (Time const &b) const
constexpr bool	operator== (Time const &x) const

Private Attributes
MathLib::KahanSum	value_

Friends
std::ostream &	operator<< (std::ostream &os, Time const &t)

Constructor & Destructor Documentation

Time()

NumLib::Time::Time ( double const time )

inlineexplicitconstexpr

Definition at line 35 of file Time.h.

: value_{time} {}

Member Function Documentation

operator()()

double NumLib::Time::operator() ( ) const

inlineconstexpr

Definition at line 37 of file Time.h.

{ return value_(); }

References value_.

operator+()

Time NumLib::Time::operator+ ( double const increment ) const

inlineconstexpr

Definition at line 45 of file Time.h.

    {
        Time result = *this;
        result += increment;
        return result;
    }

operator+=()

Time & NumLib::Time::operator+= ( double const increment )

inlineconstexpr

Definition at line 39 of file Time.h.

    {
        value_ += increment;
        return *this;
    }

References value_.

operator-()

Time NumLib::Time::operator- ( double const decrement ) const

inlineconstexpr

Definition at line 58 of file Time.h.

    {
        Time result = *this;
        result -= decrement;
        return result;
    }

operator-=()

Time & NumLib::Time::operator-= ( double const decrement )

inlineconstexpr

Definition at line 52 of file Time.h.

    {
        value_ -= decrement;
        return *this;
    }

References value_.

operator<=>()

std::weak_ordering NumLib::Time::operator<=> ( Time const & b ) const

inlineconstexpr

Definition at line 65 of file Time.h.

    {
        Time const& a = *this;
        double const diff = b() - a();
 
        double const eps = 10 * std::numeric_limits<double>::epsilon() *
                           std::max(1., (std::abs(a()) + std::abs(b())) / 2);
 
        // Keep for debugging
        // DBUG("Compare {} to {}. x is {} and y is {}. Eps {}, diff {}", a, b,
        //      x, y, eps, diff);
 
        if (diff < -eps)
        {
            return std::weak_ordering::greater;
        }
        if (diff > eps)
        {
            return std::weak_ordering::less;
        }
        return std::weak_ordering::equivalent;
    }

operator==()

bool NumLib::Time::operator== ( Time const & x ) const

inlineconstexpr

Definition at line 88 of file Time.h.

    {
        return (*this <=> x) == std::weak_ordering::equivalent;
    }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, Time const & t )

friend

Definition at line 93 of file Time.h.

    {
        auto const precision = os.precision();
        return os << std::setprecision(
                         std::numeric_limits<double>::max_digits10)
                  << t() << std::setprecision(precision);
    }

Member Data Documentation

value_

MathLib::KahanSum NumLib::Time::value_

private

Definition at line 102 of file Time.h.

Referenced by operator()(), operator+=(), and operator-=().

---

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

• NumLib/TimeStepping/Time.h