Namespaces
	filesystem

	string

Classes
class	LexiComparator
	Compares std::vector< T > in lexicographic order. More...

class	Timer
	A simple Timer class to measure execution time. More...

Functions
void	processAbort ()
	Gracefully aborts the application. More...

template<typename T >
AXOM_HOST_DEVICE T	abs (const T &x)
	Returns the absolute value of x. More...

template<typename T >
AXOM_HOST_DEVICE const T &	max (const T &x, const T &y)
	Returns the max value of x and y. More...

template<typename T >
AXOM_HOST_DEVICE const T &	min (const T &x, const T &y)
	Returns the min value of x and y. More...

template<typename T >
AXOM_HOST_DEVICE void	swap (T &a, T &b)
	Swaps the values of a, b. More...

template<typename T >
T	log2 (T &val)
	Returns the base 2 logarithm of the input. More...

template<typename T >
AXOM_HOST_DEVICE T	clampVal (T val, T lower, T upper)
	Clamps an input value to a given range. More...

template<typename T >
AXOM_HOST_DEVICE T	clampUpper (T val, T upper)
	Clamps the upper range on an input value. More...

template<typename T >
AXOM_HOST_DEVICE T	clampLower (T val, T lower)
	Clamps the lower range on an input value. More...

template<typename T >
T	random_real (const T &a, const T &b)
	Returns a random real number within the specified interval. More...

template<typename T >
T	random_real (const T &a, const T &b, unsigned int seed)
	Returns a random real number within the specified interval given the bounds of the interval and a seed value for the underlying random number generator. More...

bool	isLittleEndian ()
	Tests the endianness of the system. More...

template<typename T >
T	swapEndian (T val)
	Swaps the endianness of the input value. More...

template<typename RealType >
AXOM_HOST_DEVICE bool	isNearlyEqual (RealType a, RealType b, RealType thresh=1.0e-8)
	Fuzzy comparison of two real valued quantities. More...

template<typename RealType >
AXOM_HOST_DEVICE bool	isNearlyEqualRelative (RealType a, RealType b, RealType relThresh=1.0e-6, RealType absThresh=1.0e-8)
	Fuzzy comparison of two real valued quantities. More...

Function Documentation

◆ processAbort()

void axom::utilities::processAbort ( )

Gracefully aborts the application.

Referenced by axom::Array< double >::dynamicRealloc(), and axom::Array< double >::setCapacity().

◆ abs()

template<typename T >

AXOM_HOST_DEVICE T axom::utilities::abs ( const T & x )

inline

Returns the absolute value of x.

Parameters

[in] x value whose absolute value is computed.

Returns: abs(x) the absolute value of x.

Referenced by axom::primal::abs(), isNearlyEqual(), isNearlyEqualRelative(), axom::numerics::jacobi_eigensolve(), axom::numerics::lu_decompose(), axom::primal::Triangle< T, NDIMS >::physToBarycentric(), and axom::primal::Tetrahedron< T, NDIMS >::volume().

◆ max()

template<typename T >

AXOM_HOST_DEVICE const T& axom::utilities::max	(	const T &	x,
		const T &	y
	)

inline

Returns the max value of x and y.

Parameters

[in]	x	the first value to check.
[in]	y	the second value to check.

Returns: max(x, y) the max value of x and y.

Referenced by axom::mint::bind_basis(), axom::primal::OrientedBoundingBox< T, NDIMS >::bisect(), axom::slam::BitSet::BitSet(), axom::primal::NumericArray< IndexType, NDIMS >::clampLower(), axom::primal::BoundingBox< double, DIM >::clear(), axom::quest::SignedDistance< NDIMS >::computeDistance(), axom::spin::BVHTree< T, NDIMS >::contains(), axom::spin::BVHTree< T, NDIMS >::empty(), axom::spin::BVHTree< T, NDIMS >::find(), axom::primal::BoundingBox< double, DIM >::getLongestDimension(), axom::primal::BoundingBox< double, DIM >::getPoints(), axom::spin::BVH< NDIMS, ExecSpace, FloatType >::getTolerance(), axom::spin::ImplicitGrid< NDIMS, TheIndexType >::initialize(), axom::spin::BroodRepresentationTraits< CoordType, DIM, BroodDataType, RepresentationType >::initializeMap(), axom::spin::BroodRepresentationTraits< CoordType, DIM, BroodDataType, primal::Point< CoordType, DIM > >::initializeMap(), axom::primal::BoundingBox< double, DIM >::intersect(), isNearlyEqualRelative(), and axom::primal::NumericArray< IndexType, NDIMS >::size().

