ARTS  2.2.66
ConstTensor5View Class Reference

A constant view of a Tensor5. More...

#include <matpackV.h>

Inheritance diagram for ConstTensor5View:
Collaboration diagram for ConstTensor5View:

Public Member Functions

Index nshelves () const
 Returns the number of shelves. More...
 
Index nbooks () const
 Returns the number of books. 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...
 
ConstTensor5View operator() (const Range &s, const Range &b, const Range &p, const Range &r, const Range &c) const
 Const index operator for subrange. More...
 
ConstTensor4View operator() (const Range &s, const Range &b, const Range &p, const Range &r, Index c) const
 Const index operator returning an object of type ConstTensor4View. More...
 
ConstTensor4View operator() (const Range &s, const Range &b, const Range &p, Index r, const Range &c) const
 Const index operator returning an object of type ConstTensor4View. More...
 
ConstTensor4View operator() (const Range &s, const Range &b, Index p, const Range &r, const Range &c) const
 Const index operator returning an object of type ConstTensor4View. More...
 
ConstTensor4View operator() (const Range &s, Index b, const Range &p, const Range &r, const Range &c) const
 Const index operator returning an object of type ConstTensor4View. More...
 
ConstTensor4View operator() (Index s, const Range &b, const Range &p, const Range &r, const Range &c) const
 Const index operator returning an object of type ConstTensor4View. More...
 
