gslpp::complex Class Reference

A class for defining operations on and functions of complex numbers. More...

#include <gslpp_complex.h>

Detailed Description

A class for defining operations on and functions of complex numbers.

Author

HEPfit Collaboration

Copyright

GNU General Public License

This class defines some common operations on complex variables using the GSL.

Definition at line 35 of file gslpp_complex.h.

Public Member Functions
double	abs () const
double	abs2 () const
double	arg () const
gsl_complex &	as_gsl_type ()
const gsl_complex &	as_gsl_type () const
gsl_complex *	as_gsl_type_ptr () const
void	assign (const double &real, const double &imag, bool polar)
	complex ()
	Default constructor for the complex class. More...
	complex (const complex &z)
	Copy constructor for the complex class. More...
	complex (const double &a)
	Conversion constructor for the complex class. Converts a real double to a complex type. More...
	complex (const double &real, const double &imag, bool polar=false)
	Overleaded constructor for the complex class. More...
	complex (const gsl_complex &z)
	Conversion constructor for the complex class. Converts a gsl_complex type reference to a complex type. More...
	complex (const gsl_complex *z)
	Conversion constructor for the complex class. Converts a gsl_complex type pointer to a complex type. More...
complex	conjugate () const
double &	imag ()
const double &	imag () const
complex	inverse () const
bool	is_imag () const
	Check if complex number is purely imaginary. More...
bool	is_real () const
	Check if complex number is purely real. More...
double	log_of_abs () const
	operator const gsl_complex & () const
	operator gsl_complex & ()
bool	operator!= (const complex &z1) const
	Inequivalence operator between two complex variables. More...
complex	operator* (const complex &z1) const
	Multiplication operator for a complex number. More...
complex	operator* (const double &a) const
	Multiplication operator for multiplying a real number to a complex number. More...
complex &	operator*= (const complex &z1)
	Muliplication assignment operator for a complex number. More...
complex &	operator*= (const double &a)
	Multiplication assignment operator for mulitplying a real number to a complex number. More...
complex	operator+ (const complex &z1) const
	Addition operator for a complex number. More...
complex	operator+ (const double &a) const
	Addition operator for adding a real number to a complex number. More...
complex &	operator+= (const complex &z1)
	Addition assignment operator for a complex number. More...
complex &	operator+= (const double &a)
	Addition assignment operator for adding a real number to a complex number. More...
complex	operator- () const
	Unary minus operator for a complex number. More...
complex	operator- (const complex &z1) const
	Subtraction operator for a complex number. More...
complex	operator- (const double &a) const
	Subtraction operator for subtracting a real number from a complex number. More...
complex &	operator-= (const complex &z1)
	Subtraction assignment operator for a complex number. More...
complex &	operator-= (const double &a)
	Subtraction assignment operator for subtracting a real number from a complex number. More...
complex	operator/ (const complex &z1) const
	Division operator for a complex number. More...
complex	operator/ (const double &a) const
	Divsion operator for dividing a complex number by a real number. More...
complex &	operator/= (const complex &z1)
	Division assignment operator for a complex number. More...
complex &	operator/= (const double &a)
	Division assignment operator for dividing a complex number by a real number. More...
complex &	operator= (const complex &z)
	Assignment operator for a complex variable of complex type. More...
complex &	operator= (const double &x)
	Assignment operator for a double variable to complex type. More...
bool	operator== (const complex &z1) const
	Equivalence operator between two complex variables. More...
double &	real ()
const double &	real () const
virtual	~complex ()
	Default destructor for the complex class. More...

Static Public Member Functions
static const complex &	i ()

Private Attributes
gsl_complex	_complex

Friends
complex	arccos (const complex &z)
complex	arccosh (const complex &z)
complex	arccot (const complex &z)
complex	arccoth (const complex &z)
complex	arccsc (const complex &z)
complex	arccsch (const complex &z)
complex	arcsec (const complex &z)
complex	arcsech (const complex &z)
complex	arcsin (const complex &z)
complex	arcsinh (const complex &z)
complex	arctan (const complex &z)
complex	arctanh (const complex &z)
complex	cos (const complex &z)
complex	cosh (const complex &z)
complex	cot (const complex &z)
complex	coth (const complex &z)
complex	csc (const complex &z)
complex	csch (const complex &z)
complex	dilog (const complex &z)
complex	exp (const complex &z)
complex	log (const complex &z)
complex	log (const complex &z, const complex &b)
complex	log10 (const complex &z)
std::ostream &	operator<< (std::ostream &output, const complex &z)
complex	pow (const complex &z, const double x)
complex	pow (const complex &z1, const complex &z2)
complex	sec (const complex &z)
complex	sech (const complex &z)
complex	sin (const complex &z)
complex	sinh (const complex &z)
complex	sqrt (const complex &z)
complex	tan (const complex &z)
complex	tanh (const complex &z)
Operations on complex numbers
complex	operator+ (const double &x1, const complex &z2)
complex	operator- (const double &x1, const complex &z2)
complex	operator* (const double &x1, const complex &z2)
complex	operator/ (const double &x1, const complex &z2)

