#include <complex.h>

Inheritance diagram for ComplexMatrixView:

Public Types
typedef ComplexIterator2D	iterator

Public Types inherited from ConstComplexMatrixView
typedef ConstComplexIterator2D	const_iterator

Public Member Functions
constexpr	ComplexMatrixView (const ComplexMatrixView &)=default

Complex &	operator() (Index r, Index c)
	Plain index operator. More...

Complex &	get (Index r, Index c)
	Get element implementation without assertions. More...

Numeric &	get_real (Index r, Index c)
	Get element implementation without assertions. More...

Numeric &	get_imag (Index r, Index c)
	Get element implementation without assertions. More...

MatrixView	real ()
	Get a view of the real part of the matrix. More...

MatrixView	imag ()
	Get a view of the imaginary parts of the matrix. More...

ComplexMatrixView	operator() (const Range &r, const Range &c)
	Index operator for subrange. More...

ComplexVectorView	operator() (const Range &r, Index c)
	Index operator returning a column as an object of type ComplexVectorView. More...

ComplexVectorView	operator() (Index r, const Range &c)
	Index operator returning a row as an object of type ComplexVectorView. More...

ComplexIterator2D	begin ()
	Return iterator to first row. More...

ComplexIterator2D	end ()
	Return iterator behind last row. More...

ComplexVectorView	diagonal ()
	ComplexMatrix diagonal as vector. More...

ComplexMatrixView &	operator= (const ConstComplexMatrixView &v)
	Assignment operator. More...

ComplexMatrixView &	operator= (const ComplexMatrixView &v)
	Assignment from ComplexMatrixView to ComplexMatrixView. More...

ComplexMatrixView &	operator= (const ComplexMatrix &v)
	Assignment from a ComplexMatrix. More...

ComplexMatrixView &	operator= (const ConstComplexVectorView &v)
	Assignment from a vector. More...

ComplexMatrixView &	operator= (Complex x)
	Assigning a scalar to a MatrixView will set all elements to this value. More...

ComplexMatrixView &	operator*= (Complex x)
	Multiplication by scalar. More...

ComplexMatrixView &	operator/= (Complex x)
	Division by scalar. More...

ComplexMatrixView &	operator+= (Complex x)
	Addition of scalar. More...

ComplexMatrixView &	operator-= (Complex x)
	Subtraction of scalar. More...

ComplexMatrixView &	operator*= (Numeric x)
	Multiplication by scalar. More...

ComplexMatrixView &	operator/= (Numeric x)
	Division by scalar. More...

ComplexMatrixView &	operator+= (Numeric x)
	Addition of scalar. More...

ComplexMatrixView &	operator-= (Numeric x)
	Subtraction of scalar. More...

ComplexMatrixView &	operator*= (const ConstComplexMatrixView &x)
	Element-vise multiplication by another Matrix. More...

ComplexMatrixView &	operator/= (const ConstComplexMatrixView &x)
	Element-vise division by another Matrix. More...

ComplexMatrixView &	operator+= (const ConstComplexMatrixView &x)
	Element-vise addition of another Matrix. More...

ComplexMatrixView &	operator-= (const ConstComplexMatrixView &x)
	Element-vise subtraction of another Matrix. More...

ComplexMatrixView &	operator*= (const ConstMatrixView &x)
	Element-vise multiplication by another Matrix. More...

ComplexMatrixView &	operator/= (const ConstMatrixView &x)
	Element-vise division by another Matrix. More...

ComplexMatrixView &	operator+= (const ConstMatrixView &x)
	Element-vise addition of another Matrix. More...

ComplexMatrixView &	operator-= (const ConstMatrixView &x)
	Element-vise subtraction of another Matrix. More...

ComplexMatrixView &	operator*= (const ConstComplexVectorView &x)

ComplexMatrixView &	operator/= (const ConstComplexVectorView &x)

ComplexMatrixView &	operator+= (const ConstComplexVectorView &x)

ComplexMatrixView &	operator-= (const ConstComplexVectorView &x)

const Complex *	get_c_array () const
	Conversion to plain C-array. More...

Complex *	get_c_array ()
	Conversion to plain C-array. More...

virtual	~ComplexMatrixView ()=default
	Destructor. More...

Public Member Functions inherited from ConstComplexMatrixView
constexpr	ConstComplexMatrixView (const ConstComplexMatrixView &)=default

constexpr	ConstComplexMatrixView (ConstComplexMatrixView &&)=default

ConstComplexMatrixView &	operator= (const ConstComplexMatrixView &)=default