◆ min()

template<typename T >

AXOM_HOST_DEVICE const T& axom::utilities::min	(	const T &	x,
		const T &	y
	)

inline

Returns the min value of x and y.

Parameters

[in]	x	the first value to check.
[in]	y	the second value to check.

Returns: min(x, y) the min value of x and y.

Referenced by axom::mint::bind_basis(), axom::primal::NumericArray< IndexType, NDIMS >::clampUpper(), axom::quest::SignedDistance< NDIMS >::computeDistance(), axom::spin::BVHTree< T, NDIMS >::contains(), axom::spin::BVHTree< T, NDIMS >::empty(), axom::spin::BVHTree< T, NDIMS >::find(), axom::spin::SpatialOctree< DIM, InOutBlockData >::findGridCellAtLevel(), axom::primal::BoundingBox< double, DIM >::getLongestDimension(), axom::primal::BoundingBox< double, DIM >::getPoints(), axom::spin::BVH< NDIMS, ExecSpace, FloatType >::getTolerance(), axom::primal::BoundingBox< double, DIM >::intersect(), axom::utilities::LexiComparator< T >::operator()(), and axom::primal::NumericArray< IndexType, NDIMS >::size().

◆ swap()

template<typename T >

AXOM_HOST_DEVICE void axom::utilities::swap	(	T &	a,
		T &	b
	)

inline

Swaps the values of a, b.

Parameters

[in,out]	a	1st object to swap.
[in,out]	b	2nd object to swap.

Referenced by axom::primal::clip(), axom::numerics::eigen_sort(), axom::numerics::lu_solve(), axom::primal::BoundingBox< double, DIM >::shift(), and axom::numerics::Matrix< T >::swapRows().

◆ log2()

template<typename T >

T axom::utilities::log2 ( T & val )

inline

Returns the base 2 logarithm of the input.

Parameters

[in] val The input value

◆ clampVal()

template<typename T >

AXOM_HOST_DEVICE T axom::utilities::clampVal	(	T	val,
		T	lower,
		T	upper
	)

inline

Clamps an input value to a given range.

Parameters

[in]	val	The value to clamp.
[in]	lower	The lower range.
[in]	upper	The upper range.

Returns: The clamped value.

Precondition: lower <= upper

Postcondition: lower <= returned value <= upper.

Referenced by axom::primal::NumericArray< IndexType, NDIMS >::clamp(), axom::spin::UniformGrid< T, NDIMS >::insert(), and axom::primal::NumericArray< IndexType, NDIMS >::NumericArray().

◆ clampUpper()

template<typename T >

AXOM_HOST_DEVICE T axom::utilities::clampUpper	(	T	val,
		T	upper
	)

inline

Clamps the upper range on an input value.

Parameters

[in]	val	The value to clamp
[in]	upper	The upper range

Returns: upper if val > upper, else val

Postcondition: returned value is less than or equal to upper

Referenced by axom::spin::ImplicitGrid< NDIMS, TheIndexType >::contains(), axom::spin::ImplicitGrid< NDIMS, TheIndexType >::getCandidates(), axom::spin::ImplicitGrid< NDIMS, TheIndexType >::insert(), and axom::primal::NumericArray< IndexType, NDIMS >::size().

◆ clampLower()

template<typename T >

AXOM_HOST_DEVICE T axom::utilities::clampLower	(	T	val,
		T	lower
	)

inline

Clamps the lower range on an input value.

Parameters

[in]	val	The value to clamp
[in]	lower	The lower range

Returns: lower if val < lower, else val

Postcondition: returned value is greater than or equal to lower

Referenced by axom::spin::ImplicitGrid< NDIMS, TheIndexType >::contains(), axom::spin::ImplicitGrid< NDIMS, TheIndexType >::insert(), and axom::primal::NumericArray< IndexType, NDIMS >::size().

◆ random_real() [1/2]

template<typename T >

T axom::utilities::random_real	(	const T &	a,
		const T &	b
	)

inline

Returns a random real number within the specified interval.

Parameters

[in]	a	the interval's lower bound
[in]	b	the interval's upper bound

Returns: r the random real number within the specified interval.

Template Parameters

