#include <matpackI.h>

Inheritance diagram for VectorView:

Public Types
using	iterator = Iterator1D

Public Types inherited from ConstVectorView
using	const_iterator = ConstIterator1D

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

	VectorView (const Vector &)
	Bail out immediately if somebody tries to create a VectorView from a const Vector. More...

	VectorView (Vector &v) ARTS_NOEXCEPT
	Create VectorView from a Vector. More...

Numeric &	operator[] (Index n) ARTS_NOEXCEPT
	Plain Index operator. More...

Numeric &	get (Index n) ARTS_NOEXCEPT
	Get element implementation without assertions. More...

VectorView	operator[] (const Range &r) ARTS_NOEXCEPT
	Index operator for subrange. More...

Iterator1D	begin () ARTS_NOEXCEPT
	Return iterator to first element. More...

Iterator1D	end () ARTS_NOEXCEPT
	Return iterator behind last element. More...

VectorView &	operator= (const ConstVectorView &v)
	Assignment operator. More...

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

VectorView &	operator= (const Vector &v)
	Assignment from Vector. More...

VectorView &	operator= (const Array< Numeric > &v)
	Assignment operator from Array<Numeric>. More...

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

VectorView	operator*= (Numeric x) ARTS_NOEXCEPT
	Multiplication by scalar. More...

VectorView	operator/= (Numeric x) ARTS_NOEXCEPT
	Division by scalar. More...

VectorView	operator+= (Numeric x) ARTS_NOEXCEPT
	Addition of scalar. More...

VectorView	operator-= (Numeric x) ARTS_NOEXCEPT
	Subtraction of scalar. More...

VectorView	operator*= (const ConstVectorView &x) ARTS_NOEXCEPT
	Element-vise multiplication by another vector. More...

VectorView	operator/= (const ConstVectorView &x) ARTS_NOEXCEPT
	Element-vise division by another vector. More...

VectorView	operator+= (const ConstVectorView &x) ARTS_NOEXCEPT
	Element-vise addition of another vector. More...

VectorView	operator-= (const ConstVectorView &x) ARTS_NOEXCEPT
	Element-vise subtraction of another vector. More...

	operator MatrixView () ARTS_NOEXCEPT
	Conversion to 1 column matrix. More...

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

Numeric *	get_c_array () ARTS_NOEXCEPT
	Conversion to plain C-array, non-const version. More...

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

	VectorView (Numeric &a) ARTS_NOEXCEPT
	A special constructor, which allows to make a VectorView from a scalar. More...

ConstIterator1D	begin () const ARTS_NOEXCEPT
	Return const iterator to first element. More...

ConstIterator1D	end () const ARTS_NOEXCEPT
	Return const iterator behind last element. More...

Numeric	get (Index n) const ARTS_NOEXCEPT
	Get element implementation without assertions. More...

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

constexpr	ConstVectorView (ConstVectorView &&)=default

ConstVectorView &	operator= (const ConstVectorView &)=default

ConstVectorView &	operator= (ConstVectorView &&)=default

bool	empty () const noexcept
	Returns true if variable size is zero. More...

Index	nelem () const noexcept
	Returns the number of elements. More...

Index	size () const noexcept

Shape< 1 >	shape () const

Numeric	sum () const ARTS_NOEXCEPT
	The sum of all elements of a Vector. More...

Numeric	operator[] (Index n) const ARTS_NOEXCEPT
	Plain const index operator. More...

Numeric	get (Index n) const ARTS_NOEXCEPT
	Get element implementation without assertions. More...

ConstVectorView	operator[] (const Range &r) const ARTS_NOEXCEPT
	Const index operator for subrange. More...

ConstIterator1D	begin () const ARTS_NOEXCEPT
	Return const iterator to first element. More...