ConstComplexMatrixView &	operator= (ConstComplexMatrixView &&)=default

bool	empty () const

Index	nrows () const

Index	ncols () const

Complex	operator() (Index r, Index c) const
	Plain const index operator. More...

Complex	get (Index r, Index c) const
	Get element implementation without assertions. More...

Numeric	get_real (Index r, Index c) const
	Get element implementation without assertions. More...

Numeric	get_imag (Index r, Index c) const
	Get element implementation without assertions. More...

ConstMatrixView	real () const
	Get a view of the real part of the matrix. More...

ConstMatrixView	imag () const
	Get a view of the imaginary part of the matrix. More...

Index	get_column_extent () const
	Get the extent of the underlying data. More...

ConstComplexMatrixView	operator() (const Range &r, const Range &c) const
	Returns true if variable size is zero. More...

ConstComplexVectorView	operator() (const Range &r, Index c) const
	Const index operator returning a column as an object of type C onstComplex*VectorView. More...

ConstComplexVectorView	operator() (Index r, const Range &c) const
	Const index operator returning a row as an object of type C onstComplex*VectorView. More...

ConstComplexIterator2D	begin () const
	Return const iterator to first row. More...

ConstComplexIterator2D	end () const
	Return const iterator behind last row. More...

ConstComplexVectorView	diagonal () const
	ComplexMatrix diagonal as vector. More...

virtual	~ConstComplexMatrixView ()=default
	Destructor. More...

Protected Member Functions
	ComplexMatrixView ()
	Default constructor. More...

	ComplexMatrixView (Complex *data, const Range &r, const Range &c)
	Explicit constructor. More...

	ComplexMatrixView (Complex *data, const Range &pr, const Range &pc, const Range &nr, const Range &nc)
	Recursive constructor. More...

Protected Member Functions inherited from ConstComplexMatrixView
	ConstComplexMatrixView ()=default

	ConstComplexMatrixView (Complex *data, const Range &r, const Range &c)
	Explicit constructor. More...

	ConstComplexMatrixView (Complex *data, const Range &pr, const Range &pc, const Range &nr, const Range &nc)
	Recursive constructor. More...

Friends
class	ComplexVectorView

ConstComplexMatrixView	transpose (ConstComplexMatrixView m)
	Const version of transpose. More...

ComplexMatrixView	transpose (ComplexMatrixView m)
	Returns the transpose. More...

Additional Inherited Members
Protected Attributes inherited from ConstComplexMatrixView
Range	mrr {0, 0, 1}
	The row range of mdata that is actually used. More...

Range	mcr {0, 0, 1}
	The column range of mdata that is actually used. More...

Complex *	mdata {nullptr}
	Pointer to the plain C array that holds the data. More...

Detailed Description

The ComplexMatrixView class.

This contains the main implementation of a ComplexMatrix. It defines the concepts of ComplexMatrixView. Plus additionally the recursive subrange operator, which makes it possible to create a ComplexMatrixView from a subrange of a ComplexMatrixView.

The class ComplexMatrix is just a special case of a ComplexMatrixView which also allocates storage.

Definition at line 731 of file complex.h.

Member Typedef Documentation

◆ iterator

typedef ComplexIterator2D ComplexMatrixView::iterator

Definition at line 747 of file complex.h.

Constructor & Destructor Documentation

◆ ComplexMatrixView() [1/4]

constexpr ComplexMatrixView::ComplexMatrixView ( const ComplexMatrixView & )

default

◆ ~ComplexMatrixView()

virtual ComplexMatrixView::~ComplexMatrixView ( )

virtualdefault

Destructor.

◆ ComplexMatrixView() [2/4]

ComplexMatrixView::ComplexMatrixView ( )

protected

Default constructor.

This is necessary, so that we can have a default constructor for the derived class Matrix.

Definition at line 1270 of file complex.cc.

Referenced by transpose().

◆ ComplexMatrixView() [3/4]

ComplexMatrixView::ComplexMatrixView	(	Complex *	data,
		const Range &	rr,
		const Range &	cr
	)

protected

Explicit constructor.

This one is used by ComplexMatrix to initialize its own ComplexMatrixView part. The row range rr must have a stride to account for the length of one row.

Definition at line 1277 of file complex.cc.

◆ ComplexMatrixView() [4/4]

ComplexMatrixView::ComplexMatrixView	(	Complex *	data,
		const Range &	pr,
		const Range &	pc,
		const Range &	nr,
		const Range &	nc
	)

protected

Recursive constructor.

This is used to construct SubMatrices from SubMatrices. That means that the new ranges have to be interpreted relative to the original ranges.

