#include <matpackI.h>

Inheritance diagram for MatrixView:

Public Types
typedef Iterator2D	iterator

Public Types inherited from ConstMatrixView
typedef ConstIterator2D	const_iterator

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

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

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

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

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

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

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

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

MatrixView &	operator= (const ConstMatrixView &v)
	Assignment operator. More...

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

MatrixView &	operator= (const Matrix &v)
	Assignment from a Matrix. More...

MatrixView &	operator= (const ConstVectorView &v)
	Assignment from a vector. More...

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

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

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

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

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

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

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

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

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

MatrixView &	operator*= (const ConstVectorView &x)
	Element-vise multiplication by a Vector (acting like a 1-column Matrix). More...

MatrixView &	operator/= (const ConstVectorView &x)
	Element-vise division by a Vector (acting like a 1-column Matrix). More...

MatrixView &	operator+= (const ConstVectorView &x)
	Element-vise addition of a Vector (acting like a 1-column Matrix). More...

MatrixView &	operator-= (const ConstVectorView &x)
	Element-vise subtraction of a Vector (acting like a 1-column Matrix). More...

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

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

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

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

constexpr	ConstMatrixView (ConstMatrixView &&)=default

ConstMatrixView &	operator= (const ConstMatrixView &)=default

ConstMatrixView &	operator= (ConstMatrixView &&)=default

bool	empty () const
	Returns true if variable size is zero. More...

Index	nrows () const
	Returns the number of rows. More...

Index	ncols () const
	Returns the number of columns. More...

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

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

ConstMatrixView	operator() (const Range &r, const Range &c) const
	Const index operator for subrange. More...

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

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

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

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

ConstVectorView	diagonal () const
	Matrix diagonal as vector. More...

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

Protected Member Functions
	MatrixView ()=default

	MatrixView (Numeric *data, const Range &r, const Range &c)
	Explicit constructor. More...

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

Protected Member Functions inherited from ConstMatrixView
	ConstMatrixView ()=default

	ConstMatrixView (Numeric *data, const Range &r, const Range &c)
	Explicit constructor. More...

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

Friends
class	VectorView

class	Iterator3D

class	Tensor3View

class	Tensor4View

class	Tensor5View

class	Tensor6View

class	Tensor7View

class	ComplexMatrixView

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

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

void	mult (MatrixView, const ConstMatrixView &, const ConstMatrixView &)
	Matrix-Matrix Multiplication. More...

Additional Inherited Members
Protected Attributes inherited from ConstMatrixView
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...

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

Detailed Description

The MatrixView class.

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

The class Matrix is just a special case of a MatrixView which also allocates storage.

Definition at line 1093 of file matpackI.h.

Member Typedef Documentation

◆ iterator

typedef Iterator2D MatrixView::iterator

Definition at line 1104 of file matpackI.h.

Constructor & Destructor Documentation

◆ MatrixView() [1/4]

constexpr MatrixView::MatrixView ( const MatrixView & )

default

◆ ~MatrixView()

virtual MatrixView::~MatrixView ( )

virtualdefault

Destructor.

◆ MatrixView() [2/4]

MatrixView::MatrixView ( )

protecteddefault

Referenced by transpose().

◆ MatrixView() [3/4]

MatrixView::MatrixView	(	Numeric *	data,
		const Range &	rr,
		const Range &	cr
	)

protected

Explicit constructor.

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

Definition at line 882 of file matpackI.cc.

◆ MatrixView() [4/4]

