sigma::detail_ Namespace Reference

The namespace that contains the implementation details of the library. More...

Classes
class	Setter
	Modifies an unceratin variable. More...

Functions
template<typename T>
void	inplace_unary (Uncertain< T > &c, T mean, T dcda)
	Generalized Inplace Unary Changes.
template<typename T>
Uncertain< T >	unary_result (const Uncertain< T > &a, T mean, T dcda)
	Generalized Unary Changes.
template<typename T>
void	inplace_binary (Uncertain< T > &c, const Uncertain< T > &b, T mean, T dcda, T dcdb)
	Generalized Inplace Binary Changes.
template<typename T>
Uncertain< T >	binary_result (const Uncertain< T > &a, const Uncertain< T > &b, T mean, T dcda, T dcdb)
	Generalized Binary Changes.
template<typename FunctionType, typename NumericType>
NumericType	numeric_derivative (FunctionType f, NumericType a)
	Compute the numeric derivative of a function.

Variables
constexpr double	pi = 3.14159265358979323846
	Value of Pi.

Detailed Description

The namespace that contains the implementation details of the library.

This is the namespace details not intended for user interaction.

Function Documentation

binary_result()

template<typename T>

Uncertain< T > sigma::detail_::binary_result	(	const Uncertain< T > &	a,
		const Uncertain< T > &	b,
		T	mean,
		T	dcda,
		T	dcdb )

Generalized Binary Changes.

Template Parameters

T	The value type of the variable

Parameters

a	The variable being altered copied
b	The variable whose dependencies are being added to a's
mean	The new mean value of the variable
dcda	The partial derivative being added to the chain from a
dcdb	The partial derivative being added to the chain from b

Returns

A variable with the new mean value and the dependencies of a and b, altered respectively by dcda and dcdb.

Exceptions

none	No throw guarantee

inplace_binary()

template<typename T>

void sigma::detail_::inplace_binary	(	Uncertain< T > &	c,
		const Uncertain< T > &	b,
		T	mean,
		T	dcda,
		T	dcdb )

Generalized Inplace Binary Changes.

Template Parameters

T	The value type of the variable

Parameters

c	The variable being altered
b	The variable whose dependencies are being added to c's
mean	The new mean value of the variable
dcda	The partial derivative being added to the chain from a
dcdb	The partial derivative being added to the chain from b

Exceptions

none	No throw guarantee

inplace_unary()

template<typename T>

void sigma::detail_::inplace_unary	(	Uncertain< T > &	c,
		T	mean,
		T	dcda )

Generalized Inplace Unary Changes.

Template Parameters

T	The value type of the variable

Parameters

c	The variable being altered
mean	The new mean value of the variable
dcda	The partial derivative being added to the chain

Exceptions

none	No throw guarantee

numeric_derivative()

template<typename FunctionType, typename NumericType>

NumericType sigma::detail_::numeric_derivative	(	FunctionType	f,
		NumericType	a )

Compute the numeric derivative of a function.

Template Parameters

FunctionType	The type of the function f
NumericType	The numeric type of a

Parameters

f	The function whose derivative is computed
a	The value aroud which the derivative of f is computed

Returns

The derivative of f evaluated at a.

Exceptions

none	No throw guarantee

unary_result()

template<typename T>

Uncertain< T > sigma::detail_::unary_result	(	const Uncertain< T > &	a,
		T	mean,
		T	dcda )

Generalized Unary Changes.

Template Parameters

T	The value type of the variable

Parameters

a	The variable being altered copied
mean	The new mean value of the variable
dcda	The partial derivative being added to the chain

Returns

A variable with the new mean value and the dependencies of a altered by dcda.

Exceptions

none	No throw guarantee