C-XSC - A C++ Class Library for Extended Scientific Computing 2.5.4
cxsc::complex Class Reference

The Scalar Type complex. More...

#include <complex.hpp>

Collaboration diagram for cxsc::complex:
Collaboration graph

Public Member Functions

 complex (const cdotprecision &) noexcept
 Constructor of class complex.
 
 complex (const cmatrix &) noexcept
 Constructor of class complex.
 
 complex (const cmatrix_slice &) noexcept
 Constructor of class complex.
 
 complex (const cvector &) noexcept
 Constructor of class complex.
 
 complex (const cvector_slice &) noexcept
 Constructor of class complex.
 
 complex (const real &a, const real &b) noexcept
 Constructor of class complex.
 
 complex (const real &r) noexcept
 Constructor of class complex.
 
 complex (void) noexcept
 Constructor of class complex.
 
complexoperator= (const cdotprecision &) noexcept
 Implementation of standard assigning operator.
 
complexoperator= (const l_complex &) noexcept
 Assigning l_complex to complex.
 
complexoperator= (const lx_complex &) noexcept
 Assigning lx_complex to complex.
 
complexoperator= (const real &r) noexcept
 Implementation of standard assigning operator.
 

Friends

complex _complex (const cdotprecision &a) noexcept
 Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.
 
complex _complex (const cmatrix &) noexcept
 Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.
 
complex _complex (const cmatrix_slice &) noexcept
 Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.
 
complex _complex (const cvector &) noexcept
 Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.
 
complex _complex (const cvector_slice &) noexcept
 Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.
 
real abs (complex z)
 Returns the absolute value of a complex value.
 
real abs2 (const complex &a)
 Returns the absolute value of a complex value.
 
complex adddown (const complex &a, const complex &b)
 Returns the downward rounded result of the addition operation.
 
complex adddown (const complex &a, const real &b)
 Returns the downward rounded result of the addition operation.
 
complex adddown (const real &a, const complex &b)
 Returns the downward rounded result of the addition operation.
 
complex addup (const complex &a, const complex &b)
 Returns the upward rounded result of the addition operation.
 
complex addup (const complex &a, const real &b)
 Returns the upward rounded result of the addition operation.
 
complex addup (const real &a, const complex &b)
 Returns the upward rounded result of the addition operation.
 
complex conj (const complex &a)
 Returns the conjugated complex value.
 
complex divdown (const complex &a, const complex &b)
 Returns the downward rounded result of the division operation.
 
complex divdown (const complex &a, const real &b)
 Returns the downward rounded result of the division operation.
 
complex divdown (const real &a, const complex &b)
 Returns the downward rounded result of the division operation.
 
complex divn (const complex &a, const complex &b)
 Returns the nearest rounded result of the division operation.
 
complex divup (const complex &a, const complex &b)
 Returns the upward rounded result of the operation.
 
complex divup (const complex &a, const real &b)
 Returns the upward rounded result of the division operation.
 
complex divup (const real &a, const complex &b)
 Returns the upward rounded result of the division operation.
 
realIm (complex &a)
 Returns the imaginary part of the complex value.
 
real Im (const complex &a)
 Returns the imaginary part of the complex value.
 
complex multdown (const complex &a, const complex &b)
 Returns the downward rounded result of the multiplication operation.
 
complex multdown (const complex &a, const real &b)
 Returns the downward rounded result of the multiplication operation.
 
complex multdown (const real &a, const complex &b)
 Returns the downward rounded result of the multiplication operation.
 
complex multup (const complex &a, const complex &b)
 Returns the upward rounded result of the multiplication operation.
 
complex multup (const complex &a, const real &b)
 Returns the upward rounded result of the multiplication operation.
 
complex multup (const real &a, const complex &b)
 Returns the upward rounded result of the multiplication operation.
 
bool operator! (const complex &a)
 Implementation of standard negation operation.
 
bool operator!= (const complex &a, const complex &b)
 Implementation of standard negated equality operation.
 
bool operator!= (const complex &a, const dotprecision &b)
 Implementation of standard negated equality operation.
 
bool operator!= (const complex &a, const real &b)
 Implementation of standard negated equality operation.
 
bool operator!= (const dotprecision &a, const complex &b)
 Implementation of standard negated equality operation.
 
bool operator!= (const real &a, const complex &b)
 Implementation of standard negated equality operation.
 
complex operator* (const complex &a, const complex &b)
 Implementation of standard algebraic multiplication operation.
 
complex operator* (const complex &a, const real &b)
 Implementation of standard algebraic multiplication operation.
 
complex operator* (const real &a, const complex &b)
 Implementation of standard algebraic multiplication operation.
 
complexoperator*= (complex &a, const complex &b)
 Implementation of standard algebraic multiplication and allocation operation.
 
complexoperator*= (complex &a, const real &b)
 Implementation of standard algebraic multiplication and allocation operation.
 
complex operator+ (const complex &a)
 Implementation of standard algebraic positive sign operation.
 
