olb::utilities::Fraction Class Reference

Floating-point independent fraction type. More...

#include <fraction.h>

Collaboration diagram for olb::utilities::Fraction:

Public Member Functions
constexpr	Fraction (int num, int denum)
constexpr	Fraction (int parts[2])
constexpr	Fraction (int num)
constexpr	Fraction ()
template<typename T >
constexpr T	as () const
template<typename T >
constexpr T	inverseAs () const

Detailed Description

Floating-point independent fraction type.

Definition at line 34 of file fraction.h.

Constructor & Destructor Documentation

Fraction() [1/4]

constexpr olb::utilities::Fraction::Fraction ( int num, int denum )

inlineconstexpr

Definition at line 40 of file fraction.h.

                                        :
    _numerator(num), _denominator(denum)
  {
    if (_denominator == 0) {
      throw std::invalid_argument("denominator must not be zero");
    }
  }

Fraction() [2/4]

constexpr olb::utilities::Fraction::Fraction ( int parts[2] )

inlineconstexpr

Definition at line 48 of file fraction.h.

                                  :
    Fraction(parts[0], parts[1]) { }

Fraction() [3/4]

constexpr olb::utilities::Fraction::Fraction ( int num )

inlineconstexpr

Definition at line 51 of file fraction.h.

                             :
    Fraction(num, 1) { }

Fraction() [4/4]

constexpr olb::utilities::Fraction::Fraction ( )

inlineconstexpr

Definition at line 54 of file fraction.h.

                      :
    Fraction(0) { }

Member Function Documentation

as()

template<typename T >

constexpr T olb::utilities::Fraction::as ( ) const

inlineconstexpr

Definition at line 58 of file fraction.h.

  {
    return T(_numerator) / T(_denominator);
  }

inverseAs()

template<typename T >

constexpr T olb::utilities::Fraction::inverseAs ( ) const

inlineconstexpr

Definition at line 64 of file fraction.h.

  {
    return _numerator != 0 ? T(_denominator) / T(_numerator) : throw std::invalid_argument("inverse of zero is undefined");
  }

---

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

• src/utilities/fraction.h