NRLib::Grid< A > Class Template Reference

#include <grid.hpp>

Inheritance diagram for NRLib::Grid< A >:

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
	Grid ()
	Grid (size_t ni, size_t nj, size_t nk, const A &val=A())
virtual	~Grid ()
void	Resize (size_t ni, size_t nj, size_t nk, const A &val=A())
void	GetAvgMinMax (A &avg, A &min, A &max)
void	GetAvgMinMaxWithMissing (A &avg, A &min, A &max, A missing)
void	LogTransform (A missing)
reference	operator() (size_t i, size_t j, size_t k)
reference	operator() (size_t index)
reference	GetValue (size_t i, size_t j, size_t k)
const_reference	operator() (size_t i, size_t j, size_t k) const
const_reference	operator() (size_t index) const
const_reference	GetValue (size_t i, size_t j, size_t k) const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
size_t	GetNI () const
size_t	GetNJ () const
size_t	GetNK () const
size_t	GetN () const
size_t	GetIndex (size_t i, size_t j, size_t k) const
void	GetIJK (size_t index, size_t &i, size_t &j, size_t &k) const
void	SetValue (size_t i, size_t j, size_t k, const A &value)
void	Swap (Grid< A > &other)

Member Typedef Documentation

const_iterator

template<class A >

typedef std::vector<A>::const_iterator NRLib::Grid< A >::const_iterator

const_reference

template<class A >

typedef std::vector<A>::const_reference NRLib::Grid< A >::const_reference

iterator

template<class A >

typedef std::vector<A>::iterator NRLib::Grid< A >::iterator

reference

template<class A >

typedef std::vector<A>::reference NRLib::Grid< A >::reference

Constructor & Destructor Documentation

Grid() [1/2]

template<class A >

NRLib::Grid< A >::Grid

Grid() [2/2]

template<class A >

NRLib::Grid< A >::Grid	(	size_t	ni,
		size_t	nj,
		size_t	nk,
		const A &	val = A()
	)

Parameters

val	Initial cell value.

~Grid()

template<class A >

NRLib::Grid< A >::~Grid

virtual

Member Function Documentation

begin() [1/2]

template<class A >

iterator NRLib::Grid< A >::begin ( )

inline

begin() [2/2]

template<class A >

const_iterator NRLib::Grid< A >::begin ( ) const

inline

end() [1/2]

template<class A >

iterator NRLib::Grid< A >::end ( )

inline

end() [2/2]

template<class A >

const_iterator NRLib::Grid< A >::end ( ) const

inline

GetAvgMinMax()

template<class A >

void NRLib::Grid< A >::GetAvgMinMax	(	A &	avg,
		A &	min,
		A &	max
	)

References exprtk::details::numeric::max(), exprtk::details::numeric::min(), and exprtk::details::value().

GetAvgMinMaxWithMissing()

template<class A >

void NRLib::Grid< A >::GetAvgMinMaxWithMissing	(	A &	avg,
		A &	min,
		A &	max,
		A	missing
	)

References exprtk::details::numeric::max(), exprtk::details::numeric::min(), and exprtk::details::value().

GetIJK()

template<class A >

void NRLib::Grid< A >::GetIJK	(	size_t	index,
		size_t &	i,
		size_t &	j,
		size_t &	k
	)		const

References index.

GetIndex()

template<class A >

size_t NRLib::Grid< A >::GetIndex ( size_t  i, size_t  j, size_t  k  ) const

inline

GetN()

template<class A >

size_t NRLib::Grid< A >::GetN ( ) const

inline

GetNI()

template<class A >

size_t NRLib::Grid< A >::GetNI ( ) const

inline

GetNJ()

template<class A >

size_t NRLib::Grid< A >::GetNJ ( ) const

inline

GetNK()

template<class A >

size_t NRLib::Grid< A >::GetNK ( ) const

inline

GetValue() [1/2]

template<class A >

Grid< A >::reference NRLib::Grid< A >::GetValue ( size_t  i, size_t  j, size_t  k  )

inline

GetValue() [2/2]

template<class A >

Grid< A >::const_reference NRLib::Grid< A >::GetValue ( size_t  i, size_t  j, size_t  k  ) const

inline

LogTransform()

template<class A >

void NRLib::Grid< A >::LogTransform

(

A

missing

)

References exprtk::details::value().

operator()() [1/4]

template<class A >

Grid< A >::reference NRLib::Grid< A >::operator() ( size_t  i, size_t  j, size_t  k  )

inline

operator()() [2/4]

template<class A >

Grid< A >::const_reference NRLib::Grid< A >::operator() ( size_t  i, size_t  j, size_t  k  ) const

inline

operator()() [3/4]

template<class A >

Grid< A >::reference NRLib::Grid< A >::operator() ( size_t  index )

inline

References index.

operator()() [4/4]

template<class A >

Grid< A >::const_reference NRLib::Grid< A >::operator() ( size_t  index ) const

inline

References index.

Resize()

template<class A >

void NRLib::Grid< A >::Resize	(	size_t	ni,
		size_t	nj,
		size_t	nk,
		const A &	val = A()
	)

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

Parameters

val	Initial cell value.

SetValue()

template<class A >

void NRLib::Grid< A >::SetValue	(	size_t	i,
		size_t	j,
		size_t	k,
		const A &	value
	)

References exprtk::details::value().

Swap()

template<class A >

void NRLib::Grid< A >::Swap

(

NRLib::Grid< A > &

other

)

---

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

• grid.hpp