#include "tensorstore/util/rational.h"
template <typename I>
class tensorstore::Rational;

Represents a rational number (numerator / denominator), with explicit NaN state.

This allows precise representation of relative scales for MultiscaleStore.

This is based on the Boost.Rational library, but differs in that it has an explicit NaN state (denominator == 0) that is used to signal invalid inputs or overflow.

The internal representation is always normalized: the numerator and denominator are relatively prime and the denominator is positive (except to indicate NaN).

Template Parameters:
typename I

The base integer type, must be signed.

Types

using int_type = I;

The base integer type.

Constructors

constexpr Rational(I value = 0);

Constructs from an integer.

constexpr Rational(I n, I d);

Constructs n / d. Unrepresentable values will convert to a NaN value.

Methods

constexpr Rational& operator=(I value);

Assigns to an integer.

constexpr I numerator() const;

Returns the normalized numerator.

constexpr I denominator() const;

Returns the normalized denominator.

constexpr bool is_nan() const;

Indicates whether this is an invalid number.

static constexpr Rational nan();

Returns a special not-a-number value. All comparisons involving nan() return false.

constexpr Rational operator+() const;

No-op.

constexpr Rational operator-() const;

Negates a rational number.

static Rational FromDouble(double value);

Converts a floating-point number to a rational representation.

constexpr Rational Approximate(I max_denominator) const;

Approximates as the closest rational number with a denominator at most max_denominator.

Conversion operators

explicit constexpr operator bool() const;

Equivalent to *this != 0.

Friend functions

friend constexpr bool operator==(Rational t, Rational r);

Compares two rational numbers for equality. As with floating point numbers, NaN values always compare unequal.

friend constexpr bool operator!=(Rational t, Rational r);

Compares two rational numbers for inequality. As with floating point numbers, NaN values always compare unequal.

friend void AbslStringify(Sink& sink, Rational x);

Formats a rational number to an ostream.

friend constexpr Rational operator+(Rational t, Rational r);

Adds two rational numbers.

friend constexpr Rational operator-(Rational t, Rational r);

Subtracts two rational numbers.

friend constexpr Rational operator*(Rational t, Rational r);

Multiplies two rational numbers.

friend constexpr Rational operator/(Rational t, Rational r);

Divides two rational numbers.