gslpp::matrix< complex > Class Template Reference

A class for constructing and defining operations on complex matrices. More...

#include <gslpp_matrix_complex.h>

Detailed Description

template<>
class gslpp::matrix< complex >

A class for constructing and defining operations on complex matrices.

Author

HEPfit Collaboration

Copyright

GNU General Public License

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

Definition at line 45 of file gslpp_matrix_complex.h.

Public Member Functions
gsl_matrix_complex &	as_gsl_type ()
const gsl_matrix_complex &	as_gsl_type () const
gsl_matrix_complex *	as_gsl_type_ptr () const
void	assign (const size_t &i, const size_t &j, const complex &z)
void	assign (const size_t &i, const size_t &j, const double &a)
void	assign (const size_t &i, const size_t &j, const matrix< complex > &z)
void	assign (const size_t &i, const size_t &j, const matrix< double > &a)
void	assignim (const size_t &i, const size_t &j, const double &a)
void	assignre (const size_t &i, const size_t &j, const double &a)
void	eigensystem (matrix< complex > &U, vector< double > &S) const
matrix< complex >	hconjugate () const
matrix< double >	imag () const
matrix< complex >	inverse () const
bool	isSingular ()
	matrix (const gsl_matrix_complex &m)
	matrix (const gsl_matrix_complex *m)
	matrix (const matrix< complex > &m)
	matrix (const matrix< double > &m)
	matrix (const size_t &size_i, const complex &z)
	matrix (const size_t &size_i, const double &a)
	matrix (const size_t &size_i, const size_t &size_j, const complex &z)
	Constructor. More...
	matrix (const size_t &size_i, const size_t &size_j, const double &a)
	Constructor. More...
	matrix (const vector< complex > &v)
	matrix (const vector< double > &v)
bool	operator!= (const matrix< complex > &a) const
const complex	operator() (const size_t &i, const size_t &j) const
matrix< complex >	operator* (const complex &z) const
matrix< complex >	operator* (const double &a) const
matrix< complex >	operator* (const matrix< complex > &m) const
matrix< complex >	operator* (const matrix< double > &m) const
vector< complex >	operator* (const vector< complex > &v) const
vector< complex >	operator* (const vector< double > &v) const
matrix< complex > &	operator*= (const complex &z)
matrix< complex > &	operator*= (const double &a)
matrix< complex > &	operator*= (const matrix< complex > &m)
matrix< complex >	operator+ (const complex &z) const
matrix< complex >	operator+ (const double &a) const
matrix< complex >	operator+ (const matrix< complex > &m) const
matrix< complex >	operator+ (const matrix< double > &m) const
matrix< complex > &	operator+= (const complex &z)
matrix< complex > &	operator+= (const double &a)
matrix< complex > &	operator+= (const matrix< complex > &m)
matrix< complex >	operator- () const
matrix< complex >	operator- (const complex &z) const
matrix< complex >	operator- (const double &a) const
matrix< complex >	operator- (const matrix< complex > &m) const
matrix< complex >	operator- (const matrix< double > &m) const
matrix< complex > &	operator-= (const complex &z)
matrix< complex > &	operator-= (const double &a)
matrix< complex > &	operator-= (const matrix< complex > &m)
matrix< complex >	operator/ (const complex &z) const
matrix< complex >	operator/ (const double &a) const
matrix< complex > &	operator/= (const complex &z)
matrix< complex > &	operator/= (const double &a)
matrix< complex > &	operator= (const matrix< complex > &m)
bool	operator== (const matrix< complex > &a) const
matrix< double >	real () const
void	reset ()
void	singularvalue (matrix< complex > &U, matrix< complex > &V, vector< double > &S) const
size_t	size () const
size_t	size_i () const
size_t	size_j () const
matrix< complex >	transpose () const
	~matrix ()

Static Public Member Functions
static matrix< complex >	Id (size_t size)

Private Attributes
gsl_matrix_complex *	_matrix

Friends
std::ostream &	operator<< (std::ostream &output, const matrix< complex > &v)
Operations on matrix<complex>
matrix< complex >	operator+ (matrix< double > m1, const matrix< complex > m2)
matrix< complex >	operator- (matrix< double > m1, const matrix< complex > m2)
matrix< complex >	operator+ (const complex &z, const matrix< complex > m)
matrix< complex >	operator- (const complex &z, const matrix< complex > m)
matrix< complex >	operator* (const complex &z, const matrix< complex > m)
vector< complex >	operator* (const vector< complex > &v, const matrix< complex > m)
vector< complex >	operator* (const vector< double > &v, const matrix< complex > m)
matrix< complex >	operator+ (const double &a, const matrix< complex > m)
matrix< complex >	operator- (const double &a, const matrix< complex > m)
matrix< complex >	operator* (const double &a, const matrix< complex > m)

