fix_functions.h

Go to the documentation of this file.

#ifndef FIX_FUNCTIONS_H
#define FIX_FUNCTIONS_H

#include <itpp/fixed/cfix.h>
#include <itpp/base/vec.h>
#include <itpp/base/mat.h>
#include <itpp/base/array.h>
#include <itpp/base/converters.h>
#include <itpp/itexports.h>


namespace itpp
{


template<class T> inline bool is_fix(const T &) {return false;}
template<> inline bool is_fix(const Fix &) {return true;}
template<> inline bool is_fix(const fixvec &) {return true;}
template<> inline bool is_fix(const fixmat &) {return true;}
template<> inline bool is_fix(const CFix &) {return true;}
template<> inline bool is_fix(const cfixvec &) {return true;}
template<> inline bool is_fix(const cfixmat &) {return true;}
template<class T> inline bool is_fix(const Array<T> &) {return is_fix(T());}

inline void set_fix(Fix &y, double x, int n) {y.set(x, n);}
inline void set_fix(Fix &y, double x, int n, q_mode q) {y.set(x, n, q);}
inline void set_fix(fixvec &y, const vec &x, int n)
{
  y.set_size(x.length());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n);
}
inline void set_fix(fixvec &y, const vec &x, int n, q_mode q)
{
  y.set_size(x.length());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n, q);
}
inline void set_fix(fixmat &y, const mat &x, int n)
{
  y.set_size(x.rows(), x.cols());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n);
}
inline void set_fix(fixmat &y, const mat &x, int n, q_mode q)
{
  y.set_size(x.rows(), x.cols());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n, q);
}
inline void set_fix(double &y, double x, int) {y = x;}
inline void set_fix(double &y, double x, int, q_mode) {y = x;}
inline void set_fix(vec &y, const vec &x, int) {y = x;}
inline void set_fix(vec &y, const vec &x, int, q_mode) {y = x;}
inline void set_fix(mat &y, const mat &x, int) {y = x;}
inline void set_fix(mat &y, const mat &x, int, q_mode) {y = x;}

inline void set_fix(CFix &y, std::complex<double> x, int n) {y.set(x, n);}
inline void set_fix(CFix &y, double real, double imag, int n) {y.set(real, imag, n);}
inline void set_fix(CFix &y, std::complex<double> x, int n, q_mode q) {y.set(x, n, q);}
inline void set_fix(CFix &y, double real, double imag, int n, q_mode q) {y.set(real, imag, n, q);}
inline void set_fix(cfixvec &y, const cvec &x, int n)
{
  y.set_size(x.length());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n);
}
inline void set_fix(cfixvec &y, const vec &real, const vec &imag, int n)
{
  it_assert_debug(real.length() == imag.length(), "set_fix: real and imag should have the same size");
  y.set_size(real.length());
  for (int i = 0; i < y.size(); i++) y(i).set(real(i), imag(i), n);
}
inline void set_fix(cfixvec &y, const cvec &x, int n, q_mode q)
{
  y.set_size(x.length());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n, q);
}
inline void set_fix(cfixvec &y, const vec &real, const vec &imag, int n, q_mode q)
{
  it_assert_debug(real.length() == imag.length(), "set_fix: real and imag should have the same size");
  y.set_size(real.length());
  for (int i = 0; i < y.size(); i++) y(i).set(real(i), imag(i), n, q);
}
inline void set_fix(cfixmat &y, const cmat &x, int n)
{
  y.set_size(x.rows(), x.cols());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n);
}
inline void set_fix(cfixmat &y, const mat &real, const mat &imag, int n)
{
  it_assert_debug(real.rows() == imag.rows() && real.cols() == imag.cols(), "set_fix: real and imag should have the same size");
  y.set_size(real.rows(), real.cols());
  for (int i = 0; i < y.size(); i++) y(i).set(real(i), imag(i), n);
}
inline void set_fix(cfixmat &y, const cmat &x, int n, q_mode q)
{
  y.set_size(x.rows(), x.cols());
  for (int i = 0; i < y.size(); i++) y(i).set(x(i), n, q);
}
inline void set_fix(cfixmat &y, const mat &real, const mat &imag, int n, q_mode q)
{
  it_assert_debug(real.rows() == imag.rows() && real.cols() == imag.cols(), "set_fix: real and imag should have the same size");
  y.set_size(real.rows(), real.cols());
  for (int i = 0; i < y.size(); i++) y(i).set(real(i), imag(i), n, q);
}
inline void set_fix(std::complex<double> &y, const std::complex<double> &x, int) {y = x;}
inline void set_fix(std::complex<double> &y, double real, double imag, int) {y = std::complex<double>(real, imag);}
inline void set_fix(std::complex<double> &y, const std::complex<double> &x, int, q_mode) {y = x;}
inline void set_fix(std::complex<double> &y, double real, double imag, int, q_mode) {y = std::complex<double>(real, imag);}
inline void set_fix(cvec &y, const cvec &x, int) {y = x;}
inline void set_fix(cvec &y, const vec &real, const vec &imag, int) {y = to_cvec(real, imag);}
inline void set_fix(cvec &y, const cvec &x, int, q_mode) {y = x;}
inline void set_fix(cvec &y, const vec &real, const vec &imag, int, q_mode) {y = to_cvec(real, imag);}
inline void set_fix(cmat &y, const cmat &x, int) {y = x;}
inline void set_fix(cmat &y, const mat &real, const mat &imag, int) {y = to_cmat(real, imag);}
inline void set_fix(cmat &y, const cmat &x, int, q_mode) {y = x;}
inline void set_fix(cmat &y, const mat &real, const mat &imag, int, q_mode) {y = to_cmat(real, imag);}

