Matrix.Max Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.0

Overload List

Max<T>(Matrix<T>, T) Returns a matrix whose elements are the maximum of the components of a matrix and a real number.
Max<T>(Matrix<T>, Matrix<T>) Returns a matrix whose elements are the maximums of the components of two vectors.
Max<T>(T, Matrix<T>) Returns a matrix whose elements are the maximum of the components of a matrix and a real number.

Max<T>(Matrix<T>, T)

Returns a matrix whose elements are the maximum of the components of a matrix and a real number.
C# 
public static Matrix<T> Max<T>(
	this Matrix<T> matrix,
	T value
)

Parameters

matrix  Matrix<T>
A Matrix<T>.
value  T
A real number.

Type Parameters

T

Return Value

Matrix<T>
A matrix whose elements are the largest of the corresponding element of matrix and value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Matrix<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException

matrix is null.

Max<T>(Matrix<T>, Matrix<T>)

Returns a matrix whose elements are the maximums of the components of two vectors.
C# 
public static Matrix<T> Max<T>(
	this Matrix<T> left,
	Matrix<T> right
)

Parameters

left  Matrix<T>
A Matrix<T>.
right  Matrix<T>
A Matrix<T>.

Type Parameters

T

Return Value

Matrix<T>
A matrix whose elements are the largest of the corresponding elements of left and right.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Matrix<T>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException

left is null.

-or-

right is null.

DimensionMismatchException

The length of left is not equal to the length of right.

Max<T>(T, Matrix<T>)

Returns a matrix whose elements are the maximum of the components of a matrix and a real number.
C# 
public static Matrix<T> Max<T>(
	T value,
	Matrix<T> matrix
)

Parameters

value  T
A real number.
matrix  Matrix<T>
A Matrix<T>.

Type Parameters

T

Return Value

Matrix<T>
A matrix whose elements are the largest of the corresponding element of matrix and value.

Exceptions

ArgumentNullException

matrix is null.

See Also