ConstIterator1D	end () const ARTS_NOEXCEPT
	Return const iterator behind last element. More...

	operator ConstMatrixView () const
	Conversion to const 1 column matrix. More...

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

	ConstVectorView (const Numeric &a) ARTS_NOEXCEPT
	A special constructor, which allows to make a ConstVectorView from a scalar. More...

Protected Member Functions
	VectorView ()=default

	VectorView (Numeric *data, const Range &range) ARTS_NOEXCEPT
	Explicit constructor. More...

	VectorView (Numeric *data, const Range &p, const Range &n) ARTS_NOEXCEPT
	Recursive constructor. More...

Protected Member Functions inherited from ConstVectorView
	ConstVectorView ()=default

	ConstVectorView (Numeric *data, const Range &range) ARTS_NOEXCEPT
	Explicit constructor. More...

	ConstVectorView (Numeric *data, const Range &p, const Range &n) ARTS_NOEXCEPT
	Recursive constructor. More...

Friends
class	ConstIterator2D

class	Iterator2D

class	MatrixView

class	Tensor3View

class	Tensor4View

class	Tensor5View

class	Tensor6View

class	Tensor7View

class	ComplexVectorView

Additional Inherited Members
Protected Attributes inherited from ConstVectorView
Range	mrange {0, 0}
	The 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 VectorView class.

This contains the main implementation of a vector. The class Vector is just a special case of subvector which also allocates storage.

Unfortunately, names of element functions of derived classes hide the names of the original class, even if the arguments are different. This means that we have to redefine those element functions that can have different arguments, for example the constant index operators and iterators.

Definition at line 658 of file matpackI.h.

Member Typedef Documentation

◆ iterator

using VectorView::iterator = Iterator1D

Definition at line 676 of file matpackI.h.

Constructor & Destructor Documentation

◆ VectorView() [1/7]

constexpr VectorView::VectorView ( const VectorView & )

constexprdefault

◆ VectorView() [2/7]

VectorView::VectorView ( const Vector & )

Bail out immediately if somebody tries to create a VectorView from a const Vector.

Definition at line 126 of file matpackI.cc.

References ARTS_ASSERT.

◆ VectorView() [3/7]

VectorView::VectorView ( Vector & v )

Create VectorView from a Vector.

Definition at line 135 of file matpackI.cc.

References v.

◆ ~VectorView()

virtual VectorView::~VectorView ( )

virtualdefault

Destructor.

◆ VectorView() [4/7]

VectorView::VectorView ( Numeric & a )

A special constructor, which allows to make a VectorView from a scalar.

Definition at line 288 of file matpackI.cc.

◆ VectorView() [5/7]

VectorView::VectorView ( )

protecteddefault

◆ VectorView() [6/7]

VectorView::VectorView	(	Numeric *	data,
		const Range &	range
	)

protected

Explicit constructor.

This one is used by Vector to initialize its own VectorView part.

Definition at line 292 of file matpackI.cc.

◆ VectorView() [7/7]

VectorView::VectorView	(	Numeric *	data,
		const Range &	p,
		const Range &	n
	)

protected

Recursive constructor.

This is used to construct sub ranges from sub ranges. That means that the new range has to be interpreted relative to the original range. The new range 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

[in]	*data	The actual data.
[in]	p	Previous range.
[in]	n	New Range.

Definition at line 297 of file matpackI.cc.

Member Function Documentation

◆ begin() [1/2]

Iterator1D VectorView::begin ( )

Return iterator to first element.

Definition at line 144 of file matpackI.cc.

References ConstVectorView::mdata, ConstVectorView::mrange, Range::mstart, and Range::mstride.

Referenced by Raw::Average::nanstd(), EnergyLevelMap::OK(), MatrixView::operator*=(), MatrixView::operator+=(), MatrixView::operator-=(), MatrixView::operator/=(), operator=(), Vector::operator=(), Raw::Average::std(), test46(), transform(), and Vector::Vector().

◆ begin() [2/2]

ConstIterator1D ConstVectorView::begin ( ) const

Return const iterator to first element.