MatrixView::MatrixView	(	Numeric *	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 901 of file matpackI.cc.

Member Function Documentation

◆ begin()

Iterator2D MatrixView::begin ( )

Return const iterator to first row.

Has to be redefined here, since it is hiden by the non-const operator of the derived class. Return const iterator behind last row. Return iterator to first row.

Definition at line 618 of file matpackI.cc.

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

Referenced by copy(), Matrix::Matrix(), mult_general(), operator=(), Matrix::operator=(), and transform().

◆ end()

Iterator2D MatrixView::end ( )

Return iterator behind last row.

Definition at line 623 of file matpackI.cc.

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

Referenced by copy(), mult_general(), and operator=().

◆ get()

Numeric& MatrixView::get	(	Index	r,
		Index	c
	)

inline

Get element implementation without assertions.

Definition at line 1118 of file matpackI.h.

◆ get_c_array() [1/2]

const Numeric * MatrixView::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 735 of file matpackI.cc.

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

Referenced by get_covariance_matrix_block(), get_variable_value(), nca_get_data_Matrix(), nca_put_var_Matrix(), nca_read_from_file(), nca_write_to_file(), Reduce(), InteractiveWorkspace::set_matrix_variable(), and test38().

◆ get_c_array() [2/2]

Numeric * MatrixView::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 750 of file matpackI.cc.

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

◆ operator()() [1/4]

Numeric& MatrixView::operator()	(	Index	r,
		Index	c
	)

inline

Plain index operator.

Definition at line 1108 of file matpackI.h.

◆ operator()() [2/4]

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

Index operator for subrange.

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

Definition at line 576 of file matpackI.cc.

◆ operator()() [3/4]

VectorView MatrixView::operator()	(	const Range &	r,
		Index	c
	)

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

Parameters

r	A range of rows.
c	Index of selected column

Definition at line 584 of file matpackI.cc.

◆ operator()() [4/4]

VectorView MatrixView::operator()	(	Index	r,
		const Range &	c
	)

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

Parameters

r	Index of selected row.
c	Range of columns

Definition at line 596 of file matpackI.cc.

◆ operator*=() [1/3]

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

Multiplication by scalar.

Definition at line 690 of file matpackI.cc.

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

◆ operator*=() [2/3]

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

Element-vise multiplication by another Matrix.

Definition at line 760 of file matpackI.cc.

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

◆ operator*=() [3/3]

MatrixView & MatrixView::operator*= ( const ConstVectorView & x )

Element-vise multiplication by a Vector (acting like a 1-column Matrix).

Definition at line 824 of file matpackI.cc.

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

◆ operator+=() [1/3]

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

Addition of scalar.

Definition at line 710 of file matpackI.cc.

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

◆ operator+=() [2/3]

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

Element-vise addition of another Matrix.

Definition at line 792 of file matpackI.cc.

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

◆ operator+=() [3/3]

MatrixView & MatrixView::operator+= ( const ConstVectorView & x )

Element-vise addition of a Vector (acting like a 1-column Matrix).

Definition at line 852 of file matpackI.cc.

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

◆ operator-=() [1/3]

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

Subtraction of scalar.

Definition at line 720 of file matpackI.cc.

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

◆ operator-=() [2/3]

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

Element-vise subtraction of another Matrix.

Definition at line 808 of file matpackI.cc.

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

◆ operator-=() [3/3]

MatrixView & MatrixView::operator-= ( const ConstVectorView & x )

Element-vise subtraction of a Vector (acting like a 1-column Matrix).

Definition at line 866 of file matpackI.cc.

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

◆ operator/=() [1/3]

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

Division by scalar.

Definition at line 700 of file matpackI.cc.

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

◆ operator/=() [2/3]

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

Element-vise division by another Matrix.

Definition at line 776 of file matpackI.cc.

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

◆ operator/=() [3/3]

MatrixView & MatrixView::operator/= ( const ConstVectorView & x )

Element-vise division by a Vector (acting like a 1-column Matrix).

Definition at line 838 of file matpackI.cc.

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

◆ operator=() [1/5]

MatrixView & MatrixView::operator= ( const ConstMatrixView & m )

Assignment operator.

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

Definition at line 633 of file matpackI.cc.

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

◆ operator=() [2/5]

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

Assignment from MatrixView to MatrixView.

This is a tricky one. The problem is that since MatrixView 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 647 of file matpackI.cc.

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

◆ operator=() [3/5]

MatrixView & MatrixView::operator= ( const Matrix & m )

Assignment from a Matrix.

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

Definition at line 659 of file matpackI.cc.

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

◆ operator=() [4/5]

MatrixView & MatrixView::operator= ( const ConstVectorView & v )

Assignment from a vector.

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

Definition at line 672 of file matpackI.cc.

References ConstMatrixView::begin(), copy(), ConstMatrixView::end(), ConstMatrixView::mcr, Range::mextent, ConstMatrixView::mrr, and ConstVectorView::nelem().

◆ operator=() [5/5]

MatrixView & MatrixView::operator= ( Numeric x )

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

Definition at line 684 of file matpackI.cc.

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

Friends And Related Function Documentation

◆ ComplexMatrixView

friend class ComplexMatrixView

friend

Definition at line 1169 of file matpackI.h.

◆ Iterator3D

friend class Iterator3D

friend

Definition at line 1163 of file matpackI.h.

◆ mult

void mult	(	MatrixView	,
		const ConstMatrixView &	,
		const ConstMatrixView &
	)

friend

Matrix-Matrix Multiplication.

Performs the matrix multiplication A = B * C. The dimensions must match, i.e. A must be a m times n matrix, B a m times k matrix and C a k times c matrix. No memory reallocation takes place, only the data is copied. Using this function on overlapping MatrixViews belonging to the same Matrix will lead to unpredictable results. In particular, this means that A and B must not be the same matrix!

If the memory layout allows it, the multiplication is performed using BLAS' _dgemm, which leads to a significant speed up of the operation. To be compatible with BLAS the matrix views A, B and C must satisfy:

A must have column or row stride 1
B must have column or row stride 1
C must have column stride 1

That means that A and B can be ConstMatrixView objects corresponding to transposed/non-transposed submatrices of a matrix, that are continuous along their first/second dimension. C must correspond to a non-transposed submatrix of a matrix, that is continuous along its second dimension.

Parameters

[in,out]	A	The matrix A, that will hold the result of the multiplication.
[in]	B	The matrix B
[in]	C	The matrix C

Definition at line 1242 of file matpackI.cc.

◆ Tensor3View

friend class Tensor3View

friend

Definition at line 1164 of file matpackI.h.

◆ Tensor4View

friend class Tensor4View

friend

Definition at line 1165 of file matpackI.h.

◆ Tensor5View

friend class Tensor5View

friend

Definition at line 1166 of file matpackI.h.

◆ Tensor6View

friend class Tensor6View

friend

Definition at line 1167 of file matpackI.h.

◆ Tensor7View

friend class Tensor7View

friend

Definition at line 1168 of file matpackI.h.

◆ transpose [1/2]

ConstMatrixView transpose ( ConstMatrixView m )

friend

Const version of transpose.

Definition at line 1444 of file matpackI.cc.

Referenced by mult_general(), and transpose().

◆ transpose [2/2]

MatrixView transpose ( MatrixView m )

friend

Returns the transpose.

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

Definition at line 1450 of file matpackI.cc.

◆ VectorView

friend class VectorView

friend

Definition at line 1162 of file matpackI.h.

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

◆ MatrixView() [1/4]

◆ ~MatrixView()

◆ MatrixView() [2/4]

◆ MatrixView() [3/4]

◆ MatrixView() [4/4]

Member Function Documentation

◆ begin()

◆ end()

◆ get()

◆ get_c_array() [1/2]

◆ get_c_array() [2/2]

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator*=() [3/3]

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator-=() [1/3]

◆ operator-=() [2/3]

◆ operator-=() [3/3]

◆ operator/=() [1/3]

◆ operator/=() [2/3]

◆ operator/=() [3/3]

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

Friends And Related Function Documentation

◆ ComplexMatrixView

◆ Iterator3D

◆ mult

◆ Tensor3View

◆ Tensor4View

◆ Tensor5View

◆ Tensor6View

◆ Tensor7View

◆ transpose [1/2]

◆ transpose [2/2]

◆ VectorView