The new ranges may contain -1 for the extent which acts as a joker. However, the used Range constructor converts this to an explicit range, consistent with the original Range.

Parameters

*data	The actual data.
pr	Previous range.
pc	Previous range.
nr	New Range.
nc	New Range.

Definition at line 1298 of file complex.cc.

Member Function Documentation

◆ begin()

ComplexIterator2D ComplexMatrixView::begin ( )

Return iterator to first row.

Definition at line 937 of file complex.cc.

References ConstComplexMatrixView::mcr, ConstComplexMatrixView::mdata, ConstComplexMatrixView::mrr, Range::mstart, and Range::mstride.

Referenced by ComplexMatrix::ComplexMatrix(), operator=(), and ComplexMatrix::operator=().

◆ diagonal()

ComplexVectorView ComplexMatrixView::diagonal ( )

ComplexMatrix diagonal as vector.

Returns a ComplexMatrixView on the diagonal entries of the matrix. For a given (n,m) matrix M the diagonal vector v is the vector of length min{n,m} with entries

 v[i] = M(i,i)

Returns: The diagonal vector v.

Definition at line 958 of file complex.cc.

References ConstComplexMatrixView::mcr, ConstComplexMatrixView::mdata, Range::mextent, min, ConstComplexMatrixView::mrr, Range::mstart, Range::mstride, and n.

◆ end()

ComplexIterator2D ComplexMatrixView::end ( )

Return iterator behind last row.

Definition at line 943 of file complex.cc.

References ConstComplexMatrixView::mcr, ConstComplexMatrixView::mdata, Range::mextent, ConstComplexMatrixView::mrr, Range::mstart, and Range::mstride.

Referenced by ComplexMatrix::ComplexMatrix(), copy(), operator=(), and ComplexMatrix::operator=().

◆ get()

Complex& ComplexMatrixView::get	(	Index	r,
		Index	c
	)

inline

Get element implementation without assertions.

Definition at line 761 of file complex.h.

◆ get_c_array() [1/2]

const Complex * ComplexMatrixView::get_c_array ( ) const

Conversion to plain C-array.

This function returns a pointer to the raw data. It fails if the MatrixView is not pointing to the beginning of a Matrix or the stride is not 1 because the caller expects to get a C array with continuous data.

Definition at line 1112 of file complex.cc.

References ConstComplexMatrixView::mcr, ConstComplexMatrixView::mdata, Range::mextent, ConstComplexMatrixView::mrr, Range::mstart, and Range::mstride.

Referenced by diagonalize(), and inv().

◆ get_c_array() [2/2]

Complex * ComplexMatrixView::get_c_array ( )

Conversion to plain C-array.

This function returns a pointer to the raw data. It fails if the MatrixView is not pointing to the beginning of a Matrix or the stride is not 1 because the caller expects to get a C array with continuous data.

Definition at line 1127 of file complex.cc.

References ConstComplexMatrixView::mcr, ConstComplexMatrixView::mdata, Range::mextent, ConstComplexMatrixView::mrr, Range::mstart, and Range::mstride.

◆ get_imag()

Numeric& ComplexMatrixView::get_imag	(	Index	r,
		Index	c
	)

inline

Get element implementation without assertions.

Definition at line 772 of file complex.h.

◆ get_real()

Numeric& ComplexMatrixView::get_real	(	Index	r,
		Index	c
	)

inline

Get element implementation without assertions.

Definition at line 767 of file complex.h.

◆ imag()

MatrixView ComplexMatrixView::imag ( )

inline

Get a view of the imaginary parts of the matrix.

Definition at line 781 of file complex.h.

◆ operator()() [1/4]

Complex& ComplexMatrixView::operator()	(	Index	r,
		Index	c
	)

inline

Plain index operator.

Definition at line 751 of file complex.h.

◆ operator()() [2/4]

ComplexMatrixView ComplexMatrixView::operator()	(	const Range &	r,
		const Range &	c
	)

Index operator for subrange.

We have to also account for the case, t hat *this is already a subrange of a Complex*Matrix. This allows correct recursive behavior.

Definition at line 907 of file complex.cc.

◆ operator()() [3/4]

ComplexVectorView ComplexMatrixView::operator()	(	const Range &	r,
		Index	c
	)

Index operator returning a column as an object of type ComplexVectorView.

Parameters

r	A range of rows.
c	Index of selected column

Definition at line 916 of file complex.cc.

◆ operator()() [4/4]

ComplexVectorView ComplexMatrixView::operator()	(	Index	r,
		const Range &	c
	)