template<class T1, class T2> inline void set_fix(Array<T1> &y, const Array<T2> &x, int n)
{
  y.set_size(x.size());
  for (int i = 0; i < y.size(); i++) set_fix(y(i), x(i), n);
}
template<class T1, class T2> inline void set_fix(Array<T1> &y, const Array<T2> &real, const Array<T2> &imag, int n)
{
  it_assert_debug(real.size() == imag.size(), "set_fix: real and imag should have the same size");
  y.set_size(real.size());
  for (int i = 0; i < y.size(); i++) set_fix(y(i), real(i), imag(i), n);
}
template<class T1, class T2> inline void set_fix(Array<T1> &y, const Array<T2> &x, int n, q_mode q)
{
  y.set_size(x.size());
  for (int i = 0; i < y.size(); i++) set_fix(y(i), x(i), n, q);
}
template<class T1, class T2> inline void set_fix(Array<T1> &y, const Array<T2> &real, const Array<T2> &imag, int n, q_mode q)
{
  it_assert_debug(real.size() == imag.size(), "set_fix: real and imag should have the same size");
  y.set_size(real.size());
  for (int i = 0; i < y.size(); i++) set_fix(y(i), real(i), imag(i), n, q);
}

inline void lshift_fix(Fix &y, int n) {y.lshift(n);}
inline void rshift_fix(Fix &y, int n) {y.rshift(n);}
inline void rshift_fix(Fix &y, int n, q_mode q) {y.rshift(n, q);}
inline void lshift_fix(fixvec &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).lshift(n);}
inline void rshift_fix(fixvec &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n);}
inline void rshift_fix(fixvec &y, int n, q_mode q)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n, q);}
inline void lshift_fix(fixmat &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).lshift(n);}
inline void rshift_fix(fixmat &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n);}
inline void rshift_fix(fixmat &y, int n, q_mode q)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n, q);}
inline void lshift_fix(double &, int) {}
inline void rshift_fix(double &, int) {}
inline void rshift_fix(double &, int, q_mode) {}
inline void lshift_fix(vec &, int) {}
inline void rshift_fix(vec &, int) {}
inline void rshift_fix(vec &, int, q_mode) {}
inline void lshift_fix(mat &, int) {}
inline void rshift_fix(mat &, int) {}
inline void rshift_fix(mat &, int, q_mode) {}
inline void lshift_fix(CFix &y, int n) {y.lshift(n);}
inline void rshift_fix(CFix &y, int n) {y.rshift(n);}
inline void rshift_fix(CFix &y, int n, q_mode q) {y.rshift(n, q);}
inline void lshift_fix(cfixvec &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).lshift(n);}
inline void rshift_fix(cfixvec &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n);}
inline void rshift_fix(cfixvec &y, int n, q_mode q)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n, q);}
inline void lshift_fix(cfixmat &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).lshift(n);}
inline void rshift_fix(cfixmat &y, int n)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n);}
inline void rshift_fix(cfixmat &y, int n, q_mode q)
{for(int i = 0; i < y.size(); i++) y(i).rshift(n, q);}
inline void lshift_fix(std::complex<double> &, int) {}
inline void rshift_fix(std::complex<double> &, int) {}
inline void rshift_fix(std::complex<double> &, int, q_mode) {}
inline void lshift_fix(cvec &, int) {}
inline void rshift_fix(cvec &, int) {}
inline void rshift_fix(cvec &, int, q_mode) {}
inline void lshift_fix(cmat &, int) {}
inline void rshift_fix(cmat &, int) {}
inline void rshift_fix(cmat &, int, q_mode) {}
template<class T> inline void lshift_fix(Array<T> &y, int n)
{for(int i = 0; i < y.size(); i++) lshift_fix(y(i), n);}
template<class T> inline void rshift_fix(Array<T> &y, int n)
{for(int i = 0; i < y.size(); i++) rshift_fix(y(i), n);}
template<class T> inline void rshift_fix(Array<T> &y, int n, q_mode q)
{for(int i = 0; i < y.size(); i++) rshift_fix(y(i), n, q);}