Constructor & Destructor Documentation

complex() [1/6]

gslpp::complex::complex

(

)

Default constructor for the complex class.

Definition at line 18 of file gslpp_complex.cpp.

  {
    assign(0., 0., false);
  }

complex() [2/6]

gslpp::complex::complex	(	const double &	real,
		const double &	imag,
		bool	polar = false
	)

Overleaded constructor for the complex class.

Parameters

[in]	real	real part of the comlex number
[in]	imag	imaginary part of the complex number
[in]	polar	boolean switch for specifying polar form of of the complex number (default: false)

Definition at line 23 of file gslpp_complex.cpp.

  {
    assign(real, imag, polar);
  }

complex() [3/6]

gslpp::complex::complex

(

const complex &

z

)

Copy constructor for the complex class.

Definition at line 28 of file gslpp_complex.cpp.

  {
    assign(z.real(), z.imag(), false);
  }

complex() [4/6]

gslpp::complex::complex

(

const double &

a

)

Conversion constructor for the complex class. Converts a real double to a complex type.

Definition at line 32 of file gslpp_complex.cpp.

  {
    assign(a, 0., false);
  }

complex() [5/6]

gslpp::complex::complex

(

const gsl_complex *

z

)

Conversion constructor for the complex class. Converts a gsl_complex type pointer to a complex type.

Definition at line 160 of file gslpp_complex.cpp.

  {
//    _complex = (gsl_complex*)malloc(sizeof(gsl_complex));
    GSL_SET_COMPLEX(&_complex, GSL_REAL(*z), GSL_IMAG(*z));
  }

complex() [6/6]

gslpp::complex::complex

(

const gsl_complex &

z

)

Conversion constructor for the complex class. Converts a gsl_complex type reference to a complex type.

Definition at line 166 of file gslpp_complex.cpp.

  {
//    _complex = (gsl_complex*)malloc(sizeof(gsl_complex));
    GSL_SET_COMPLEX(&_complex, GSL_REAL(z), GSL_IMAG(z));
  }

~complex()

gslpp::complex::~complex ( )

virtual

Default destructor for the complex class.

Definition at line 37 of file gslpp_complex.cpp.

  {
  }

Member Function Documentation

abs()

double gslpp::complex::abs

(

)

const

Returns

The absolute value of a complex number

Definition at line 81 of file gslpp_complex.cpp.

  {
      return gsl_complex_abs(_complex);
  }

abs2()

double gslpp::complex::abs2

(

)

const

Returns

The square of the absolute value of a complex number

Definition at line 86 of file gslpp_complex.cpp.

  {
      return gsl_complex_abs2(_complex);
  }

arg()

double gslpp::complex::arg

(

)

const

Returns

The argument of a complex number

Definition at line 76 of file gslpp_complex.cpp.

  {
      return gsl_complex_arg(_complex);
  }

as_gsl_type() [1/2]

gsl_complex & gslpp::complex::as_gsl_type

(

)

Definition at line 123 of file gslpp_complex.cpp.

  {
    return _complex;
  }

as_gsl_type() [2/2]

const gsl_complex & gslpp::complex::as_gsl_type

(

)

const

Definition at line 128 of file gslpp_complex.cpp.

  {
      return _complex;
  }

as_gsl_type_ptr()

gsl_complex * gslpp::complex::as_gsl_type_ptr

(

)

const

Conversion

Definition at line 118 of file gslpp_complex.cpp.

  {
      return const_cast<gsl_complex*>(&_complex);
  }

assign()

void gslpp::complex::assign	(	const double &	real = 0.,
		const double &	imag = 0.,
		bool	polar = false
	)

Assign

Definition at line 173 of file gslpp_complex.cpp.

  {
    if (polar)
      _complex = gsl_complex_polar(real,imag);
    else
      {
        GSL_SET_COMPLEX(&_complex, real, imag);
        // *_complex = gsl_complex_rect(real,imag);
      }
  }

