A constant view of a Tensor3. More...

#include <matpackIII.h>

Inheritance diagram for ConstTensor3View:

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

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

Friends
class	Tensor3View

class	ConstIterator4D

class	ConstTensor4View

class	ConstTensor5View

class	ConstTensor6View

class	ConstTensor7View

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

Constructor & Destructor Documentation

◆ ConstTensor3View() [1/6]

constexpr ConstTensor3View::ConstTensor3View ( const ConstTensor3View & )

constexprdefault

◆ ConstTensor3View() [2/6]

constexpr ConstTensor3View::ConstTensor3View ( ConstTensor3View && )

constexprdefault

◆ ~ConstTensor3View()

virtual ConstTensor3View::~ConstTensor3View ( )

virtualdefault

Destructor.

◆ ConstTensor3View() [3/6]

ConstTensor3View::ConstTensor3View ( const ConstMatrixView & a )

Special constructor to make a Tensor3 view of a matrix.

Definition at line 153 of file matpackIII.cc.

◆ ConstTensor3View() [4/6]

ConstTensor3View::ConstTensor3View ( )

protecteddefault

◆ ConstTensor3View() [5/6]

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

Definition at line 165 of file matpackIII.cc.

◆ ConstTensor3View() [6/6]

ConstTensor3View::ConstTensor3View	(	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 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 180 of file matpackIII.cc.

Member Function Documentation

◆ begin()

ConstIterator3D ConstTensor3View::begin ( ) const

Return const iterator to first page.

Definition at line 139 of file matpackIII.cc.

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

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

◆ empty()

bool ConstTensor3View::empty ( ) const

Check if variable is empty.

Parameters

[in] x The variable to check.

Returns: True if the size of any dimension of x is 0.

Definition at line 38 of file matpackIII.cc.

References ncols(), npages(), and nrows().

Referenced by get_variable_value(), and test_empty().

◆ end()

ConstIterator3D ConstTensor3View::end ( ) const

Return const iterator behind last page.

Definition at line 145 of file matpackIII.cc.

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

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

◆ get()

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

inline

Get element implementation without assertions.

Definition at line 180 of file matpackIII.h.

◆ ncols()

Index ConstTensor3View::ncols ( ) const

inline

Returns the number of columns.

Definition at line 150 of file matpackIII.h.

References mcr, and Range::mextent.

Referenced by abs_vecTransform(), Append(), apply_iy_unit2(), AtmFieldPRegrid(), GriddedField3::checksize(), GriddedField3::checksize_strict(), chk_scat_species_field(), Compare(), complex_n_interp(), empty(), ext_matTransform(), flat(), get_pfct(), get_pmom(), get_stepwise_transmission_matrix(), get_variable_value(), GriddedFieldLatLonExpand(), GriddedFieldPRegrid(), iy_transmission_mult(), MatrixExtractFromTensor3(), mult(), nca_write_to_file(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), Tensor3::operator=(), Reduce(), regrid_atmfield_by_gp_oem(), reshape(), select_dims_by_size(), surface_calc(), Tensor3::Tensor3(), Tensor3AddScalar(), Tensor3Scale(), test01(), test06(), xaStandard(), and xml_write_to_stream().

◆ npages()

Index ConstTensor3View::npages ( ) const

inline

Returns the number of pages.

Definition at line 144 of file matpackIII.h.

References Range::mextent, and mpr.

Referenced by _cr_internal_(), Append(), apply_iy_unit2(), AtmFieldPRegrid(), AtmFieldsCalcExpand1D(), cayley_hamilton_fitted_method_4x4_propmat_to_transmat__eigen(), cayley_hamilton_fitted_method_4x4_propmat_to_transmat__explicit(), GriddedField3::checksize(), GriddedField3::checksize_strict(), chk_scat_species_field(), Compare(), complex_n_interp(), diagonalize(), diy_from_path_to_rgrids(), empty(), Extract(), find_cloudlimits(), flat(), get_pfct(), get_pmom(), get_variable_value(), GriddedFieldLatLonExpand(), GriddedFieldLatLonRegrid(), iy_transmission_mult(), MagFieldsCalcExpand1D(), matrix_exp_dmatrix_exp(), MatrixExtractFromTensor3(), mult(), nca_write_to_file(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), Tensor3::operator=(), propmat4x4_to_transmat4x4(), Reduce(), regrid_atmfield_by_gp_oem(), reshape(), rtmethods_jacobian_finalisation(), select_dims_by_size(), Tensor3::Tensor3(), Tensor3AddScalar(), Tensor3Scale(), test04(), test31(), WindFieldsCalcExpand1D(), xaStandard(), and xml_write_to_stream().

◆ nrows()

Index ConstTensor3View::nrows ( ) const

inline

Returns the number of rows.

Definition at line 147 of file matpackIII.h.

References Range::mextent, and mrr.

Referenced by Append(), apply_iy_unit2(), AtmFieldPRegrid(), GriddedField3::checksize(), GriddedField3::checksize_strict(), chk_scat_species_field(), Compare(), complex_n_interp(), empty(), flat(), get_pfct(), get_pmom(), get_variable_value(), GriddedFieldLatLonExpand(), GriddedFieldPRegrid(), iy_transmission_mult(), MatrixExtractFromTensor3(), mult(), nca_write_to_file(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), Tensor3::operator=(), Reduce(), regrid_atmfield_by_gp_oem(), reshape(), select_dims_by_size(), surface_calc(), Tensor3::Tensor3(), Tensor3AddScalar(), Tensor3Scale(), test31(), xaStandard(), and xml_write_to_stream().

◆ operator()() [1/8]

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

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 45 of file matpackIII.cc.

◆ operator()() [2/8]

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

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by one.)