inline void assert_fixshift(double, int) {}
inline void assert_fixshift(const std::complex<double> &, int) {}
inline void assert_fixshift(const Fix &x, int shift)
{it_assert_debug(x.get_shift() == shift, "Shift should be " + to_str(shift) + " but it is " + to_str(x.get_shift()) + ".");}
inline void assert_fixshift(const CFix &x, int shift)
{it_assert_debug(x.get_shift() == shift, "Shift should be " + to_str(shift) + " but it is " + to_str(x.get_shift()) + ".");}

ITPP_EXPORT vec to_vec(const fixvec &v);
ITPP_EXPORT cvec to_cvec(const cfixvec &v);
ITPP_EXPORT mat to_mat(const fixmat &m);
ITPP_EXPORT cmat to_cmat(const cfixmat &m);


template<class T, class U>
class ConvertU2T
{
public:
  typedef T result;
};
template<class T, class U>
class ConvertU2T<T, Array<U> >
{
public:
  typedef Array<typename ConvertU2T<T, U>::result> result;  // Recursive
};
template<class T, class U>
class ConvertU2T<T, Vec<U> >
{
public:
  typedef Vec<T> result;
};
template<class T, class U>
class ConvertU2T<T, Mat<U> >
{
public:
  typedef Mat<T> result;
};


template<class T> inline T to(double x) {return T(x);}
template<class T> inline T to(const Fix &x) {return T(x);}
template<class T> inline T to(const std::complex<double> &x) {return T(x);}
template<class T> inline T to(const CFix &x) {return T(x);}
template<class T> inline T to(double real, double imag) {return T(real, imag);}
template<class T> inline T to(const Fix &real, const Fix &imag) {return T(real, imag);}

template<class T, class U> Vec<T> to(const Vec<U> &x)
{
  Vec<T> y(x.length());
  for (int i = 0; i < x.length(); i++) {
    y(i) = T(x(i));
  }
  return y;
}
template<> inline vec to<double>(const vec &x) {return x;}
template<> inline cvec to<std::complex<double> >(const cvec &x) {return x;}
template<> inline fixvec to<Fix>(const fixvec &x) {return x;}
template<> inline cfixvec to<CFix>(const cfixvec &x) {return x;}

