#include <matpack_complex.h>

Inheritance diagram for ComplexMatrixView:

Public Types
using	iterator = ComplexIterator2D

Public Types inherited from ConstComplexMatrixView
using	const_iterator = ConstComplexIterator2D

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

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

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

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

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

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

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

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

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

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

ComplexIterator2D	begin ()
	Return iterator to first row.

ComplexIterator2D	end ()
	Return iterator behind last row.

ComplexVectorView	diagonal ()
	ComplexMatrix diagonal as vector.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ComplexMatrixView &	operator*= (const ConstComplexVectorView &x)

ComplexMatrixView &	operator/= (const ConstComplexVectorView &x)

ComplexMatrixView &	operator+= (const ConstComplexVectorView &x)

ComplexMatrixView &	operator-= (const ConstComplexVectorView &x)

	~ComplexMatrixView () override=default
	Destructor.

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

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

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

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

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

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

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

ConstComplexVectorView	diagonal () const
	ComplexMatrix diagonal as vector.

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

constexpr	ConstComplexMatrixView (ConstComplexMatrixView &&)=default

ConstComplexMatrixView &	operator= (const ConstComplexMatrixView &)=default

ConstComplexMatrixView &	operator= (ConstComplexMatrixView &&)=default

Index	selem () const noexcept

Index	nrows () const noexcept

Index	ncols () const noexcept

Index	drows () const noexcept

Index	dcols () const noexcept

Index	size () const noexcept

bool	empty () const noexcept

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

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

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

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

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

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

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

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

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

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

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

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

ConstComplexVectorView	diagonal () const
	ComplexMatrix diagonal as vector.

virtual	~ConstComplexMatrixView ()=default
	Destructor.

Complex *	get_c_array () const noexcept

Protected Member Functions
	ComplexMatrixView ()
	Default constructor.

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

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

Protected Member Functions inherited from ConstComplexMatrixView
	ConstComplexMatrixView ()=default

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

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

Friends
class	ComplexVectorView

ConstComplexMatrixView	transpose (ConstComplexMatrixView m)
	Const version of transpose.

ComplexMatrixView	transpose (ComplexMatrixView m)
	Returns the transpose.

Additional Inherited Members
Static Public Attributes inherited from ConstComplexMatrixView
static constexpr bool	matpack_type {true}

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

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

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

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 794 of file matpack_complex.h.

Member Typedef Documentation

◆ iterator

using ComplexMatrixView::iterator = ComplexIterator2D

Definition at line 810 of file matpack_complex.h.

Constructor & Destructor Documentation

◆ ComplexMatrixView() [1/4]

constexpr ComplexMatrixView::ComplexMatrixView ( const ComplexMatrixView & )

constexprdefault

◆ ~ComplexMatrixView()

ComplexMatrixView::~ComplexMatrixView ( )

overridedefault

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 1271 of file matpack_complex.cc.

Referenced by operator()().

◆ 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 1278 of file matpack_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 1299 of file matpack_complex.cc.

Member Function Documentation

◆ begin() [1/2]

ComplexIterator2D ComplexMatrixView::begin ( )

Return iterator to first row.

Definition at line 968 of file matpack_complex.cc.

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

Referenced by ComplexMatrix::ComplexMatrix(), operator*=(), operator+=(), operator-=(), operator/=(), ComplexMatrix::operator=(), and operator=().

◆ begin() [2/2]

ConstComplexIterator2D ConstComplexMatrixView::begin ( ) const

Return const iterator to first row.

Definition at line 735 of file matpack_complex.cc.

◆ diagonal() [1/2]

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 989 of file matpack_complex.cc.

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

Referenced by lm_hitran_2017::convtp(), and lm_hitran_2017::hitran_lm_eigenvalue_approximation().

◆ diagonal() [2/2]

ConstComplexVectorView ConstComplexMatrixView::diagonal ( ) const

ComplexMatrix diagonal as vector.

R eturns a ConstComplex*MatrixView 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 739 of file matpack_complex.cc.

◆ end() [1/2]

ComplexIterator2D ComplexMatrixView::end ( )

Return iterator behind last row.

Definition at line 974 of file matpack_complex.cc.

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

Referenced by ComplexMatrix::ComplexMatrix(), operator*=(), operator+=(), operator-=(), operator/=(), ComplexMatrix::operator=(), and operator=().

◆ end() [2/2]

ConstComplexIterator2D ConstComplexMatrixView::end ( ) const

Return const iterator behind last row.

Definition at line 736 of file matpack_complex.cc.