Classes | Functions
labust::math Namespace Reference

Classes

struct  Limit
struct  LimitIO
class  Line
struct  unwrap

Functions

template<class type , typename precission >
type coerce (type value, const Limit< precission > &limit)
template<class type >
type coerce (type value, double min, double max)
template<class Iterator >
double mean (const Iterator &first, const Iterator &last)
template<class Vector >
double mean (const Vector &vec)
template<class Vector >
double std2 (const Vector &vec)
template<class Vector >
double std2 (const Vector &vec, double mean)
double wrapDeg (double angle)
double wrapRad (double angle)

Function Documentation

template<class type , typename precission >
type labust::math::coerce ( type  value,
const Limit< precission > &  limit 
) [inline]

The function coerces a value into the [min,max] range based on the labust::math::Limit parameter.

Parameters:
valueThe arbitrary value.
limitThe range limit of the coerced value.
Returns:
The coerced value.

Definition at line 80 of file NumberManipulation.hpp.

template<class type >
type labust::math::coerce ( type  value,
double  min,
double  max 
) [inline]

The function coerces a value into the [min,max] range.

Parameters:
valueThe arbitrary value.
minThe coercion range minimum.
maxThe coercion range maximum.
Returns:
The coerced value.

Definition at line 95 of file NumberManipulation.hpp.

template<class Iterator >
double labust::math::mean ( const Iterator &  first,
const Iterator &  last 
) [inline]

The function calculates the vector mean over a range.

Parameters:
firstIterator to the first element.
lastIterator to the last element.
Template Parameters:
Templateused for polymorphism.

Definition at line 110 of file NumberManipulation.hpp.

template<class Vector >
double labust::math::mean ( const Vector &  vec) [inline]

The function calculates the vector mean over a range.

Parameters:
vecData vector.
Template Parameters:
Templateused for polymorphism.

Definition at line 125 of file NumberManipulation.hpp.

template<class Vector >
double labust::math::std2 ( const Vector &  vec) [inline]

The function calculates the vector deviation over a range.

Parameters:
vecData vector.
Template Parameters:
Templateused for polymorphism.

Definition at line 140 of file NumberManipulation.hpp.

template<class Vector >
double labust::math::std2 ( const Vector &  vec,
double  mean 
) [inline]

The function calculates the vector deviation over a range.

Parameters:
vecData vector.
meanMean value of the same data
Template Parameters:
Templateused for polymorphism.

Definition at line 158 of file NumberManipulation.hpp.

double labust::math::wrapDeg ( double  angle) [inline]

The function wraps any value into the [-180,180> range.

Parameters:
angleThe arbitrary value.
Returns:
The wrapped value in the [-pi,pi> interval.

Definition at line 65 of file NumberManipulation.hpp.

double labust::math::wrapRad ( double  angle) [inline]

The function wraps any value into the [-pi,pi> range.

Parameters:
angleThe arbitrary value.
Returns:
The wrapped value in the [-pi,pi> interval.

Definition at line 52 of file NumberManipulation.hpp.



snippets
Author(s): Gyula Nagy
autogenerated on Fri Aug 28 2015 11:22:33