array_utility3 Namespace Reference

Namespace that provides various utility functions. More...

Functions
template<class T >
bool	empty (const array3< T > &array)
	Get if a grid is empty. More...
template<class T >
bool	has_different_values (const array3< T > &array)
	Get if a grid constain different values. More...
template<class T >
bool	has_value_not (const array3< T > &array, const T &v)
	Get if a grid constain a value that is different from an input value. More...
template<class T >
bool	value_exist (const array3< T > &array)
	Get if a grid constain a value that is different from the background value. More...
template<class T >
bool	levelset_exist (const array3< T > &levelset)
	Get if a level set grid constain both negative and positive values. More...

Detailed Description

Namespace that provides various utility functions.

Function Documentation

empty()

template<class T >

bool array_utility3::empty

(

const array3< T > &

array

)

Get if a grid is empty.

Parameters

[in]

array

Array to examine.

Returns

\true if the grid is empty. false otherwise.

has_different_values()

template<class T >

bool array_utility3::has_different_values

(

const array3< T > &

array

)

Get if a grid constain different values.

Parameters

[in]

array

Array to examine.

Returns

\true if the grid has different values. false otherwise.

has_value_not()

template<class T >

bool array_utility3::has_value_not	(	const array3< T > &	array,
		const T &	v
	)

Get if a grid constain a value that is different from an input value.

Parameters

[in]	array	Array to examine.
[in]	v	Input value.

Returns

\true if the grid has different values other than the input of v. false otherwise.

levelset_exist()

template<class T >

bool array_utility3::levelset_exist

(

const array3< T > &

levelset

)

Get if a level set grid constain both negative and positive values.

Parameters

[in]

array

Level set grid to examine.

Returns

\true if the grid has both negative and positive values. false otherwise.

value_exist()

template<class T >

bool array_utility3::value_exist

(

const array3< T > &

array

)

Get if a grid constain a value that is different from the background value.

Parameters

[in]

array

Array to examine.

Returns

\true if the grid has value that is different from the background value. false otherwise.