Clip

Advanced Analysis Library Only

AnalysisLibErrType Clip (double inputArray[], int numberOfElements, double upperLimit, double lowerLimit, double outputArray[]);

Purpose

Clips each element of the array between the specified upper and lower limits.

Clip obtains the element of the resulting array using the following formula:

If upperLimit is less than lowerLimit, Clip returns an error code. This operation can be performed in place; that is, the input and output arrays can be the same.

Parameters

Input
Name Type Description
inputArray double-precision array Input array whose values are clipped.
numberOfElements integer Number of elements in to clip.
upperLimit double-precision Upper limit for the clipping operation. Array elements greater than this value are set equal to this value.

Default Value: 1.0.
lowerLimit double-precision Lower limit for the clipping operation. Array elements less than this value are set equal to this value.

Default Value: 0.0.
Output
Name Type Description
outputArray double-precision array Clipped array.

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.