Constructor & Destructor Documentation

matrix() [1/10]

gslpp::matrix< complex >::matrix	(	const size_t &	size_i,
		const size_t &	size_j,
		const complex &	z
	)

Constructor.

Parameters

size_i	number of rows
size_j	number of columns
z	initial value of entries (complex)

Constructor

Definition at line 25 of file gslpp_matrix_complex.cpp.

    {
        _matrix = gsl_matrix_complex_alloc(size_i, size_j);
        gsl_matrix_complex_set_all(_matrix, z.as_gsl_type());
    }

matrix() [2/10]

gslpp::matrix< complex >::matrix	(	const size_t &	size_i,
		const complex &	z
	)

Definition at line 31 of file gslpp_matrix_complex.cpp.

    {
        _matrix = gsl_matrix_complex_alloc(size_i, size_i);
        gsl_matrix_complex_set_all(_matrix, z.as_gsl_type());
    }

matrix() [3/10]

gslpp::matrix< complex >::matrix	(	const size_t &	size_i,
		const size_t &	size_j,
		const double &	a
	)

Constructor.

Parameters

size_i	number of rows
size_j	number of columns
a	initial value of entries (double)

Definition at line 37 of file gslpp_matrix_complex.cpp.

    {
        complex z(a);
        _matrix = gsl_matrix_complex_alloc(size_i, size_j);
        gsl_matrix_complex_set_all(_matrix, z.as_gsl_type());
    }

matrix() [4/10]

gslpp::matrix< complex >::matrix	(	const size_t &	size_i,
		const double &	a
	)

Definition at line 44 of file gslpp_matrix_complex.cpp.

    {
        complex z(a);
        _matrix = gsl_matrix_complex_alloc(size_i, size_i);
        gsl_matrix_complex_set_all(_matrix, z.as_gsl_type());
    }

matrix() [5/10]

gslpp::matrix< complex >::matrix

(

const matrix< complex > &

m

)

Copy constructor

Copy constructor

Definition at line 52 of file gslpp_matrix_complex.cpp.

    {
        _matrix = gsl_matrix_complex_alloc(m.size_i(), m.size_j());
        gsl_matrix_complex_memcpy(_matrix, m.as_gsl_type_ptr());
    }

matrix() [6/10]

gslpp::matrix< complex >::matrix

(

const matrix< double > &

m

)

Definition at line 58 of file gslpp_matrix_complex.cpp.

    {
        size_t i, j, size_i, size_j;
        size_i = m.size_i();
        size_j = m.size_j();
        _matrix = gsl_matrix_complex_alloc(size_i, size_j);
        for (i = 0; i < size_i; ++i)
            for (j = 0; j < size_j; ++j)
                gsl_matrix_complex_set(_matrix, i, j, m(i, j) + 0. * complex::i());
    }

matrix() [7/10]

gslpp::matrix< complex >::matrix

(

const vector< complex > &

v

)

Definition at line 69 of file gslpp_matrix_complex.cpp.

    {
        size_t i, size = v.size();
        complex z(0, 0, false);
        _matrix = gsl_matrix_complex_alloc(size, size);
        gsl_matrix_complex_set_all(_matrix, z.as_gsl_type());
        for (i = 0; i < size; ++i)
            gsl_matrix_complex_set(_matrix, i, i, v(i));
    }

matrix() [8/10]

gslpp::matrix< complex >::matrix

(

const vector< double > &

v

)

Definition at line 79 of file gslpp_matrix_complex.cpp.

    {
        size_t i, size = v.size();
        complex z(0, 0, false);
        _matrix = gsl_matrix_complex_alloc(size, size);
        gsl_matrix_complex_set_all(_matrix, z.as_gsl_type());
        for (i = 0; i < size; ++i)
            gsl_matrix_complex_set(_matrix, i, i, v(i) + 0. * complex::i());
    }

matrix() [9/10]

gslpp::matrix< complex >::matrix

(

const gsl_matrix_complex &

m

)

Definition at line 89 of file gslpp_matrix_complex.cpp.

    {
        _matrix = gsl_matrix_complex_alloc(m.size1, m.size2);
        gsl_matrix_complex_memcpy(_matrix, &m);
    }

matrix() [10/10]

gslpp::matrix< complex >::matrix

(

const gsl_matrix_complex *

m

)

Definition at line 95 of file gslpp_matrix_complex.cpp.

    {
        _matrix = gsl_matrix_complex_alloc(m->size1, m->size2);
        gsl_matrix_complex_memcpy(_matrix, m);
    }

~matrix()

gslpp::matrix< complex >::~matrix

(

)

