Templated fixed-point data type. More...
#include <itpp/fixed/fixed.h>
Public Member Functions | |
Fixed (double x=0.0, int s=0, Stat *ptr=0) | |
Default constructor. | |
Fixed (Stat *ptr) | |
Constructor. | |
Fixed (const Fix &x, Stat *ptr=0) | |
Constructor. | |
virtual | ~Fixed () |
Destructor. | |
Fixed & | operator= (const Fix &x) |
Assignment from Fix. | |
Fixed & | operator= (int x) |
Assignment from int. | |
Fix & | operator+= (const Fix &x) |
Addition of Fix. | |
Fix & | operator+= (const int x) |
Addition of int. | |
Fix & | operator-= (const Fix &x) |
Subtraction of Fix. | |
Fix & | operator-= (const int x) |
Subtraction of int. | |
Fix & | operator*= (const Fix &x) |
Multiplication with Fix. | |
Fix & | operator*= (const int x) |
Multiplication with int. | |
Fix & | operator/= (const Fix &x) |
Division with Fix using quantization mode TRN . | |
Fix & | operator/= (const int x) |
Division with int using quantization mode TRN . | |
Fix | operator- () const |
Unary negative of Fix. | |
Fix & | operator<<= (const int n) |
Left shift n bits. | |
Fix & | operator>>= (const int n) |
Right shift n bits using quantization mode qmode (constructor argument) | |
void | set (double x, int n) |
Set to x * pow2(n) using quantization mode qmode (constructor argument) | |
void | set (double x, int n, q_mode q) |
Set to x * pow2(n) using quantization mode q (function argument) | |
void | set_re (fixrep x) |
Set data representation (mainly for internal use since it reveals the representation type) | |
void | lshift (int n) |
Left shift n bits. | |
void | rshift (int n) |
Right shift n bits using quantization mode qmode (constructor argument) | |
void | rshift (int n, q_mode q) |
Right shift n bits using quantization mode q (function argument) | |
virtual void | print () const |
Print restrictions. | |
fixrep | get_re () const |
Get data representation (mainly for internal use since it reveals the representation type) | |
double | unfix () const |
Conversion to double. | |
operator double () const | |
Conversion to double. | |
void | set_shift (int s) |
Set shift (without shifting) | |
int | get_shift () const |
Get shift. | |
int | get_wordlen () const |
Get word length. | |
e_mode | get_e_mode () const |
Get sign encoding mode. | |
o_mode | get_o_mode () const |
Get overflow mode. | |
q_mode | get_q_mode () const |
Get quantization mode. | |
output_mode | get_output_mode () const |
Get output mode. | |
fixrep | get_max () const |
Get maximum value of data representation. | |
fixrep | get_min () const |
Get minimum value of data representation. | |
Static Public Member Functions | |
static void | set_output_mode (output_mode o) |
Set output mode to OUTPUT_FIX, OUTPUT_FIX_SHIFT, OUTPUT_FLOAT or OUTPUT_FLOAT_SHIFT. Static member function. | |
static void | set_output_mode (std::string o) |
Set output mode to "OUTPUT_FIX", "OUTPUT_FIX_SHIFT", "OUTPUT_FLOAT" or "OUTPUT_FLOAT_SHIFT". Static member function. | |
Protected Member Functions | |
void | init () |
Calculate help variables min, max and n_unused_bits. | |
fixrep | apply_o_mode (fixrep x) const |
Handle overflows using overflow mode omode and make call to statistics object (if any) | |
fixrep | scale_and_apply_modes (double x) const |
Convert from double to fixrep using shift and quantization mode qmode , then call limit() | |
fixrep | scale_and_apply_modes (double x, q_mode q) const |
Convert from double to fixrep using shift and quantization mode q , then call limit() | |
fixrep | rshift_and_apply_q_mode (fixrep x, int n) const |
Right shift n bits using quantization mode qmode and make call to statistics object (if any) | |
fixrep | rshift_and_apply_q_mode (fixrep x, int n, q_mode q) const |
Right shift n bits using quantization mode q and make call to statistics object (if any) | |
Protected Attributes | |
fixrep | re |
Data representation. | |
int | shift |
Accumulated bitshift (positive means left-shifted, negative means right-shifted) | |
int | wordlen |
Word length. | |
e_mode | emode |
Sign encoding mode. | |
o_mode | omode |
Overflow mode. | |
q_mode | qmode |
Quantization mode. | |
Stat * | stat_ptr |
Pointer to statistics object. | |
fixrep | min |
Minimum allowed value (help variable to speed up calculations) | |
fixrep | max |
Maximum allowed value (help variable to speed up calculations) | |
int | n_unused_bits |
Number of unused (MSB) bits (help variable to speed up calculations) | |
Templated fixed-point data type.
See the Detailed Description in the Fixed-point Module module.
|
inline |
|
inlineexplicit |
|
inline |
|
inlinevirtual |
|
inline |
Assignment from Fix.
Definition at line 64 of file fixed.h.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::re, and itpp::Fix_Base::shift.
|
inline |
Assignment from int.
Definition at line 70 of file fixed.h.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::re, and itpp::Fix_Base::shift.
Addition of Fix.
Definition at line 52 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::assert_shifts, itpp::Fix::re, and itpp::Fix_Base::shift.
Addition of int.
Definition at line 59 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::assert_shifts, and itpp::Fix::re.
Subtraction of Fix.
Definition at line 66 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::assert_shifts, itpp::Fix::re, and itpp::Fix_Base::shift.
Subtraction of int.
Definition at line 73 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::assert_shifts, and itpp::Fix::re.
Multiplication with Fix.
Definition at line 80 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::re, and itpp::Fix_Base::shift.
Multiplication with int.
Definition at line 87 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), and itpp::Fix::re.
Division with Fix using quantization mode TRN
.
Definition at line 93 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), itpp::Fix::re, and itpp::Fix_Base::shift.
Division with int using quantization mode TRN
.
Definition at line 100 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), and itpp::Fix::re.
|
inherited |
Unary negative of Fix.
Definition at line 106 of file fix.cpp.
References itpp::Fix::re, and itpp::Fix_Base::shift.
Left shift n
bits.
Definition at line 111 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), it_assert_debug, itpp::Fix::re, and itpp::Fix_Base::shift.
Right shift n
bits using quantization mode qmode
(constructor argument)
Definition at line 119 of file fix.cpp.
References itpp::Fix::re, itpp::Fix_Base::rshift_and_apply_q_mode(), and itpp::Fix_Base::shift.
Set to x * pow2(n)
using quantization mode qmode
(constructor argument)
Definition at line 126 of file fix.cpp.
References itpp::Fix::re, itpp::Fix_Base::scale_and_apply_modes(), and itpp::Fix_Base::shift.
Referenced by itpp::operator>>(), itpp::set_fix(), and itpp::set_fix().
Set to x * pow2(n)
using quantization mode q
(function argument)
Definition at line 132 of file fix.cpp.
References itpp::Fix::re, itpp::Fix_Base::scale_and_apply_modes(), and itpp::Fix_Base::shift.
Set data representation (mainly for internal use since it reveals the representation type)
Definition at line 104 of file fix.h.
Referenced by itpp::operator>>().
Left shift n
bits.
Definition at line 138 of file fix.cpp.
References itpp::Fix_Base::apply_o_mode(), it_assert_debug, itpp::Fix::re, and itpp::Fix_Base::shift.
Referenced by itpp::lshift_fix().
Right shift n
bits using quantization mode qmode
(constructor argument)
Definition at line 145 of file fix.cpp.
References itpp::Fix::re, itpp::Fix_Base::rshift_and_apply_q_mode(), and itpp::Fix_Base::shift.
Referenced by itpp::rshift_fix(), and itpp::rshift_fix().
Right shift n
bits using quantization mode q
(function argument)
Definition at line 151 of file fix.cpp.
References itpp::Fix::re, itpp::Fix_Base::rshift_and_apply_q_mode(), and itpp::Fix_Base::shift.
|
virtualinherited |
Print restrictions.
Reimplemented from itpp::Fix_Base.
Definition at line 163 of file fix.cpp.
References itpp::Fix_Base::print(), and itpp::Fix::re.
|
inlineinherited |
Get data representation (mainly for internal use since it reveals the representation type)
Definition at line 116 of file fix.h.
Referenced by itpp::abs(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator+(), itpp::operator+(), itpp::operator+(), itpp::operator+(), itpp::operator+(), itpp::operator-(), itpp::operator-(), itpp::operator-(), itpp::operator-(), itpp::operator-(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator/(), and itpp::operator<<().
|
inherited |
Conversion to double.
Definition at line 157 of file fix.cpp.
References itpp::DOUBLE_POW2, it_assert_debug, itpp::Fix::re, and itpp::Fix_Base::shift.
Referenced by itpp::unfix().
|
inlineinherited |
Conversion to double.
Definition at line 122 of file fix.h.
References itpp::DOUBLE_POW2, and it_assert_debug.
Set shift (without shifting)
Definition at line 994 of file fix_base.h.
Referenced by itpp::operator>>(), and itpp::operator>>().
|
inlinestaticinherited |
Set output mode to OUTPUT_FIX, OUTPUT_FIX_SHIFT, OUTPUT_FLOAT or OUTPUT_FLOAT_SHIFT. Static member function.
Definition at line 996 of file fix_base.h.
Referenced by itpp::operator<<().
|
staticinherited |
Set output mode to "OUTPUT_FIX", "OUTPUT_FIX_SHIFT", "OUTPUT_FLOAT" or "OUTPUT_FLOAT_SHIFT". Static member function.
Definition at line 40 of file fix_base.cpp.
References it_error, itpp::OUTPUT_FIX, itpp::OUTPUT_FIX_SHIFT, itpp::OUTPUT_FLOAT, and itpp::OUTPUT_FLOAT_SHIFT.
|
inlineinherited |
Get shift.
Definition at line 1001 of file fix_base.h.
Referenced by itpp::abs(), itpp::assert_fixshift(), itpp::assert_fixshift(), itpp::conj(), itpp::imag(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator*(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator/(), itpp::operator<<(), itpp::operator<<(), and itpp::real().
|
inlineinherited |
Get word length.
Definition at line 1003 of file fix_base.h.
|
inlineinherited |
Get sign encoding mode.
Definition at line 1005 of file fix_base.h.
|
inlineinherited |
Get overflow mode.
Definition at line 1007 of file fix_base.h.
|
inlineinherited |
Get quantization mode.
Definition at line 1009 of file fix_base.h.
|
inlineinherited |
Get output mode.
Definition at line 1011 of file fix_base.h.
Referenced by itpp::operator<<(), and itpp::operator<<().
|
inlineinherited |
Get maximum value of data representation.
Definition at line 1013 of file fix_base.h.
References itpp::max().
|
inlineinherited |
Get minimum value of data representation.
Definition at line 1015 of file fix_base.h.
References itpp::min().
|
protectedinherited |
Calculate help variables min, max and n_unused_bits.
Definition at line 67 of file fix_base.cpp.
References itpp::Fix_Base::emode, it_assert_debug, it_error, itpp::Fix_Base::max, itpp::MAX_WORDLEN, itpp::Fix_Base::min, itpp::Fix_Base::n_unused_bits, itpp::TC, itpp::UINT64_POW2, itpp::US, and itpp::Fix_Base::wordlen.
Handle overflows using overflow mode omode
and make call to statistics object (if any)
Definition at line 88 of file fix_base.cpp.
References it_error, itpp::Fix_Base::max, itpp::Fix_Base::min, itpp::Fix_Base::n_unused_bits, itpp::Fix_Base::omode, itpp::Stat::sample(), itpp::SAT, itpp::Fix_Base::stat_ptr, and itpp::WRAP.
Referenced by itpp::CFix::lshift(), itpp::Fix::lshift(), itpp::CFix::operator*=(), itpp::CFix::operator*=(), itpp::Fix::operator*=(), itpp::CFix::operator*=(), itpp::Fix::operator*=(), itpp::CFix::operator+=(), itpp::CFix::operator+=(), itpp::Fix::operator+=(), itpp::CFix::operator+=(), itpp::Fix::operator+=(), itpp::CFix::operator-=(), itpp::CFix::operator-=(), itpp::Fix::operator-=(), itpp::CFix::operator-=(), itpp::Fix::operator-=(), itpp::CFix::operator/=(), itpp::CFix::operator/=(), itpp::Fix::operator/=(), itpp::CFix::operator/=(), itpp::Fix::operator/=(), itpp::CFix::operator<<=(), itpp::Fix::operator<<=(), itpp::CFix::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::CFix::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::Fix::operator=(), itpp::Fixed< w, e, o, q >::operator=(), itpp::CFix::operator=(), itpp::Fix::operator=(), itpp::CFix::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::Fixed< w, e, o, q >::operator=(), and itpp::Fix_Base::scale_and_apply_modes().
Convert from double
to fixrep
using shift
and quantization mode qmode
, then call limit()
Definition at line 1044 of file fix_base.h.
References itpp::Fix_Base::scale_and_apply_modes().
Referenced by itpp::Fix_Base::scale_and_apply_modes(), itpp::CFix::set(), itpp::CFix::set(), itpp::CFix::set(), itpp::CFix::set(), itpp::Fix::set(), and itpp::Fix::set().
Convert from double
to fixrep
using shift
and quantization mode q
, then call limit()
Definition at line 128 of file fix_base.cpp.
References itpp::Fix_Base::apply_o_mode(), itpp::DOUBLE_POW2, it_assert_debug, it_error, itpp::RND, itpp::RND_CONV, itpp::RND_CONV_ODD, itpp::RND_INF, itpp::RND_MIN_INF, itpp::RND_ZERO, itpp::round(), itpp::Fix_Base::shift, itpp::TRN, and itpp::TRN_ZERO.
Right shift n
bits using quantization mode qmode
and make call to statistics object (if any)
Definition at line 1048 of file fix_base.h.
References itpp::Fix_Base::rshift_and_apply_q_mode().
Referenced by itpp::CFix::operator>>=(), itpp::Fix::operator>>=(), itpp::CFix::rshift(), itpp::Fix::rshift(), itpp::CFix::rshift(), itpp::Fix::rshift(), and itpp::Fix_Base::rshift_and_apply_q_mode().
|
protectedinherited |
Right shift n
bits using quantization mode q
and make call to statistics object (if any)
Definition at line 182 of file fix_base.cpp.
References it_assert_debug, it_error, itpp::RND, itpp::RND_CONV, itpp::RND_CONV_ODD, itpp::RND_INF, itpp::RND_MIN_INF, itpp::RND_ZERO, itpp::Stat::sample(), itpp::Fix_Base::stat_ptr, itpp::TRN, and itpp::TRN_ZERO.
|
protectedinherited |
Data representation.
Definition at line 137 of file fix.h.
Referenced by itpp::Fix::lshift(), itpp::CFix::operator*=(), itpp::Fix::operator*=(), itpp::Fix::operator*=(), itpp::CFix::operator+=(), itpp::Fix::operator+=(), itpp::Fix::operator+=(), itpp::Fix::operator-(), itpp::CFix::operator-=(), itpp::Fix::operator-=(), itpp::Fix::operator-=(), itpp::CFix::operator/=(), itpp::Fix::operator/=(), itpp::Fix::operator/=(), itpp::Fix::operator<<=(), itpp::CFix::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::Fix::operator=(), itpp::Fixed< w, e, o, q >::operator=(), itpp::Fix::operator=(), itpp::Fixed< w, e, o, q >::operator=(), itpp::Fix::operator>>=(), itpp::Fix::print(), itpp::Fix::rshift(), itpp::Fix::rshift(), itpp::Fix::set(), itpp::Fix::set(), and itpp::Fix::unfix().
|
protectedinherited |
Accumulated bitshift (positive means left-shifted, negative means right-shifted)
Definition at line 1021 of file fix_base.h.
Referenced by itpp::CFix::lshift(), itpp::Fix::lshift(), itpp::CFix::operator*=(), itpp::CFix::operator*=(), itpp::Fix::operator*=(), itpp::CFix::operator+=(), itpp::CFix::operator+=(), itpp::Fix::operator+=(), itpp::CFix::operator-(), itpp::Fix::operator-(), itpp::CFix::operator-=(), itpp::CFix::operator-=(), itpp::Fix::operator-=(), itpp::CFix::operator/=(), itpp::CFix::operator/=(), itpp::Fix::operator/=(), itpp::CFix::operator<<=(), itpp::Fix::operator<<=(), itpp::CFix::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::CFix::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::Fix::operator=(), itpp::Fixed< w, e, o, q >::operator=(), itpp::CFix::operator=(), itpp::Fix::operator=(), itpp::CFix::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::CFixed< w, e, o, q >::operator=(), itpp::Fixed< w, e, o, q >::operator=(), itpp::CFix::operator>>=(), itpp::Fix::operator>>=(), itpp::Fix_Base::print(), itpp::CFix::rshift(), itpp::Fix::rshift(), itpp::CFix::rshift(), itpp::Fix::rshift(), itpp::Fix_Base::scale_and_apply_modes(), itpp::CFix::set(), itpp::CFix::set(), itpp::CFix::set(), itpp::CFix::set(), itpp::Fix::set(), itpp::Fix::set(), itpp::CFix::unfix(), and itpp::Fix::unfix().
|
protectedinherited |
Word length.
Definition at line 1023 of file fix_base.h.
Referenced by itpp::Fix_Base::init(), and itpp::Fix_Base::print().
|
protectedinherited |
Sign encoding mode.
Definition at line 1025 of file fix_base.h.
Referenced by itpp::Fix_Base::init(), and itpp::Fix_Base::print().
|
protectedinherited |
Overflow mode.
Definition at line 1027 of file fix_base.h.
Referenced by itpp::Fix_Base::apply_o_mode(), and itpp::Fix_Base::print().
|
protectedinherited |
Quantization mode.
Definition at line 1029 of file fix_base.h.
Referenced by itpp::Fix_Base::print().
|
protectedinherited |
Pointer to statistics object.
Definition at line 1031 of file fix_base.h.
Referenced by itpp::Fix_Base::apply_o_mode(), itpp::Fix_Base::print(), and itpp::Fix_Base::rshift_and_apply_q_mode().
|
protectedinherited |
Minimum allowed value (help variable to speed up calculations)
Definition at line 1033 of file fix_base.h.
Referenced by itpp::Fix_Base::apply_o_mode(), itpp::Fix_Base::init(), and itpp::Fix_Base::print().
|
protectedinherited |
Maximum allowed value (help variable to speed up calculations)
Definition at line 1035 of file fix_base.h.
Referenced by itpp::Fix_Base::apply_o_mode(), itpp::Fix_Base::init(), and itpp::Fix_Base::print().
|
protectedinherited |
Number of unused (MSB) bits (help variable to speed up calculations)
Definition at line 1037 of file fix_base.h.
Referenced by itpp::Fix_Base::apply_o_mode(), itpp::Fix_Base::init(), and itpp::Fix_Base::print().
Generated on Tue Aug 17 2021 10:59:15 for IT++ by Doxygen 1.9.8