Saf::Math Namespace Reference

Mathematical functions and structures. More...

Namespaces
namespace	Algebra
	Implementations of various objects from algebra.
namespace	Calculus
	Calculus related functions and classes.
namespace	Constant
	Mathematical constants.
namespace	Range
	Mathematical algorithms and functions that execute on a range of elements.
Classes
class	ConvergenceException
	Numerical algorithm convergence failure exception. More...
Functions
template<class T >
T	Abs (T x)
	Calculate absolute value of a number.
template<class T >
T	IntegerDivCeil (T dividend, T divisor)
	Integer division rounded up.
template<class T >
T	Restrict (T x, T low, T high)
	Restrict the value of a number.
template<class T >
T	Round (T v)
	Round number.
template<class T >
Int8	Sgn (T val)
	Sign function.

---

Detailed Description

Mathematical functions and structures.

---

Function Documentation

template<class T >

T Saf::Math::Abs

(

T

x

)

[inline]

Calculate absolute value of a number.

template<class T >

T Saf::Math::IntegerDivCeil	(	T	dividend,
		T	divisor
	)		[inline]

Integer division rounded up.

template<class T >

T Saf::Math::Restrict	(	T	x,
		T	low,
		T	high
	)		[inline]

Restrict the value of a number.

Parameters:

[in]	x	Number.
[in]	low	Left interval boundary.
[in]	high	Right interval boundary.

Returns:

A number from the interval [low, high] closest to x.

template<class T >

T Saf::Math::Round

(

T

v

)

[inline]

Round number.

Remarks:

This method does nothing for integer numbers.

template<class T >

Int8 Saf::Math::Sgn

(

T

val

)

[inline]

Sign function.

Returns:

1 for positive numbers, -1 for negative and 0 for zero.