Definition at line 53 of file matpackIII.cc.

◆ operator()() [3/8]

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

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by one.)

Definition at line 65 of file matpackIII.cc.

◆ operator()() [4/8]

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

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by two.)

Definition at line 123 of file matpackIII.cc.

◆ operator()() [5/8]

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

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by one.)

Definition at line 77 of file matpackIII.cc.

◆ operator()() [6/8]

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

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by two.)

Definition at line 106 of file matpackIII.cc.

◆ operator()() [7/8]

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

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by two.)

Definition at line 89 of file matpackIII.cc.

◆ operator()() [8/8]

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

inline

Plain const index operator.

Definition at line 166 of file matpackIII.h.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

ConstTensor3View& ConstTensor3View::operator= ( ConstTensor3View && )

default

Friends And Related Function Documentation

◆ ConstIterator4D

friend class ConstIterator4D

friend

Definition at line 194 of file matpackIII.h.

◆ ConstTensor4View

friend class ConstTensor4View

friend

Definition at line 195 of file matpackIII.h.

◆ ConstTensor5View

friend class ConstTensor5View

friend

Definition at line 196 of file matpackIII.h.

◆ ConstTensor6View

friend class ConstTensor6View

friend

Definition at line 197 of file matpackIII.h.

◆ ConstTensor7View

friend class ConstTensor7View

friend

Definition at line 198 of file matpackIII.h.

◆ Tensor3View

friend class Tensor3View

friend

Definition at line 193 of file matpackIII.h.

Member Data Documentation

◆ mcr

Range ConstTensor3View::mcr {0, 0, 1}

protected

The column range of mdata that is actually used.

Definition at line 225 of file matpackIII.h.

Referenced by Tensor3View::begin(), begin(), Tensor3View::end(), end(), Tensor3View::get_c_array(), ncols(), ConstIterator4D::operator!=(), Iterator4D::operator!=(), Tensor3View::operator=(), and swap().

◆ mdata

Numeric* ConstTensor3View::mdata {nullptr}

protected

Pointer to the plain C array that holds the data.

Definition at line 227 of file matpackIII.h.

Referenced by Tensor3View::begin(), begin(), Tensor3View::end(), end(), Tensor3View::get_c_array(), ConstIterator4D::operator!=(), Iterator4D::operator!=(), Iterator4D::operator++(), ConstIterator4D::operator++(), Tensor3::operator=(), swap(), Tensor3::Tensor3(), and Tensor3::~Tensor3().

◆ mpr

Range ConstTensor3View::mpr {0, 0, 1}

protected

The page range of mdata that is actually used.

Definition at line 221 of file matpackIII.h.

Referenced by Tensor3View::begin(), begin(), Tensor3View::end(), end(), Tensor3View::get_c_array(), npages(), ConstIterator4D::operator!=(), Iterator4D::operator!=(), Tensor3View::operator=(), and swap().

◆ mrr

Range ConstTensor3View::mrr {0, 0, 1}

protected

The row range of mdata that is actually used.

Definition at line 223 of file matpackIII.h.

Referenced by Tensor3View::begin(), begin(), Tensor3View::end(), end(), Tensor3View::get_c_array(), nrows(), ConstIterator4D::operator!=(), Iterator4D::operator!=(), Tensor3View::operator=(), and swap().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ConstTensor3View() [1/6]

◆ ConstTensor3View() [2/6]

◆ ~ConstTensor3View()

◆ ConstTensor3View() [3/6]

◆ ConstTensor3View() [4/6]

◆ ConstTensor3View() [5/6]

◆ ConstTensor3View() [6/6]

Member Function Documentation

◆ begin()

◆ empty()

◆ end()

◆ get()

◆ 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]

◆ operator=() [1/2]

◆ operator=() [2/2]

Friends And Related Function Documentation

◆ ConstIterator4D

◆ ConstTensor4View

◆ ConstTensor5View

◆ ConstTensor6View

◆ ConstTensor7View

◆ Tensor3View

Member Data Documentation

◆ mcr

◆ mdata

◆ mpr

◆ mrr