Matrix.SubtractInto Method

Definition

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

Overload List

SubtractInto<T>(Matrix<T>, T, Matrix<T>)	Subtracts two matrices.
SubtractInto<T>(Matrix<T>, Matrix<T>, Matrix<T>)	Subtracts one matrix from another.
SubtractInto<T>(T, Matrix<T>, Matrix<T>)	Subtracts a matrix from a scalar.
SubtractInto<T>(Matrix<T>, Vector<T>, Dimension, Matrix<T>)	Subtracts a vector broadcast along the specified dimension from a matrix.

SubtractInto<T>(Matrix<T>, T, Matrix<T>)

Subtracts two matrices.

public static Matrix<T> SubtractInto<T>(
	Matrix<T> matrix,
	T value,
	Matrix<T>? result
)

Visual Basic

Public Shared Function SubtractInto(Of T) ( 
	matrix As Matrix(Of T),
	value As T,
	result As Matrix(Of T)
) As Matrix(Of T)

C++/CLI

public:
generic<typename T>
static Matrix<T>^ SubtractInto(
	Matrix<T>^ matrix, 
	T value, 
	Matrix<T>^ result
)

static member SubtractInto : 
        matrix : Matrix<'T> * 
        value : 'T * 
        result : Matrix<'T> -> Matrix<'T>

Parameters

matrix Matrix<T>: The matrix to subtract from.
value T: The value to subtract.
result Matrix<T>: The matrix that is to hold the result. May be null.

Type Parameters

T

Return Value

Matrix<T>
A matrix whose elements are equal to the corresponding element of matrix minus value.

Exceptions

ArgumentNullException

matrix is null.

-or-

result is null.

DimensionMismatchException

matrix and result do not have the same length.

SubtractInto<T>(Matrix<T>, Matrix<T>, Matrix<T>)

Subtracts one matrix from another.

public static Matrix<T> SubtractInto<T>(
	Matrix<T> left,
	Matrix<T> right,
	Matrix<T>? result
)

Visual Basic

Public Shared Function SubtractInto(Of T) ( 
	left As Matrix(Of T),
	right As Matrix(Of T),
	result As Matrix(Of T)
) As Matrix(Of T)

C++/CLI

public:
generic<typename T>
static Matrix<T>^ SubtractInto(
	Matrix<T>^ left, 
	Matrix<T>^ right, 
	Matrix<T>^ result
)

static member SubtractInto : 
        left : Matrix<'T> * 
        right : Matrix<'T> * 
        result : Matrix<'T> -> Matrix<'T>

Parameters

left Matrix<T>: The matrix to subtract from.
right Matrix<T>: The matrix to subtract.
result Matrix<T>: The matrix that is to hold the result. May be null.

Type Parameters

T

Return Value

Matrix<T>
A matrix whose elements are equal to the corresponding element of left minus the corresponding element of right.

Exceptions

ArgumentNullException

left is null.

-or-

right is null.

DimensionMismatchException

left and right do not have the same length.

SubtractInto<T>(T, Matrix<T>, Matrix<T>)

Subtracts a matrix from a scalar.

public static Matrix<T> SubtractInto<T>(
	T value,
	Matrix<T> matrix,
	Matrix<T>? result
)

Visual Basic

Public Shared Function SubtractInto(Of T) ( 
	value As T,
	matrix As Matrix(Of T),
	result As Matrix(Of T)
) As Matrix(Of T)

C++/CLI

public:
generic<typename T>
static Matrix<T>^ SubtractInto(
	T value, 
	Matrix<T>^ matrix, 
	Matrix<T>^ result
)

static member SubtractInto : 
        value : 'T * 
        matrix : Matrix<'T> * 
        result : Matrix<'T> -> Matrix<'T>

Parameters

value T: The value to subtract from.
matrix Matrix<T>: The matrix to subtract.
result Matrix<T>: The matrix that is to hold the result. May be null.

Type Parameters

T

Return Value

Matrix<T>
A matrix whose elements are equal to the corresponding element of value minus the corresponding element of matrix.

Exceptions

ArgumentNullException	matrix is null.
DimensionMismatchException	matrix and result do not have the same length.

SubtractInto<T>(Matrix<T>, Vector<T>, Dimension, Matrix<T>)

Subtracts a vector broadcast along the specified dimension from a matrix.

public static Matrix<T> SubtractInto<T>(
	Matrix<T> left,
	Vector<T> right,
	Dimension broadcastDimension,
	Matrix<T>? result
)

Visual Basic

Public Shared Function SubtractInto(Of T) ( 
	left As Matrix(Of T),
	right As Vector(Of T),
	broadcastDimension As Dimension,
	result As Matrix(Of T)
) As Matrix(Of T)

C++/CLI

public:
generic<typename T>
static Matrix<T>^ SubtractInto(
	Matrix<T>^ left, 
	Vector<T>^ right, 
	Dimension broadcastDimension, 
	Matrix<T>^ result
)

static member SubtractInto : 
        left : Matrix<'T> * 
        right : Vector<'T> * 
        broadcastDimension : Dimension * 
        result : Matrix<'T> -> Matrix<'T>

Parameters

left Matrix<T>: The matrix to subtract from.
right Vector<T>: The vector to broadcast and subtract.
broadcastDimension Dimension: A value that specifies whether the elements in right should be broadcast across rows or columns.
result Matrix<T>: The matrix that is to hold the result. May be null.

Type Parameters

T

Return Value

Matrix<T>
A matrix whose elements are equal to the corresponding element of left minus the corresponding element of right.

Exceptions

ArgumentNullException

left is null.

-or-

right is null.

DimensionMismatchException

left and right do not have the same length.

Matrix.SubtractInto Method

Definition

Overload List

SubtractInto<T>(Matrix<T>, T, Matrix<T>)

Parameters

Type Parameters

Return Value

Exceptions

SubtractInto<T>(Matrix<T>, Matrix<T>, Matrix<T>)

Parameters

Type Parameters

Return Value

Exceptions

SubtractInto<T>(T, Matrix<T>, Matrix<T>)

Parameters

Type Parameters

Return Value

Exceptions

SubtractInto<T>(Matrix<T>, Vector<T>, Dimension, Matrix<T>)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference