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

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

Index	size () const noexcept

bool	empty () const noexcept

Shape< 3 >	shape () const

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

std::ostream &	operator<< (std::ostream &os, const ConstTensor3View &v)
	Output operator. More...

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

◆ ConstTensor3View() [4/6]

ConstTensor3View::ConstTensor3View ( )

protecteddefault

Referenced by operator()().

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

Member Function Documentation

◆ begin()

ConstIterator3D ConstTensor3View::begin ( ) const

Return const iterator to first page.

Definition at line 130 of file matpackIII.cc.

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

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

◆ empty()

bool ConstTensor3View::empty ( ) const

inlinenoexcept

Definition at line 152 of file matpackIII.h.

References size().

Referenced by cloudbox_checkedCalc(), iyIndependentBeamApproximation(), iyTransmissionStandard(), pndFromPsd(), pndFromPsdBasic(), and x2artsAtmAndSurf().

◆ end()

ConstIterator3D ConstTensor3View::end ( ) const

Return const iterator behind last page.

Definition at line 136 of file matpackIII.cc.

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

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

◆ get()

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

inline

Get element implementation without assertions.

Definition at line 185 of file matpackIII.h.

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

Referenced by interp(), and operator()().

◆ ncols()

Index ConstTensor3View::ncols ( ) const

inline

Returns the number of columns.

Definition at line 146 of file matpackIII.h.

References mcr, and Range::mextent.

Referenced by abs_vecTransform(), add_normed_phase_functions(), Append(), apply_iy_unit2(), AtmFieldPRegrid(), atmgeom_checkedCalc(), GriddedField3::checksize(), chk_atm_field(), chk_scat_species_field(), chk_size(), complex_n_interp(), IGRF::compute(), describe(), ext_abs_pfun_from_tro(), ext_matTransform(), field_of_propagation(), flat(), get_pfct(), get_pmom(), GriddedFieldLatLonExpand(), GriddedFieldPRegrid(), GriddedFieldZToPRegrid(), Interpolation::interp(), is_size(), iy_transmittance_mult(), iyLoopFrequencies(), iyMC(), MagFieldsCalcIGRF(), MagFieldsFromAltitudeRawCalc(), MatrixExtractFromTensor3(), mult(), nca_write_to_file(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), Tensor3::operator=(), particle_bulkpropRadarOnionPeeling(), pndFromPsd(), pndFromPsdBasic(), Reduce(), Tensor3::reduce_rank(), regrid_atmfield_by_gp_oem(), reshape(), run_cdisort(), run_cdisort_flux(), select_dims_by_size(), shape(), size(), surface_calc(), surface_props_check(), surfaceFlatReflectivity(), Tensor3::Tensor3(), Tensor3Add(), Tensor3Multiply(), test01(), test06(), transform(), water_p_eq_fieldMK05(), x2artsAtmAndSurf(), and xml_write_to_stream().

◆ npages()

Index ConstTensor3View::npages ( ) const

inline

Returns the number of pages.

Definition at line 140 of file matpackIII.h.

References Range::mextent, and mpr.

Referenced by add_normed_phase_functions(), Append(), apply_iy_unit2(), AtmFieldPRegrid(), atmfields_checkedCalc(), AtmFieldsCalcExpand1D(), AtmFieldsExtract1D(), atmgeom_checkedCalc(), GriddedField3::checksize(), chk_atm_field(), chk_scat_species_field(), chk_size(), cloudboxSetManuallyAltitude(), complex_n_interp(), IGRF::compute(), describe(), ext_abs_pfun_from_tro(), Extract(), field_of_propagation(), find_cloudlimits(), flat(), get_pfct(), get_pmom(), get_ppath_atmvars(), GriddedFieldLatLonExpand(), GriddedFieldLatLonRegrid(), GriddedFieldZToPRegrid(), Interpolation::interp(), is_size(), iy_transmittance_mult(), iySurfaceFastem(), iySurfaceFlatReflectivity(), iySurfaceFlatRefractiveIndex(), iySurfaceLambertian(), iySurfaceRtpropAgenda(), iySurfaceRtpropCalc(), MagFieldsCalcExpand1D(), MagFieldsCalcIGRF(), MagFieldsFromAltitudeRawCalc(), MatrixExtractFromTensor3(), mult(), nca_write_to_file(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), Tensor3::operator=(), OptimizeDoitPressureGrid(), particle_bulkpropRadarOnionPeeling(), pndFromPsd(), pndFromPsdBasic(), ppath_end_3d(), ppath_fieldFromDownUpLimbGeoms(), ppathFixedLstep(), ppathPlaneParallel(), Reduce(), Tensor3::reduce_rank(), regrid_atmfield_by_gp_oem(), reshape(), rtmethods_jacobian_finalisation(), select_dims_by_size(), shape(), size(), surface_props_check(), surface_props_interp(), surfaceFlatReflectivity(), Tensor3::Tensor3(), Tensor3Add(), Tensor3Multiply(), test04(), transform(), water_p_eq_fieldMK05(), WindFieldsCalcExpand1D(), WriteMolTau(), x2artsAtmAndSurf(), and xml_write_to_stream().