Definition at line 576 of file matpackI.cc.

◆ end() [1/2]

Iterator1D VectorView::end ( )

Return iterator behind last element.

Definition at line 148 of file matpackI.cc.

References ConstVectorView::mdata, Range::mextent, ConstVectorView::mrange, Range::mstart, and Range::mstride.

Referenced by Raw::Average::nanstd(), EnergyLevelMap::OK(), MatrixView::operator*=(), MatrixView::operator+=(), MatrixView::operator-=(), MatrixView::operator/=(), operator=(), Raw::Average::std(), and test46().

◆ end() [2/2]

ConstIterator1D ConstVectorView::end ( ) const

Return const iterator behind last element.

Definition at line 579 of file matpackI.cc.

References c.

◆ get() [1/2]

Numeric & VectorView::get ( Index n )

inline

Get element implementation without assertions.

Definition at line 686 of file matpackI.h.

References ConstVectorView::mdata, ConstVectorView::mrange, Range::mstart, and Range::mstride.

Referenced by interpweights(), MatrixView::operator()(), ConstMatrixView::operator()(), and operator[]().

◆ get() [2/2]

Numeric ConstVectorView::get ( Index n ) const

inline

Get element implementation without assertions.

Definition at line 561 of file matpackI.h.

◆ get_c_array() [1/2]

Numeric * VectorView::get_c_array ( )

Conversion to plain C-array, non-const version.

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

Definition at line 280 of file matpackI.cc.

References ARTS_ASSERT, ConstVectorView::mdata, Range::mextent, ConstVectorView::mrange, Range::mstart, and Range::mstride.

◆ get_c_array() [2/2]

const Numeric * VectorView::get_c_array ( ) const

Conversion to plain C-array, const-version.

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

Definition at line 272 of file matpackI.cc.

References ARTS_ASSERT, ConstVectorView::mdata, Range::mextent, ConstVectorView::mrange, Range::mstart, and Range::mstride.

Referenced by diagonalize(), XsecRecord::Extract(), fastem(), Reduce(), tmatrix_random_orientation(), and tmatrix_tmd_test().

◆ operator MatrixView()

VectorView::operator MatrixView ( )

Conversion to 1 column matrix.

Definition at line 263 of file matpackI.cc.

◆ operator*=() [1/2]

VectorView VectorView::operator*= ( const ConstVectorView & x )

Element-vise multiplication by another vector.

Definition at line 215 of file matpackI.cc.

References ARTS_ASSERT, and Absorption::nelem().

◆ operator*=() [2/2]

VectorView VectorView::operator*= ( Numeric x )

Multiplication by scalar.

Definition at line 191 of file matpackI.cc.

◆ operator+=() [1/2]

VectorView VectorView::operator+= ( const ConstVectorView & x )

Element-vise addition of another vector.

Definition at line 239 of file matpackI.cc.

References ARTS_ASSERT, and Absorption::nelem().

◆ operator+=() [2/2]

VectorView VectorView::operator+= ( Numeric x )

Addition of scalar.

Definition at line 203 of file matpackI.cc.

◆ operator-=() [1/2]

VectorView VectorView::operator-= ( const ConstVectorView & x )

Element-vise subtraction of another vector.

Definition at line 251 of file matpackI.cc.

References ARTS_ASSERT, and Absorption::nelem().

◆ operator-=() [2/2]

VectorView VectorView::operator-= ( Numeric x )

Subtraction of scalar.

Definition at line 209 of file matpackI.cc.

◆ operator/=() [1/2]

VectorView VectorView::operator/= ( const ConstVectorView & x )

Element-vise division by another vector.

Definition at line 227 of file matpackI.cc.

References ARTS_ASSERT, and Absorption::nelem().

◆ operator/=() [2/2]

VectorView VectorView::operator/= ( Numeric x )

Division by scalar.

Definition at line 197 of file matpackI.cc.

◆ operator=() [1/5]

