Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Real » ClampDouble

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: fil
Module: FoundationLite

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

Syntax

void fil::ClampDouble
(
	const double inValue,
	const double inMinimum,
	const double inMaximum,
	double& outClampedValue
)

Parameters

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

Errors

List of possible exceptions:

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