Destructor

Definition at line 102 of file gslpp_matrix_complex.cpp.

    {
        gsl_matrix_complex_free(_matrix);
    }

Member Function Documentation

as_gsl_type() [1/2]

gsl_matrix_complex & gslpp::matrix< complex >::as_gsl_type

(

)

Definition at line 389 of file gslpp_matrix_complex.cpp.

    {
        return const_cast<gsl_matrix_complex&> (*_matrix);
    }

as_gsl_type() [2/2]

const gsl_matrix_complex & gslpp::matrix< complex >::as_gsl_type

(

)

const

Definition at line 394 of file gslpp_matrix_complex.cpp.

    {
        return const_cast<gsl_matrix_complex&> (*_matrix);
    }

as_gsl_type_ptr()

gsl_matrix_complex * gslpp::matrix< complex >::as_gsl_type_ptr

(

)

const

Conversion

Conversion

Definition at line 384 of file gslpp_matrix_complex.cpp.

    {
        return _matrix;
    }

assign() [1/4]

void gslpp::matrix< complex >::assign	(	const size_t &	i,
		const size_t &	j,
		const complex &	z
	)

Assign element

Definition at line 140 of file gslpp_matrix_complex.cpp.

    {
        gsl_complex *x = gsl_matrix_complex_ptr(_matrix, i, j);
        *x = z.as_gsl_type();
    }

assign() [2/4]

void gslpp::matrix< complex >::assign	(	const size_t &	i,
		const size_t &	j,
		const double &	a
	)

Definition at line 146 of file gslpp_matrix_complex.cpp.

    {
        gsl_complex *x = gsl_matrix_complex_ptr(_matrix, i, j);
        *x = complex(a).as_gsl_type();
    }

assign() [3/4]

void gslpp::matrix< complex >::assign	(	const size_t &	i,
		const size_t &	j,
		const matrix< complex > &	z
	)

Assign submatrix

Definition at line 165 of file gslpp_matrix_complex.cpp.

    {
        size_t ki, kj;
        gsl_complex *x;
        if (i + z.size_i() <= size_i() && j + z.size_j() <= size_j())
            for (ki = i; ki < i + z.size_i(); ki++)
                for (kj = j; kj < j + z.size_j(); kj++)
                {
                    x = gsl_matrix_complex_ptr(_matrix, ki, kj);
                    *x = z(ki - i, kj - j).as_gsl_type();
                } else
        {
            std::cout << "\n ** Wrong size assign in matrix<complex> assign submatrix" << std::endl;
            exit(EXIT_FAILURE);
        }
    }

assign() [4/4]

void gslpp::matrix< complex >::assign	(	const size_t &	i,
		const size_t &	j,
		const matrix< double > &	a
	)

Definition at line 182 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> z(a);
        assign(i, j, z);
    }

assignim()

void gslpp::matrix< complex >::assignim	(	const size_t &	i,
		const size_t &	j,
		const double &	a
	)

Definition at line 158 of file gslpp_matrix_complex.cpp.

    {
        gsl_complex *x = gsl_matrix_complex_ptr(_matrix, i, j);
        GSL_SET_IMAG(x, a);
    }

assignre()

void gslpp::matrix< complex >::assignre	(	const size_t &	i,
		const size_t &	j,
		const double &	a
	)

Definition at line 152 of file gslpp_matrix_complex.cpp.

    {
        gsl_complex *x = gsl_matrix_complex_ptr(_matrix, i, j);
        GSL_SET_REAL(x, a);
    }

eigensystem()

void gslpp::matrix< complex >::eigensystem	(	matrix< complex > &	U,
		vector< double > &	S
	)		const

Eigenvalues and eigenvectors

Parameters

U	matrix<complex>& eigenvectors
S	vector<double>& eigenvalues

Definition at line 347 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m(*this);
 
        gsl_eigen_hermv_workspace *ws;
 
        ws = gsl_eigen_hermv_alloc(size_i());
 
        gsl_eigen_hermv(m.as_gsl_type_ptr(), S.as_gsl_type_ptr(), U.as_gsl_type_ptr(), ws);
 
        gsl_eigen_hermv_sort(S.as_gsl_type_ptr(), U.as_gsl_type_ptr(),
                GSL_EIGEN_SORT_VAL_ASC);
 
        gsl_eigen_hermv_free(ws);
    }

hconjugate()

matrix< complex > gslpp::matrix< complex >::hconjugate

(

)

const

Hermitean conjugate matrix

