GlobalSim::ap_fixed< width, dp, S, T, WS > Struct Template Reference

#include <ap_fixed.h>

Collaboration diagram for GlobalSim::ap_fixed< width, dp, S, T, WS >:

Public Member Functions
	ap_fixed ()=default
	ap_fixed (const double d) requires(std
	ap_fixed (const double d) requires(std
	operator double () const
const ap_fixed	operator+ (const ap_fixed &f) const
const ap_fixed &	operator+= (const ap_fixed &f)
ap_fixed	operator- (const ap_fixed &f) const
const ap_fixed &	operator-= (const ap_fixed &f)
ap_fixed	operator* (const ap_fixed &f) const
const ap_fixed &	operator*= (const ap_fixed &f)
ap_fixed	operator/ (const ap_fixed &f) const
const ap_fixed &	operator/= (const ap_fixed &f)
ap_fixed	operator- () const
void	test_overflow ()

Static Public Member Functions
static ap_fixed	form (T v)

Public Attributes
T	m_value = T{0}
bool	m_ovflw {false}

Static Public Attributes
static constexpr T	m_overflow_mask = max_to_overflow<width, T>()

Friends
std::ostream &	operator<< (std::ostream &os, const ap_fixed< width, dp, S, T, WS > ap)

Detailed Description

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>
struct GlobalSim::ap_fixed< width, dp, S, T, WS >

Definition at line 44 of file ap_fixed.h.

Constructor & Destructor Documentation

ap_fixed() [1/3]

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

GlobalSim::ap_fixed< width, dp, S, T, WS >::ap_fixed ( )

default

ap_fixed() [2/3]

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

GlobalSim::ap_fixed< width, dp, S, T, WS >::ap_fixed ( const double  d )

inline

Definition at line 58 of file ap_fixed.h.

                                                             :
        m_value(d * double (1<< dp) + (d >= 0 ? 0.5 : -0.5)){
      test_overflow();
    }

ap_fixed() [3/3]

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

GlobalSim::ap_fixed< width, dp, S, T, WS >::ap_fixed ( const double  d )

inline

Definition at line 63 of file ap_fixed.h.

                                                              :
        m_value(d * double (1<< dp) + (d >= 0 ? 0. : -1.0)){
      test_overflow();
    }

Member Function Documentation

form()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

static ap_fixed GlobalSim::ap_fixed< width, dp, S, T, WS >::form ( T  v )

inlinestatic

Definition at line 74 of file ap_fixed.h.

                              {
      ap_fixed k; k.m_value = v; k.test_overflow();return k;
    }

operator double()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

GlobalSim::ap_fixed< width, dp, S, T, WS >::operator double ( ) const

inline

Definition at line 69 of file ap_fixed.h.

                           {
      return double(this->m_value) / double(1 << dp);
    }

operator*()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

ap_fixed GlobalSim::ap_fixed< width, dp, S, T, WS >::operator* ( const ap_fixed< width, dp, S, T, WS > &  f ) const

inline

Definition at line 100 of file ap_fixed.h.

                                                  {
      return form((WS(this->m_value) * WS(f.m_value)) >> dp);
    }

operator*=()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

const ap_fixed& GlobalSim::ap_fixed< width, dp, S, T, WS >::operator*= ( const ap_fixed< width, dp, S, T, WS > &  f )

inline

Definition at line 104 of file ap_fixed.h.

                                                    {
      this->m_value = (WS(this->m_value) * WS(f.m_value) >> dp);
      test_overflow();
      return *this;
    }

operator+()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

const ap_fixed GlobalSim::ap_fixed< width, dp, S, T, WS >::operator+ ( const ap_fixed< width, dp, S, T, WS > &  f ) const

inline

Definition at line 78 of file ap_fixed.h.

                                                        {
      return form(this->m_value + f.m_value);
    }

operator+=()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

const ap_fixed& GlobalSim::ap_fixed< width, dp, S, T, WS >::operator+= ( const ap_fixed< width, dp, S, T, WS > &  f )

inline

Definition at line 83 of file ap_fixed.h.

                                                     {
      this->m_value += f.m_value;
      test_overflow();
      return *this;
    }

operator-() [1/2]

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

ap_fixed GlobalSim::ap_fixed< width, dp, S, T, WS >::operator- ( ) const

inline

Definition at line 122 of file ap_fixed.h.

                                 {
      return form(-this->m_value);
    }

operator-() [2/2]

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

ap_fixed GlobalSim::ap_fixed< width, dp, S, T, WS >::operator- ( const ap_fixed< width, dp, S, T, WS > &  f ) const

inline

Definition at line 89 of file ap_fixed.h.

                                                  {
      return form(this->m_value - f.m_value);
    }

operator-=()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

const ap_fixed& GlobalSim::ap_fixed< width, dp, S, T, WS >::operator-= ( const ap_fixed< width, dp, S, T, WS > &  f )

inline

Definition at line 94 of file ap_fixed.h.

                                                    {
      this->m_value -= f.m_value;
      test_overflow();
      return *this;
    }

operator/()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

ap_fixed GlobalSim::ap_fixed< width, dp, S, T, WS >::operator/ ( const ap_fixed< width, dp, S, T, WS > &  f ) const

inline

Definition at line 111 of file ap_fixed.h.

                                                  {
      return form((WS(this->m_value) << dp) / WS(f.m_value));
    }

operator/=()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

const ap_fixed& GlobalSim::ap_fixed< width, dp, S, T, WS >::operator/= ( const ap_fixed< width, dp, S, T, WS > &  f )

inline

Definition at line 115 of file ap_fixed.h.

                                                    {
      this->m_value = ((WS(this->m_value) << dp) / WS(f.m_value));
      test_overflow();
      return *this;
    }

test_overflow()

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

void GlobalSim::ap_fixed< width, dp, S, T, WS >::test_overflow ( )

inline

Definition at line 126 of file ap_fixed.h.

                         {
 
      if (m_value > 0) {
    if (m_value & m_overflow_mask) {
      m_ovflw=true;
    }
      } else {
    if (-m_value & m_overflow_mask) {
      m_ovflw=true;
    }
      }
 
      if (m_ovflw) {
    std::stringstream ss;
    T val = std::abs(m_value);
    
    ss << "ap_fixed overflow. val: " 
       << m_value << " abs(val): " << val
       << ' ' << std::hex << val
       <<  " masked " << (val & m_overflow_mask);
    throw std::out_of_range(ss.str());
      }
    }

Friends And Related Function Documentation

operator<<

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

std::ostream& operator<< ( std::ostream &  os, const ap_fixed< width, dp, S, T, WS >  ap  )

friend

Definition at line 50 of file ap_fixed.h.

                                                             {
      os << ap.m_value << ' ' << double(ap);
      return os;
    }

Member Data Documentation

m_overflow_mask

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

constexpr T GlobalSim::ap_fixed< width, dp, S, T, WS >::m_overflow_mask = max_to_overflow<width, T>()

staticconstexpr

Definition at line 47 of file ap_fixed.h.

m_ovflw

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

bool GlobalSim::ap_fixed< width, dp, S, T, WS >::m_ovflw {false}

Definition at line 49 of file ap_fixed.h.

m_value

template<std::size_t width, std::size_t dp, typename S = XilDef, typename T = int16_t, typename WS = int32_t>

T GlobalSim::ap_fixed< width, dp, S, T, WS >::m_value = T{0}

Definition at line 46 of file ap_fixed.h.

---

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

• ap_fixed.h