Matrix..::..Clip Method

Matrix Class See Also

Returns a matrix whose components are the components of a matrix constrained to be within the specified interval.

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 4.2.11333.0 (4.2.12253.0)

Syntax

C#
public static Matrix Clip( Matrix matrix, double lowerBound, double upperBound )

Visual Basic (Declaration)
Public Shared Function Clip ( _ matrix As Matrix, _ lowerBound As Double, _ upperBound As Double _ ) As Matrix

Visual C++
public: static Matrix^ Clip( Matrix^ matrix, double lowerBound, double upperBound )

F#
static member Clip : matrix:Matrix * lowerBound:float * upperBound:float -> Matrix

Parameters

matrix: Type: Extreme.Mathematics..::..Matrix
A Matrix.

lowerBound: Type: System..::..Double
The lower bound of the interval.

upperBound: Type: System..::..Double
The upper bound of the interval.

Return Value

A matrix whose components are the corresponding component of matrix constrained as follows: If the value is less than or equal to lowerBound, then lowerBound; otherwise, if the value is greater than or equal to upperBound, then upperBound; otherwise, the value is unchanged.

Exceptions

Exception	Condition
System..::..ArgumentNullException	matrix is nullNothingnullptra null reference (Nothing in Visual Basic).