fix.h

Go to the documentation of this file.

#ifndef FIX_H
#define FIX_H

#include <itpp/fixed/fix_base.h>
#include <itpp/fixed/fix_factory.h>
#include <itpp/itexports.h>

namespace itpp
{

// Forward declarations
template<class Num_T> class Vec;
template<class Num_T> class Mat;


class ITPP_EXPORT Fix : public Fix_Base
{
  friend class CFix;
  template<int, e_mode, o_mode, q_mode> friend class Fixed;
  template<int, e_mode, o_mode, q_mode> friend class CFixed;
public:
  Fix(double x = 0.0, int s = 0, int w = MAX_WORDLEN, e_mode e = TC, o_mode o = WRAP, q_mode q = TRN, Stat *ptr = 0)
      : Fix_Base(s, w, e, o, q, ptr), re(scale_and_apply_modes(x)) {}
  explicit Fix(const Fix_Factory &f)
      : Fix_Base(0, f.wordlen, f.emode, f.omode, f.qmode, f.stat_ptr), re(0) {}
  Fix(fixrep r, int s, int, int)
      : Fix_Base(s), re(r) {}
  Fix(const Fix &x, int w = MAX_WORDLEN, e_mode e = TC, o_mode o = WRAP, q_mode q = TRN, Stat *ptr = 0)
      : Fix_Base(x.shift, w, e, o, q, ptr), re(x.re) {}
  virtual ~Fix() {}

  Fix& operator=(const Fix &x);
  Fix& operator=(const int x);
  Fix& operator+=(const Fix &x);
  Fix& operator+=(const int x);
  Fix& operator-=(const Fix &x);
  Fix& operator-=(const int x);
  Fix& operator*=(const Fix &x);
  Fix& operator*=(const int x);
  Fix& operator/=(const Fix &x);
  Fix& operator/=(const int x);
  Fix operator-() const;
  Fix& operator<<=(const int n);
  Fix& operator>>=(const int n);

  void set(double x, int n);
  void set(double x, int n, q_mode q);
  void set_re(fixrep x) {re = apply_o_mode(x);}

  void lshift(int n);
  void rshift(int n);
  void rshift(int n, q_mode q);

  virtual void print() const;
  fixrep get_re() const {return re;}
  double unfix() const;

#ifndef NO_IMPLICIT_FIX_CONVERSION
  operator double() const {
    it_assert_debug(shift>=-63 && shift <= 64, "Fix::operator double: Illegal shift!");
    return double(re)*DOUBLE_POW2[64 - shift];
  }
#endif

  friend ITPP_EXPORT int assert_shifts(const CFix &x, const Fix &y);
  friend ITPP_EXPORT int assert_shifts(const Fix &x, const Fix &y);
  friend ITPP_EXPORT int assert_shifts(const Fix &x, int y);

protected:
  fixrep re;
};

ITPP_EXPORT int assert_shifts(const Fix &x, const Fix &y);
ITPP_EXPORT int assert_shifts(const Fix &x, int y);

ITPP_EXPORT std::istream &operator>>(std::istream &is, Fix &x);
ITPP_EXPORT std::ostream &operator<<(std::ostream &os, const Fix &x);

typedef Vec<Fix> fixvec;
typedef Mat<Fix> fixmat;

// Specialization of template definition in vec.cpp
template<> void fixvec::set(const char *values);
// Specialization of template definition in mat.cpp
template<> void fixmat::set(const char *values);


} // namespace itpp

#endif // #ifndef FIX_H