Rational.h

Go to the documentation of this file.

/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited and is protected by copyright law
 * and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable ONIXS Software
 * Services Agreement (the Agreement) and Customer end user license agreements granting
 * a non-assignable, non-transferable and non-exclusive license to use the software
 * for it's own data processing purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
 * of this source code or associated reference material to any other location for further reproduction
 * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
 * the terms of the Agreement is a violation of copyright law.
 */

#pragma once

#include "Export.h"

#include <iosfwd>
#include <string>

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// Rational number representation.
struct ONIXS_ICEMDH_EXPORT Rational
{
    /// This value indicates that value is in not set.
    static const long long NO_VALUE;

    /// Numerator
    long long numerator;

    /// Denominator.
    unsigned int denominator;

    /// Constructs default instance.
    Rational();

    /// Create initialized instance.
    Rational(long long numerator, unsigned int denominator);

    /// Converts some Rational value to another denominator.
    Rational(const Rational& other, unsigned int newDenominator);

    /// Indicates if Rational has no value.
    bool noValue() const;

    /// Converts Rational representation to needed number type.
    ///
    /// Target number type should have accessible constructor from \c int type,
    /// and should have visible \c operator/.
    ///
    /// \code
    /// Decimal d = rational.convertTo<Decimal>()
    /// \endcode
    ///
    template <typename T>
    T convertTo() const;

    /// Implicit conversion to float number type
    operator float() const;

    /// Implicit conversion to double number type
    operator double() const;

    /// string representation of Rational
    std::string toString () const;

    /// Rational comparison
    bool operator==(const Rational& right) const;
    bool operator!=(const Rational& right) const;
    bool operator<(const Rational& right) const;
    bool operator>(const Rational& right) const;
    bool operator<=(const Rational& right) const;
    bool operator>=(const Rational& right) const;
};

/// Make it printable to formatted C++ I/O streams.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream& stream, const Rational& value);

inline Rational::Rational()
    : numerator(NO_VALUE)
    , denominator(1)
{
}

inline Rational::Rational(long long inNumerator, unsigned int inDenominator)
    : numerator(inNumerator)
    , denominator(inDenominator)
{
}

inline Rational::Rational(const Rational& other, unsigned int newDenominator)
    : numerator(newDenominator == other.denominator ? other.numerator : int (other.convertTo<double>() * newDenominator))
    , denominator(newDenominator)
{
}

inline bool Rational::noValue() const
{
    return numerator == NO_VALUE;
}

template <typename T>
inline T Rational::convertTo() const
{
    return T(numerator) / T(denominator);
}

inline Rational::operator float() const
{
    return convertTo<float>();
}

inline Rational::operator double() const
{
    return convertTo<double>();
}

inline bool Rational::operator==(const Rational& right) const
{
    if (denominator == right.denominator)
        return numerator == right.numerator;

    return numerator * right.denominator == right.numerator * denominator;
}

inline bool Rational::operator!=(const Rational& right) const
{
    return !(*this == right);
}

inline bool Rational::operator<(const Rational& right) const
{
    if (denominator == right.denominator)
        return numerator < right.numerator;

    return numerator * right.denominator < right.numerator * denominator;
}

inline bool Rational::operator>(const Rational& right) const
{
    return right < *this;
}

inline bool Rational::operator<=(const Rational& right) const
{
    return !(right < *this);
}

inline bool Rational::operator>=(const Rational& right) const
{
    return !(*this < right);
}

}}}}                                                        // namespace MarketData, iMpact, ICE, OnixS