conjugate()

complex gslpp::complex::conjugate

(

)

const

Returns

The conjugate of a complex number

Definition at line 288 of file gslpp_complex.cpp.

  {
      gsl_complex t = gsl_complex_conjugate(_complex);
      return complex(t);
  }

i()

const complex & gslpp::complex::i ( )

static

Definition at line 154 of file gslpp_complex.cpp.

  {
    static complex _i(0.,1.);
    return _i;
  }

imag() [1/2]

double & gslpp::complex::imag

(

)

Get the imaginary part

Definition at line 71 of file gslpp_complex.cpp.

  {
    return GSL_IMAG(_complex);
  }

imag() [2/2]

const double & gslpp::complex::imag

(

)

const

Set imaginary part

Definition at line 59 of file gslpp_complex.cpp.

  {
      return GSL_IMAG(_complex);
  }

inverse()

complex gslpp::complex::inverse

(

)

const

Returns

The inverse of a complex number

Definition at line 294 of file gslpp_complex.cpp.

  {
      gsl_complex t = gsl_complex_inverse(_complex);
      return complex(t);
  }

is_imag()

bool gslpp::complex::is_imag

(

)

const

Check if complex number is purely imaginary.

Returns

boolean true/false

Definition at line 47 of file gslpp_complex.cpp.

  {
      return ::fabs(real()/imag()) < GSLEPS;
  }

is_real()

bool gslpp::complex::is_real

(

)

const

Check if complex number is purely real.

Returns

boolean true/false

Definition at line 41 of file gslpp_complex.cpp.

  {
      return ::fabs(imag()/real()) < GSLEPS;
  }

log_of_abs()

double gslpp::complex::log_of_abs

(

)

const

Returns

The logarithm of the absolute value of a complex number

Definition at line 91 of file gslpp_complex.cpp.

  {
      return gsl_complex_logabs(_complex);
  }

operator const gsl_complex &()

gslpp::complex::operator const gsl_complex &

(

)

const

Definition at line 138 of file gslpp_complex.cpp.

  {
      return _complex;
  }

operator gsl_complex &()

gslpp::complex::operator gsl_complex &

(

)

Definition at line 133 of file gslpp_complex.cpp.

  {
    return _complex;
  }

operator!=()

bool gslpp::complex::operator!=

(

const complex &

z1

)

const

Inequivalence operator between two complex variables.

Definition at line 113 of file gslpp_complex.cpp.

  {
      return !(GSL_COMPLEX_EQ(_complex, z1._complex));
  }

operator*() [1/2]

complex gslpp::complex::operator*

(

const complex &

z1

)

const

Multiplication operator for a complex number.

Definition at line 203 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_mul(_complex, z1._complex);
    return complex(rl);
  }

operator*() [2/2]

complex gslpp::complex::operator*

(

const double &

a

)

const

Multiplication operator for multiplying a real number to a complex number.

Definition at line 251 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_mul_real(_complex,a);
    return complex(rl);
  }

operator*=() [1/2]

complex & gslpp::complex::operator*=

(

const complex &

z1

)

Muliplication assignment operator for a complex number.

Definition at line 227 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_mul(_complex, z1._complex);
    return *this;
  }

operator*=() [2/2]

complex & gslpp::complex::operator*=

(

const double &

a

)

Multiplication assignment operator for mulitplying a real number to a complex number.

Definition at line 276 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_mul_real(_complex,a);
    return *this;
  }

operator+() [1/2]

complex gslpp::complex::operator+

(

const complex &

z1

)

const

Addition operator for a complex number.

Definition at line 191 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_add(_complex, z1._complex);
    return complex(rl);
  }

operator+() [2/2]

complex gslpp::complex::operator+

(

const double &

a

)

const

Addition operator for adding a real number to a complex number.

Definition at line 239 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_add_real(_complex,a);
    return complex(rl);
  }

operator+=() [1/2]

complex & gslpp::complex::operator+=

(

const complex &

z1

)

Addition assignment operator for a complex number.

Definition at line 215 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_add(_complex, z1._complex);
    return *this;
  }

operator+=() [2/2]

complex & gslpp::complex::operator+=

(

const double &

a

)

Addition assignment operator for adding a real number to a complex number.

Definition at line 263 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_add_real(_complex,a);
    return *this;
  }

operator-() [1/3]

complex gslpp::complex::operator-

(

)

const

Unary minus operator for a complex number.

