Gambit::FcomplexT< T > Class Template Reference

Fortran complex type. More...

#include <util_types.hpp>

Collaboration diagram for Gambit::FcomplexT< T >:

Public Member Functions
	FcomplexT ()
	Default constructor. More...
	~FcomplexT ()
	Default destructor. More...
template<typename T2 >
	FcomplexT (const FcomplexT< T2 > &in)
	Default copy constructor. More...
	FcomplexT (const std::complex< T > &in)
	Constructor from a C++ complex type. More...
	FcomplexT (const T &in)
	Constructor from a single instance of some type. More...
template<typename T2 >
FcomplexT &	operator= (const FcomplexT< T2 > &in)
	Assignment from another Fortran complex type. More...
FcomplexT &	operator= (const std::complex< T > &in)
	Assignment from a C++ complex type. More...
FcomplexT &	operator= (const T &in)
	Assignment from a single instance of some type. More...
template<typename T2 >
	operator FcomplexT< T2 > ()
	Type casting to another Fortran complex type. More...
	operator std::complex< T > ()
	Type casting to a C++ complex type. More...
T	abs () const
template<typename T2 >
FcomplexT	operator* (const FcomplexT< T2 > &in)
template<typename T2 >
FcomplexT	operator/ (const FcomplexT< T2 > &in)

Public Attributes
T	re
T	im

Detailed Description

template<typename T>
class Gambit::FcomplexT< T >

Fortran complex type.

Use typdef versions instead of the DO NOT UNDER ANY CIRCUMSTANCE add new member variables to this class!

Definition at line 524 of file util_types.hpp.

Constructor & Destructor Documentation

FcomplexT() [1/4]

template<typename T>

Gambit::FcomplexT< T >::FcomplexT ( )

inline

Default constructor.

Definition at line 530 of file util_types.hpp.

{}

~FcomplexT()

template<typename T>

Gambit::FcomplexT< T >::~FcomplexT ( )

inline

Default destructor.

Definition at line 532 of file util_types.hpp.

{}

FcomplexT() [2/4]

template<typename T>

template<typename T2 >

Gambit::FcomplexT< T >::FcomplexT ( const FcomplexT< T2 > &  in )

inline

Default copy constructor.

Definition at line 535 of file util_types.hpp.

References Gambit::FcomplexT< T >::im, and Gambit::FcomplexT< T >::re.

      {
        re = in.re;
        im = in.im;
      }

FcomplexT() [3/4]

template<typename T>

Gambit::FcomplexT< T >::FcomplexT ( const std::complex< T > &  in )

inline

Constructor from a C++ complex type.

Definition at line 541 of file util_types.hpp.

      {
        re = in.real();
        im = in.imag();
      }

FcomplexT() [4/4]

template<typename T>

Gambit::FcomplexT< T >::FcomplexT ( const T &  in )

inline

Constructor from a single instance of some type.

Definition at line 547 of file util_types.hpp.

      {
        re = in;
        im = 0.0;
      }

Member Function Documentation

abs()

template<typename T>

T Gambit::FcomplexT< T >::abs ( ) const

inline

Definition at line 586 of file util_types.hpp.

Referenced by Gambit::FcomplexT< T >::operator/().

      {
        return sqrt(re*re + im*im);
      }

Here is the caller graph for this function:

operator FcomplexT< T2 >()

template<typename T>

template<typename T2 >

Gambit::FcomplexT< T >::operator FcomplexT< T2 > ( )

inline

Type casting to another Fortran complex type.

Definition at line 576 of file util_types.hpp.

      {
        return FcomplexT<T2>(std::complex<T2>(re, im));
      }

operator std::complex< T >()

template<typename T>

Gambit::FcomplexT< T >::operator std::complex< T > ( )

inline

Type casting to a C++ complex type.

Definition at line 581 of file util_types.hpp.

      {
        return std::complex<T>(re, im);
      }

operator*()

template<typename T>

template<typename T2 >

FcomplexT Gambit::FcomplexT< T >::operator* ( const FcomplexT< T2 > &  in )

inline

Definition at line 592 of file util_types.hpp.

References Gambit::FcomplexT< T >::im, and Gambit::FcomplexT< T >::re.

      {
        FcomplexT out;

        out.re = re*in.re - im*in.im;
        out.im = re*in.im + im*in.re;

        return out;
      }

operator/()

template<typename T>

template<typename T2 >

FcomplexT Gambit::FcomplexT< T >::operator/ ( const FcomplexT< T2 > &  in )

inline

Definition at line 603 of file util_types.hpp.

References Gambit::FcomplexT< T >::abs(), Gambit::FcomplexT< T >::im, and Gambit::FcomplexT< T >::re.

      {
        FcomplexT out;

        if(in.abs() != 0)
        {
          out.re = (re*in.re + im*in.im) / in.abs();
          out.im = (im*in.re - re*in.im) / in.abs();
        }
        else
        {
          out.re = 0;
          out.im = 0;
        }

        return out;
      }

Here is the call graph for this function:

operator=() [1/3]

template<typename T>

template<typename T2 >

FcomplexT& Gambit::FcomplexT< T >::operator= ( const FcomplexT< T2 > &  in )

inline

Assignment from another Fortran complex type.

Definition at line 554 of file util_types.hpp.

References Gambit::FcomplexT< T >::im, and Gambit::FcomplexT< T >::re.

      {
        re = in.re;
        im = in.im;
        return *this;
      }

operator=() [2/3]

template<typename T>

FcomplexT& Gambit::FcomplexT< T >::operator= ( const std::complex< T > &  in )

inline

Assignment from a C++ complex type.

Definition at line 561 of file util_types.hpp.

      {
        re = in.real();
        im = in.imag();
        return *this;
      }

operator=() [3/3]

template<typename T>

FcomplexT& Gambit::FcomplexT< T >::operator= ( const T &  in )

inline

Assignment from a single instance of some type.

Definition at line 568 of file util_types.hpp.

      {
        re = in;
        im = 0.0;
        return *this;
      }

Member Data Documentation

im

template<typename T>

T Gambit::FcomplexT< T >::im

Definition at line 528 of file util_types.hpp.

Referenced by Gambit::FcomplexT< T >::FcomplexT(), Gambit::FcomplexT< T >::operator*(), Gambit::FcomplexT< T >::operator/(), and Gambit::FcomplexT< T >::operator=().

re

template<typename T>

T Gambit::FcomplexT< T >::re

Definition at line 527 of file util_types.hpp.

Referenced by Gambit::FcomplexT< T >::FcomplexT(), Gambit::FcomplexT< T >::operator*(), Gambit::FcomplexT< T >::operator/(), and Gambit::FcomplexT< T >::operator=().

---

The documentation for this class was generated from the following file:

• Utils/include/gambit/Utils/util_types.hpp