VectorView & VectorView::operator= ( const Array< Numeric > & v )

Assignment operator from Array<Numeric>.

This copies the data from an Array<Numeric> to this VectorView. Dimensions must agree! Resizing would destroy the selection that we might have done in this VectorView by setting its range.

Array<Numeric> can be useful to collect things in, because there is a .push_back method for it. Then, after collecting we usually have to transfer the content to a Vector. With this assignment operator that's easy.

Definition at line 1665 of file matpackI.cc.

References ARTS_ASSERT, Range::mextent, ConstVectorView::mrange, and v.

◆ operator=() [2/5]

VectorView & VectorView::operator= ( const ConstVectorView & v )

Assignment operator.

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

Definition at line 153 of file matpackI.cc.

References ARTS_ASSERT, begin(), copy(), Range::mextent, ConstVectorView::mrange, and v.

Referenced by Vector::operator=().

◆ operator=() [3/5]

VectorView & VectorView::operator= ( const Vector & v )

Assignment from Vector.

This is important to avoid a bug when assigning a Vector to a VectorView.

Definition at line 175 of file matpackI.cc.

References ARTS_ASSERT, begin(), copy(), Range::mextent, ConstVectorView::mrange, and v.

◆ operator=() [4/5]

VectorView & VectorView::operator= ( const VectorView & v )

Assignment from VectorView to VectorView.

This is a tricky one. The problem is that since VectorView is derived from ConstVectorView, 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 164 of file matpackI.cc.

References ARTS_ASSERT, begin(), copy(), Range::mextent, ConstVectorView::mrange, and v.

◆ operator=() [5/5]

VectorView & VectorView::operator= ( Numeric x )

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

Definition at line 186 of file matpackI.cc.

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

◆ operator[]() [1/2]

VectorView VectorView::operator[] ( const Range & r )

Index operator for subrange.

We have to also account for the case, that *this is already a subrange of a Vector. This allows correct recursive behavior.

Definition at line 140 of file matpackI.cc.

◆ operator[]() [2/2]

Numeric & VectorView::operator[] ( Index n )

inline

Plain Index operator.

Definition at line 679 of file matpackI.h.

References ARTS_ASSERT, get(), Range::mextent, and ConstVectorView::mrange.

Friends And Related Function Documentation

◆ ComplexVectorView

friend class ComplexVectorView

friend

Definition at line 783 of file matpackI.h.

◆ ConstIterator2D

friend class ConstIterator2D

friend

Definition at line 775 of file matpackI.h.

◆ Iterator2D

friend class Iterator2D

friend

Definition at line 776 of file matpackI.h.

◆ MatrixView

friend class MatrixView

friend

Definition at line 777 of file matpackI.h.

◆ Tensor3View

friend class Tensor3View

friend

Definition at line 778 of file matpackI.h.

◆ Tensor4View

friend class Tensor4View

friend

Definition at line 779 of file matpackI.h.

◆ Tensor5View

friend class Tensor5View

friend

Definition at line 780 of file matpackI.h.

◆ Tensor6View

friend class Tensor6View

friend

Definition at line 781 of file matpackI.h.

◆ Tensor7View

friend class Tensor7View

friend

Definition at line 782 of file matpackI.h.

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

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ iterator

Constructor & Destructor Documentation

◆ VectorView() [1/7]

◆ VectorView() [2/7]

◆ VectorView() [3/7]

◆ ~VectorView()

◆ VectorView() [4/7]

◆ VectorView() [5/7]

◆ VectorView() [6/7]

◆ VectorView() [7/7]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ get_c_array() [1/2]

◆ get_c_array() [2/2]

◆ operator MatrixView()

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

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

Friends And Related Function Documentation

◆ ComplexVectorView

◆ ConstIterator2D

◆ Iterator2D

◆ MatrixView

◆ Tensor3View

◆ Tensor4View

◆ Tensor5View

◆ Tensor6View

◆ Tensor7View