#include <matpackIII.h>

Inheritance diagram for Tensor3View:

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

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

MatrixView	operator() (const Range &p, const Range &r, Index c)
	Index operator returning an object of type MatrixView. More...

MatrixView	operator() (const Range &p, Index r, const Range &c)
	Index operator returning an object of type MatrixView. More...

MatrixView	operator() (Index p, const Range &r, const Range &c)
	Index operator returning an object of type MatrixView. More...

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

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

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

Numeric &	operator() (Index p, Index r, Index c)
	Plain non-const index operator. More...

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

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

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

Iterator3D	begin ()
	Return iterator to first page. More...

Iterator3D	end ()
	Return iterator behind last page. More...

Tensor3View &	operator= (const ConstTensor3View &v)
	Assignment operator. More...

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

Tensor3View &	operator= (const Tensor3 &v)
	Assignment from a Tensor3. More...

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

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

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

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

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

Tensor3View &	operator*= (const ConstTensor3View &x)
	Element-vise multiplication by another Tensor3. More...

Tensor3View &	operator/= (const ConstTensor3View &x)
	Element-vise division by another Tensor3. More...

Tensor3View &	operator+= (const ConstTensor3View &x)
	Element-vise addition of another Tensor3. More...

Tensor3View &	operator-= (const ConstTensor3View &x)
	Element-vise subtraction of another Tensor3. More...

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

	Tensor3View (const MatrixView &a)
	Special constructor to make a Tensor3 view of a matrix. More...

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

constexpr	ConstTensor3View (ConstTensor3View &&)=default

ConstTensor3View &	operator= (const ConstTensor3View &)=default

ConstTensor3View &	operator= (ConstTensor3View &&)=default

bool	empty () const
	Check if variable is empty. More...

Index	npages () const
	Returns the number of pages. More...

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

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

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

ConstMatrixView	operator() (const Range &p, const Range &r, Index c) const
	Const index operator returning an object of type ConstMatrixView. More...

ConstMatrixView	operator() (const Range &p, Index r, const Range &c) const
	Const index operator returning an object of type ConstMatrixView. More...

ConstMatrixView	operator() (Index p, const Range &r, const Range &c) const
	Const index operator returning an object of type ConstMatrixView. More...

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

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

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

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

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

ConstIterator3D	begin () const
	Return const iterator to first page. More...

ConstIterator3D	end () const
	Return const iterator behind last page. More...

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

	ConstTensor3View (const ConstMatrixView &a)
	Special constructor to make a Tensor3 view of a matrix. More...

Protected Member Functions
	Tensor3View ()=default

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

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

Protected Member Functions inherited from ConstTensor3View
	ConstTensor3View ()=default

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

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

Friends
class	Iterator4D

class	Tensor4View

class	Tensor5View

class	Tensor6View

class	Tensor7View

Additional Inherited Members
Protected Attributes inherited from ConstTensor3View
Range	mpr {0, 0, 1}
	The page range of mdata that is actually used. More...

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 Tensor3View class.

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

The class Tensor3 is just a special case of a Tensor3View which also allocates storage.

Definition at line 239 of file matpackIII.h.

Constructor & Destructor Documentation

◆ Tensor3View() [1/5]

constexpr Tensor3View::Tensor3View ( const Tensor3View & )

default

◆ ~Tensor3View()

virtual Tensor3View::~Tensor3View ( )

virtualdefault

Destructor.

◆ Tensor3View() [2/5]

Tensor3View::Tensor3View ( const MatrixView & a )

Special constructor to make a Tensor3 view of a matrix.

Definition at line 490 of file matpackIII.cc.

◆ Tensor3View() [3/5]

Tensor3View::Tensor3View ( )

protecteddefault

◆ Tensor3View() [4/5]

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

protected

Explicit constructor.

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

Definition at line 499 of file matpackIII.cc.

◆ Tensor3View() [5/5]

