vnl_complex_ops.hxx

Go to the documentation of this file.

// This is core/vnl/vnl_complex_ops.hxx
#ifndef vnl_complex_ops_hxx_
#define vnl_complex_ops_hxx_
//:
// \file
// \author fsm
// This is the implementation file for the following three header files:
// vnl_complexify.h vnl_real.h vnl_imag.h

#include "vnl_complexify.h"
#include "vnl_real.h"
#include "vnl_imag.h"

#include <cassert>
#ifdef _MSC_VER
#  include <vcl_msvc_warnings.h>
#endif

//-----------------------------------------------------------------------

template <class T>
void
vnl_complexify(T const *src, std::complex<T> *dst, unsigned n)
{
  for (unsigned i=0; i<n; ++i)
    dst[i] = src[i];
}

template <class T>
void
vnl_complexify(T const *re, T const *im, std::complex<T> *dst, unsigned n)
{
  for (unsigned i=0; i<n; ++i)
    dst[i] = std::complex<T>(re[i], im[i]);
}

// Real Alone:
// - vnl_vector
// - vnl_vector_fixed -- in header
// - vnl_matrix
// - vnl_matrix_fixed -- in header
// - vnl_diag_matrix
// - vnl_diag_matrix_fixed -- in header
// - vnl_sym_matrix

template <class T>
vnl_vector<std::complex<T> >
  vnl_complexify(vnl_vector<T> const &R)
{
  vnl_vector<std::complex<T> > C(R.size());
  vnl_complexify(R.begin(), C.begin(), R.size());
  return C;
}

template <class T>
vnl_matrix<std::complex<T> >
  vnl_complexify(vnl_matrix<T> const &R)
{
  vnl_matrix<std::complex<T> > C(R.rows(), R.cols());
  vnl_complexify(R.begin(), C.begin(), R.size());
  return C;
}

template <class T>
vnl_diag_matrix<std::complex<T> >
  vnl_complexify(vnl_diag_matrix<T> const& R)
{
  vnl_diag_matrix<std::complex<T> > C(R.rows(), R.cols());
  vnl_complexify(R.begin(), C.begin(), R.size());
  return C;
}

template <class T>
vnl_sym_matrix<std::complex<T> >
  vnl_complexify(vnl_sym_matrix<T> const& R)
{
  vnl_sym_matrix<std::complex<T> > C(R.size());
  vnl_complexify(R.begin(), C.begin(), R.size());
  return C;
}

//----------------------------------------------------------------------

// Real + Imaginary:
// - vnl_vector
// - vnl_vector_fixed -- in header
// - vnl_matrix
// - vnl_matrix_fixed -- in header
// - vnl_diag_matrix
// - vnl_diag_matrix_fixed -- in header
// - vnl_sym_matrix

template <class T>
vnl_vector<std::complex<T> >
  vnl_complexify(vnl_vector<T> const &R, vnl_vector<T> const &I)
{
  assert(R.size() == I.size());
  vnl_vector<std::complex<T> > C(R.size());
  vnl_complexify(R.begin(), I.begin(), C.begin(), R.size());
  return C;
}

template <class T>
vnl_matrix<std::complex<T> >
  vnl_complexify(vnl_matrix<T> const &R, vnl_matrix<T> const &I)
{
  assert(R.rows() == I.rows());
  assert(R.cols() == I.cols());
  vnl_matrix<std::complex<T> > C(R.rows(), R.cols());
  vnl_complexify(R.begin(), I.begin(), C.begin(), R.size());
  return C;
}

template <class T>
vnl_diag_matrix<std::complex<T> >
  vnl_complexify(vnl_diag_matrix<T> const &R, vnl_diag_matrix<T> const &I)
{
  assert(R.rows() == I.rows());
  vnl_diag_matrix<std::complex<T> > C(R.rows());
  vnl_complexify(R.begin(), I.begin(), C.begin(), R.size());
  return C;
}

template <class T>
vnl_sym_matrix<std::complex<T> >
  vnl_complexify(vnl_sym_matrix<T> const &R, vnl_sym_matrix<T> const &I)
{
  assert(R.rows() == I.rows());
  vnl_sym_matrix<std::complex<T> > C(R.rows());
  vnl_complexify(R.begin(), I.begin(), C.begin(), R.size());
  return C;
}

//----------------------------------------------------------------------
// vnl_real()
// - vnl_vector
// - vnl_vector_fixed -- in header
// - vnl_matrix
// - vnl_matrix_fixed -- in header
// - vnl_diag_matrix
// - vnl_diag_matrix_fixed -- in header
// - vnl_sym_matrix

//: Return array of real parts of complex array.
template <class T>
void
  vnl_real(std::complex<T> const* C, T* R, unsigned int n)
{
  for (unsigned int i=0; i<n; ++i)
    R[i] = std::real(C[i]);
}

//: Vector of real parts of vnl_vector<std::complex<T> >.
template <class T>
vnl_vector<T>
  vnl_real(vnl_vector<std::complex<T> > const & C)
{
  vnl_vector<T> R(C.size());
  typename vnl_vector<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_vector<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::real(*cIt);
  return R;
}

//: Matrix of real parts of vnl_matrix<std::complex<T> >.
template <class T>
vnl_matrix<T>
  vnl_real(vnl_matrix<std::complex<T> > const& C)
{
  vnl_matrix<T> R(C.rows(), C.columns());
  typename vnl_matrix<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_matrix<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::real(*cIt);
  return R;
}