complex operator+ (const complex &a, const complex &b)
 Implementation of standard algebraic addition operation.
 
complex operator+ (const complex &a, const real &b)
 Implementation of standard algebraic addition operation.
 
complex operator+ (const real &a, const complex &b)
 Implementation of standard algebraic addition operation.
 
complexoperator+= (complex &a, const complex &b)
 Implementation of standard algebraic addition and allocation operation.
 
complexoperator+= (complex &a, const real &b)
 Implementation of standard algebraic addition and allocation operation.
 
complex operator- (const complex &a)
 Implementation of standard algebraic negative sign operation.
 
complex operator- (const complex &a, const complex &b)
 Implementation of standard algebraic subtraction operation.
 
complex operator- (const complex &a, const real &b)
 Implementation of standard algebraic subtraction operation.
 
complex operator- (const real &a, const complex &b)
 Implementation of standard algebraic subtraction operation.
 
complexoperator-= (complex &a, const complex &b)
 Implementation of standard algebraic subtraction and allocation operation.
 
complexoperator-= (complex &a, const real &b)
 Implementation of standard algebraic subtraction and allocation operation.
 
complex operator/ (const complex &a, const complex &b)
 Implementation of standard algebraic division operation.
 
complex operator/ (const complex &a, const real &b)
 Implementation of standard algebraic division operation.
 
complex operator/ (const real &a, const complex &b)
 Implementation of standard algebraic division operation.
 
complexoperator/= (complex &a, const complex &b)
 Implementation of standard algebraic division and allocation operation.
 
complexoperator/= (complex &a, const real &b)
 Implementation of standard algebraic division and allocation operation.
 
std::ostream & operator<< (std::ostream &s, const complex &a)
 Implementation of standard output method.
 
std::string & operator<< (std::string &s, const complex &a)
 Implementation of standard output method.
 
bool operator== (const complex &a, const complex &b)
 Implementation of standard equality operation.
 
bool operator== (const complex &a, const dotprecision &b)
 Implementation of standard equality operation.
 
bool operator== (const complex &a, const real &b)
 Implementation of standard equality operation.
 
bool operator== (const dotprecision &a, const complex &b)
 Implementation of standard equality operation.
 
bool operator== (const real &a, const complex &b)
 Implementation of standard equality operation.
 
void operator>> (const char *s, complex &a)
 Implementation of standard input method.
 
void operator>> (const std::string &s, complex &a)
 Implementation of standard input method.
 
std::istream & operator>> (std::istream &s, complex &a)
 Implementation of standard input method.
 
std::string & operator>> (std::string &s, complex &a)
 Implementation of standard input method.
 
realRe (complex &a)
 Returns the real part of the complex value.
 
real Re (const complex &a)
 Returns the real part of the complex value.
 
complexSetIm (complex &a, const real &b)
 Sets the imaginary part of a complex value.
 
complexSetRe (complex &a, const real &b)
 Sets the real part of a complex value.
 
complex subdown (const complex &a, const complex &b)
 Returns the downward rounded result of the subtraction operation.
 
complex subdown (const complex &a, const real &b)
 Returns the downward rounded result of the subtraction operation.
 
complex subdown (const real &a, const complex &b)
 Returns the downward rounded result of the subtraction operation.
 
complex subup (const complex &a, const complex &b)
 Returns the upward rounded result of the subtraction operation.
 
complex subup (const complex &a, const real &b)
 Returns the upward rounded result of the subtraction operation.
 
complex subup (const real &a, const complex &b)
 Returns the upward rounded result of the subtraction operation.
 

Detailed Description

The Scalar Type complex.

The data type complex is used to store complex numbers $ z = x + i y \in C $, where $ x $ denotes the real part, $ y $ denotes the imaginary part of $ z $, and $ i $ denotes the imaginary unit $ \sqrt{-1} $.

Definition at line 49 of file complex.hpp.

Friends And Related Symbol Documentation

◆ _complex [1/5]

complex _complex ( const cdotprecision & a)
friend

Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.

Deprecated
use standard contructors for typecasting
See also
cxsc::complex::complex(const cdotprecision &)

Definition at line 160 of file complex.hpp.

◆ _complex [2/5]

complex _complex ( const cmatrix & )
friend

Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.

Deprecated
use standard contructors for typecasting
See also
cxsc::complex::complex(const cmatrix &)

◆ _complex [3/5]

complex _complex ( const cmatrix_slice & )
friend

Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.

Deprecated
use standard contructors for typecasting
See also
cxsc::complex::complex(const cmatrix_slice &)

◆ _complex [4/5]

complex _complex ( const cvector & )
friend

Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.

Deprecated
use standard contructors for typecasting
See also
cxsc::complex::complex(const cvector &)

◆ _complex [5/5]

complex _complex ( const cvector_slice & )
friend

Deprecated typecast, which only exist for the reason of compatibility with older versions of C-XSC.

Deprecated
use standard contructors for typecasting
See also
cxsc::complex::complex(const cvector_slice &)

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