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

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

Definition

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

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.