Index operator returning a row as an object of type ComplexVectorView.

Parameters

r	Index of selected row.
c	Range of columns

Definition at line 928 of file complex.cc.

◆ operator*=() [1/5]

ComplexMatrixView & ComplexMatrixView::operator*= ( Complex x )

Multiplication by scalar.

Definition at line 1027 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator*=() [2/5]

ComplexMatrixView & ComplexMatrixView::operator*= ( Numeric x )

Multiplication by scalar.

Definition at line 1037 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator*=() [3/5]

ComplexMatrixView & ComplexMatrixView::operator*= ( const ConstComplexMatrixView & x )

Element-vise multiplication by another Matrix.

Definition at line 1137 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstComplexMatrixView::nrows(), and r.

◆ operator*=() [4/5]

ComplexMatrixView & ComplexMatrixView::operator*= ( const ConstMatrixView & x )

Element-vise multiplication by another Matrix.

Definition at line 1154 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstMatrixView::ncols(), ConstComplexMatrixView::nrows(), ConstMatrixView::nrows(), and r.

◆ operator*=() [5/5]

ComplexMatrixView& ComplexMatrixView::operator*= ( const ConstComplexVectorView & x )

◆ operator+=() [1/5]

ComplexMatrixView & ComplexMatrixView::operator+= ( Complex x )

Addition of scalar.

Definition at line 1067 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator+=() [2/5]

ComplexMatrixView & ComplexMatrixView::operator+= ( Numeric x )

Addition of scalar.

Definition at line 1077 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator+=() [3/5]

ComplexMatrixView & ComplexMatrixView::operator+= ( const ConstComplexMatrixView & x )

Element-vise addition of another Matrix.

Definition at line 1203 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstComplexMatrixView::nrows(), and r.

◆ operator+=() [4/5]

ComplexMatrixView & ComplexMatrixView::operator+= ( const ConstMatrixView & x )

Element-vise addition of another Matrix.

Definition at line 1220 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstMatrixView::ncols(), ConstComplexMatrixView::nrows(), ConstMatrixView::nrows(), and r.

◆ operator+=() [5/5]

ComplexMatrixView& ComplexMatrixView::operator+= ( const ConstComplexVectorView & x )

◆ operator-=() [1/5]

ComplexMatrixView & ComplexMatrixView::operator-= ( Complex x )

Subtraction of scalar.

Definition at line 1087 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator-=() [2/5]

ComplexMatrixView & ComplexMatrixView::operator-= ( Numeric x )

Subtraction of scalar.

Definition at line 1097 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator-=() [3/5]

ComplexMatrixView & ComplexMatrixView::operator-= ( const ConstComplexMatrixView & x )

Element-vise subtraction of another Matrix.

Definition at line 1236 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstComplexMatrixView::nrows(), and r.

◆ operator-=() [4/5]

ComplexMatrixView & ComplexMatrixView::operator-= ( const ConstMatrixView & x )

Element-vise subtraction of another Matrix.

Definition at line 1253 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstMatrixView::ncols(), ConstComplexMatrixView::nrows(), ConstMatrixView::nrows(), and r.

◆ operator-=() [5/5]

ComplexMatrixView& ComplexMatrixView::operator-= ( const ConstComplexVectorView & x )

◆ operator/=() [1/5]

ComplexMatrixView & ComplexMatrixView::operator/= ( Complex x )

Division by scalar.

Definition at line 1047 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator/=() [2/5]

ComplexMatrixView & ComplexMatrixView::operator/= ( Numeric x )

Division by scalar.

Definition at line 1057 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), and r.

◆ operator/=() [3/5]

ComplexMatrixView & ComplexMatrixView::operator/= ( const ConstComplexMatrixView & x )

Element-vise division by another Matrix.

Definition at line 1170 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstComplexMatrixView::nrows(), and r.

◆ operator/=() [4/5]

ComplexMatrixView & ComplexMatrixView::operator/= ( const ConstMatrixView & x )

Element-vise division by another Matrix.

Definition at line 1187 of file complex.cc.

References ConstComplexMatrixView::begin(), ConstMatrixView::begin(), ConstComplexMatrixView::end(), ConstComplexMatrixView::ncols(), ConstMatrixView::ncols(), ConstComplexMatrixView::nrows(), ConstMatrixView::nrows(), and r.

◆ operator/=() [5/5]

ComplexMatrixView& ComplexMatrixView::operator/= ( const ConstComplexVectorView & x )

◆ operator=() [1/5]