template<class T, class U> Vec<T> to(const Vec<U> &real, const Vec<U> &imag)
{
  it_assert_debug(real.length() == imag.length(), "to: real and imag should have the same size");
  Vec<T> y(real.length());
  for (int i = 0; i < real.length(); i++) {
    y(i) = T(real(i), imag(i));
  }
  return y;
}

template<class T, class U> Mat<T> to(const Mat<U> &x)
{
  Mat<T> y(x.rows(), x.cols());
  for (int i = 0; i < x.rows(); i++) {
    for (int j = 0; j < x.cols(); j++) {
      y(i, j) = T(x(i, j));
    }
  }
  return y;
}
template<> inline mat to<double>(const mat &x) {return x;}
template<> inline cmat to<std::complex<double> >(const cmat &x) {return x;}
template<> inline fixmat to<Fix>(const fixmat &x) {return x;}
template<> inline cfixmat to<CFix>(const cfixmat &x) {return x;}

template<class T, class U> Mat<T> to(const Mat<U> &real, const Mat<U> &imag)
{
  it_assert_debug(real.rows() == imag.rows() && real.cols() == imag.cols(), "to: real and imag should have the same size");
  Mat<T> y(real.rows(), real.cols());
  for (int i = 0; i < real.rows(); i++) {
    for (int j = 0; j < real.cols(); j++) {
      y(i, j) = T(real(i, j), imag(i, j));
    }
  }
  return y;
}

template<class T, class U>
Array<typename ConvertU2T<T, U>::result> to(const Array<U> &x)
{
  Array<typename ConvertU2T<T, U>::result> y(x.size());
  for (int i = 0; i < x.size(); i++) {
    y(i) = to<T>(x(i));
  }
  return y;
}

template<class T, class U>
Array<typename ConvertU2T<T, U>::result> to(const Array<U> &real, const Array<U> &imag)
{
  it_assert_debug(real.size() == imag.size(), "to: real and imag should have the same size");
  Array<typename ConvertU2T<T, U>::result> y(real.size());
  for (int i = 0; i < real.size(); i++) {
    y(i) = to<T>(real(i), imag(i));
  }
  return y;
}

inline double unfix(const Fix &x) {return x.unfix();}
inline std::complex<double> unfix(const CFix &x) {return x.unfix();}
inline vec unfix(const fixvec &x) {return to_vec(x);}
inline cvec unfix(const cfixvec &x) {return to_cvec(x);}
inline mat unfix(const fixmat &x) {return to_mat(x);}
inline cmat unfix(const cfixmat &x) {return to_cmat(x);}

inline double unfix(double x) {return x;}
inline std::complex<double> unfix(const std::complex<double> &x) {return x;}
inline vec unfix(const vec &x) {return x;}
inline cvec unfix(const cvec &x) {return x;}
inline mat unfix(const mat &x) {return x;}
inline cmat unfix(const cmat &x) {return x;}


template<class T>
class Convert
{
public:
  typedef double to_double;
};
template<>
class Convert<CFix>
{
public:
  typedef std::complex<double> to_double;
};
template<class T>
class Convert<std::complex<T> >
{
public:
  typedef std::complex<double> to_double;
};
template<class T>
class Convert<Array<T> >
{
public:
  typedef Array<typename Convert<T>::to_double> to_double;  // Recursive
};
template<class T>
class Convert<Vec<T> >
{
public:
  typedef Vec<typename Convert<T>::to_double> to_double;  // Recursive
};
template<class T>
class Convert<Mat<T> >
{
public:
  typedef Mat<typename Convert<T>::to_double> to_double;  // Recursive
};


template<class T>
Array<typename Convert<T>::to_double> unfix(const Array<T> &x)
{
  Array<typename Convert<T>::to_double> y(x.size());
  for (int i = 0; i < x.size(); i++) {
    y(i) = unfix(x(i));
  }
  return y;
}

ITPP_EXPORT Fix abs(const Fix &x);
ITPP_EXPORT Fix real(const CFix &x);
ITPP_EXPORT Fix imag(const CFix &x);
ITPP_EXPORT CFix conj(const CFix &x);


} // namespace itpp

#endif // #ifndef FIX_FUNCTIONS_H