PndCAArray< T, Dim > Class Template Reference

#include <PndCAArray.h>

Inheritance diagram for PndCAArray< T, Dim >:

Public Types
typedef PndCAInternal::ArrayBase< T, Dim >	Parent

Public Member Functions
int	Size () const
	operator bool () const
bool	IsValid () const
T &	operator* ()
const T &	operator* () const
T *	Data ()
const T *	Data () const
PndCAArray	operator+ (int x) const
PndCAArray	operator- (int x) const
template<typename Other >
PndCAArray< Other, Dim >	ReinterpretCast () const

Detailed Description

template<typename T, int Dim>
class PndCAArray< T, Dim >

C-Array like class with the dimension dependent behavior defined in the ArrayBase class

Definition at line 73 of file PndCAArray.h.

Member Typedef Documentation

template<typename T, int Dim>

typedef PndCAInternal::ArrayBase<T, Dim> PndCAArray< T, Dim >::Parent

Definition at line 368 of file PndCAArray.h.

Member Function Documentation

template<typename T, int Dim>

T* PndCAArray< T, Dim >::Data ( )

inline

returns a pointer to the data This circumvents bounds checking so it should not be used.

Definition at line 398 of file PndCAArray.h.

{ return Parent::fData; }

template<typename T, int Dim>

const T* PndCAArray< T, Dim >::Data ( ) const

inline

returns a const pointer to the data This circumvents bounds checking so it should not be used.

Definition at line 403 of file PndCAArray.h.

{ return Parent::fData; }

template<typename T, int Dim>

bool PndCAArray< T, Dim >::IsValid ( ) const

inline

allows you to check for validity of the array

Definition at line 383 of file PndCAArray.h.

{ return Parent::fData != 0; }

template<typename T, int Dim>

PndCAArray< T, Dim >::operator bool ( ) const

inline

allows you to check for validity of the array by casting to bool

Definition at line 379 of file PndCAArray.h.

{ return Parent::fData != 0; }

template<typename T, int Dim>

T& PndCAArray< T, Dim >::operator* ( )

inline

returns a reference to the data at index 0

Definition at line 388 of file PndCAArray.h.

{ BOUNDS_CHECK( 0, Parent::fData[0] ); return *Parent::fData; }

template<typename T, int Dim>

const T& PndCAArray< T, Dim >::operator* ( ) const

inline

returns a const reference to the data at index 0

Definition at line 392 of file PndCAArray.h.

{ BOUNDS_CHECK( 0, Parent::fData[0] ); return *Parent::fData; }

template<typename T , int Dim>

PndCAArray< T, Dim > PndCAArray< T, Dim >::operator+ ( int  x ) const

inline

moves the array base pointer so that the data that was once at index 0 will then be at index -x

Definition at line 654 of file PndCAArray.h.

References r, and x.

{
  PndCAArray<T, Dim> r( *this );
  r.fData += x;
  r.MoveBounds( -x );
  return r;
}

template<typename T , int Dim>

PndCAArray< T, Dim > PndCAArray< T, Dim >::operator- ( int  x ) const

inline

moves the array base pointer so that the data that was once at index 0 will then be at index x

Definition at line 662 of file PndCAArray.h.

References r, and x.

{
  PndCAArray<T, Dim> r( *this );
  r.fData -= x;
  r.MoveBounds( x );
  return r;
}

template<typename T, int Dim>

template<typename Other >

PndCAArray<Other, Dim> PndCAArray< T, Dim >::ReinterpretCast ( ) const

inline

Definition at line 414 of file PndCAArray.h.

Referenced by PndCAArray< PndCAInternal::TypeForAlignmentHelper< T, alignment >::Type, Size::Dim >::ReinterpretCast().

                                                                                   {
      PndCAArray<Other, Dim> r;
      r.fData = reinterpret_cast<Other *>( Parent::fData );
      r.ReinterpretCast( *this, sizeof( T ), sizeof( Other ) );
    }

template<typename T, int Dim>

int PndCAArray< T, Dim >::Size ( ) const

inline

Returns the number of elements in the array. If it is a multi-dimensional array the size is the multiplication of the dimensions ( e.g. a 10 x 20 array returns 200 as its size ).

Definition at line 374 of file PndCAArray.h.

{ return Parent::fSize; }

---

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

• PndCAArray.h