Definition at line 185 of file gslpp_complex.cpp.

    {
      gsl_complex t = gsl_complex_negative(_complex);
      return complex(&t);
    }

operator-() [2/3]

complex gslpp::complex::operator-

(

const complex &

z1

)

const

Subtraction operator for a complex number.

Definition at line 197 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_sub(_complex, z1._complex);
    return complex(rl);
  }

operator-() [3/3]

complex gslpp::complex::operator-

(

const double &

a

)

const

Subtraction operator for subtracting a real number from a complex number.

Definition at line 245 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_sub_real(_complex,a);
    return complex(rl);
  }

operator-=() [1/2]

complex & gslpp::complex::operator-=

(

const complex &

z1

)

Subtraction assignment operator for a complex number.

Definition at line 221 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_sub(_complex, z1._complex);
    return *this;
  }

operator-=() [2/2]

complex & gslpp::complex::operator-=

(

const double &

a

)

Subtraction assignment operator for subtracting a real number from a complex number.

Definition at line 269 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_sub_real(_complex,a);
    return *this;
  }

operator/() [1/2]

complex gslpp::complex::operator/

(

const complex &

z1

)

const

Division operator for a complex number.

Definition at line 209 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_div(_complex, z1._complex);
    return complex(rl);
  }

operator/() [2/2]

complex gslpp::complex::operator/

(

const double &

a

)

const

Divsion operator for dividing a complex number by a real number.

Definition at line 257 of file gslpp_complex.cpp.

  {
    gsl_complex rl = gsl_complex_div_real(_complex,a);
    return complex(rl);
  }

operator/=() [1/2]

complex & gslpp::complex::operator/=

(

const complex &

z1

)

Division assignment operator for a complex number.

Definition at line 233 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_div(_complex, z1._complex);
    return *this;
  }

operator/=() [2/2]

complex & gslpp::complex::operator/=

(

const double &

a

)

Division assignment operator for dividing a complex number by a real number.

Definition at line 282 of file gslpp_complex.cpp.

  {
    _complex = gsl_complex_div_real(_complex,a);
    return *this;
  }

operator=() [1/2]

complex & gslpp::complex::operator=

(

const complex &

z

)

Assignment operator for a complex variable of complex type.

Definition at line 96 of file gslpp_complex.cpp.

  {
    GSL_SET_COMPLEX(&_complex, z.real(), z.imag());
    return *this;
  }

operator=() [2/2]

complex & gslpp::complex::operator=

(

const double &

x

)

Assignment operator for a double variable to complex type.

Definition at line 102 of file gslpp_complex.cpp.

  {
    GSL_SET_COMPLEX(&_complex, x, 0);
    return *this;
  }

operator==()

bool gslpp::complex::operator==

(

const complex &

z1

)

const

Equivalence operator between two complex variables.

Definition at line 108 of file gslpp_complex.cpp.

  {
      return GSL_COMPLEX_EQ(_complex, z1._complex);
  }

real() [1/2]

double & gslpp::complex::real

(

)

Get the real part

Definition at line 65 of file gslpp_complex.cpp.

  {
    return GSL_REAL(_complex);
  }

real() [2/2]

const double & gslpp::complex::real

(

)

const

Set the real part

Definition at line 53 of file gslpp_complex.cpp.

  {
      return GSL_REAL(_complex);
  }

Friends And Related Function Documentation

arccos

complex arccos ( const complex &  z )

friend

Inverse cosine

Parameters

[in]

z

Complex number

Returns

\( \arccos z \)

Definition at line 483 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arccos(z.as_gsl_type()));
  }

arccosh

complex arccosh ( const complex &  z )

friend

Inverse hyperbolic cosine

Parameters

[in]

z

Complex number

Returns

\( \mathrm{acosh} z \)

Definition at line 596 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arccosh(z.as_gsl_type()));
  }

arccot

complex arccot ( const complex &  z )

friend

Inverse cotangent

Parameters

[in]

z

Complex number

Returns

\( \mathrm{acot} z \)

Definition at line 519 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arccot(z.as_gsl_type()));
  }

arccoth

complex arccoth ( const complex &  z )

friend

Inverse hyperbolic cotangent

Parameters

[in]

z

Complex number

Returns

\( \mathrm{acoth}(z) \)

Definition at line 632 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arccoth(z.as_gsl_type()));
  }

arccsc

complex arccsc ( const complex &  z )

friend

Inverse cosecant

Parameters

[in]

z

Complex number

Returns