Definition at line 229 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(*this);
        gsl_complex z1, z2;
 
        GSL_SET_COMPLEX(&z1, 1., 0.);
        GSL_SET_COMPLEX(&z2, 0., 0.);
 
        if (gsl_blas_zgemm(CblasConjTrans, CblasNoTrans, z1, _matrix,
                Id(size_j()).as_gsl_type_ptr(), z2, m1.as_gsl_type_ptr()) != 0)
        {
            std::cout << "\n ** Error in matrix<complex> conjugate" << std::endl;
            exit(EXIT_FAILURE);
        }
 
        return m1;
    }

Id()

matrix< complex > gslpp::matrix< complex >::Id ( size_t  size )

static

Identity matrix

Definition at line 211 of file gslpp_matrix_complex.cpp.

    {
        return matrix<double>::Id(size) * (1. + 0. * complex::i());
    }

imag()

matrix< double > gslpp::matrix< complex >::imag

(

)

const

Get matrix of imaginary parts

Definition at line 335 of file gslpp_matrix_complex.cpp.

    {
        matrix<double> res(size_i(), size_j());
        for (size_t i = 0; i < size_i(); i++)
        {
            gsl_vector_complex_view tmp = gsl_matrix_complex_row(_matrix, i);
            gsl_vector_view tmpd = gsl_vector_complex_imag(&tmp.vector);
            gsl_matrix_set_row(res.as_gsl_type_ptr(), i, &tmpd.vector);
        }
        return res;
    }

inverse()

matrix< complex > gslpp::matrix< complex >::inverse

(

)

const

Inverse matrix

Definition at line 248 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        matrix<complex> m2(_matrix);
        int signum;
        gsl_permutation *p;
 
        if (size_j() != size_i())
        {
            std::cout << "\n ** Size mismatch in matrix<complex> inverse" << std::endl;
            exit(EXIT_FAILURE);
        }
 
        if ((p = gsl_permutation_alloc(size_i())) == NULL)
        {
            std::cout << "\n ** Error in matrix<complex> inverse" << std::endl;
            exit(EXIT_FAILURE);
        }
 
        if (gsl_linalg_complex_LU_decomp(m1.as_gsl_type_ptr(), p, &signum))
        {
            std::cout << "\n ** Error in matrix<complex> inverse" << std::endl;
            gsl_permutation_free(p);
            exit(EXIT_FAILURE);
        }
 
        if (gsl_linalg_complex_LU_invert(m1.as_gsl_type_ptr(), p,
                m2.as_gsl_type_ptr()))
        {
            std::cout << "\n ** Error in matrix<complex> inverse" << std::endl;
            gsl_permutation_free(p);
            exit(EXIT_FAILURE);
        }
        gsl_permutation_free(p);
        return m2;
    }

isSingular()

bool gslpp::matrix< complex >::isSingular

(

)

Check is matrix is singular to avoid errors in luc.c

Check if matrix is singular (This is to avoid error checking by luc.c)

Definition at line 287 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        int signum;
        gsl_permutation *p;
 
        if (size_j() != size_i())
        {
            std::cout << "\n ** Size mismatch in bool isSingular" << std::endl;
            exit(EXIT_FAILURE);
        }
 
        if ((p = gsl_permutation_alloc(size_i())) == NULL)
        {
            std::cout << "\n ** Error in bool isSingular" << std::endl;
            exit(EXIT_FAILURE);
        }
 
        if (gsl_linalg_complex_LU_decomp(m1.as_gsl_type_ptr(), p, &signum))
        {
            std::cout << "\n ** Error in bool isSingular" << std::endl;
            gsl_permutation_free(p);
            exit(EXIT_FAILURE);
        }
        
        size_t i, n = m1.size_i();
 
        for (i = 0; i < n; i++) {
            gsl_complex u = gsl_matrix_complex_get(m1.as_gsl_type_ptr(), i, i);
            if (GSL_REAL(u) == 0 && GSL_IMAG(u) == 0) return 1;
        }
        return 0;
    }

operator!=()

bool gslpp::matrix< complex >::operator!= ( const matrix< complex > &  a ) const

inline

Definition at line 182 of file gslpp_matrix_complex.h.

      {
          return(!(*this == a));
      }

operator()()

const complex gslpp::matrix< complex >::operator()	(	const size_t &	i,
		const size_t &	j
	)		const

Get i-th element

Definition at line 108 of file gslpp_matrix_complex.cpp.

    {
        gsl_complex *x = gsl_matrix_complex_ptr(_matrix, i, j);
        return complex(x);
    }

operator*() [1/6]

matrix< complex > gslpp::matrix< complex >::operator*

(

const complex &

z

)

const

Multiplication operator

Multiplication operator (complex)

