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

virtual	~ConstTensor3View ()
	Destructor. More...

	ConstTensor3View (const ConstMatrixView &a)
	Special constructor to make a Tensor3 view of a matrix. 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

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

Constructor & Destructor Documentation

◆ ~ConstTensor3View()

virtual ConstTensor3View::~ConstTensor3View ( )

inlinevirtual

Destructor.

Definition at line 191 of file matpackIII.h.

◆ ConstTensor3View() [1/4]

ConstTensor3View::ConstTensor3View ( const ConstMatrixView & a )

Special constructor to make a Tensor3 view of a matrix.

Definition at line 160 of file matpackIII.cc.

◆ ConstTensor3View() [2/4]

ConstTensor3View::ConstTensor3View ( )

protected

Default constructor.

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

Definition at line 171 of file matpackIII.cc.

Referenced by operator()().

◆ ConstTensor3View() [3/4]

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

◆ ConstTensor3View() [4/4]

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

Member Function Documentation

◆ begin()

ConstIterator3D ConstTensor3View::begin ( ) const

Return const iterator to first page.

Definition at line 141 of file matpackIII.cc.

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

Referenced by Tensor3View::begin(), copy(), max(), min(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), operator<<(), Tensor3View::operator=(), Tensor3::Tensor3(), and transform().

◆ end()

ConstIterator3D ConstTensor3View::end ( ) const

Return const iterator behind last page.

Definition at line 150 of file matpackIII.cc.

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

Referenced by copy(), Tensor3View::end(), max(), min(), operator<<(), Tensor3View::operator=(), Tensor3::Tensor3(), and transform().

◆ ncols()

Index ConstTensor3View::ncols ( ) const

inline

Returns the number of columns.

Definition at line 157 of file matpackIII.h.

References mcr, and Range::mextent.

Referenced by abs_vecTransform(), apply_y_unit2(), basics_checkedCalc(), calc_nd_field(), GriddedField3::checksize(), chk_atm_field(), chk_massdensity_field(), chk_size(), describe(), ext_matAddGas(), ext_matAddPart(), ext_matTransform(), interp_gfield3(), is_size(), iy_transmission_mult(), iy_transmission_mult_scalar_tau(), iyMC(), jacobianCalcAbsSpeciesPerturbations(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), opt_prop_sptFromData(), opt_prop_sptFromMonoData(), perturbation_field_3d(), pnd_fieldSetup(), surface_calc(), Tensor3AddScalar(), Tensor3Scale(), test01(), test06(), test31(), transform(), xml_write_to_stream(), and z_fieldFromHSE().

◆ npages()

Index ConstTensor3View::npages ( ) const

inline

Returns the number of pages.

Definition at line 151 of file matpackIII.h.

References Range::mextent, and mpr.

Referenced by abs_vecTransform(), apply_y_unit2(), AtmFieldsCalcExpand1D(), basics_checkedCalc(), calc_nd_field(), GriddedField3::checksize(), chk_atm_field(), chk_massdensity_field(), chk_size(), cloudbox_checkedCalc(), cloudboxSetManuallyAltitude(), describe(), ext_matAddGas(), ext_matAddPart(), ext_matTransform(), Extract(), get_iy_of_background(), get_ppath_atmvars(), get_refr_index_2d(), is_size(), iy_transmission_mult(), iy_transmission_mult_scalar_tau(), jacobianCalcAbsSpeciesPerturbations(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), opt_prop_sptFromData(), opt_prop_sptFromMonoData(), perturbation_field_3d(), pnd_fieldSetup(), ppath_end_3d(), Tensor3AddScalar(), Tensor3Scale(), test04(), test31(), transform(), xml_write_to_stream(), and z_fieldFromHSE().

◆ nrows()

Index ConstTensor3View::nrows ( ) const

inline

Returns the number of rows.

Definition at line 154 of file matpackIII.h.

References Range::mextent, and mrr.

Referenced by apply_y_unit2(), basics_checkedCalc(), calc_nd_field(), GriddedField3::checksize(), chk_atm_field(), chk_massdensity_field(), chk_size(), describe(), ext_matAddGas(), ext_matAddPart(), interp_gfield3(), is_size(), iy_transmission_mult(), iy_transmission_mult_scalar_tau(), jacobianCalcAbsSpeciesPerturbations(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), perturbation_field_3d(), pnd_fieldSetup(), surface_calc(), Tensor3AddScalar(), Tensor3Scale(), test31(), transform(), xml_write_to_stream(), and z_fieldFromHSE().

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

References ConstTensor3View(), mcr, mdata, mpr, and mrr.

Referenced by Tensor3View::operator()().

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

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

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

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

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

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

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

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

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

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

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

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

◆ operator()() [8/8]

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

inline

Plain const index operator.

Definition at line 171 of file matpackIII.h.

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

Friends And Related Function Documentation

◆ ConstIterator4D

friend class ConstIterator4D

friend

Definition at line 195 of file matpackIII.h.

◆ ConstTensor4View

friend class ConstTensor4View

friend

Definition at line 196 of file matpackIII.h.

◆ ConstTensor5View

friend class ConstTensor5View

friend

Definition at line 197 of file matpackIII.h.

◆ ConstTensor6View

friend class ConstTensor6View

friend

Definition at line 198 of file matpackIII.h.

◆ ConstTensor7View

friend class ConstTensor7View

friend

Definition at line 199 of file matpackIII.h.

◆ Tensor3View

friend class Tensor3View

friend

Definition at line 194 of file matpackIII.h.

Member Data Documentation

◆ mcr

Range ConstTensor3View::mcr

protected

The column range of mdata that is actually used.

Definition at line 220 of file matpackIII.h.

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

◆ mdata

Numeric* ConstTensor3View::mdata

protected

Pointer to the plain C array that holds the data.

Definition at line 222 of file matpackIII.h.

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

◆ mpr

Range ConstTensor3View::mpr

protected

The page range of mdata that is actually used.

Definition at line 216 of file matpackIII.h.

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

◆ mrr

Range ConstTensor3View::mrr

protected

The row range of mdata that is actually used.

Definition at line 218 of file matpackIII.h.

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

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()

◆ ConstTensor3View() [1/4]

◆ ConstTensor3View() [2/4]

◆ ConstTensor3View() [3/4]

◆ ConstTensor3View() [4/4]

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

◆ ConstIterator4D

◆ ConstTensor4View

◆ ConstTensor5View

◆ ConstTensor6View

◆ ConstTensor7View

◆ Tensor3View

Member Data Documentation

◆ mcr

◆ mdata

◆ mpr

◆ mrr