NRLib::Grid2D< A > Class Template Reference

#include <grid2d.hpp>

Inheritance diagram for NRLib::Grid2D< A >:
Inheritance graph

Public Types

typedef std::vector< A >::iterator iterator
 
typedef std::vector< A >::const_iterator const_iterator
 
typedef std::vector< A >::reference reference
 
typedef std::vector< A >::const_reference const_reference
 

Public Member Functions

 Grid2D ()
 
 Grid2D (size_t ni, size_t nj, const A &val=A())
 
virtual ~Grid2D ()
 
virtual void Resize (size_t ni, size_t nj, const A &val=A())
 
reference operator() (size_t i, size_t j)
 
reference operator() (size_t index)
 
const_reference operator() (size_t i, size_t j) const
 
const_reference operator() (size_t index) const
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
size_t GetNI () const
 
size_t GetNJ () const
 
size_t GetN () const
 
size_t GetIndex (size_t i, size_t j) const
 
void GetIJ (size_t index, size_t &i, size_t &j) const
 
bool IsValidIndex (int i, int j) const
 
void Swap (Grid2D< A > &other)
 
FindMin (A missingValue) const
 
FindMax (A missingValue) const
 

Member Typedef Documentation

◆ const_iterator

template<class A >
typedef std::vector<A>::const_iterator NRLib::Grid2D< A >::const_iterator

◆ const_reference

template<class A >
typedef std::vector<A>::const_reference NRLib::Grid2D< A >::const_reference

◆ iterator

template<class A >
typedef std::vector<A>::iterator NRLib::Grid2D< A >::iterator

◆ reference

template<class A >
typedef std::vector<A>::reference NRLib::Grid2D< A >::reference

Constructor & Destructor Documentation

◆ Grid2D() [1/2]

template<class A >
NRLib::Grid2D< A >::Grid2D

◆ Grid2D() [2/2]

template<class A >
NRLib::Grid2D< A >::Grid2D ( size_t  ni,
size_t  nj,
const A &  val = A() 
)
Parameters
valInitial cell value.

◆ ~Grid2D()

template<class A >
NRLib::Grid2D< A >::~Grid2D
virtual

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

template<class A >
const_iterator NRLib::Grid2D< A >::begin ( ) const
inline

◆ end() [1/2]

◆ end() [2/2]

template<class A >
const_iterator NRLib::Grid2D< A >::end ( ) const
inline

◆ FindMax()

template<class A >
A NRLib::Grid2D< A >::FindMax ( missingValue) const

References Catch::begin.

◆ FindMin()

template<class A >
A NRLib::Grid2D< A >::FindMin ( missingValue) const

References Catch::begin.

◆ GetIJ()

template<class A >
void NRLib::Grid2D< A >::GetIJ ( size_t  index,
size_t &  i,
size_t &  j 
) const

References index.

Referenced by NRLib::RegularSurface< A >::GetNode().

◆ GetIndex()

template<class A >
size_t NRLib::Grid2D< A >::GetIndex ( size_t  i,
size_t  j 
) const
inline

◆ GetN()

◆ GetNI()

◆ GetNJ()

◆ IsValidIndex()

template<class A >
bool NRLib::Grid2D< A >::IsValidIndex ( int  i,
int  j 
) const

◆ operator()() [1/4]

template<class A >
Grid2D< A >::reference NRLib::Grid2D< A >::operator() ( size_t  i,
size_t  j 
)
inline

◆ operator()() [2/4]

template<class A >
Grid2D< A >::const_reference NRLib::Grid2D< A >::operator() ( size_t  i,
size_t  j 
) const
inline

◆ operator()() [3/4]

template<class A >
Grid2D< A >::reference NRLib::Grid2D< A >::operator() ( size_t  index)
inline

References index.

◆ operator()() [4/4]

template<class A >
Grid2D< A >::const_reference NRLib::Grid2D< A >::operator() ( size_t  index) const
inline

References index.

◆ Resize()

template<class A >
void NRLib::Grid2D< A >::Resize ( size_t  ni,
size_t  nj,
const A &  val = A() 
)
virtual

All values in the grid are erased when the grid is resized.

Parameters
valInitial cell value.

Reimplemented in NRLib::RegularSurface< A >.

Referenced by NRLib::RegularSurface< A >::Resize().

◆ Swap()

template<class A >
void NRLib::Grid2D< A >::Swap ( NRLib::Grid2D< A > &  other)

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