$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Mathematical Tools

Functions

template<typename T >
T mln::math::abs (const T &v)
template<unsigned n>
value::int_u< n > mln::math::abs (const value::int_u< n > &v)
template<typename T >
T mln::math::acos (const T &v)
template<typename T >
T mln::math::cos (const T &v)
template<typename T >
T mln::math::diff_abs (const T &v1, const T &v2)
algebra::quat mln::math::jacobi (algebra::mat< 4u, 4u, float > a)
template<typename T >
T mln::math::max (const T &v1, const T &v2)
template<typename T >
T mln::math::min (const T &v1, const T &v2)
template<typename R , typename T >
mln::math::round (const T &v)
template<typename R , typename T >
mln::math::round (const T &v, const R &return_type)
template<typename R , typename T >
mln::math::round_sat (const T &v)
template<typename R , typename T >
mln::math::round_sat (const T &v, const R &return_type)
template<typename T >
sign_t mln::math::sign (const T &v)
template<typename T >
T mln::math::sin (const T &v)
template<typename T >
T mln::math::sqr (const T &v)
template<typename T >
T mln::math::sqrt (const T &v)

Variables

const double mln::math::pi
int mln::math::abs (int v)
long mln::math::abs (long v)
float mln::math::abs (float v)
double mln::math::abs (double v)
long double mln::math::abs (long double v)

Detailed Description

All mathematical tools.

Function Documentation

template<typename T >
T mln::math::abs ( const T v)

Generic version.

int mln::math::abs ( int  v)

Specializations for existing overloads of std::abs.

   Reference:
     ISO/IEC 14882:2003 C++ standard, section 26.5
     (C Library, [lib.c.math]).
long mln::math::abs ( long  v)
float mln::math::abs ( float  v)
double mln::math::abs ( double  v)
long double mln::math::abs ( long double  v)
template<unsigned n>
value::int_u<n> mln::math::abs ( const value::int_u< n > &  v)

Specialization for mln::value::int_u.

template<typename T >
T mln::math::acos ( const T v)

The arc cosinus (acos) function.

template<typename T >
T mln::math::cos ( const T v)

The cosinus (cos) function.

template<typename T >
T mln::math::diff_abs ( const T v1,
const T v2 
)

Return the absolute difference between v1 and v2.

That is, compute $|v1 - v2|$.

algebra::quat mln::math::jacobi ( algebra::mat< 4u, 4u, float >  a)

Jacobi's method for matrix diagonalization.

template<typename T >
T mln::math::max ( const T v1,
const T v2 
)

Returns the maximum value.

template<typename T >
T mln::math::min ( const T v1,
const T v2 
)

Returns the minimum value.

template<typename R , typename T >
R mln::math::round ( const T v)

Round a given value.

Parameters
[in]vThe value to be rounded.
Returns
A round value of type
Template Parameters
R.
Warning
The return type
Template Parameters
mustbe passed as template parameter on function call.
template<typename R , typename T >
R mln::math::round ( const T v,
const R &  return_type 
)

Round a given value.

Parameters
[in]vThe value to be rounded.
[in]return_typeThe returned type to be used.
Returns
A round value of type
Template Parameters
R.
template<typename R , typename T >
R mln::math::round_sat ( const T v)

Round a given value considering its type as circular.

Parameters
[in]vThe value to be rounded.
Returns
A round value of type
Template Parameters
R.
Warning
The return type
Template Parameters
mustbe passed as template parameter on function call.
template<typename R , typename T >
R mln::math::round_sat ( const T v,
const R &  return_type 
)

Round a given value considering its type as circular.

Parameters
[in]vThe value to be rounded.
[in]return_typeThe returned type to be used.
Returns
A round value of type
Template Parameters
R.
template<typename T >
sign_t mln::math::sign ( const T v)

Return the sign of the given value.

template<typename T >
T mln::math::sin ( const T v)

The sinus (sin) function.

template<typename T >
T mln::math::sqr ( const T v)

The square function.

template<typename T >
T mln::math::sqrt ( const T v)

The square root (sqrt) function.

Variable Documentation

const double mln::math::pi

The Pi constant (20-decimal double constant).