cfix.h

Go to the documentation of this file.

#ifndef CFIX_H
#define CFIX_H

#include <itpp/fixed/fix.h>
#include <itpp/itexports.h>


namespace itpp
{

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


class ITPP_EXPORT CFix : public Fix_Base
{
  template<int, e_mode, o_mode, q_mode> friend class CFixed;
public:
  CFix(double r = 0.0, double i = 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(r)), im(scale_and_apply_modes(i)) {}
  CFix(std::complex<double> x, double, 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(std::real(x))), im(scale_and_apply_modes(std::imag(x))) {}
  explicit CFix(const Fix_Factory &f)
      : Fix_Base(0, f.wordlen, f.emode, f.omode, f.qmode, f.stat_ptr), re(0), im(0) {}
  CFix(fixrep r, fixrep i, int s, int, int)
      : Fix_Base(s), re(r), im(i) {}
  CFix(const Fix &r, const Fix &i = 0.0, int w = MAX_WORDLEN, e_mode e = TC, o_mode o = WRAP, q_mode q = TRN, Stat *ptr = 0)
      : Fix_Base(assert_shifts(r, i), w, e, o, q, ptr), re(r.re), im(i.re) {}
  CFix(const CFix &x, double, 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), im(x.im) {}
  virtual ~CFix() {}

  CFix& operator=(const CFix &x);
  CFix& operator=(const Fix &x);
  CFix& operator=(const std::complex<double> &x);
  CFix& operator=(const int x);
  CFix& operator+=(const CFix &x);
  CFix& operator+=(const Fix &x);
  CFix& operator+=(const int x);
  CFix& operator-=(const CFix &x);
  CFix& operator-=(const Fix &x);
  CFix& operator-=(const int x);
  CFix& operator*=(const CFix &x);
  CFix& operator*=(const Fix &x);
  CFix& operator*=(const int x);
  CFix& operator/=(const CFix &x);
  CFix& operator/=(const Fix &x);
  CFix& operator/=(const int x);
  CFix operator-() const;
  CFix& operator<<=(const int n);
  CFix& operator>>=(const int n);

  void set(double real, double imag, int n);
  void set(double real, double imag, int n, q_mode q);
  void set(const std::complex<double> &x, int n);
  void set(const std::complex<double> &x, int n, q_mode q);
  void set_re(fixrep x) {re = apply_o_mode(x);}
  void set_im(fixrep x) {im = 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;}
  fixrep get_im() const {return im;}
  std::complex<double> unfix() const;

#ifndef NO_IMPLICIT_FIX_CONVERSION

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

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

protected:
  fixrep re;   
  fixrep im;   
};

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

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

typedef Vec<CFix> cfixvec;
typedef Mat<CFix> cfixmat;

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


} // namespace itpp

#endif // #ifndef CFIX_H