UAM built-in functions definitions

Built-in functions that can be invoked directly from UAM map files. More...

Functions
template<typename T >
eval_result_type< T >	ast::min_value (std::vector< eval_result_type< T > > &results)
	Find the min value of a set of expressions. More...
template<typename T >
eval_result_type< T >	ast::max_value (std::vector< eval_result_type< T > > &results)
	Find the max value of a set of expressions. More...
template<typename T >
eval_result_type< T >	ast::average_value (std::vector< eval_result_type< T > > &results)
	Find the average value of a set of expressions. More...
template<typename T >
eval_result_type< T >	ast::absolute_value (std::vector< eval_result_type< T > > &results)
	Find the absolute value of the first defined expression. More...
template<typename T >
eval_result_type< T >	ast::are_all_defined (std::vector< eval_result_type< T > > &results)
	Checks if all the expressions are defined (i.e. have a result) More...
template<typename T >
eval_result_type< T >	ast::is_any_defined (std::vector< eval_result_type< T > > &results)
	Checks if any of the expressions are defined (i.e. have a result) More...
template<typename T >
eval_result_type< T >	ast::are_all_undefined (std::vector< eval_result_type< T > > &results)
	Checks if all of the expressions are undefined (i.e. do not have a result) More...
template<typename T >
eval_result_type< T >	ast::is_any_undefined (std::vector< eval_result_type< T > > &results)
	Checks if any of the expressions are defined (i.e. have a result) More...
template<typename T >
eval_result_type< T >	ast::log10 (std::vector< eval_result_type< T > > &results)
	Computes the log10 of the first defined argument. More...

Detailed Description

Built-in functions that can be invoked directly from UAM map files.

This submodule provides a list of available functions in UAM synthax files.

Function Documentation

absolute_value()

template<typename T >

eval_result_type< T > ast::absolute_value

(

std::vector< eval_result_type< T > > &

results

)

Find the absolute value of the first defined expression.

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

The absolute value of the dirst defined expressions. Returns "undefined" value if all of the expression are undefined

are_all_defined()

template<typename T >

eval_result_type< T > ast::are_all_defined

(

std::vector< eval_result_type< T > > &

results

)

Checks if all the expressions are defined (i.e. have a result)

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

true if all expressions are defined (have a value)

false if any expressions is undefined (does not have a value)

are_all_undefined()

template<typename T >

eval_result_type< T > ast::are_all_undefined

(

std::vector< eval_result_type< T > > &

results

)

Checks if all of the expressions are undefined (i.e. do not have a result)

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

true if all expressions are defined (have a value)

false if any expressions is undefined (does not have a value)

average_value()

template<typename T >

eval_result_type< T > ast::average_value

(

std::vector< eval_result_type< T > > &

results

)

Find the average value of a set of expressions.

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

The average value of the list of expressions. Returns "undefined" value if any of the expression is undefined

is_any_defined()

template<typename T >

eval_result_type< T > ast::is_any_defined

(

std::vector< eval_result_type< T > > &

results

)

Checks if any of the expressions are defined (i.e. have a result)

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

true if all expressions are defined (have a value)

false if any expressions is undefined (does not have a value)

is_any_undefined()

template<typename T >

eval_result_type< T > ast::is_any_undefined

(

std::vector< eval_result_type< T > > &

results

)

Checks if any of the expressions are defined (i.e. have a result)

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

true if all expressions are defined (have a value)

false if any expressions is undefined (does not have a value)

log10()

template<typename T >

eval_result_type< T > ast::log10

(

std::vector< eval_result_type< T > > &

results

)

Computes the log10 of the first defined argument.

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

undefined value if if all expressions are undefined (do not have a value)

log10 value otherwise

max_value()

template<typename T >

eval_result_type< T > ast::max_value

(

std::vector< eval_result_type< T > > &

results

)

Find the max value of a set of expressions.

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

The maximum value of the list of expressions. Returns "undefined" value if any of the expression is undefined

min_value()

template<typename T >

eval_result_type< T > ast::min_value

(

std::vector< eval_result_type< T > > &

results

)

Find the min value of a set of expressions.

Template Parameters

T	Type of the result.

Parameters

results

Vector of expressions results.

Returns

The minimum value of the list of expressions. Returns "undefined" value if any of the expression is undefined