Complex.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.1.19
// ----------------------------------------------------------------------------
// pcl/Complex.h - Released 2019-11-07T10:59:34Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2019 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (http://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------

#ifndef __PCL_Complex_h
#define __PCL_Complex_h


#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>

#include <pcl/Constants.h>
#include <pcl/Math.h>
#include <pcl/Relational.h>

namespace pcl
{

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

#define real   C[0]
#define imag   C[1]

template <typename T>
class PCL_CLASS Complex
{
public:

   typedef T   component;

   Complex()
   {
   }

   Complex( T r, T i = 0 )
   {
      real = r;
      imag = i;
   }

   template <typename T1>
   Complex( const Complex<T1>& c )
   {
      real = T( c.Real() );
      imag = T( c.Imag() );
   }

   constexpr T Real() const
   {
      return real;
   }

   T& Real()
   {
      return real;
   }

   constexpr T Imag() const
   {
      return imag;
   }

   T& Imag()
   {
      return imag;
   }

   constexpr bool IsReal() const
   {
      return imag == 0;
   }

   template <typename T1>
   Complex<T>& operator =( const Complex<T1>& c )
   {
      real = T( c.Real() ), imag = T( c.Imag() );
      return *this;
   }

   template <typename T1>
   Complex<T>& operator +=( const Complex<T1>& c )
   {
      real += c.Real(), imag += c.Imag();
      return *this;
   }

   template <typename T1>
   Complex<T>& operator -=( const Complex<T1>& c )
   {
      real -= c.Real(), imag -= c.Imag();
      return *this;
   }

   template <typename T1>
   Complex<T>& operator *=( const Complex<T1>& c )
   {
      T t = T( real*c.Real() - imag*c.Imag() );
      imag = T( imag*c.Real() + real*c.Imag() );
      real = t;
      return *this;
   }

   template <typename T1>
   Complex<T>& operator /=( const Complex<T1>& c )
   {
      T r, d, t;
      if ( pcl::Abs( c.Real() ) >= pcl::Abs( c.Imag() ) )
      {
         PCL_PRECONDITION( c.Real() != 0 )
         r = T( c.Imag()/c.Real() );
         d = T( c.Real() + r*c.Imag() );
         t = T( (real + r*imag)/d );
         imag = (imag - r*real)/d;
      }
      else
      {
         PCL_PRECONDITION( c.Imag() != 0 )
         r = T( c.Real()/c.Imag() );
         d = T( c.Imag() + r*c.Real() );
         t = T( (real*r + imag)/d );
         imag = (imag*r - real)/d;
      }
      real = t;
      return *this;
   }

   template <typename T1>
   Complex<T>& operator =( T1 x )
   {
      real = x, imag = 0;
      return *this;
   }

   template <typename T1>
   Complex<T>& operator +=( T1 x )
   {
      real += x;
      return *this;
   }

   template <typename T1>
   Complex<T>& operator -=( T1 x )
   {
      real -= x;
      return *this;
   }

   template <typename T1>
   Complex<T>& operator *=( T1 x )
   {
      real *= x, imag *= x;
      return *this;
   }

   template <typename T1>
   Complex<T>& operator /=( T1 x )
   {
      PCL_PRECONDITION( x != 0 )
      real /= x, imag /= x;
      return *this;
   }

   Complex<T> operator +() const
   {
      return *this;
   }

   Complex<T> operator -() const
   {
      return Complex<T>( -real, -imag );
   }

   Complex<T> Conj() const
   {
      return Complex<T>( real, -imag );
   }

   Complex<T> operator ~() const
   {
      return Conj();
   }

   void SetConj()
   {
      imag = -imag;
   }

   T Mag() const
   {
      T r = pcl::Abs( real );
      T i = pcl::Abs( imag );
      T m;
      if ( r == 0 )
         m = i;
      else if ( i == 0 )
         m = r;
      else
      {
         bool q = r < i;
         m = q ? r/i : i/r;
         m = (q ? i : r) * pcl::Sqrt( 1 + m*m );
      }
      return m;
   }

   constexpr T Norm() const
   {
      return real*real + imag*imag;
   }

