A constant view of a Tensor3. More...

#include <matpackIII.h>

Inheritance diagram for ConstTensor3View:

Public Member Functions
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...

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

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

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

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

Protected Attributes
Range	mpr
	The page range of mdata that is actually used. More...

Range	mrr
	The row range of mdata that is actually used. More...

Range	mcr
	The column range of mdata that is actually used. More...

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

Friends
class	Tensor3View

Detailed Description

A constant view of a Tensor3.

This, together with the derived class Tensor3View, 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 three dimensions of the tensor are called: page, row, column.

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

Definition at line 93 of file matpackIII.h.

Constructor & Destructor Documentation

◆ ConstTensor3View() [1/3]

ConstTensor3View::ConstTensor3View ( )

inlineprotected

Default constructor.

This is necessary, so that we can have a default constructor for derived classes.

Definition at line 556 of file matpackIII.h.

◆ ConstTensor3View() [2/3]

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

inlineprotected

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. The page range pr must have a stride to account for the length of one page.

Definition at line 566 of file matpackIII.h.

◆ ConstTensor3View() [3/3]

ConstTensor3View::ConstTensor3View	(	Numeric *	data,
		const Range &	pp,
		const Range &	pr,
		const Range &	pc,
		const Range &	np,
		const Range &	nr,
		const Range &	nc
	)

inlineprotected

Recursive constructor.

This is used to construct sub-tensors from sub-tensors. 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.

Definition at line 585 of file matpackIII.h.

Member Function Documentation

◆ begin()

ConstIterator3D ConstTensor3View::begin ( ) const

inline

Return const iterator to first page.

Definition at line 536 of file matpackIII.h.

◆ end()

ConstIterator3D ConstTensor3View::end ( ) const

inline

Return const iterator behind last page.

Definition at line 545 of file matpackIII.h.

◆ ncols()

Index ConstTensor3View::ncols ( ) const

inline

Returns the number of columns.

Definition at line 404 of file matpackIII.h.

◆ npages()

Index ConstTensor3View::npages ( ) const

inline

Returns the number of pages.

Definition at line 392 of file matpackIII.h.

◆ nrows()

Index ConstTensor3View::nrows ( ) const

inline

Returns the number of rows.

Definition at line 398 of file matpackIII.h.

◆ operator()() [1/8]

ConstTensor3View ConstTensor3View::operator()	(	const Range &	p,
		const Range &	r,
		const Range &	c
	)		const

inline

Const 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 412 of file matpackIII.h.

◆ operator()() [2/8]

ConstMatrixView ConstTensor3View::operator()	(	const Range &	p,
		const Range &	r,
		Index	c
	)		const

inline

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by one.)

Definition at line 421 of file matpackIII.h.

◆ operator()() [3/8]

ConstMatrixView ConstTensor3View::operator()	(	const Range &	p,
		Index	r,
		const Range &	c
	)		const

inline

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by one.)

Definition at line 436 of file matpackIII.h.

◆ operator()() [4/8]

ConstVectorView ConstTensor3View::operator()	(	const Range &	p,
		Index	r,
		Index	c
	)		const

inline

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by two.)

Definition at line 502 of file matpackIII.h.

◆ operator()() [5/8]

ConstMatrixView ConstTensor3View::operator()	(	Index	p,
		const Range &	r,
		const Range &	c
	)		const

inline

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by one.)

Definition at line 451 of file matpackIII.h.

◆ operator()() [6/8]

ConstVectorView ConstTensor3View::operator()	(	Index	p,
		const Range &	r,
		Index	c
	)		const

inline

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by two.)

Definition at line 484 of file matpackIII.h.

◆ operator()() [7/8]

ConstVectorView ConstTensor3View::operator()	(	Index	p,
		Index	r,
		const Range &	c
	)		const

inline

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by two.)

Definition at line 466 of file matpackIII.h.

◆ operator()() [8/8]

Numeric ConstTensor3View::operator()	(	Index	p,
		Index	r,
		Index	c
	)		const

inline

Plain const index operator.

Definition at line 519 of file matpackIII.h.

Friends And Related Function Documentation

◆ Tensor3View

friend class Tensor3View

friend

Definition at line 118 of file matpackIII.h.

Member Data Documentation

◆ mcr

Range ConstTensor3View::mcr

protected

The column range of mdata that is actually used.

Definition at line 137 of file matpackIII.h.

◆ mdata

Numeric* ConstTensor3View::mdata

protected

Pointer to the plain C array that holds the data.

Definition at line 139 of file matpackIII.h.

◆ mpr

Range ConstTensor3View::mpr

protected

The page range of mdata that is actually used.

Definition at line 133 of file matpackIII.h.

◆ mrr

Range ConstTensor3View::mrr

protected

The row range of mdata that is actually used.

Definition at line 135 of file matpackIII.h.

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

matpackIII.h

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ConstTensor3View() [1/3]

◆ ConstTensor3View() [2/3]

◆ ConstTensor3View() [3/3]

Member Function Documentation

◆ begin()

◆ end()

◆ ncols()

◆ npages()

◆ nrows()

◆ operator()() [1/8]

◆ operator()() [2/8]

◆ operator()() [3/8]

◆ operator()() [4/8]

◆ operator()() [5/8]

◆ operator()() [6/8]

◆ operator()() [7/8]

◆ operator()() [8/8]

Friends And Related Function Documentation

◆ Tensor3View

Member Data Documentation

◆ mcr

◆ mdata

◆ mpr

◆ mrr