int64x64-double.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010 INRIA
 *
 * SPDX-License-Identifier: GPL-2.0-only
 */
 
#ifndef INT64X64_DOUBLE_H
#define INT64X64_DOUBLE_H
 
#include "ns3/core-config.h"
 
#if defined(INT64X64_USE_DOUBLE) || defined(PYTHON_SCAN)
/** Using the ns3::int64x64_t based on double values. */
 
#include <cmath> // pow
#include <stdint.h>
#include <utility> // pair
 
/**
 * \file
 * \ingroup highprec
 * Declaration and implementation of the ns3::int64x64_t type
 * using the double type.
 */
 
namespace ns3
{
 
/**
 * \internal
 * The implementation documented here uses native long double.
 */
class int64x64_t
{
    /// Mask for fraction part
    static const uint64_t HP_MASK_LO = 0xffffffffffffffffULL;
 
  public:
    /// Floating point value of HP_MASK_LO + 1
    static constexpr long double HP_MAX_64 = (static_cast<uint64_t>(1) << 63) * 2.0L;
 
    /**
     * Type tag for the underlying implementation.
     *
     * A few testcases are are sensitive to implementation,
     * specifically the double implementation.  To handle this,
     * we expose the underlying implementation type here.
     */
    enum impl_type
    {
        int128_impl, //!< Native int128_t implementation.
        cairo_impl,  //!< cairo wideint implementation
        ld_impl,     //!< long double implementation
    };
 
    /// Type tag for this implementation.
    static const enum impl_type implementation = ld_impl;
 
    /// Default constructor
    inline int64x64_t()
        : _v(0)
    {
    }
 
    /**
     * \name Construct from a floating point value.
     */
    /**
     * @{
     * Constructor from a floating point.
     *
     * \param [in] value Floating value to represent.
     */
    inline int64x64_t(double value)
        : _v(value)
    {
    }
 
    inline int64x64_t(long double value)
        : _v(value)
    {
    }
 
    /**@}*/
 
    /**
     * \name Construct from an integral type.
     */
    /**@{*/
    /**
     * Construct from an integral type.
     *
     * \param [in] v Integer value to represent
     */
    inline int64x64_t(int v)
        : _v(v)
    {
    }
 
    inline int64x64_t(long int v)
        : _v(v)
    {
    }
 
    inline int64x64_t(long long int v)
        : _v(static_cast<long double>(v))
    {
    }
 
    inline int64x64_t(unsigned int v)
        : _v(v)
    {
    }
 
    inline int64x64_t(unsigned long int v)
        : _v(v)
    {
    }
 
    inline int64x64_t(unsigned long long int v)
        : _v(static_cast<long double>(v))
    {
    }
 
    /**@}*/
    /**
     * Construct from explicit high and low values.
     *
     * \param [in] hi Integer portion.
     * \param [in] lo Fractional portion, already scaled to HP_MAX_64.
     */
    explicit inline int64x64_t(int64_t hi, uint64_t lo)
    {
        const bool negative = hi < 0;
        const long double hild = static_cast<long double>(hi);
        const long double fhi = negative ? -hild : hild;
        const long double flo = lo / HP_MAX_64;
        _v = negative ? -fhi : fhi;
        _v += flo;
        // _v = negative ? -_v : _v;
    }
 
    /**
     * Copy constructor.
     *
     * \param [in] o Value to copy.
     */
    inline int64x64_t(const int64x64_t& o)
        : _v(o._v)
    {
    }
 
    /**
     * Assignment.
     *
     * \param [in] o Value to assign to this int64x64_t.
     * \returns a copy of \pname{o}
     */
    inline int64x64_t& operator=(const int64x64_t& o)
    {
        _v = o._v;
        return *this;
    }
 
    /** Explicit bool conversion. */
    inline explicit operator bool() const
    {
        return (_v != 0);
    }
 
    /**
     * Get this value as a double.
     *
     * \return This value in floating form.
     */
    inline double GetDouble() const
    {
        return (double)_v;
    }
 