\( \mathrm{acsc} z \)

Definition at line 510 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arccsc(z.as_gsl_type()));
  }

arccsch

complex arccsch ( const complex &  z )

friend

Inverse hyperbolic cosecant

Parameters

[in]

z

Complex number

Returns

\( \mathrm{acsch} z \)

Definition at line 623 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arccsch(z.as_gsl_type()));
  }

arcsec

complex arcsec ( const complex &  z )

friend

Inverse secant

Parameters

[in]

z

Complex number

Returns

\( \mathrm{asec} z \)

Definition at line 501 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arcsec(z.as_gsl_type()));
  }

arcsech

complex arcsech ( const complex &  z )

friend

Inverse hyperbolic secant

Parameters

[in]

z

Complex number

Returns

\( \mathrm{asech} z \)

Definition at line 614 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arcsech(z.as_gsl_type()));
  }

arcsin

complex arcsin ( const complex &  z )

friend

Inverse sine

Parameters

[in]

z

Complex number

Returns

\( \arcsin z \)

Definition at line 474 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arcsin(z.as_gsl_type()));
  }

arcsinh

complex arcsinh ( const complex &  z )

friend

Inverse hyperbolic sine

Parameters

[in]

z

Complex number

Returns

\( \mathrm{asinh} z \)

Definition at line 587 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arcsinh(z.as_gsl_type()));
  }

arctan

complex arctan ( const complex &  z )

friend

Inverse tangent

Parameters

[in]

z

Complex number

Returns

\( \arctan z \)

Definition at line 492 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arctan(z.as_gsl_type()));
  }

arctanh

complex arctanh ( const complex &  z )

friend

Inverse hyperbolic tangent

Parameters

[in]

z

Complex number

Returns

\( \mathrm{atanh} z \)

Definition at line 605 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_arctanh(z.as_gsl_type()));
  }

cos

complex cos ( const complex &  z )

friend

Cosine

Parameters

[in]

z

Complex number

Returns

\( \cos z \)

Definition at line 429 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_cos(z.as_gsl_type()));
  }

cosh

complex cosh ( const complex &  z )

friend

Hyperbolic cosine

Parameters

[in]

z

Complex number

Returns

\( \cosh z \)

Definition at line 542 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_cosh(z.as_gsl_type()));
  }

cot

complex cot ( const complex &  z )

friend

Cotangent

Parameters

[in]

z

Complex number

Returns

\( \cot z \)

Definition at line 465 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_cot(z.as_gsl_type()));
  }

coth

complex coth ( const complex &  z )

friend

Hyperbolic cotangent

Parameters

[in]

z

Complex number

Returns

\( \coth z \)

Definition at line 578 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_coth(z.as_gsl_type()));
  }

csc

complex csc ( const complex &  z )

friend

Cosecant

Parameters

[in]

z

Complex number

Returns

\( \csc z \)

Definition at line 456 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_csc(z.as_gsl_type()));
  }

csch

complex csch ( const complex &  z )

friend

Hyperbolic cosecant

Parameters

[in]

z

Complex number

Returns

\( \mathrm{csch} z \)

Definition at line 569 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_csch(z.as_gsl_type()));
  }

dilog

complex dilog ( const complex &  z )

friend

DiLogarithm of a complex number

Parameters

[in]

z

Complex number

Returns

\( Li_2(z) \)

Definition at line 370 of file gslpp_complex.cpp.

  {
    gsl_sf_result re, im;
    gsl_sf_complex_dilog_xy_e(z.real(), z.imag(), &re, &im);
    return complex(re.val, im.val, false);
  }

exp

complex exp ( const complex &  z )

friend

exponentioal of a complex number

Parameters

[in]

z

Complex number

Returns

\( e^z \)

Definition at line 333 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_exp(z.as_gsl_type()));
  }

log [1/2]

complex log ( const complex &  z )

friend

Logarithm of a complex number (base e)

Parameters

[in]

z

Complex number

Returns

\( \log z \)

Definition at line 342 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_log(z.as_gsl_type()));
  }

log [2/2]

complex log ( const complex &  z, const complex &  b  )

friend

Logarithm of a complex number (base b)

Parameters

[in]	z	Complex number
[in]	b	Complex number

Returns

\( \log_b z \)

Definition at line 361 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_log_b(z.as_gsl_type(),b.as_gsl_type()));
  }

log10

complex log10 ( const complex &  z )

friend

Logarithm of a complex number (base 10)

Parameters

[in]

z

Complex number

Returns

