Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Real » ClampReal

ClampReal


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: avl

Returns a value as close as possible to inValue, but in the specified range.

Syntax

void avl::ClampReal
(
	const float inValue,
	const float inMinimum,
	const float inMaximum,
	float& outClampedValue
)

Parameters

Name Type Default Description
Input value
 inValue const float
Input value
 inMinimum const float
Input value
 inMaximum const float
Output value
 outClampedValue float&

Errors

List of possible exceptions:

Error type Description
DomainError Invalid range (inMinimum > inMaximum) given in ClampReal.