//: Matrix of real parts of vnl_diag_matrix<std::complex<T> >.
template <class T>
vnl_diag_matrix<T>
  vnl_real(vnl_diag_matrix<std::complex<T> > const& C)
{
  vnl_diag_matrix<T> R(C.rows());
  typename vnl_diag_matrix<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_diag_matrix<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::real(*cIt);
  return R;
}

//: Matrix of real parts of vnl_sym_matrix<std::complex<T> >.
template <class T>
vnl_sym_matrix<T>
  vnl_real(vnl_sym_matrix<std::complex<T> > const& C)
{
  vnl_sym_matrix<T> R(C.rows());
  typename vnl_sym_matrix<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_sym_matrix<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::real(*cIt);
  return R;
}

//----------------------------------------------------------------------
// vnl_imag()
// - vnl_vector
// - vnl_vector_fixed -- in header
// - vnl_matrix
// - vnl_matrix_fixed -- in header
// - vnl_diag_matrix
// - vnl_diag_matrix_fixed -- in header
// - vnl_sym_matrix

//: Return array of imaginary parts of complex array.
template <class T>
void
  vnl_imag(std::complex<T> const* C, T* I, unsigned int n)
{
  for (unsigned int i=0; i<n; ++i)
    I[i] = std::imag(C[i]);
}

//: Vector of imaginary parts of vnl_vector<std::complex<T> >.
template <class T>
vnl_vector<T>
  vnl_imag(vnl_vector<std::complex<T> > const & C)
{
  vnl_vector<T> R(C.size());
  typename vnl_vector<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_vector<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::imag(*cIt);
  return R;
}

//: Matrix of imaginary parts of vnl_matrix<std::complex<T> >.
template <class T>
vnl_matrix<T>
  vnl_imag(vnl_matrix<std::complex<T> > const& C)
{
  vnl_matrix<T> R(C.rows(), C.columns());
  typename vnl_matrix<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_matrix<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::imag(*cIt);
  return R;
}

//: Matrix of real parts of vnl_diag_matrix<std::complex<T> >.
template <class T>
vnl_diag_matrix<T>
  vnl_imag(vnl_diag_matrix<std::complex<T> > const& C)
{
  vnl_diag_matrix<T> R(C.rows());
  typename vnl_diag_matrix<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_diag_matrix<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::imag(*cIt);
  return R;
}

//: Matrix of real parts of vnl_sym_matrix<std::complex<T> >.
template <class T>
vnl_sym_matrix<T>
  vnl_imag(vnl_sym_matrix<std::complex<T> > const& C)
{
  vnl_sym_matrix<T> R(C.rows());
  typename vnl_sym_matrix<std::complex<T> >::const_iterator cIt = C.begin();
  typename vnl_sym_matrix<T>::iterator rIt = R.begin();
  for (; cIt != C.end(); ++cIt, ++rIt)
    *rIt = std::imag(*cIt);
  return R;
}

//-------------------------------------------------------------------------

#define VNL_COMPLEX_OPS_INSTANTIATE(T) \
template VNL_EXPORT void vnl_complexify(T const *, std::complex<T > *, unsigned); \
template VNL_EXPORT void vnl_complexify(T const *, T const *, std::complex<T > *, unsigned); \
\
template VNL_EXPORT vnl_vector<std::complex<T > > vnl_complexify(vnl_vector<T > const &); \
template VNL_EXPORT vnl_vector<std::complex<T > > vnl_complexify(vnl_vector<T > const &, vnl_vector<T > const &); \
template VNL_EXPORT vnl_matrix<std::complex<T > > vnl_complexify(vnl_matrix<T > const &); \
template VNL_EXPORT vnl_matrix<std::complex<T > > vnl_complexify(vnl_matrix<T > const &, vnl_matrix<T > const &); \
template VNL_EXPORT vnl_diag_matrix<std::complex<T > > vnl_complexify(vnl_diag_matrix<T > const &); \
template VNL_EXPORT vnl_diag_matrix<std::complex<T > > vnl_complexify(vnl_diag_matrix<T > const &,vnl_diag_matrix<T > const&); \
template VNL_EXPORT vnl_sym_matrix<std::complex<T > > vnl_complexify(vnl_sym_matrix<T > const &); \
template VNL_EXPORT vnl_sym_matrix<std::complex<T > > vnl_complexify(vnl_sym_matrix<T > const &,vnl_sym_matrix<T > const&); \
\
template VNL_EXPORT void vnl_real(std::complex<T > const*, T*, unsigned int); \
template VNL_EXPORT void vnl_imag(std::complex<T > const*, T*, unsigned int); \
\
template VNL_EXPORT vnl_vector<T > vnl_real(vnl_vector<std::complex<T > > const&); \
template VNL_EXPORT vnl_vector<T > vnl_imag(vnl_vector<std::complex<T > > const&); \
\
template VNL_EXPORT vnl_matrix<T > vnl_real(vnl_matrix<std::complex<T > > const&); \
template VNL_EXPORT vnl_matrix<T > vnl_imag(vnl_matrix<std::complex<T > > const&); \
\
template VNL_EXPORT vnl_diag_matrix<T > vnl_real(vnl_diag_matrix<std::complex<T > > const&); \
template VNL_EXPORT vnl_diag_matrix<T > vnl_imag(vnl_diag_matrix<std::complex<T > > const&); \
\
template VNL_EXPORT vnl_sym_matrix<T > vnl_real(vnl_sym_matrix<std::complex<T > > const&); \
template VNL_EXPORT vnl_sym_matrix<T > vnl_imag(vnl_sym_matrix<std::complex<T > > const&)

#endif // vnl_complex_ops_hxx_