Array2D< T > Struct Template Reference

#include <array_2D.h>

Public Member Functions
	Array2D ()
	Array2D (int xSize, int ySize)
	Array2D (const Array2D &other)
	Copy constructor. More...
	~Array2D ()
	Destructor. More...
void	allocateZeros (int xSize, int ySize)
	Allocate memory and initialized with zeros. More...
void	clear ()
	Clear memory. More...
Array2D &	operator= (const Array2D &other)
	Assignment. More...
T &	operator() (int x, int y) const
int	getXSize () const
	get Xsize More...
int	getYSize () const
	get Ysize More...
bool	inRange (int x, int y) const
	check if in range More...
bool	inRangeX (int x) const
	check x in range More...
bool	inRangeY (int y) const
	check Y in range More...
T *	getRow (int y) const
	get y-th row More...

Detailed Description

template<typename T>
struct Array2D< T >

struct is used for compatibility with OpenCL / C for Cuda Instance of this struct represent a 2D array of arbitrary type. Data are being stored as a dynamic 2D array (i.e. not continuous block of memory). Access to elements will be the fastest if traversing in Y -> X order.

Definition at line 38 of file array_2D.h.

Constructor & Destructor Documentation

Array2D() [1/3]

template<typename T>

Array2D< T >::Array2D ( )

inline

Empty constructor

Definition at line 41 of file array_2D.h.

: xSize(0), ySize(0), data(nullptr) {};

Array2D() [2/3]

template<typename T>

Array2D< T >::Array2D ( int  xSize, int  ySize  )

inline

Constructor, allocates the data immediately

Definition at line 44 of file array_2D.h.

                                  :
            xSize(xSize), ySize(ySize) {
        allocateZeros(xSize, ySize);
    }

Array2D() [3/3]

template<typename T>

Array2D< T >::Array2D ( const Array2D< T > &  other )

inline

Copy constructor.

Definition at line 50 of file array_2D.h.

                                  {
        *this=other;
    }

~Array2D()

template<typename T>

Array2D< T >::~Array2D ( )

inline

Destructor.

Definition at line 55 of file array_2D.h.

               {
        clear();
    }

Member Function Documentation

allocateZeros()

template<typename T>

void Array2D< T >::allocateZeros ( int  xSize, int  ySize  )

inline

Allocate memory and initialized with zeros.

Definition at line 60 of file array_2D.h.

    {
        data = new T*[ySize];
        for (int y = 0; y < ySize; y++)
            data[y] = new T[xSize]();
    #if DEBUG
        std::cout << "Array2D created (" << getXSize() << "x" << getYSize()
            << ") at " << data << std::endl;
    #endif
    }

clear()

template<typename T>

void Array2D< T >::clear ( )

inline

Clear memory.

Definition at line 72 of file array_2D.h.

    {
        for (int y = 0; y < ySize; y++) {
            delete[] data[y];
        }
        delete[] data;
    #if DEBUG
        std::cout << "Array2D deleted (" << getXSize() << "x" << getYSize()
            << ") at " << data << std::endl;
    #endif
        data = nullptr;
    }

getRow()

template<typename T>

T* Array2D< T >::getRow ( int  y ) const

inline

get y-th row

Definition at line 139 of file array_2D.h.

                           {
        return data[y];
    }

getXSize()

template<typename T>

int Array2D< T >::getXSize ( ) const

inline

get Xsize

Definition at line 114 of file array_2D.h.

                         {
        return xSize;
    }

getYSize()

template<typename T>

int Array2D< T >::getYSize ( ) const

inline

get Ysize

Definition at line 119 of file array_2D.h.

                         {
        return ySize;
    }

inRange()

template<typename T>

bool Array2D< T >::inRange ( int  x, int  y  ) const

inline

check if in range

Definition at line 124 of file array_2D.h.

                                     {
        return inRangeX(x) && inRangeY(y);
    }

inRangeX()

template<typename T>

bool Array2D< T >::inRangeX ( int  x ) const

inline

check x in range

Definition at line 129 of file array_2D.h.

                               {
        return (x >= 0) && (x < xSize);
    }

inRangeY()

template<typename T>

bool Array2D< T >::inRangeY ( int  y ) const

inline

check Y in range

Definition at line 134 of file array_2D.h.

                               {
        return (y >= 0) && (y < ySize);
    }

operator()()

template<typename T>

T& Array2D< T >::operator() ( int  x, int  y  ) const

inline

Method to access elements of the array

Definition at line 102 of file array_2D.h.

                                      {
    #if DEBUG
        if (0 > x || x >= xSize)
            std::cout << "Array2D " << data << " X=" << x << " out of range [0.." << getXSize() << ")\n";
        if (0 > y || y >= ySize)
            std::cout << "Array2D " << data << " Y=" << y << " out of range [0.." << getYSize() << ")\n";
        std::cout << std::flush;
    #endif
        return data[y][x];
    }

operator=()

template<typename T>

Array2D& Array2D< T >::operator= ( const Array2D< T > &  other )

inline

Assignment.

Definition at line 86 of file array_2D.h.

    {
        clear();
        xSize=other.xSize;
        ySize=other.ySize;

        data = new T*[ySize];
        for (int y = 0; y < ySize; y++) {
            data[y] = new T[xSize];
            memcpy(data[y],other.data[y],xSize*sizeof(T));
        }

        return *this;
    }

---

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

• xmipp/libraries/data/array_2D.h