Tensor3View::Tensor3View	(	Numeric *	data,
		const Range &	pp,
		const Range &	pr,
		const Range &	pc,
		const Range &	np,
		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.
pp	Previous range.
pr	Previous range.
pc	Previous range.
np	New Range.
nr	New Range.
nc	New Range.

Definition at line 523 of file matpackIII.cc.

Member Function Documentation

◆ begin()

Iterator3D Tensor3View::begin ( )

Return iterator to first page.

Definition at line 332 of file matpackIII.cc.

References ConstTensor3View::mcr, ConstTensor3View::mdata, ConstTensor3View::mpr, ConstTensor3View::mrr, Range::mstart, and Range::mstride.

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

◆ end()

Iterator3D Tensor3View::end ( )

Return iterator behind last page.

Definition at line 337 of file matpackIII.cc.

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

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

◆ get()

Numeric& Tensor3View::get	(	Index	p,
		Index	r,
		Index	c
	)

inline

Get element implementation without assertions.

Definition at line 275 of file matpackIII.h.

◆ get_c_array() [1/2]

const Numeric * Tensor3View::get_c_array ( ) const

Conversion to plain C-array.

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

Definition at line 321 of file matpackIII.cc.

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

Referenced by get_variable_value(), nca_read_from_file(), nca_write_to_file(), Reduce(), and InteractiveWorkspace::set_tensor3_variable().

◆ get_c_array() [2/2]

Numeric * Tensor3View::get_c_array ( )

Conversion to plain C-array.

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

Definition at line 305 of file matpackIII.cc.

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

◆ operator()() [1/8]

Tensor3View Tensor3View::operator()	(	const Range &	p,
		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 Tensor3. This allows correct recursive behavior.

Definition at line 218 of file matpackIII.cc.

◆ operator()() [2/8]

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

Index operator returning an object of type MatrixView.

(Reducing the dimension by one.)

Definition at line 226 of file matpackIII.cc.

◆ operator()() [3/8]

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

Index operator returning an object of type MatrixView.

(Reducing the dimension by one.)

Definition at line 236 of file matpackIII.cc.

◆ operator()() [4/8]

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

Index operator returning an object of type MatrixView.

(Reducing the dimension by one.)

Definition at line 246 of file matpackIII.cc.

◆ operator()() [5/8]

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

Index operator returning an object of type VectorView.

(Reducing the dimension by two.)

Definition at line 256 of file matpackIII.cc.

◆ operator()() [6/8]

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

Index operator returning an object of type VectorView.

(Reducing the dimension by two.)

Definition at line 271 of file matpackIII.cc.

◆ operator()() [7/8]

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

Index operator returning an object of type VectorView.

(Reducing the dimension by two.)

Definition at line 286 of file matpackIII.cc.

◆ operator()() [8/8]

Numeric& Tensor3View::operator()	(	Index	p,
		Index	r,
		Index	c
	)

inline

Plain non-const index operator.

Definition at line 262 of file matpackIII.h.

References r.

◆ operator*=() [1/2]

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

Multiplication by scalar.

Definition at line 398 of file matpackIII.cc.

References ConstTensor3View::begin(), and ConstTensor3View::end().

◆ operator*=() [2/2]

Tensor3View & Tensor3View::operator*= ( const ConstTensor3View & x )

Element-vise multiplication by another Tensor3.

Definition at line 434 of file matpackIII.cc.

References ConstTensor3View::begin(), ConstTensor3View::end(), ConstTensor3View::ncols(), ConstTensor3View::npages(), and ConstTensor3View::nrows().

◆ operator+=() [1/2]

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

Addition of scalar.

Definition at line 416 of file matpackIII.cc.

References ConstTensor3View::begin(), and ConstTensor3View::end().

◆ operator+=() [2/2]

Tensor3View & Tensor3View::operator+= ( const ConstTensor3View & x )

Element-vise addition of another Tensor3.

Definition at line 462 of file matpackIII.cc.

References ConstTensor3View::begin(), ConstTensor3View::end(), ConstTensor3View::ncols(), ConstTensor3View::npages(), and ConstTensor3View::nrows().

◆ operator-=() [1/2]

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

Subtraction of scalar.

Definition at line 425 of file matpackIII.cc.

References ConstTensor3View::begin(), and ConstTensor3View::end().

◆ operator-=() [2/2]

Tensor3View & Tensor3View::operator-= ( const ConstTensor3View & x )

Element-vise subtraction of another Tensor3.

Definition at line 476 of file matpackIII.cc.

References ConstTensor3View::begin(), ConstTensor3View::end(), ConstTensor3View::ncols(), ConstTensor3View::npages(), and ConstTensor3View::nrows().

◆ operator/=() [1/2]

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

Division by scalar.

Definition at line 407 of file matpackIII.cc.

References ConstTensor3View::begin(), and ConstTensor3View::end().

◆ operator/=() [2/2]

Tensor3View & Tensor3View::operator/= ( const ConstTensor3View & x )

Element-vise division by another Tensor3.

Definition at line 448 of file matpackIII.cc.

References ConstTensor3View::begin(), ConstTensor3View::end(), ConstTensor3View::ncols(), ConstTensor3View::npages(), and ConstTensor3View::nrows().

◆ operator=() [1/4]

Tensor3View & Tensor3View::operator= ( const ConstTensor3View & m )

Assignment operator.

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

Definition at line 347 of file matpackIII.cc.

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

◆ operator=() [2/4]

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

Assignment from Tensor3View to Tensor3View.

This is a tricky one. The problem is that since Tensor3View is derived from ConstTensor3View, 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 362 of file matpackIII.cc.

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

◆ operator=() [3/4]

Tensor3View & Tensor3View::operator= ( const Tensor3 & m )

Assignment from a Tensor3.

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

Definition at line 375 of file matpackIII.cc.

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

◆ operator=() [4/4]

Tensor3View & Tensor3View::operator= ( Numeric x )

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

Definition at line 387 of file matpackIII.cc.

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

Friends And Related Function Documentation

◆ Iterator4D

friend class Iterator4D

friend

Definition at line 309 of file matpackIII.h.

◆ Tensor4View

friend class Tensor4View

friend

Definition at line 310 of file matpackIII.h.

◆ Tensor5View

friend class Tensor5View

friend

Definition at line 311 of file matpackIII.h.

◆ Tensor6View

friend class Tensor6View

friend

Definition at line 312 of file matpackIII.h.

◆ Tensor7View

friend class Tensor7View

friend

Definition at line 313 of file matpackIII.h.

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Tensor3View() [1/5]

◆ ~Tensor3View()

◆ Tensor3View() [2/5]

◆ Tensor3View() [3/5]

◆ Tensor3View() [4/5]

◆ Tensor3View() [5/5]

Member Function Documentation

◆ begin()

◆ end()

◆ get()

◆ get_c_array() [1/2]

◆ get_c_array() [2/2]

◆ operator()() [1/8]

◆ operator()() [2/8]

◆ operator()() [3/8]

◆ operator()() [4/8]

◆ operator()() [5/8]

◆ operator()() [6/8]

◆ operator()() [7/8]

◆ operator()() [8/8]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Friends And Related Function Documentation

◆ Iterator4D

◆ Tensor4View

◆ Tensor5View

◆ Tensor6View

◆ Tensor7View