Contains protable wrappers around cmath functions and some cuda specific functions. More...

Functions
Square root and inverse square root.
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	sqrt (float const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	sqrt (T const x)

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	invSqrt (float const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	invSqrt (T const x)

Trigonometric functions
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	sin (float const theta)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	sin (T const theta)

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	cos (float const theta)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	cos (T const theta)

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE void	sincos (float const theta, float &sinTheta, float &cosTheta)
	Compute the sine and cosine of `theta`. More...

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE void	sincos (double const theta, double &sinTheta, double &cosTheta)
	Compute the sine and cosine of `theta`. More...

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE void	sincos (T const theta, double &sinTheta, double &cosTheta)
	Compute the sine and cosine of `theta`. More...

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	tan (float const theta)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	tan (T const theta)

Inverse trigonometric functions
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	asin (float const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	asin (T const x)

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	acos (float const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	acos (T const x)

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	atan2 (float const y, float const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	atan2 (T const y, T const x)

Exponential functions
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	exp (float const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	exp (T const x)

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float	log (float const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double	log (T const x)

General purpose functions
template<typename T >
using	SingleType = typename internal::SingleType< T >::type
	The type of a single value of type `T`. More...

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr int	numValues ()
	Return the number of values stored in type. More...

template<typename T , typename U >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T	convert (U const u)
	Convert `u` to type. More...

template<typename T , typename U , typename V >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T	convert (U const u, V const v)
	Convert `u` and `v` to a dual type. More...

template<typename T >
LVARRAY_DEVICE LVARRAY_FORCE_INLINE SingleType< T >	getFirst (T const x)

template<typename T >
LVARRAY_DEVICE LVARRAY_FORCE_INLINE SingleType< T >	getSecond (T const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr std::enable_if_t< std::is_arithmetic< T >::value, T >	max (T const a, T const b)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr std::enable_if_t< std::is_arithmetic< T >::value, T >	min (T const a, T const b)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T	abs (T const x)

template<typename T >
LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T	square (T const x)

Detailed Description

Contains protable wrappers around cmath functions and some cuda specific functions.

Typedef Documentation

◆ SingleType

template<typename T >

using LvArray::math::SingleType = typedef typename internal::SingleType< T >::type

The type of a single value of type T.

Template Parameters

T	The type to query.

Function Documentation

◆ abs()

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T LvArray::math::abs ( T const x )

Returns: The absolute value of x.

Parameters

x	The number to get the absolute value of.

Note: This set of overloads is valid for any numeric type.

◆ acos() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::acos ( float const x )

Returns: The arccosine of the value x.

Parameters

x	The value to get the arccosine of, must be in [-1, 1].

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ acos() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::acos ( T const x )

Returns: The arccosine of the value x.

Parameters

x	The value to get the arccosine of, must be in [-1, 1].

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ asin() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::asin ( float const x )

Returns: The arcsine of the value x.

Parameters

x	The value to get the arcsine of, must be in [-1, 1].

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ asin() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::asin ( T const x )

Returns: The arcsine of the value x.

Parameters

x	The value to get the arcsine of, must be in [-1, 1].

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ atan2() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::atan2	(	float const	y,
		float const	x
	)

Returns: The angle corresponding to the point (x, y).

Parameters

y	The y coordinate.
x	The x coordinate.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ atan2() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::atan2	(	T const	y,
		T const	x
	)

Returns: The angle corresponding to the point (x, y).

Parameters

y	The y coordinate.
x	The x coordinate.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ convert() [1/2]

template<typename T , typename U >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T LvArray::math::convert ( U const u )

Convert u to type.

Template Parameters

T.
T	The type to convert to.
U	The type to convert from.

Parameters

u	The value to convert.

Note: No checking is done to ensure the conversion is safe. Ie you could convert -1 to uint.

Returns: u converted to

Template Parameters

T.

◆ convert() [2/2]

template<typename T , typename U , typename V >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T LvArray::math::convert	(	U const	u,
		V const	v
	)

Convert u and v to a dual type.

Template Parameters

T.
T	The type to convert to, must hold two values such as __half2.
U	The first type to convert from.
U	The second type to convert from.

Parameters

u	The first value to convert.
v	The second value to convert.

Note: No checking is done to ensure the conversion is safe. Ie you could convert -1 to uint.

Returns: u, v converted to

Template Parameters

T.

◆ cos() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::cos ( float const theta )

Returns: The cosine of theta.

Parameters

theta The angle in radians.

Note: This set of overloads is valid for any numeric type. If theta is not a float it is converted to a double and the return type is double.

◆ cos() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::cos ( T const theta )

Returns: The cosine of theta.

Parameters

theta The angle in radians.

Note: This set of overloads is valid for any numeric type. If theta is not a float it is converted to a double and the return type is double.

◆ exp() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::exp ( float const x )

Returns: e raised to the x.

Parameters

x	The power to raise e to.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ exp() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::exp ( T const x )

Returns: e raised to the x.

Parameters

x	The power to raise e to.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ getFirst()

template<typename T >

LVARRAY_DEVICE LVARRAY_FORCE_INLINE SingleType< T > LvArray::math::getFirst ( T const x )

Returns: The fist value in x.

Template Parameters

T	The type of `x`.

Parameters

x	The value to query.

Note: If
numValues< T >() == 1
then x is returned.

◆ getSecond()

template<typename T >

LVARRAY_DEVICE LVARRAY_FORCE_INLINE SingleType< T > LvArray::math::getSecond ( T const x )

Returns: The second value in x.

Template Parameters

T	The type of `x`.

Parameters

x	The value to query.

Note: If
numValues< T >() == 1
then x is returned.

◆ invSqrt() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::invSqrt ( float const x )

Returns: One over the square root of x.

Parameters

x	The number to get the inverse square root of.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ invSqrt() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::invSqrt ( T const x )

Returns: One over the square root of x.

Parameters

x	The number to get the inverse square root of.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ log() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::log ( float const x )

Returns: The natural logarithm of x.

Parameters

x	The number to get the natural logarithm of.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ log() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::log ( T const x )

Returns: The natural logarithm of x.

Parameters

x	The number to get the natural logarithm of.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ max()

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr std::enable_if_t< std::is_arithmetic< T >::value, T > LvArray::math::max	(	T const	a,
		T const	b
	)

Returns: Return the maximum of the numbers a and b.

Template Parameters

T	A numeric type.

Parameters

a	The first number.
b	The second number.

◆ min()

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr std::enable_if_t< std::is_arithmetic< T >::value, T > LvArray::math::min	(	T const	a,
		T const	b
	)

Returns: Return the minimum of the numbers a and b.

Template Parameters

T	A numeric type.

Parameters

a	The first number.
b	The second number.

◆ numValues()

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr int LvArray::math::numValues ( )

Return the number of values stored in type.

Template Parameters

T.

Parameters

T	The type to query.

Returns: The number of values stored in type

Template Parameters

T.

◆ sin() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::sin ( float const theta )

Returns: The sine of theta.

Parameters

theta The angle in radians.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ sin() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::sin ( T const theta )

Returns: The sine of theta.

Parameters

theta The angle in radians.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ sincos() [1/3]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE void LvArray::math::sincos	(	float const	theta,
		float &	sinTheta,
		float &	cosTheta
	)

Compute the sine and cosine of theta.

Parameters

theta	The angle in radians.
sinTheta	The sine of `theta`.
cosTheta	The cosine of `theta`.

◆ sincos() [2/3]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE void LvArray::math::sincos	(	double const	theta,
		double &	sinTheta,
		double &	cosTheta
	)

Compute the sine and cosine of theta.

Parameters

theta	The angle in radians.
sinTheta	The sine of `theta`.
cosTheta	The cosine of `theta`.

◆ sincos() [3/3]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE void LvArray::math::sincos	(	T const	theta,
		double &	sinTheta,
		double &	cosTheta
	)

Compute the sine and cosine of theta.

Parameters

theta	The angle in radians.
sinTheta	The sine of `theta`.
cosTheta	The cosine of `theta`.

◆ sqrt() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::sqrt ( float const x )

Returns: The square root of x.

Parameters

x	The number to get the square root of.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ sqrt() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::sqrt ( T const x )

Returns: The square root of x.

Parameters

x	The number to get the square root of.

Note: This set of overloads is valid for any numeric type. If x is integral it is converted to double and the return type is double.

◆ square()

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE constexpr T LvArray::math::square ( T const x )

Returns: x * x
.

Template Parameters

T	The typeof `x`.

Parameters

x	The value to square.

◆ tan() [1/2]

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE float LvArray::math::tan ( float const theta )

Returns: The tangent of theta.

Parameters

theta The angle in radians.

Note: This set of overloads is valid for any numeric type. If theta is not a float it is converted to a double and the return type is double.

◆ tan() [2/2]

template<typename T >

LVARRAY_HOST_DEVICE LVARRAY_FORCE_INLINE double LvArray::math::tan ( T const theta )

Returns: The tangent of theta.

Parameters

theta The angle in radians.

Note: This set of overloads is valid for any numeric type. If theta is not a float it is converted to a double and the return type is double.

Functions

General purpose functions

Detailed Description

Typedef Documentation

◆ SingleType

Function Documentation

◆ abs()

◆ acos() [1/2]

◆ acos() [2/2]

◆ asin() [1/2]

◆ asin() [2/2]

◆ atan2() [1/2]

◆ atan2() [2/2]

◆ convert() [1/2]

◆ convert() [2/2]

◆ cos() [1/2]

◆ cos() [2/2]

◆ exp() [1/2]

◆ exp() [2/2]

◆ getFirst()

◆ getSecond()

◆ invSqrt() [1/2]

◆ invSqrt() [2/2]

◆ log() [1/2]

◆ log() [2/2]

◆ max()

◆ min()

◆ numValues()

◆ sin() [1/2]

◆ sin() [2/2]

◆ sincos() [1/3]

◆ sincos() [2/3]

◆ sincos() [3/3]

◆ sqrt() [1/2]

◆ sqrt() [2/2]

◆ square()

◆ tan() [1/2]

◆ tan() [2/2]