ConstTensor3View operator() (const Range &s, const Range &b, const Range &p, Index r, Index c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (const Range &s, const Range &b, Index p, const Range &r, Index c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (const Range &s, const Range &b, Index p, Index r, const Range &c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (const Range &s, Index b, const Range &p, Index r, const Range &c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (const Range &s, Index b, const Range &p, const Range &r, Index c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (const Range &s, Index b, Index p, const Range &r, const Range &c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (Index s, const Range &b, Index p, const Range &r, const Range &c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (Index s, const Range &b, const Range &p, Index r, const Range &c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (Index s, const Range &b, const Range &p, const Range &r, Index c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstTensor3View operator() (Index s, Index b, const Range &p, const Range &r, const Range &c) const
 Const index operator returning an object of type ConstTensor3View. More...
 
ConstMatrixView operator() (const Range &s, const Range &b, Index p, Index r, Index c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (const Range &s, Index b, const Range &p, Index r, Index c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (const Range &s, Index b, Index p, const Range &r, Index c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (const Range &s, Index b, Index p, Index r, const Range &c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (Index s, const Range &b, Index p, Index r, const Range &c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (Index s, const Range &b, Index p, const Range &r, Index c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (Index s, const Range &b, const Range &p, Index r, Index c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (Index s, Index b, const Range &p, const Range &r, Index c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (Index s, Index b, const Range &p, Index r, const Range &c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstMatrixView operator() (Index s, Index b, Index p, const Range &r, const Range &c) const
 Const index operator returning an object of type ConstMatrixView. More...
 
ConstVectorView operator() (const Range &s, Index b, Index p, Index r, Index c) const
 Const index operator returning an object of type ConstVectorView. More...
 
ConstVectorView operator() (Index s, const Range &b, Index p, Index r, Index c) const
 Const index operator returning an object of type ConstVectorView. More...
 
ConstVectorView operator() (Index s, Index b, const Range &p, Index r, Index c) const
 Const index operator returning an object of type ConstVectorView. More...
 
ConstVectorView operator() (Index s, Index b, Index p, const Range &r, Index c) const
 Const index operator returning an object of type ConstVectorView. More...
 
ConstVectorView operator() (Index s, Index b, Index p, Index r, const Range &c) const
 Const index operator returning an object of type ConstVectorView. More...
 
Numeric operator() (Index s, Index b, Index p, Index r, Index c) const
 Plain const index operator. More...
 
Numeric get (Index s, Index b, Index p, Index r, Index c) const
 Get element implementation without assertions. More...
 
ConstIterator5D begin () const
 Return const iterator to first shelf. More...
 
ConstIterator5D end () const
 Return const iterator behind last shelf. More...
 
virtual ~ConstTensor5View ()
 Destructor. More...
 
 ConstTensor5View (const ConstTensor4View &a)
 Special constructor to make a Tensor5 view of a Tensor4. More...
 

Protected Member Functions

 ConstTensor5View ()
 Default constructor. More...
 
 ConstTensor5View (Numeric *data, const Range &s, const Range &b, const Range &p, const Range &r, const Range &c)
 Explicit constructor. More...
 
 ConstTensor5View (Numeric *data, const Range &ps, const Range &pb, const Range &pp, const Range &pr, const Range &pc, const Range &ns, const Range &nb, const Range &np, const Range &nr, const Range &nc)
 Recursive constructor. More...
 

Protected Attributes

Range msr
 The shelf range of mdata that is actually used. More...
 
Range mbr
 The book range of mdata that is actually used. More...
 
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...
 
Numericmdata
 Pointer to the plain C array that holds the data. More...
 

Friends

class Tensor5View
 
class ConstIterator6D
 
class ConstTensor6View
 
class ConstTensor7View
 

Detailed Description

A constant view of a Tensor5.

This, together with the derived class Tensor5View, contains the main implementation of a Tensor5. It defines the concepts of Tensor5View. Plus additionally the recursive subrange operator, which makes it possible to create a Tensor5View from a subrange of a Tensor5View.

The five dimensions of the tensor are called: shelf, book, page, row, column.

The class Tensor5 is just a special case of a Tensor5View which also allocates storage.

Definition at line 152 of file matpackV.h.

Constructor & Destructor Documentation

◆ ~ConstTensor5View()

virtual ConstTensor5View::~ConstTensor5View ( )
inlinevirtual

Destructor.

Definition at line 231 of file matpackV.h.

◆ ConstTensor5View() [1/4]

ConstTensor5View::ConstTensor5View ( const ConstTensor4View a)

Special constructor to make a Tensor5 view of a Tensor4.

Definition at line 809 of file matpackV.cc.

◆ ConstTensor5View() [2/4]

ConstTensor5View::ConstTensor5View ( )
protected

Default constructor.

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

Definition at line 826 of file matpackV.cc.

Referenced by operator()().

◆ ConstTensor5View() [3/4]

ConstTensor5View::ConstTensor5View ( Numeric data,
const Range sr,
const Range br,
const Range pr,
const Range rr,
const Range cr 
)
protected

Explicit constructor.

This one is used by Tensor5 to initialize its own Tensor5View part. The book range br must have a stride to account for the length of one book. The shelf range sr must have a stride to account for the length of one shelf.

Definition at line 841 of file matpackV.cc.

◆ ConstTensor5View() [4/4]

ConstTensor5View::ConstTensor5View ( Numeric data,
const Range ps,
const Range pb,
const Range pp,
const Range pr,
const Range pc,
const Range ns,
const Range nb,
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 864 of file matpackV.cc.

Member Function Documentation

◆ begin()

◆ end()

◆ get()

Numeric ConstTensor5View::get ( Index  s,
Index  b,
Index  p,
Index  r,
Index  c 
) const
inline

Get element implementation without assertions.

Definition at line 216 of file matpackV.h.

References Range::mstride.

Referenced by Tensor5View::get(), and interp().

◆ nbooks()

◆ ncols()

◆ npages()

◆ nrows()

◆ nshelves()

◆ operator()() [1/32]

ConstTensor5View ConstTensor5View::operator() ( const Range s,
const Range b,
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 Tensor5. This allows correct recursive behavior.

Definition at line 67 of file matpackV.cc.

References ConstTensor5View(), mbr, mcr, mdata, mpr, mrr, and msr.

Referenced by Tensor5View::operator()().

◆ operator()() [2/32]

ConstTensor4View ConstTensor5View::operator() ( const Range s,
const Range b,
const Range p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstTensor4View.

(Reducing the dimension by one.)

Definition at line 80 of file matpackV.cc.

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

◆ operator()() [3/32]

ConstTensor4View ConstTensor5View::operator() ( const Range s,
const Range b,
const Range p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstTensor4View.

(Reducing the dimension by one.)

Definition at line 98 of file matpackV.cc.

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

◆ operator()() [4/32]

ConstTensor4View ConstTensor5View::operator() ( const Range s,
const Range b,
Index  p,
const Range r,
const Range c 
) const

Const index operator returning an object of type ConstTensor4View.

(Reducing the dimension by one.)

Definition at line 116 of file matpackV.cc.

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

◆ operator()() [5/32]

ConstTensor4View ConstTensor5View::operator() ( const Range s,
Index  b,
const Range p,
const Range r,
const Range c 
) const

Const index operator returning an object of type ConstTensor4View.

(Reducing the dimension by one.)

Definition at line 134 of file matpackV.cc.

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

◆ operator()() [6/32]

ConstTensor4View ConstTensor5View::operator() ( Index  s,
const Range b,
const Range p,
const Range r,
const Range c 
) const

Const index operator returning an object of type ConstTensor4View.

(Reducing the dimension by one.)

Definition at line 152 of file matpackV.cc.

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

◆ operator()() [7/32]

ConstTensor3View ConstTensor5View::operator() ( const Range s,
const Range b,
const Range p,
Index  r,
Index  c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 170 of file matpackV.cc.

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

◆ operator()() [8/32]

ConstTensor3View ConstTensor5View::operator() ( const Range s,
const Range b,
Index  p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 191 of file matpackV.cc.

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

◆ operator()() [9/32]

ConstTensor3View ConstTensor5View::operator() ( const Range s,
const Range b,
Index  p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 212 of file matpackV.cc.

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

◆ operator()() [10/32]

ConstTensor3View ConstTensor5View::operator() ( const Range s,
Index  b,
const Range p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 233 of file matpackV.cc.

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

◆ operator()() [11/32]

ConstTensor3View ConstTensor5View::operator() ( const Range s,
Index  b,
const Range p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 254 of file matpackV.cc.

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

◆ operator()() [12/32]

ConstTensor3View ConstTensor5View::operator() ( const Range s,
Index  b,
Index  p,
const Range r,
const Range c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 275 of file matpackV.cc.

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

◆ operator()() [13/32]

ConstTensor3View ConstTensor5View::operator() ( Index  s,
const Range b,
Index  p,
const Range r,
const Range c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 296 of file matpackV.cc.

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

◆ operator()() [14/32]

ConstTensor3View ConstTensor5View::operator() ( Index  s,
const Range b,
const Range p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 317 of file matpackV.cc.

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

◆ operator()() [15/32]

ConstTensor3View ConstTensor5View::operator() ( Index  s,
const Range b,
const Range p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 338 of file matpackV.cc.

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

◆ operator()() [16/32]

ConstTensor3View ConstTensor5View::operator() ( Index  s,
Index  b,
const Range p,
const Range r,
const Range c 
) const

Const index operator returning an object of type ConstTensor3View.

(Reducing the dimension by two.)

Definition at line 359 of file matpackV.cc.

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

◆ operator()() [17/32]

ConstMatrixView ConstTensor5View::operator() ( const Range s,
const Range b,
Index  p,
Index  r,
Index  c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 380 of file matpackV.cc.

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

◆ operator()() [18/32]

ConstMatrixView ConstTensor5View::operator() ( const Range s,
Index  b,
const Range p,
Index  r,
Index  c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 404 of file matpackV.cc.

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

◆ operator()() [19/32]

ConstMatrixView ConstTensor5View::operator() ( const Range s,
Index  b,
Index  p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 428 of file matpackV.cc.

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

◆ operator()() [20/32]

ConstMatrixView ConstTensor5View::operator() ( const Range s,
Index  b,
Index  p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 452 of file matpackV.cc.

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

◆ operator()() [21/32]

ConstMatrixView ConstTensor5View::operator() ( Index  s,
const Range b,
Index  p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 476 of file matpackV.cc.

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

◆ operator()() [22/32]

ConstMatrixView ConstTensor5View::operator() ( Index  s,
const Range b,
Index  p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 500 of file matpackV.cc.

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

◆ operator()() [23/32]

ConstMatrixView ConstTensor5View::operator() ( Index  s,
const Range b,
const Range p,
Index  r,
Index  c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 524 of file matpackV.cc.

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

◆ operator()() [24/32]

ConstMatrixView ConstTensor5View::operator() ( Index  s,
Index  b,
const Range p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 548 of file matpackV.cc.

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

◆ operator()() [25/32]

ConstMatrixView ConstTensor5View::operator() ( Index  s,
Index  b,
const Range p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 572 of file matpackV.cc.

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

◆ operator()() [26/32]

ConstMatrixView ConstTensor5View::operator() ( Index  s,
Index  b,
Index  p,
const Range r,
const Range c 
) const

Const index operator returning an object of type ConstMatrixView.

(Reducing the dimension by three.)

Definition at line 596 of file matpackV.cc.

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

◆ operator()() [27/32]

ConstVectorView ConstTensor5View::operator() ( const Range s,
Index  b,
Index  p,
Index  r,
Index  c 
) const

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by four.)

Definition at line 620 of file matpackV.cc.

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

◆ operator()() [28/32]

ConstVectorView ConstTensor5View::operator() ( Index  s,
const Range b,
Index  p,
Index  r,
Index  c 
) const

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by four.)

Definition at line 647 of file matpackV.cc.

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

◆ operator()() [29/32]

ConstVectorView ConstTensor5View::operator() ( Index  s,
Index  b,
const Range p,
Index  r,
Index  c 
) const

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by four.)

Definition at line 674 of file matpackV.cc.

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

◆ operator()() [30/32]

ConstVectorView ConstTensor5View::operator() ( Index  s,
Index  b,
Index  p,
const Range r,
Index  c 
) const

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by four.)

Definition at line 701 of file matpackV.cc.

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

◆ operator()() [31/32]

ConstVectorView ConstTensor5View::operator() ( Index  s,
Index  b,
Index  p,
Index  r,
const Range c 
) const

Const index operator returning an object of type ConstVectorView.

(Reducing the dimension by four.)

Definition at line 728 of file matpackV.cc.

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

◆ operator()() [32/32]

Numeric ConstTensor5View::operator() ( Index  s,
Index  b,
Index  p,
Index  r,
Index  c 
) const
inline

Plain const index operator.

Definition at line 199 of file matpackV.h.

Friends And Related Function Documentation

◆ ConstIterator6D

friend class ConstIterator6D
friend

Definition at line 235 of file matpackV.h.

◆ ConstTensor6View

friend class ConstTensor6View
friend

Definition at line 236 of file matpackV.h.

◆ ConstTensor7View

friend class ConstTensor7View
friend

Definition at line 237 of file matpackV.h.

◆ Tensor5View

friend class Tensor5View
friend

Definition at line 234 of file matpackV.h.

Referenced by Tensor5View::operator()().

Member Data Documentation

◆ mbr

◆ mcr

◆ mdata

◆ mpr

◆ mrr

◆ msr


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