Definition at line 581 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        if (gsl_matrix_complex_scale(m1.as_gsl_type_ptr(), z.as_gsl_type()))
        {
            std::cout << "\n ** Error in matrix<complex> * (complex)" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator*() [2/6]

matrix< complex > gslpp::matrix< complex >::operator*

(

const double &

a

)

const

Multiplication operator

Multiplication operator (double)

Definition at line 647 of file gslpp_matrix_complex.cpp.

    {
        complex z(a);
        return *this * z;
    }

operator*() [3/6]

matrix< complex > gslpp::matrix< complex >::operator*

(

const matrix< complex > &

m

)

const

Multiplication operator

Multiplication operator (matrix complex)

Definition at line 443 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        gsl_complex z1, z2;
 
        if (size_j() != m.size_i())
        {
            std::cout << "\n ** Size mismatch in matrix<complex> *" << std::endl;
            exit(EXIT_FAILURE);
        }
        GSL_SET_COMPLEX(&z1, 1., 0.);
        GSL_SET_COMPLEX(&z2, 0., 0.);
        if (gsl_blas_zgemm(CblasNoTrans, CblasNoTrans, z1, _matrix,
                m.as_gsl_type_ptr(), z2, m1.as_gsl_type_ptr()))
        {
            std::cout << "\n ** Error in matrix<complex> *" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator*() [4/6]

matrix< complex > gslpp::matrix< complex >::operator*

(

const matrix< double > &

m

)

const

Multiplication operator

Multiplication operator (matrix double)

Definition at line 491 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(m);
        return *this * m1;
    }

operator*() [5/6]

vector< complex > gslpp::matrix< complex >::operator*

(

const vector< complex > &

v

)

const

Multiplication operator

Multiplication operator (vector complex)

Definition at line 498 of file gslpp_matrix_complex.cpp.

    {
        gsl_complex z1, z2;
        vector<complex> v1(size_i(), 0.);
 
        if (size_j() != v.size())
        {
            std::cout << "\n ** Size mismatch in matrix<complex> * (vector complex)"
                    << std::endl;
            exit(EXIT_FAILURE);
        }
        GSL_SET_COMPLEX(&z1, 1., 0.);
        GSL_SET_COMPLEX(&z2, 0., 0.);
        if (gsl_blas_zgemv(CblasNoTrans, z1, _matrix, v.as_gsl_type_ptr(),
                z2, v1.as_gsl_type_ptr()))
        {
            std::cout << "\n ** Error in matrix<complex> * (vector complex)"
                    << std::endl;
            exit(EXIT_FAILURE);
        }
        return v1;
    }

operator*() [6/6]

vector< complex > gslpp::matrix< complex >::operator*

(

const vector< double > &

v

)

const

Multiplication operator (vector double)

Definition at line 522 of file gslpp_matrix_complex.cpp.

    {
        vector<complex> v1(v);
        return *this * v1;
    }

operator*=() [1/3]

matrix< complex > & gslpp::matrix< complex >::operator*=

(

const complex &

z

)

Multiplication assignment

Multiplication assignment (complex)

Definition at line 619 of file gslpp_matrix_complex.cpp.

    {
        *this = *this * z;
        return *this;
    }

operator*=() [2/3]

matrix< complex > & gslpp::matrix< complex >::operator*=

(

const double &

a

)

Multiplication assignment

Multiplication assignment (double)

Definition at line 675 of file gslpp_matrix_complex.cpp.

    {
        *this = *this * a;
        return *this;
    }

operator*=() [3/3]

matrix< complex > & gslpp::matrix< complex >::operator*=

(

const matrix< complex > &

m

)

Multiplication assignment

Multiplication assignment (matrix)

Definition at line 543 of file gslpp_matrix_complex.cpp.

    {
        if (!((size_i() == size_j()) && (size_i() == m.size_i()) &&
                (size_j() == m.size_j())))
        {
            std::cout << "\n ** Size mismatch in matrix<complex> *= (matrix)"
                    << std::endl;
            exit(EXIT_FAILURE);
        }
        *this = *this * m;
        return *this;
    }

operator+() [1/4]

matrix< complex > gslpp::matrix< complex >::operator+

(

const complex &

z

)

const

Addition operator

Addition operator (complex)

Definition at line 557 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        if (gsl_matrix_complex_add_constant(m1.as_gsl_type_ptr(), z.as_gsl_type()))
        {
            std::cout << "\n ** Error in matrix<complex> + (complex)" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator+() [2/4]

matrix< complex > gslpp::matrix< complex >::operator+

(

const double &

a

)

const

Addition operator

Addition operator (double)

Definition at line 633 of file gslpp_matrix_complex.cpp.

    {
        complex z(a);
        return *this +z;
    }

operator+() [3/4]

matrix< complex > gslpp::matrix< complex >::operator+

(

const matrix< complex > &

m

)

const

Addition operator

Addition operator (matrix)

Definition at line 418 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        if (gsl_matrix_complex_add(m1.as_gsl_type_ptr(), m.as_gsl_type_ptr()))
        {
            std::cout << "\n ** Error in matrix<complex> +" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator+() [4/4]

matrix< complex > gslpp::matrix< complex >::operator+

(

const matrix< double > &

m

)

const

Addition operator

Addition operator (matrix)

Definition at line 465 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        matrix<complex> m2(m);
        if (gsl_matrix_complex_add(m1.as_gsl_type_ptr(), m2.as_gsl_type_ptr()))
        {
            std::cout << "\n ** Error in matrix<complex> +" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator+=() [1/3]

matrix< complex > & gslpp::matrix< complex >::operator+=

(

const complex &

z

)

Addition assignment

Addition assignment (complex)

Definition at line 605 of file gslpp_matrix_complex.cpp.

    {
        *this = *this +z;
        return *this;
    }

operator+=() [2/3]

matrix< complex > & gslpp::matrix< complex >::operator+=

(

const double &

a

)

Addition assignment

Addition assignment (double)

Definition at line 661 of file gslpp_matrix_complex.cpp.

    {
        *this = *this +a;
        return *this;
    }

operator+=() [3/3]

matrix< complex > & gslpp::matrix< complex >::operator+=

(

const matrix< complex > &

m

)

Addition assignment

Addition assignment (matrix)

Definition at line 529 of file gslpp_matrix_complex.cpp.

    {
        *this = *this +m;
        return *this;
    }

operator-() [1/5]

matrix< complex > gslpp::matrix< complex >::operator-

(

)

const

check whether two matrices are equal Unary minus

Unary minus

Definition at line 404 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        gsl_complex z1;
        GSL_SET_COMPLEX(&z1, -1., 0.);
        if (gsl_matrix_complex_scale(m1.as_gsl_type_ptr(), z1))
        {
            std::cout << "\n ** Error in matrix<complex> unary -" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator-() [2/5]

matrix< complex > gslpp::matrix< complex >::operator-

(

const complex &

z

)

const

Subtraction operator

Subtraction operator (complex)

Definition at line 569 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        if (gsl_matrix_complex_add_constant(m1.as_gsl_type_ptr(), (-z).as_gsl_type()))
        {
            std::cout << "\n ** Error in matrix<complex> - (complex)" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator-() [3/5]

matrix< complex > gslpp::matrix< complex >::operator-

(

const double &

a

)

const

Subtraction operator

Subtraction assignment (double)

Definition at line 640 of file gslpp_matrix_complex.cpp.

    {
        complex z(a);
        return *this -z;
    }

operator-() [4/5]

matrix< complex > gslpp::matrix< complex >::operator-

(

const matrix< complex > &

m

)

const

Subtraction operator

Subtraction operator (matrix)

Definition at line 430 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        matrix<complex> m2 = -m;
        if (gsl_matrix_complex_add(m1.as_gsl_type_ptr(), m2.as_gsl_type_ptr()))
        {
            std::cout << "\n ** Error in matrix<complex> +" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator-() [5/5]

matrix< complex > gslpp::matrix< complex >::operator-

(

const matrix< double > &

m

)

const

Subtraction operator

Subtraction operator (matrix)

Definition at line 478 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        matrix<complex> m2(-m);
        if (gsl_matrix_complex_add(m1.as_gsl_type_ptr(), m2.as_gsl_type_ptr()))
        {
            std::cout << "\n ** Error in matrix<complex> +" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator-=() [1/3]

matrix< complex > & gslpp::matrix< complex >::operator-=

(

const complex &

z

)

Subtraction assignment

Subtraction assignment (complex)

Definition at line 612 of file gslpp_matrix_complex.cpp.

    {
        *this = *this -z;
        return *this;
    }

operator-=() [2/3]

matrix< complex > & gslpp::matrix< complex >::operator-=

(

const double &

a

)

Subtraction assignment

Subtraction assignment (double)

Definition at line 668 of file gslpp_matrix_complex.cpp.

    {
        *this = *this -a;
        return *this;
    }

operator-=() [3/3]

matrix< complex > & gslpp::matrix< complex >::operator-=

(

const matrix< complex > &

m

)

Subtraction assignment

Subtraction assignment (matrix)

Definition at line 536 of file gslpp_matrix_complex.cpp.

    {
        *this = *this -m;
        return *this;
    }

operator/() [1/2]

matrix< complex > gslpp::matrix< complex >::operator/

(

const complex &

z

)

const

Division operator

Division operator (complex)

Definition at line 593 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(_matrix);
        if (gsl_matrix_complex_scale(m1.as_gsl_type_ptr(), z.inverse().as_gsl_type()))
        {
            std::cout << "\n ** Error in matrix<complex> / (complex)" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

operator/() [2/2]

matrix< complex > gslpp::matrix< complex >::operator/

(

const double &

a

)

const

Division operator

Division operator (double)

Definition at line 654 of file gslpp_matrix_complex.cpp.

    {
        complex z(a);
        return *this / z;
    }

operator/=() [1/2]

matrix< complex > & gslpp::matrix< complex >::operator/=

(

const complex &

z

)

Division assignment

Division assignment (complex)

Definition at line 626 of file gslpp_matrix_complex.cpp.

    {
        *this = *this / z;
        return *this;
    }

operator/=() [2/2]

matrix< complex > & gslpp::matrix< complex >::operator/=

(

const double &

a

)

Division assignment

Division assignment (double)

Definition at line 682 of file gslpp_matrix_complex.cpp.

    {
        *this = *this / a;
        return *this;
    }

operator=()

matrix< complex > & gslpp::matrix< complex >::operator=

(

const matrix< complex > &

m

)

Set i-th element Assign

Definition at line 127 of file gslpp_matrix_complex.cpp.

    {
        if (size_i() == m.size_i() && size_j() == m.size_j())
            gsl_matrix_complex_memcpy(_matrix, m.as_gsl_type_ptr());
        else
        {
            std::cout << "\n ** Wrong size assign in matrix<complex> operator =" << std::endl;
            exit(EXIT_FAILURE);
        }
        return *this;
    }

operator==()

bool gslpp::matrix< complex >::operator==

(

const matrix< complex > &

a

)

const

Comparison == (matrix)

Definition at line 689 of file gslpp_matrix_complex.cpp.

    {
        if (a.size_i() != size_i() || a.size_j() != size_j())
        {
            std::cout << "\n Error in matrix<complex>::operator== (matrix): cannot compare matrices of different size" << std::endl;
            exit(EXIT_FAILURE);
        }
        for (size_t i = 0; i < size_i(); i++)
            for (size_t j = 0; j < size_j(); j++)
                if (a(i, j) != (*this)(i, j)) return (false);
        return (true);
    }

real()

matrix< double > gslpp::matrix< complex >::real

(

)

const

Get matrix of real parts

Definition at line 322 of file gslpp_matrix_complex.cpp.

    {
        matrix<double> res(size_i(), size_j());
        for (size_t i = 0; i < size_i(); i++)
        {
            gsl_vector_complex_view tmp = gsl_matrix_complex_row(_matrix, i);
            gsl_vector_view tmpd = gsl_vector_complex_real(&tmp.vector);
            gsl_matrix_set_row(res.as_gsl_type_ptr(), i, &tmpd.vector);
        }
        return res;
    }

reset()

void gslpp::matrix< complex >::reset

(

)

Assign element

Set i-th element Assign

Definition at line 122 of file gslpp_matrix_complex.cpp.

  {
      gsl_matrix_complex_set_zero(_matrix);
  }

singularvalue()

void gslpp::matrix< complex >::singularvalue	(	matrix< complex > &	U,
		matrix< complex > &	V,
		vector< double > &	S
	)		const

Singular Value Decomposition as U diagonalmatrix(S) V^+

Parameters

U	matrix<complex>&
V	matrix<complex>&
S	vector<double>&

Definition at line 363 of file gslpp_matrix_complex.cpp.

    {
        size_t i;
        matrix<complex> m(*this);
        vector<complex> v1(size_i(), 0.);
 
        m = (*this) * hconjugate();
        m.eigensystem(U, S);
        m = hconjugate()*(*this);
        m.eigensystem(V, S);
        m = U.hconjugate()*(*this) * V;
        for (i = 0; i < m.size_i(); i++)
        {
            v1.assign(i, complex(1., -m(i, i).arg(), true));
            S(i) = m(i, i).abs();
        }
        V = V * matrix<complex>(v1);
    }

size()

size_t gslpp::matrix< complex >::size

(

)

const

Definition at line 199 of file gslpp_matrix_complex.cpp.

    {
        if (_matrix->size1 == _matrix->size2)
            return _matrix->size2;
        else
        {
            std::cout << "\n ** Non square matrix" << std::endl;
            exit(EXIT_FAILURE);
        }
    }

size_i()

size_t gslpp::matrix< complex >::size_i

(

)

const

Get matrix size

Definition at line 189 of file gslpp_matrix_complex.cpp.

    {
        return _matrix->size1;
    }

size_j()

size_t gslpp::matrix< complex >::size_j

(

)

const

Definition at line 194 of file gslpp_matrix_complex.cpp.

    {
        return _matrix->size2;
    }

transpose()

matrix< complex > gslpp::matrix< complex >::transpose

(

)

const

Transpose matrix

Definition at line 217 of file gslpp_matrix_complex.cpp.

    {
        matrix<complex> m1(size_j(), size_i(), 0.);
        if (gsl_matrix_complex_transpose_memcpy(m1.as_gsl_type_ptr(), _matrix))
        {
            std::cout << "\n ** Error in matrix<complex> transpose" << std::endl;
            exit(EXIT_FAILURE);
        }
        return m1;
    }

Friends And Related Function Documentation

operator* [1/4]

matrix<complex> operator* ( const complex &  z, const matrix< complex >  m  )

friend

Multiply a complex number by complex matrix

Parameters

z	Complex number
m	Complex matrix

Returns

\( z*m \)

Definition at line 737 of file gslpp_matrix_complex.cpp.

    {
        return m * z;
    }

operator* [2/4]

matrix<complex> operator* ( const double &  a, const matrix< complex >  m  )

friend

Multiply a real number by a complex matrix

Parameters

a	Real number
m	Complex matrix

Returns

\( z*m \)

Definition at line 762 of file gslpp_matrix_complex.cpp.

    {
        return m * a;
    }

operator* [3/4]

vector<complex> operator* ( const vector< complex > &  v, const matrix< complex >  m  )

friend

Multiply a complex vector by a complex matrix

Parameters

v	Complex vector
m	Complex matrix

Returns

\( v*m \)

Definition at line 742 of file gslpp_matrix_complex.cpp.

    {
        return m.transpose() * v;
    }

operator* [4/4]

vector<complex> operator* ( const vector< double > &  v, const matrix< complex >  m  )

friend

Multiply a real vector by a complex matrix

Parameters

v	Real vector
m	Complex matrix

Returns

\( v*m \)

Definition at line 747 of file gslpp_matrix_complex.cpp.

    {
        return m.transpose() * v;
    }

operator+ [1/3]

matrix<complex> operator+ ( const complex &  z, const matrix< complex >  m  )

friend

Add a complex number to a complex matrix

Parameters

z	Complex number
m	Complex matrix

Returns

\( z + m \)

Definition at line 727 of file gslpp_matrix_complex.cpp.

    {
        return m + z;
    }

operator+ [2/3]

matrix<complex> operator+ ( const double &  a, const matrix< complex >  m  )

friend

Add a real number to a complex matrix

Parameters

a	Real number
m	Complex matrix

Returns

\( a + m \)

Definition at line 752 of file gslpp_matrix_complex.cpp.

    {
        return m + a;
    }

operator+ [3/3]

matrix<complex> operator+ ( matrix< double >  m1, const matrix< complex >  m2  )

friend

Add a double matrix to a complex matrix

Parameters

m1	Double matrix
m2	Complex matrix

Returns

\( m2 + m1 \)

Definition at line 717 of file gslpp_matrix_complex.cpp.

    {
        return m2 + m1;
    }

operator- [1/3]

matrix<complex> operator- ( const complex &  z, const matrix< complex >  m  )

friend

Subtract a complex number from a complex matrix

Parameters

z	Complex number
m	Complex matrix

Returns

\( z - m \)

Definition at line 732 of file gslpp_matrix_complex.cpp.

    {
        return -m + z;
    }

operator- [2/3]

matrix<complex> operator- ( const double &  a, const matrix< complex >  m  )

friend

Subtract a complex matrix from a real number

Parameters

a	Real number
m	Complex matrix

Returns

\( a - m \)

Definition at line 757 of file gslpp_matrix_complex.cpp.

    {
        return -m + a;
    }

operator- [3/3]

matrix<complex> operator- ( matrix< double >  m1, const matrix< complex >  m2  )

friend

Subtract a double matrix to a complex matrix

Parameters

m1	Double matrix
m2	Complex matrix

Returns

\( -m2 + m1 \)

Definition at line 722 of file gslpp_matrix_complex.cpp.

    {
        return -m2 + m1;
    }

operator<<

std::ostream& operator<< ( std::ostream &  output, const matrix< complex > &  v  )

friend

friend functions

Definition at line 703 of file gslpp_matrix_complex.cpp.

    {
        size_t i, j;
        for (i = 0; i < m.size_i(); i++)
        {
            output << std::endl;
            output << "\t(";
            for (j = 0; j < m.size_j() - 1; j++)
                output << m(i, j) << ",";
            output << m(i, j) << ")";
        }
        return output;
    }

Member Data Documentation

_matrix

gsl_matrix_complex* gslpp::matrix< complex >::_matrix

private

Definition at line 47 of file gslpp_matrix_complex.h.

---

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

• gslpp_matrix_complex.h
• gslpp_matrix_complex.cpp