◆ nrows()

Index ConstTensor3View::nrows ( ) const

inline

Returns the number of rows.

Definition at line 143 of file matpackIII.h.

References Range::mextent, and mrr.

Referenced by add_normed_phase_functions(), Append(), apply_iy_unit2(), AtmFieldPRegrid(), atmgeom_checkedCalc(), GriddedField3::checksize(), chk_atm_field(), chk_scat_species_field(), chk_size(), complex_n_interp(), IGRF::compute(), describe(), ext_abs_pfun_from_tro(), field_of_propagation(), flat(), get_pfct(), get_pmom(), GriddedFieldLatLonExpand(), GriddedFieldPRegrid(), GriddedFieldZToPRegrid(), Interpolation::interp(), is_size(), iy_transmittance_mult(), MagFieldsCalcIGRF(), MagFieldsFromAltitudeRawCalc(), MatrixExtractFromTensor3(), mult(), nca_write_to_file(), Tensor3View::operator*=(), Tensor3View::operator+=(), Tensor3View::operator-=(), Tensor3View::operator/=(), Tensor3::operator=(), particle_bulkpropRadarOnionPeeling(), Reduce(), Tensor3::reduce_rank(), regrid_atmfield_by_gp_oem(), reshape(), run_cdisort(), run_cdisort_flux(), select_dims_by_size(), shape(), size(), surface_calc(), surface_props_check(), surfaceFlatReflectivity(), Tensor3::Tensor3(), Tensor3Add(), Tensor3Multiply(), transform(), water_p_eq_fieldMK05(), x2artsAtmAndSurf(), 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 36 of file matpackIII.cc.

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

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

References ARTS_ASSERT, c, 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 56 of file matpackIII.cc.

References ARTS_ASSERT, c, 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 114 of file matpackIII.cc.

References ARTS_ASSERT, c, 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 68 of file matpackIII.cc.

References ARTS_ASSERT, c, 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 97 of file matpackIII.cc.

References ARTS_ASSERT, c, 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 80 of file matpackIII.cc.

References ARTS_ASSERT, c, 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 ARTS_ASSERT, c, get(), mcr, Range::mextent, mpr, and mrr.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

default

◆ shape()

Shape< 3 > ConstTensor3View::shape ( ) const

inline

Returns the shape as an array (to allow templates to just look for shape on different matpack objects)

Definition at line 155 of file matpackIII.h.

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

◆ size()

Index ConstTensor3View::size ( ) const

inlinenoexcept

Definition at line 149 of file matpackIII.h.

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

Referenced by empty(), Tensor3View::get_c_array(), Tensor3::reduce_rank(), Tensor4::reduce_rank(), Tensor5::reduce_rank(), Tensor6::reduce_rank(), Tensor7::reduce_rank(), and Tensor3::transform_elementwise().

Friends And Related Function Documentation

◆ ConstIterator4D

friend class ConstIterator4D

friend

Definition at line 199 of file matpackIII.h.

◆ ConstTensor4View

friend class ConstTensor4View

friend

Definition at line 200 of file matpackIII.h.

◆ ConstTensor5View

friend class ConstTensor5View

friend

Definition at line 201 of file matpackIII.h.

◆ ConstTensor6View

friend class ConstTensor6View

friend

Definition at line 202 of file matpackIII.h.

◆ ConstTensor7View

friend class ConstTensor7View

friend

Definition at line 203 of file matpackIII.h.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const ConstTensor3View &	v
	)

friend

Output operator.

This demonstrates how iterators can be used to traverse the tensor. We use the standard output operator for Matrix to print each page in turn.

Definition at line 185 of file matpackIII.cc.

◆ Tensor3View

friend class Tensor3View

friend

Definition at line 198 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 232 of file matpackIII.h.

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

◆ mdata

Numeric* ConstTensor3View::mdata {nullptr}

protected

Pointer to the plain C array that holds the data.

Definition at line 234 of file matpackIII.h.

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

◆ mpr

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

protected

The page range of mdata that is actually used.

Definition at line 228 of file matpackIII.h.

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

◆ mrr

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

protected

The row range of mdata that is actually used.

Definition at line 230 of file matpackIII.h.

Referenced by Tensor3View::begin(), begin(), Tensor3View::end(), end(), Tensor3View::get(), get(), Tensor3View::get_c_array(), nrows(), ConstIterator4D::operator!=(), Iterator4D::operator!=(), Tensor3View::operator()(), operator()(), Tensor3View::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() [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]

◆ shape()

◆ size()

Friends And Related Function Documentation

◆ ConstIterator4D

◆ ConstTensor4View

◆ ConstTensor5View

◆ ConstTensor6View

◆ ConstTensor7View

◆ operator<<

◆ Tensor3View

Member Data Documentation

◆ mcr

◆ mdata

◆ mpr

◆ mrr