\( \log_{10} z \)

Definition at line 351 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_log10(z.as_gsl_type()));
  }

operator*

complex operator* ( const double &  x1, const complex &  z2  )

friend

Multiply a real and complex numbers

Parameters

[in]	x1	Real number
[in]	z2	Complex number

Returns

\( x_1 z_2 \)

Definition at line 314 of file gslpp_complex.cpp.

  {
    complex z1(x1, 0.);
    return z1 * z2;
  }

operator+

complex operator+ ( const double &  x1, const complex &  z2  )

friend

Add a real and complex numbers

Parameters

[in]	x1	Real number
[in]	z2	Complex number

Returns

\( x_1 + z_2 \)

Definition at line 302 of file gslpp_complex.cpp.

  {
    complex z1(x1, 0.);
    return z1 + z2;
  }

operator-

complex operator- ( const double &  x1, const complex &  z2  )

friend

Subtract a real and complex numbers

Parameters

[in]	x1	Real number
[in]	z2	Complex number

Returns

\( x_1 - z_2 \)

Definition at line 308 of file gslpp_complex.cpp.

  {
    complex z1(x1, 0.);
    return z1 - z2;
  }

operator/

complex operator/ ( const double &  x1, const complex &  z2  )

friend

Divide a real and complex numbers

Parameters

[in]	x1	Real number
[in]	z2	Complex number

Returns

\( x_1 / z_2 \)

Definition at line 320 of file gslpp_complex.cpp.

  {
    complex z1(x1, 0);
    return z1 / z2;
  }

operator<<

std::ostream& operator<< ( std::ostream &  output, const complex &  z  )

friend

Friend functions

Parameters

[in]	output	output stream
[in]	z	Complex number

Returns

formatted output for complex

Definition at line 143 of file gslpp_complex.cpp.

  {
    double absim = ::fabs(z.imag());
    output <<  z.real() << (z.imag() < 0.? "-" : "+");
    if (absim != 1.)
      output << fabs(z.imag()) << "*";
    output << "i";
    return output;
  }

pow [1/2]

complex pow ( const complex &  z, const double  x  )

friend

Complex number to the x real order

Parameters

[in]	z	Complex number
[in]	x	Real number

Returns

\( z^x \)

Definition at line 407 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_pow_real(z.as_gsl_type(), x));
  }

pow [2/2]

complex pow ( const complex &  z1, const complex &  z2  )

friend

Complex number to the z2 complex order

Parameters

[in]	z1	Complex number
[in]	z2	Complex number

Returns

\( z_1^{z_2} \)

Definition at line 395 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_pow(z1.as_gsl_type(),
                                   z2.as_gsl_type()));
  }

sec

complex sec ( const complex &  z )

friend

Secant

Parameters

[in]

z

Complex number

Returns

\( \sec z \)

Definition at line 447 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_sec(z.as_gsl_type()));
  }

sech

complex sech ( const complex &  z )

friend

Hyperbolic secant

Parameters

[in]

z

Complex number

Returns

\( \mathrm{sech} z \)

Definition at line 560 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_sech(z.as_gsl_type()));
  }

sin

complex sin ( const complex &  z )

friend

Sine

Parameters

[in]

z

Complex number

Returns

\( \sin z \)

Definition at line 420 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_sin(z.as_gsl_type()));
  }

sinh

complex sinh ( const complex &  z )

friend

Hyperbolic sine

Parameters

[in]

z

Complex number

Returns

\( \sinh z \)

Definition at line 533 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_sinh(z.as_gsl_type()));
  }

sqrt

complex sqrt ( const complex &  z )

friend

Square root of a complex number

Parameters

[in]

z

Complex number

Returns

\( \sqrt z \)

Definition at line 385 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_sqrt(z.as_gsl_type()));
  }

tan

complex tan ( const complex &  z )

friend

Tangent

Parameters

[in]

z

Complex number

Returns

\( \tan z \)

Definition at line 438 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_tan(z.as_gsl_type()));
  }

tanh

complex tanh ( const complex &  z )

friend

Hyperbolic tangent

Parameters

[in]

z

Complex number

Returns

\( \tanh z \)

Definition at line 551 of file gslpp_complex.cpp.

  {
    return complex(gsl_complex_tanh(z.as_gsl_type()));
  }

Member Data Documentation

_complex

gsl_complex gslpp::complex::_complex

private

Definition at line 37 of file gslpp_complex.h.

---

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

• gslpp_complex.h
• gslpp_complex.cpp