ArrayND< T > Class Template Reference

An ArrayND is an array with a given number of dimensions and a size. More...

#include <arraynd.h>

Inherited by Array1D< TT >, Array1D< float >, Array1D< float_complex >, Array1D< char >, Array2D< float >, Array2D< TT >, Array2D< bool >, Array2D< fT >, Array2D< Attrib::DataHolder * >, Array2D< const Attrib::DataHolder * >, Array2D< int >, Array2D< od_int64 >, Array2D< char >, Array2D< Coord3 >, Array2D< unsigned char >, Array2D< unsigned int >, Array2D< double >, Array2D< SeisTrc * >, Array2D< float_complex >, Array2D< visBase::HorizonSectionTile * >, Array3D< float >, Array3D< TT >, Array3D< bool >, Array3D< int >, Array3D< double >, Array3D< unsigned char >, Array3D< float_complex >, Array4D< TT >, ArrayNDImpl< float >, Array1D< T >, Array2D< T >, Array3D< T >, Array4D< T >, and ArrayNDImpl< T >.

Public Member Functions
virtual	~ArrayND ()
virtual bool	canChangeNrDims () const
virtual bool	canSetInfo () const
virtual bool	canSetStorage () const
virtual T *	get1D (const int *)
virtual const T *	get1D (const int *) const
virtual int	get1DDim () const
virtual void	getAll (T *ptr) const
virtual void	getAll (ValueSeries< T > &vs) const
T *	getData ()
const T *	getData () const
virtual T	getND (const int *) const =0
int	getSize (int dim) const
ValueSeries< T > *	getStorage ()
const ValueSeries< T > *	getStorage () const
virtual const ArrayNDInfo &	info () const =0
virtual bool	isEmpty () const
virtual bool	isOK () const
virtual bool	isSettable () const
int	nrDims () const
virtual void	setAll (T)
virtual void	setData (const T *)
virtual void	setEmpty ()
virtual bool	setInfo (const ArrayNDInfo &)
virtual void	setND (const int *, T)=0
virtual bool	setStorage (ValueSeries< T > *s)
od_uint64	totalSize () const
bool	validPos (int *pos) const

Protected Member Functions
virtual const T *	getData_ () const
virtual const ValueSeries< T > *	getStorage_ () const

Detailed Description

template<class T>
class ArrayND< T >

An ArrayND is an array with a given number of dimensions and a size.

The ArrayND can be accessed via set() and get().

The ArrayND can give away a pointer to its storage, but there is no guarantee that it will. If no pointer is given, the user can copy the ArrayND by constructing an ArrayNDImpl with the original array as an argument to the constructor.

<>

Constructor & Destructor Documentation

~ArrayND()

template<class T >

virtual ArrayND< T >::~ArrayND ( )

inlinevirtual

Member Function Documentation

canChangeNrDims()

template<class T >

virtual bool ArrayND< T >::canChangeNrDims ( ) const

inlinevirtual

Reimplemented in ArrayNDImpl< T >, and ArrayNDImpl< float >.

canSetInfo()

template<class T >

virtual bool ArrayND< T >::canSetInfo ( ) const

inlinevirtual

Reimplemented in Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, and ArrayNDImpl< float >.

canSetStorage()

template<class T >

virtual bool ArrayND< T >::canSetStorage ( ) const

inlinevirtual

Reimplemented in Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, and ArrayNDImpl< float >.

get1D() [1/2]

template<class T >

T * ArrayND< T >::get1D ( const int * i )

inlinevirtual

get1D() [2/2]

template<class T >

const T * ArrayND< T >::get1D ( const int * i ) const

inlinevirtual

get1DDim()

template<class T >

int ArrayND< T >::get1DDim ( ) const

inlinevirtual

getAll() [1/2]

template<class T >

void ArrayND< T >::getAll ( T * ptr ) const

inlinevirtual

Fills ptr with values from array. ptr is assumed to be allocated with info().getTotalSz() number of values.

getAll() [2/2]

template<class T >

void ArrayND< T >::getAll ( ValueSeries< T > & vs ) const

inlinevirtual

Fills vs with values from array. ptr is assumed to be allocated with info().getTotalSz() number of values.

getData() [1/2]

template<class T >

T * ArrayND< T >::getData ( )

inline

getData() [2/2]

template<class T >

const T * ArrayND< T >::getData ( ) const

inline

getData_()

template<class T >

virtual const T * ArrayND< T >::getData_ ( ) const

inlineprotectedvirtual

Reimplemented in Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, ArrayNDImpl< float >, and SeisTrcBufArray2D.

getND()

template<class T >

virtual T ArrayND< T >::getND ( const int * ) const

pure virtual

Implemented in ArrayNDImpl< T >, ArrayNDImpl< float >, Array1D< T >, Array1D< char >, Array1D< float >, Array1D< float_complex >, Array1D< TT >, Array2D< T >, Array2D< Attrib::DataHolder * >, Array2D< bool >, Array2D< char >, Array2D< const Attrib::DataHolder * >, Array2D< Coord3 >, Array2D< double >, Array2D< float >, Array2D< float_complex >, Array2D< fT >, Array2D< int >, Array2D< od_int64 >, Array2D< SeisTrc * >, Array2D< TT >, Array2D< unsigned char >, Array2D< unsigned int >, Array2D< visBase::HorizonSectionTile * >, Array3D< T >, Array3D< bool >, Array3D< double >, Array3D< float >, Array3D< float_complex >, Array3D< int >, Array3D< TT >, Array3D< unsigned char >, Array4D< T >, and Array4D< TT >.