T	a built-in floating point type, e.g., double, float, long double.

Note: Consecutive calls to this method will generate a non-deterministic sequence of numbers.

Precondition: a < b

Postcondition: a <= r < b

References AXOM_STATIC_ASSERT.

◆ random_real() [2/2]

template<typename T >

T axom::utilities::random_real	(	const T &	a,
		const T &	b,
		unsigned int	seed
	)

inline

Returns a random real number within the specified interval given the bounds of the interval and a seed value for the underlying random number generator.

Parameters

[in]	a	the interval's lower bound
[in]	b	the interval's upper bound
[in]	seed	user-supplied seed for the random number generator

Returns: r the random real number within the specified interval.

Template Parameters

T	a built-in floating type, e.g., double, float, long double.

Note: Consecutive calls to this method will generate a deterministic sequence of numbers.

Precondition: a < b

Postcondition: a <= r < b

References AXOM_STATIC_ASSERT.

◆ isLittleEndian()

bool axom::utilities::isLittleEndian ( )

inline

Tests the endianness of the system.

Returns: True, if the system is little endian, false otherwise.

◆ swapEndian()

template<typename T >

T axom::utilities::swapEndian ( T val )

Swaps the endianness of the input value.

Parameters

[in] val The input value.

Returns: The value with endianness swapped.

Note: Assumes endianness is either little or big (not PDP).

Precondition: T is a native arithmetic type (i.e. integral or floating point).; sizeof(T) must be 2, 4, or 8 bytes.

References AXOM_STATIC_ASSERT_MSG.

◆ isNearlyEqual()

template<typename RealType >

AXOM_HOST_DEVICE bool axom::utilities::isNearlyEqual	(	RealType	a,
		RealType	b,
		RealType	thresh = `1.0e-8`
	)

inline

Fuzzy comparison of two real valued quantities.

Parameters

[in]	a	The first real valued quantities we are comparing.
[in]	b	The second real valued quantities we are comparing.
[in]	thresh	The threshold of the fuzzy comparison. Default is 1.0e-8.

Returns: True if the absolute value of the difference is less than thresh and false otherwise.

References abs().

Referenced by axom::primal::Triangle< T, NDIMS >::baryToPhysical(), axom::primal::Triangle< T, NDIMS >::checkInTriangle(), axom::quest::SignedDistance< NDIMS >::computeDistance(), axom::primal::Tetrahedron< T, NDIMS >::degenerate(), axom::primal::Triangle< T, NDIMS >::degenerate(), axom::primal::Sphere< T, NDIMS >::getOrientation(), axom::primal::Plane< T, NDIMS >::getOrientation(), axom::primal::Sphere< T, NDIMS >::intersectsWith(), axom::numerics::jacobi_eigensolve(), axom::numerics::linear_solve(), axom::numerics::lu_decompose(), axom::primal::orientation(), axom::primal::Tetrahedron< T, NDIMS >::physToBarycentric(), axom::primal::Triangle< T, NDIMS >::physToBarycentric(), axom::primal::Plane< T, NDIMS >::Plane(), and axom::spin::RectangularLattice< NDIMS, double, int >::print().

◆ isNearlyEqualRelative()

template<typename RealType >

AXOM_HOST_DEVICE bool axom::utilities::isNearlyEqualRelative	(	RealType	a,
		RealType	b,
		RealType	relThresh = `1.0e-6`,
		RealType	absThresh = `1.0e-8`
	)

inline

Fuzzy comparison of two real valued quantities.

Parameters

[in]	a	The first real valued quantities we are comparing.
[in]	b	The second real valued quantities we are comparing.
[in]	relThresh	The relative threshold of the fuzzy comparison. Default is 1.0e-6.
[in]	absThresh	The absolute threshold of the fuzzy comparison. Default is 1.0e-8.

Returns: True if the absolute value of the difference is less than the sum of absThresh and the relative difference (relThresh times the absolute max of a and b).

References abs(), and max().

Namespaces

Classes

Functions

Function Documentation

◆ processAbort()

◆ abs()

◆ max()

◆ min()

◆ swap()

◆ log2()

◆ clampVal()

◆ clampUpper()

◆ clampLower()

◆ random_real() [1/2]

◆ random_real() [2/2]

◆ isLittleEndian()

◆ swapEndian()

◆ isNearlyEqual()

◆ isNearlyEqualRelative()