   constexpr T Arg() const
   {
      // Degenerate cases (real=0) are correctly handled by real ArcTan(). For
      // the undefined case real=imag=0, we silently return zero. Should we
      // throw an exception instead?
      return (real != 0 || imag != 0) ? pcl::ArcTan( imag, real ) : 0;
   }

private:

   /*
    * C99 binary-compatible complex components.
    */
   T C[ 2 ];   // C[0] = real, C[1] = imaginary
};

#undef real
#undef imag

/*
 * ### N.B.: Template class Complex<T> cannot have virtual member functions.
 *     This is because sizeof( Complex<T> ) _must_ be equal to 2*sizeof( T ).
 */
template <typename T>
struct PCL_AssertComplexSize
{
   static_assert( sizeof( Complex<T> ) == 2*sizeof( T ), "Invalid sizeof( Complex<> )" );
};

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

template <typename T> inline
T Abs( const Complex<T>& c )
{
   return c.Mag();
}

template <typename T> inline
Complex<T> Polar( T r, T stheta, T ctheta )
{
   return Complex<T>( r*ctheta, r*stheta );
}

template <typename T> inline
Complex<T> Polar( T r, T theta )
{
   return Polar( r, pcl::Sin( theta ), pcl::Cos( theta ) );
}

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

template <typename T1, class T2> inline
Complex<T1> operator +( const Complex<T1>& c1, const Complex<T2>& c2 )
{
   return Complex<T1>( T1( c1.Real() + c2.Real() ),
                       T1( c1.Imag() + c2.Imag() ) );
}

template <typename T1, class T2> inline
Complex<T1> operator +( const Complex<T1>& c, T2 x )
{
   return Complex<T1>( T1( c.Real()+x ), c.Imag() );
}

template <typename T1, class T2> inline
Complex<T2> operator +( T1 x, const Complex<T2>& c )
{
   return c + x;
}

template <typename T1, class T2> inline
Complex<T1> operator -( const Complex<T1>& c1, const Complex<T2>& c2 )
{
   return Complex<T1>( T1( c1.Real() - c2.Real() ),
                       T1( c1.Imag() - c2.Imag() ) );
}

template <typename T1, class T2> inline
Complex<T1> operator -( const Complex<T1>& c, T2 x )
{
   return Complex<T1>( T1( c.Real()-x ), c.Imag() );
}

template <typename T1, class T2> inline
Complex<T2> operator -( T1 x, const Complex<T2>& c )
{
   return Complex<T2>( T2( x-c.Real() ), -c.Imag() );
}

template <typename T1, class T2> inline
Complex<T1> operator *( const Complex<T1>& c1, const Complex<T2>& c2 )
{
   return Complex<T1>( T1( c1.Real()*c2.Real() - c1.Imag()*c2.Imag() ),
                       T1( c1.Imag()*c2.Real() + c1.Real()*c2.Imag() ) );
}

template <typename T1, class T2> inline
Complex<T1> operator *( const Complex<T1>& c, T2 x )
{
   return Complex<T1>( T1( c.Real()*x ), c.Imag()*x );
}

template <typename T1, class T2> inline
Complex<T2> operator *( T1 x, const Complex<T2>& c )
{
   return c * x;
}

template <typename T1, class T2> inline
Complex<T1> operator /( const Complex<T1>& c1, const Complex<T2>& c2 )
{
   Complex<T1> c;
   T2 r, d;
   if ( pcl::Abs( c2.Real() ) >= pcl::Abs( c2.Imag() ) )
   {
      PCL_PRECONDITION( c2.Real() != 0 )
      r = c2.Imag() / c2.Real();
      d = c2.Real() + r*c2.Imag();
      c.Real() = T1( (c1.Real() + r*c1.Imag())/d );
      c.Imag() = T1( (c1.Imag() - r*c1.Real())/d );
   }
   else
   {
      PCL_PRECONDITION( c2.Imag() != 0 )
      r = c2.Real() / c2.Imag();
      d = c2.Imag() + r*c2.Real();
      c.Real() = T1( (c1.Real()*r + c1.Imag())/d );
      c.Imag() = T1( (c1.Imag()*r - c1.Real())/d );
   }
   return c;
}

template <typename T1, class T2> inline
Complex<T1> operator /( const Complex<T1>& c, T2 x )
{
   PCL_PRECONDITION( x != 0 )
   return Complex<T1>( T1( c.Real()/x ), T1( c.Imag()/x ) );
}

template <typename T1, class T2> inline
Complex<T2> operator /( T1 x, const Complex<T2>& c )
{
   // return Complex( x, 0 )/c;
   Complex<T2> c3;
   T2 r, d;
   if ( pcl::Abs( c.Real() ) >= pcl::Abs( c.Imag() ) )
   {
      PCL_PRECONDITION( c.Real() != 0 )
      r = c.Imag()/c.Real();
      d = c.Real() + r*c.Imag();
      c3.Real() = T2( x/d );
      c3.Imag() = T2( -((r*x)/d) );
   }
   else
   {
      PCL_PRECONDITION( c.Imag() != 0 )
      r = c.Real()/c.Imag();
      d = c.Imag() + r*c.Real();
      c3.Real() = T2( (r*x)/d );
      c3.Imag() = T2( -(x/d) );
   }
   return c3;
}

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

template <typename T> inline
Complex<T> Sqrt( const Complex<T>& c )
{
   if ( c.Real() == 0 && c.Imag() == 0 )
      return Complex<T>( 0 );

   Complex<T> c1;
   T m, r = pcl::Abs( c.Real() ), i = pcl::Abs( c.Imag() );

   if ( r >= i )
   {
      PCL_PRECONDITION( r != 0 )
      T t = i/r;
      m = pcl::Sqrt( r ) * pcl::Sqrt( (1 + pcl::Sqrt( 1 + t*t ))/2 );
   }
   else
   {
      PCL_PRECONDITION( i != 0 )
      T t = r/i;
      m = pcl::Sqrt( i ) * pcl::Sqrt( (t + pcl::Sqrt( 1 + t*t ))/2 );
   }

   if ( c.Real() >= 0 )
   {
      c1.Real() = m;
      c1.Imag() = c.Imag()/(m+m);
   }
   else
   {
      c1.Imag() = (c.Imag() >= 0) ? m : -m;
      c1.Real() = c.Imag()/(c1.Imag()+c1.Imag());
   }

   return c1;
}

template <typename T> inline
Complex<T> Exp( const Complex<T>& c )
{
   T x = pcl::Exp( c.Real() );
   return Complex<T>( x*pcl::Cos( c.Imag() ), x*pcl::Sin( c.Imag() ) );
}

template <typename T> inline
Complex<T> Ln( const Complex<T>& c )
{
   return Complex<T>( pcl::Ln( c.Mag() ), c.Arg() );
}

template <typename T> inline
Complex<T> Log( const Complex<T>& c )
{
   return pcl::Const<T>::log10e() * pcl::Ln( c );
}

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

template <typename T1, class T2> inline
Complex<T1> Pow( const Complex<T1>& c, T2 x )
{
   if ( c.Imag() == 0 )
      return Complex<T1>( pcl::Pow( c.Real(), T1( x ) ) );
   else
      return pcl::Exp( T1( x )*pcl::Ln( c ) );
}

template <typename T1, class T2> inline
Complex<T2> Pow( T1 x, const Complex<T2>& c )
{
   if ( c.Imag() == 0 )
      return Complex<T2>( pcl::Pow( T2( x ), c.Real() ) );
   else
      return pcl::Exp( c*pcl::Ln( T2( x ) ) );
}

template <typename T> inline
Complex<T> Pow( const Complex<T>& c1, const Complex<T>& c2 )
{
   if ( c2.Imag() == 0 )
      return pcl::Pow( c1, c2.Real() );
   else if ( c1.Imag() == 0 )
      return Complex<T>( pcl::Pow( c1.Real(), c2 ) );
   else
      return pcl::Exp( c2*pcl::Ln( c1 ) );
}

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

template <typename T> inline
Complex<T> Sin( const Complex<T>& c )
{
   return Complex<T>( pcl::Sin( c.Real() )*pcl::Cosh( c.Imag() ),
                      pcl::Cos( c.Real() )*pcl::Sinh( c.Imag() ) );
}

template <typename T> inline
Complex<T> Cos( const Complex<T>& c )
{
   return Complex<T>( pcl::Cos( c.Real() )*pcl::Cosh( c.Imag() ),
                     -pcl::Sin( c.Real() )*pcl::Sinh( c.Imag() ) );
}

template <typename T> inline
Complex<T> Tan( const Complex<T>& c )
{
   return pcl::Sin( c )/pcl::Cos( c );
}

template <typename T> inline
Complex<T> Sinh( const Complex<T>& c )
{
   return Complex<T>( pcl::Sinh( c.Real() )*pcl::Cos( c.Imag() ),
                      pcl::Cosh( c.Real() )*pcl::Sin( c.Imag() ) );
}

template <typename T> inline
Complex<T> Cosh( const Complex<T>& c )
{
   return Complex<T>( pcl::Cosh( c.Real() )*pcl::Cos( c.Imag() ),
                      pcl::Sinh( c.Real() )*pcl::Sin( c.Imag() ) );
}

template <typename T> inline
Complex<T> Tanh( const Complex<T>& c )
{
   return pcl::Sinh( c )/pcl::Cosh( c );
}

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

template <typename T1, class T2> inline
bool operator ==( const Complex<T1>& c1, const Complex<T2>& c2 )
{
   return c1.Real() == c2.Real() && c1.Imag() == c2.Imag();
}

template <typename T1, class T2> inline
bool operator ==( const Complex<T1>& c, T2 x )
{
   return c.Real() == x && c.Imag() == T1( 0 );
}

template <typename T1, class T2> inline
bool operator ==( T1 x, const Complex<T2>& c )
{
   return c == x;
}

template <typename T1, class T2> inline
bool operator <( const Complex<T1>& c1, const Complex<T2>& c2 )
{
   return c1.Mag() < c2.Mag();
}

template <typename T1, class T2> inline
bool operator <( const Complex<T1>& c, T2 x )
{
   return c.Mag() < pcl::Abs( x );
}

template <typename T1, class T2> inline
bool operator <( T1 x, const Complex<T2>& c )
{
   return pcl::Abs( x ) < c.Mag();
}

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

template <typename T> inline
Complex<T> Round( const Complex<T>& c )
{
   return Complex<T>( pcl::Round( c.Real() ), pcl::Round( c.Imag() ) );
}

template <typename T> inline
Complex<T> Round( const Complex<T>& c, int n )
{
   PCL_PRECONDITION( n >= 0 )
   return Complex<T>( pcl::Round( c.Real(), n ), pcl::Round( c.Imag(), n ) );
}

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

template <typename T> inline
void PhaseCorrelationMatrix( Complex<T>* i, const Complex<T>* j, const Complex<T>* a, const Complex<T>* b )
{
   const T tiny = T( 1.0e-20 );
   for ( ; i < j; ++i, ++a, ++b )
   {
      Complex<T> n = *a * ~*b;
      *i = n/Max( tiny, Abs( n ) );
   }
}

template <typename T> inline
void CrossPowerSpectrumMatrix( Complex<T>* i, const Complex<T>* j, const Complex<T>* a, const Complex<T>* b )
{
   const T tiny = T( 1.0e-20 );
   for ( ; i < j; ++i, ++a, ++b )
      *i = (*b * ~*a)/Max( tiny, Abs( *a ) * Abs( *b ) );
}

//
// Stream extraction/insertion.
//
/* ### PCL 2.x: Add these along with pcl::DataStream, etc...
template <class S, typename T> inline
S& operator >>( S& s, Complex<T>& c )
{
   return s >> c.Real() >> c.Imag();
}

template <class S, typename T> inline
S& operator <<( S& s, const Complex<T>& c )
{
   return s << c.Real() << c.Imag();
}
 */

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

#ifndef __PCL_NO_COMPLEX_INSTANTIATE

typedef Complex<float>        Complex32;

typedef Complex32             fcomplex;

typedef Complex<double>       Complex64;

typedef Complex64             dcomplex;

typedef dcomplex              complex;

#endif   // __PCL_NO_COMPLEX_INSTANTIATE

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

} // pcl

#endif   // __PCL_Complex_h

// ----------------------------------------------------------------------------
// EOF pcl/Complex.h - Released 2019-11-07T10:59:34Z