MAOS
Multithreaded Adaptive Optics Simulator
Loading...
Searching...
No Matches
Array< T, Dev > Class Template Reference
Inheritance diagram for Array< T, Dev >:
Collaboration diagram for Array< T, Dev >:

Public Types

typedef T type

Public Member Functions

 ~Array ()
T & operator() (int ix, int iy)
const T & operator() (int ix, int iy) const
T & R (int ix, int iy=0)
T * Col (int icol)
const T * Col (int icol) const
long Nx () const
long Ny () const
long N () const
 operator bool () const
void init (long nxi=0, long nyi=1)
 Array ()
 Array (long nxi, long nyi=1, T *pi=NULL, int own=1)
 Array (long nxi, long nyi, const Array &pi, long offset=0)
 Array (const Array &in)
Array & operator= (const Array &in)
Array Vector () const
void deinit ()
 operator T* ()
T * operator() ()
const T * operator() () const
T & operator() (int i)
const T & operator() (int i) const
int NRef () const

Data Fields

string keywords

Protected Attributes

long nx =0
long ny =0
T * p

Detailed Description

template<typename T, template< typename > class Dev = Cpu>
class Array< T, Dev >

Generic array of basic types and classes.

Does not defines operations that are different between Numerical and NumCell array.

Constructor & Destructor Documentation

◆ ~Array()

template<typename T, template< typename > class Dev = Cpu>
Array< T, Dev >::~Array ( )

Destructor. The data is released by RefP.

◆ Array() [1/4]

template<typename T, template< typename > class Dev = Cpu>
Array< T, Dev >::Array ( )

Create an empty array.

◆ Array() [2/4]

template<typename T, template< typename > class Dev = Cpu>
Array< T, Dev >::Array ( long nxi,
long nyi = 1,
T * pi = NULL,
int own = 1 )

Create an array.

Parameters
[in]nxiNumber of rows.
[in]nyiNumber of columns.
[in]piExisting memory to use. Allocated (zeroed) if NULL.
[in]ownWhether to free pi when the last reference is released.

◆ Array() [3/4]

template<typename T, template< typename > class Dev = Cpu>
Array< T, Dev >::Array ( long nxi,
long nyi,
const Array< T, Dev > & pi,
long offset = 0 )

Create a reference to part of an existing array with offset.

Parameters
[in]nxiNumber of rows.
[in]nyiNumber of columns.
[in]piArray to reference.
[in]offsetOffset in number of elements.

◆ Array() [4/4]

template<typename T, template< typename > class Dev = Cpu>
Array< T, Dev >::Array ( const Array< T, Dev > & in)

Create a reference to an existing array.

Parameters
[in]inArray to reference.

Member Function Documentation

◆ operator()() [1/6]

template<typename T, template< typename > class Dev = Cpu>
T & Array< T, Dev >::operator() ( int ix,
int iy )
Parameters
[in]ixRow index.
[in]iyColumn index.
Returns
Reference to element (ix, iy).

◆ operator()() [2/6]

template<typename T, template< typename > class Dev = Cpu>
const T & Array< T, Dev >::operator() ( int ix,
int iy ) const
Parameters
[in]ixRow index.
[in]iyColumn index.
Returns
Reference to element (ix, iy).

◆ R()

template<typename T, template< typename > class Dev = Cpu>
T & Array< T, Dev >::R ( int ix,
int iy = 0 )

Relaxed indexing: an index along a dimension of size 1 is ignored.

Parameters
[in]ixRow index.
[in]iyColumn index.
Returns
Reference to the element.

◆ Col() [1/2]

template<typename T, template< typename > class Dev = Cpu>
T * Array< T, Dev >::Col ( int icol)
Parameters
[in]icolColumn index.
Returns
Pointer to the start of column icol.

◆ Col() [2/2]

template<typename T, template< typename > class Dev = Cpu>
const T * Array< T, Dev >::Col ( int icol) const
Parameters
[in]icolColumn index.
Returns
Pointer to the start of column icol.

◆ Nx()

template<typename T, template< typename > class Dev = Cpu>
long Array< T, Dev >::Nx ( ) const
Returns
Number of rows.

◆ Ny()

template<typename T, template< typename > class Dev = Cpu>
long Array< T, Dev >::Ny ( ) const
Returns
Number of columns.

◆ N()

template<typename T, template< typename > class Dev = Cpu>
long Array< T, Dev >::N ( ) const
Returns
Total number of elements.

◆ operator bool()

template<typename T, template< typename > class Dev = Cpu>
Array< T, Dev >::operator bool ( ) const
explicit
Returns
Whether the array is not empty.

◆ init()

template<typename T, template< typename > class Dev = Cpu>
void Array< T, Dev >::init ( long nxi = 0,
long nyi = 1 )

Reallocate the array. Existing data of the same size is kept.

Parameters
[in]nxiNumber of rows.
[in]nyiNumber of columns.

◆ operator=()

template<typename T, template< typename > class Dev = Cpu>
Array & Array< T, Dev >::operator= ( const Array< T, Dev > & in)

Release the current data and reference in.

Parameters
[in]inArray to reference.
Returns
Reference to this.

◆ Vector()

template<typename T, template< typename > class Dev = Cpu>
Array Array< T, Dev >::Vector ( ) const
Returns
A reference to the same data reshaped as a column vector.

◆ deinit()

template<typename T, template< typename > class Dev = Cpu>
void RefP< T, Dev >::deinit ( )

Release the reference and free the memory if this is the last owner.

◆ operator T*()

template<typename T, template< typename > class Dev = Cpu>
RefP< T, Dev >::operator T* ( )
Returns
The data pointer.

◆ operator()() [3/6]

template<typename T, template< typename > class Dev = Cpu>
T * RefP< T, Dev >::operator() ( )
Returns
The data pointer.

◆ operator()() [4/6]

template<typename T, template< typename > class Dev = Cpu>
const T * RefP< T, Dev >::operator() ( ) const
Returns
The data pointer.

◆ operator()() [5/6]

template<typename T, template< typename > class Dev = Cpu>
T & RefP< T, Dev >::operator() ( int i)
Parameters
[in]iIndex.
Returns
Reference to the i-th element.

◆ operator()() [6/6]

template<typename T, template< typename > class Dev = Cpu>
const T & RefP< T, Dev >::operator() ( int i) const
Parameters
[in]iIndex.
Returns
Reference to the i-th element.

◆ NRef()

template<typename T, template< typename > class Dev = Cpu>
int RefP< T, Dev >::NRef ( ) const
Returns
Number of references, or 0 if the memory is not owned.

The documentation for this class was generated from the following file:
  • cuda/math/types.h