getSize()

template<class T >

int ArrayND< T >::getSize ( int dim ) const

inline

getStorage() [1/2]

template<class T >

ValueSeries< T > * ArrayND< T >::getStorage ( )

inline

getStorage() [2/2]

template<class T >

const ValueSeries< T > * ArrayND< T >::getStorage ( ) const

inline

getStorage_()

template<class T >

virtual const ValueSeries< T > * ArrayND< T >::getStorage_ ( ) const

inlineprotectedvirtual

Reimplemented in Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, ArrayNDImpl< float >, Array1DSlice< T >, Array2DSlice< T >, and Array3DSlice< T >.

info()

template<class T >

virtual const ArrayNDInfo & ArrayND< T >::info ( ) const

pure virtual

Implemented in Attrib::DataHolderArray, Array1DConv< T, TT >, Array2DConv< T, TT >, Array3DConv< T, TT >, Array4DConv< T, TT >, Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, ArrayNDImpl< float >, Array1DSlice< T >, Array2DSlice< T >, Array3DSlice< T >, Array3DWrapper< T >, Array2DSubSelection< T >, Array3DSubSelection< T >, BIDValSetArrAdapter, SeisTrcBufArray2D, Array1D< T >, Array1D< char >, Array1D< float >, Array1D< float_complex >, Array1D< TT >, Array2D< T >, Array2D< Attrib::DataHolder * >, Array2D< bool >, Array2D< char >, Array2D< const Attrib::DataHolder * >, Array2D< Coord3 >, Array2D< double >, Array2D< float >, Array2D< float_complex >, Array2D< fT >, Array2D< int >, Array2D< od_int64 >, Array2D< SeisTrc * >, Array2D< TT >, Array2D< unsigned char >, Array2D< unsigned int >, Array2D< visBase::HorizonSectionTile * >, Array3D< T >, Array3D< bool >, Array3D< double >, Array3D< float >, Array3D< float_complex >, Array3D< int >, Array3D< TT >, Array3D< unsigned char >, Array4D< T >, and Array4D< TT >.

isEmpty()

template<class T >

bool ArrayND< T >::isEmpty ( ) const

inlinevirtual

isOK()

template<class T >

bool ArrayND< T >::isOK ( ) const

inlinevirtual

Reimplemented in Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, ArrayNDImpl< float >, Array3DWrapper< T >, Array2DSubSelection< T >, Array3DSubSelection< T >, and SeisTrcBufArray2D.

isSettable()

template<class T >

virtual bool ArrayND< T >::isSettable ( ) const

inlinevirtual

Reimplemented in Array1DSlice< T >, Array2DSlice< T >, and Array3DSlice< T >.

nrDims()

template<class T >

int ArrayND< T >::nrDims ( ) const

inline

setAll()

template<class T >

void ArrayND< T >::setAll ( T val )

inlinevirtual

Reimplemented in Array1D< T >.

setData()

template<class T >

void ArrayND< T >::setData ( const T * ptr )

inlinevirtual

setEmpty()

template<class T >

virtual void ArrayND< T >::setEmpty ( )

inlinevirtual

Reimplemented in Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, and ArrayNDImpl< float >.

setInfo()

template<class T >

virtual bool ArrayND< T >::setInfo ( const ArrayNDInfo & )

inlinevirtual

Reimplemented in Array1DImpl< T >, Array1DImpl< float >, Array1DImpl< float_complex >, Array2DImpl< T >, Array2DImpl< Attrib::DataHolder * >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< visBase::HorizonSectionTile * >, Array3DImpl< T >, Array3DImpl< bool >, Array3DImpl< float >, Array3DImpl< float_complex >, Array4DImpl< T >, ArrayNDImpl< T >, and ArrayNDImpl< float >.

setND()

template<class T >

virtual void ArrayND< T >::setND ( const int * , T  )

pure virtual

Implemented in ArrayNDImpl< float >, ArrayNDImpl< T >, Array1D< T >, Array2D< T >, Array3D< T >, and Array4D< T >.

setStorage()

template<class T >

virtual bool ArrayND< T >::setStorage ( ValueSeries< T > * s )

inlinevirtual

becomes mine. The size must be settable, or I return false.

Reimplemented in Array2DImpl< Attrib::DataHolder * >, Array3DImpl< bool >, Array2DImpl< const Attrib::DataHolder * >, Array2DImpl< double >, Array2DImpl< float >, Array3DImpl< float >, Array3DImpl< float_complex >, Array2DImpl< fT >, Array2DImpl< int >, Array2DImpl< T >, Array3DImpl< T >, Array4DImpl< T >, Array1DImpl< T >, ArrayNDImpl< T >, and Array2DImpl< visBase::HorizonSectionTile * >.

totalSize()

template<class T >

od_uint64 ArrayND< T >::totalSize ( ) const

inline

validPos()

template<class T >

bool ArrayND< T >::validPos ( int * pos ) const

inline