MathLib::KahanSum Class Reference

Detailed Description

Definition at line 25 of file KahanSum.h.

#include <KahanSum.h>

Public Member Functions
constexpr	KahanSum (double const value=0)
constexpr	KahanSum (ranges::range auto const &range)
constexpr KahanSum	operator+ (double const increment) const
constexpr KahanSum	operator- (double const increment) const
constexpr KahanSum &	operator-= (double const increment)
constexpr KahanSum &	operator+= (double const increment)
constexpr double	value () const
constexpr double	operator() () const

Private Attributes
double	value_
double	correction_ = 0.

Friends
std::ostream &	operator<< (std::ostream &os, KahanSum const &x)

Constructor & Destructor Documentation

KahanSum() [1/2]

MathLib::KahanSum::KahanSum ( double const value = 0 )

inlineexplicitconstexpr

Definition at line 28 of file KahanSum.h.

: value_(value) {}

References value(), and value_.

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

KahanSum() [2/2]

MathLib::KahanSum::KahanSum ( ranges::range auto const & range )

inlineexplicitconstexpr

Definition at line 30 of file KahanSum.h.

                                                               : value_(0)
    {
        for (auto const v : range)
        {
            *this += v;
        }
    }

References MathLib::v, and value_.

Member Function Documentation

operator()()

double MathLib::KahanSum::operator() ( ) const

inlineconstexpr

Definition at line 65 of file KahanSum.h.

{ return value_; }

References value_.

operator+()

KahanSum MathLib::KahanSum::operator+ ( double const increment ) const

inlineconstexpr

Definition at line 38 of file KahanSum.h.

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

References KahanSum().

operator+=()

KahanSum & MathLib::KahanSum::operator+= ( double const increment )

inlineconstexpr

Definition at line 55 of file KahanSum.h.

    {
        double const y = increment - correction_;
        double const t = value_ + y;
        correction_ = (t - value_) - y;
        value_ = t;
        return *this;
    }

References KahanSum(), correction_, MathLib::t, and value_.

operator-()

KahanSum MathLib::KahanSum::operator- ( double const increment ) const

inlineconstexpr

Definition at line 44 of file KahanSum.h.

    {
        KahanSum result = *this;
        return result += -increment;
    }

References KahanSum().

operator-=()

KahanSum & MathLib::KahanSum::operator-= ( double const increment )

inlineconstexpr

Definition at line 50 of file KahanSum.h.

    {
        return *this += -increment;
    }

References KahanSum().

value()

double MathLib::KahanSum::value ( ) const

inlineconstexpr

Definition at line 64 of file KahanSum.h.

{ return value_; }

References value_.

Referenced by KahanSum(), and operator<<.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, KahanSum const & x )

friend

Definition at line 67 of file KahanSum.h.

    {
        auto const precision = os.precision();
        return os << std::setprecision(
                         std::numeric_limits<double>::max_digits10)
                  << x.value() << " (± " << x.correction_ << ')'
                  << std::setprecision(precision);
    }

References KahanSum(), correction_, and value().

Member Data Documentation

correction_

double MathLib::KahanSum::correction_ = 0.

private

Definition at line 78 of file KahanSum.h.

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

value_

double MathLib::KahanSum::value_

private

Definition at line 77 of file KahanSum.h.

Referenced by KahanSum(), KahanSum(), operator()(), operator+=(), and value().

---

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

• KahanSum.h