ComplexMatrixView & ComplexMatrixView::operator= ( const ConstComplexMatrixView & m )

Assignment operator.

This copies the data from another ComplexMatrixView to this ComplexMatrixView. Dimensions must agree! Resizing would destroy the selection that we might have done in this ComplexMatrixView by setting its range.

Definition at line 968 of file complex.cc.

References ConstComplexMatrixView::begin(), copy(), ConstComplexMatrixView::end(), ConstComplexMatrixView::mcr, Range::mextent, and ConstComplexMatrixView::mrr.

◆ operator=() [2/5]

ComplexMatrixView & ComplexMatrixView::operator= ( const ComplexMatrixView & m )

Assignment from ComplexMatrixView to ComplexMatrixView.

This is a tricky one. The problem is that since ComplexMatrixView is derived from ConstMatrixView, a default = operator is generated by the compiler, which does not do what we want. So we need this one to override the default.

Definition at line 983 of file complex.cc.

References ConstComplexMatrixView::begin(), begin(), copy(), end(), ConstComplexMatrixView::mcr, Range::mextent, and ConstComplexMatrixView::mrr.

◆ operator=() [3/5]

ComplexMatrixView & ComplexMatrixView::operator= ( const ComplexMatrix & m )

Assignment from a ComplexMatrix.

This must exist to overide the automatically generated assignment operators, which don't copy the contents!

Definition at line 995 of file complex.cc.

References ConstComplexMatrixView::begin(), begin(), copy(), end(), ConstComplexMatrixView::mcr, Range::mextent, and ConstComplexMatrixView::mrr.

◆ operator=() [4/5]

ComplexMatrixView & ComplexMatrixView::operator= ( const ConstComplexVectorView & v )

Assignment from a vector.

This copies the data from a ComplexVectorView to this ComplexMatrixView. Dimensions must agree! Resizing would destroy the selection that we might have done in this ComplexMatrixView by setting its range.

Definition at line 1008 of file complex.cc.

References ConstComplexMatrixView::begin(), copy(), ConstComplexMatrixView::end(), ConstComplexMatrixView::mcr, Range::mextent, ConstComplexMatrixView::mrr, and ConstComplexVectorView::nelem().

◆ operator=() [5/5]

ComplexMatrixView & ComplexMatrixView::operator= ( Complex x )

Assigning a scalar to a MatrixView will set all elements to this value.

Definition at line 1021 of file complex.cc.

References ConstComplexMatrixView::begin(), copy(), and ConstComplexMatrixView::end().

◆ real()

MatrixView ComplexMatrixView::real ( )

inline

Get a view of the real part of the matrix.

Definition at line 777 of file complex.h.

Friends And Related Function Documentation

◆ ComplexVectorView

friend class ComplexVectorView

friend

Definition at line 835 of file complex.h.

◆ transpose [1/2]

ConstComplexMatrixView transpose ( ConstComplexMatrixView m )

friend

Const version of transpose.

Definition at line 1509 of file complex.cc.

Referenced by transpose().

◆ transpose [2/2]

ComplexMatrixView transpose ( ComplexMatrixView m )

friend

Returns the transpose.

This creates a special MatrixView for the transpose. The original is not changed!

Definition at line 1515 of file complex.cc.

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

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ iterator

Constructor & Destructor Documentation

◆ ComplexMatrixView() [1/4]

◆ ~ComplexMatrixView()

◆ ComplexMatrixView() [2/4]

◆ ComplexMatrixView() [3/4]

◆ ComplexMatrixView() [4/4]

Member Function Documentation

◆ begin()

◆ diagonal()

◆ end()

◆ get()

◆ get_c_array() [1/2]

◆ get_c_array() [2/2]

◆ get_imag()

◆ get_real()

◆ imag()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator*=() [1/5]

◆ operator*=() [2/5]

◆ operator*=() [3/5]

◆ operator*=() [4/5]

◆ operator*=() [5/5]

◆ operator+=() [1/5]

◆ operator+=() [2/5]

◆ operator+=() [3/5]

◆ operator+=() [4/5]

◆ operator+=() [5/5]

◆ operator-=() [1/5]

◆ operator-=() [2/5]

◆ operator-=() [3/5]

◆ operator-=() [4/5]

◆ operator-=() [5/5]

◆ operator/=() [1/5]

◆ operator/=() [2/5]

◆ operator/=() [3/5]

◆ operator/=() [4/5]

◆ operator/=() [5/5]

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ real()

Friends And Related Function Documentation

◆ ComplexVectorView

◆ transpose [1/2]

◆ transpose [2/2]