  private:
    /**
     * Get the high and low portions of this value.
     *
     * \return A pair of the high and low words
     */
    std::pair<int64_t, uint64_t> GetHighLow() const
    {
        const bool negative = _v < 0;
        const long double v = negative ? -_v : _v;
 
        long double fhi;
        long double flo = std::modf(v, &fhi);
        // Add 0.5 to round, which improves the last count
        // This breaks these tests:
        //   TestSuite devices-mesh-dot11s-regression
        //   TestSuite devices-mesh-flame-regression
        //   TestSuite routing-aodv-regression
        //   TestSuite routing-olsr-regression
        // Setting round = 0; breaks:
        //   TestSuite int64x64
        const long double round = 0.5;
        flo = flo * HP_MAX_64 + round;
        int64_t hi = static_cast<int64_t>(fhi);
        uint64_t lo = static_cast<uint64_t>(flo);
        if (flo >= HP_MAX_64)
        {
            // conversion to uint64 rolled over
            ++hi;
        }
        if (negative)
        {
            lo = ~lo;
            hi = ~hi;
            if (++lo == 0)
            {
                ++hi;
            }
        }
        return std::make_pair(hi, lo);
    }
 
  public:
    /**
     * Get the integer portion.
     *
     * \return The integer portion of this value.
     */
    inline int64_t GetHigh() const
    {
        return GetHighLow().first;
    }
 
    /**
     * Get the fractional portion of this value, unscaled.
     *
     * \return The fractional portion, unscaled, as an integer.
     */
    inline uint64_t GetLow() const
    {
        return GetHighLow().second;
    }
 
    /**
     * Truncate to an integer.
     * Truncation is always toward zero,
     * \return The value truncated toward zero.
     */
    int64_t GetInt() const
    {
        int64_t retval = static_cast<int64_t>(_v);
        return retval;
    }
 
    /**
     * Round to the nearest int.
     * Similar to std::round this rounds halfway cases away from zero,
     * regardless of the current (floating) rounding mode.
     * \return The value rounded to the nearest int.
     */
    int64_t Round() const
    {
        int64_t retval = std::round(_v);
        return retval;
    }
 
    /**
     * Multiply this value by a Q0.128 value, presumably representing an inverse,
     * completing a division operation.
     *
     * \param [in] o The inverse operand.
     *
     * \note There is no difference between Q64.64 and Q0.128 in this implementation,
     * so this function is a simple multiply.
     */
    inline void MulByInvert(const int64x64_t& o)
    {
        _v *= o._v;
    }
 
    /**
     * Compute the inverse of an integer value.
     *
     * \param [in] v The value to compute the inverse of.
     * \return The inverse.
     */
    static inline int64x64_t Invert(uint64_t v)
    {
        int64x64_t tmp((long double)1 / v);
        return tmp;
    }
 
  private:
    /**
     * \name Arithmetic Operators
     * Arithmetic operators for int64x64_t.
     */
    /**
     * @{
     * Arithmetic operator.
     * \param [in] lhs Left hand argument
     * \param [in] rhs Right hand argument
     * \return The result of the operator.
     */
 
    friend inline bool operator==(const int64x64_t& lhs, const int64x64_t& rhs)
    {
        return lhs._v == rhs._v;
    }
 
    friend inline bool operator<(const int64x64_t& lhs, const int64x64_t& rhs)
    {
        return lhs._v < rhs._v;
    }
 
    friend inline bool operator>(const int64x64_t& lhs, const int64x64_t& rhs)
    {
        return lhs._v > rhs._v;
    }
 
    friend inline int64x64_t& operator+=(int64x64_t& lhs, const int64x64_t& rhs)
    {
        lhs._v += rhs._v;
        return lhs;
    }
 
    friend inline int64x64_t& operator-=(int64x64_t& lhs, const int64x64_t& rhs)
    {
        lhs._v -= rhs._v;
        return lhs;
    }
 
    friend inline int64x64_t& operator*=(int64x64_t& lhs, const int64x64_t& rhs)
    {
        lhs._v *= rhs._v;
        return lhs;
    }
 
    friend inline int64x64_t& operator/=(int64x64_t& lhs, const int64x64_t& rhs)
    {
        lhs._v /= rhs._v;
        return lhs;
    }
 
    /**@}*/
 
    /**
     * \name Unary Operators
     * Unary operators for int64x64_t.
     */
    /**
     * @{
     * Unary operator.
     * \param [in] lhs Left hand argument
     * \return The result of the operator.
     */
    friend inline int64x64_t operator+(const int64x64_t& lhs)
    {
        return lhs;
    }
 
    friend inline int64x64_t operator-(const int64x64_t& lhs)
    {
        return int64x64_t(-lhs._v);
    }
 
    friend inline int64x64_t operator!(const int64x64_t& lhs)
    {
        return int64x64_t(!lhs._v);
    }
 
    /**@}*/
 
    long double _v; //!< The Q64.64 value.
 
}; // class int64x64_t
 
} // namespace ns3
 
#endif /* defined(INT64X64_USE_DOUBLE) || defined(PYTHON_SCAN) */
#endif /* INT64X64_DOUBLE_H */