Back to Aurora Vision Library Lite websiteYou are here:
Start »
All Functions »
Real »
ClampDouble
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::ClampDouble
(
const double inValue,
const double inMinimum,
const double inMaximum,
double& outClampedValue
)
Parameters
|
Name |
Type |
Default |
Description |
|
inValue |
const double |
|
|
|
inMinimum |
const double |
|
|
|
inMaximum |
const double |
|
|
|
outClampedValue |
double& |
|
|
Errors
List of possible exceptions:
Error type |
Description |
DomainError |
Invalid range (inMinimum > inMaximum) given in ClampDouble. |