QDP++
QDP::Array3dO< T > Class Template Reference

3d array, with 1-based indices More...

#include <qdp_arrays.h>

Public Member Functions

 Array3dO ()
 Array3dO (int n)
 Array3dO (int n3, int n2, int n1)
 ~Array3dO ()
 Array3dO (const Array3dO &s)
 Copy constructor.
void resize (int n3, int n2, int n1)
void resize (int n)
int size () const
int size1 () const
int size2 () const
int size3 () const
int leftSize () const
 Another variant on the size of the 3d array.
int middleSize () const
int rightSize () const
Array3dOoperator= (const Array3dO &s)
template<typename T1>
Array3dO< T > & operator= (const T1 &s1)
 Equal operator uses underlying = of T.
T & operator() (int i, int j, int k)
 Return ref to an element.
const T & operator() (int i, int j, int k) const
 Return const ref to an element.
const multi3d< T > & ref () const
 Return ref to underlying array.
multi3d< T > & ref ()
 Return ref to underlying array.

Detailed Description

template<typename T>
class QDP::Array3dO< T >

3d array, with 1-based indices

Definition at line 110 of file qdp_arrays.h.

Constructor & Destructor Documentation

◆ Array3dO() [1/4]

template<typename T>
QDP::Array3dO< T >::Array3dO ( )
inline

Definition at line 113 of file qdp_arrays.h.

Referenced by Array3dO(), operator=(), and operator=().

◆ Array3dO() [2/4]

template<typename T>
QDP::Array3dO< T >::Array3dO ( int n)
inlineexplicit

Definition at line 114 of file qdp_arrays.h.

◆ Array3dO() [3/4]

template<typename T>
QDP::Array3dO< T >::Array3dO ( int n3,
int n2,
int n1 )
inlineexplicit

Definition at line 115 of file qdp_arrays.h.

◆ ~Array3dO()

template<typename T>
QDP::Array3dO< T >::~Array3dO ( )
inline

Definition at line 116 of file qdp_arrays.h.

◆ Array3dO() [4/4]

template<typename T>
QDP::Array3dO< T >::Array3dO ( const Array3dO< T > & s)
inline

Copy constructor.

Definition at line 119 of file qdp_arrays.h.

References Array3dO().

Member Function Documentation

◆ leftSize()

template<typename T>
int QDP::Array3dO< T >::leftSize ( ) const
inline

Another variant on the size of the 3d array.

Definition at line 129 of file qdp_arrays.h.

◆ middleSize()

template<typename T>
int QDP::Array3dO< T >::middleSize ( ) const
inline

Definition at line 130 of file qdp_arrays.h.

◆ operator()() [1/2]

template<typename T>
T & QDP::Array3dO< T >::operator() ( int i,
int j,
int k )
inline

Return ref to an element.

Definition at line 140 of file qdp_arrays.h.

◆ operator()() [2/2]

template<typename T>
const T & QDP::Array3dO< T >::operator() ( int i,
int j,
int k ) const
inline

Return const ref to an element.

Definition at line 143 of file qdp_arrays.h.

◆ operator=() [1/2]

template<typename T>
Array3dO & QDP::Array3dO< T >::operator= ( const Array3dO< T > & s)
inline

Definition at line 133 of file qdp_arrays.h.

References Array3dO().

◆ operator=() [2/2]

template<typename T>
template<typename T1>
Array3dO< T > & QDP::Array3dO< T >::operator= ( const T1 & s1)
inline

Equal operator uses underlying = of T.

Definition at line 137 of file qdp_arrays.h.

References Array3dO().

◆ ref() [1/2]

template<typename T>
multi3d< T > & QDP::Array3dO< T >::ref ( )
inline

Return ref to underlying array.

Definition at line 149 of file qdp_arrays.h.

◆ ref() [2/2]

template<typename T>
const multi3d< T > & QDP::Array3dO< T >::ref ( ) const
inline

Return ref to underlying array.

Definition at line 146 of file qdp_arrays.h.

◆ resize() [1/2]

template<typename T>
void QDP::Array3dO< T >::resize ( int n)
inline

Definition at line 122 of file qdp_arrays.h.

◆ resize() [2/2]

template<typename T>
void QDP::Array3dO< T >::resize ( int n3,
int n2,
int n1 )
inline

Definition at line 121 of file qdp_arrays.h.

◆ rightSize()

template<typename T>
int QDP::Array3dO< T >::rightSize ( ) const
inline

Definition at line 131 of file qdp_arrays.h.

◆ size()

template<typename T>
int QDP::Array3dO< T >::size ( ) const
inline

Definition at line 123 of file qdp_arrays.h.

◆ size1()

template<typename T>
int QDP::Array3dO< T >::size1 ( ) const
inline

Definition at line 124 of file qdp_arrays.h.

◆ size2()

template<typename T>
int QDP::Array3dO< T >::size2 ( ) const
inline

Definition at line 125 of file qdp_arrays.h.

◆ size3()

template<typename T>
int QDP::Array3dO< T >::size3 ( ) const
inline

Definition at line 126 of file qdp_arrays.h.


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