Vector.SubtractInto Method

Definition

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

Overload List

SubtractInto<T>(Vector<T>, T, Vector<T>) Subtracts two vectors.
SubtractInto<T>(Vector<T>, Vector<T>, Vector<T>) Subtracts one vector from another.
SubtractInto<T>(T, Vector<T>, Vector<T>) Subtracts a vector from a constant.

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

Subtracts two vectors.
C# 
public static Vector<T> SubtractInto<T>(
	this Vector<T> vector,
	T value,
	Vector<T>? result
)

Parameters

vector  Vector<T>
The vector to subtract from.
value  T
The value to subtract.
result  Vector<T>
The vector that is to hold the result. May be null.

Type Parameters

T

Return Value

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

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<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).

Remarks

If result is null, the operation chooses the result representation. Otherwise, result is overwritten, returned, and its representation is preserved. The result may alias vector.

Exceptions

ArgumentNullException

vector is null.

DimensionMismatchException

vector and result do not have the same length.

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

Subtracts one vector from another.
C# 
public static Vector<T> SubtractInto<T>(
	this Vector<T> left,
	Vector<T> right,
	Vector<T>? result
)

Parameters

left  Vector<T>
The vector to subtract from.
right  Vector<T>
The vector to subtract.
result  Vector<T>
The vector that is to hold the result. May be null.

Type Parameters

T

Return Value

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

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Vector<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).

Remarks

If result is null, the operation chooses the result representation. Otherwise, result is overwritten, returned, and its representation is preserved. The result may alias either vector operand.

Exceptions

ArgumentNullException

left is null.

-or-

right is null.

DimensionMismatchException

left and right do not have the same length.

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

Subtracts a vector from a constant.
C# 
public static Vector<T> SubtractInto<T>(
	T value,
	Vector<T> vector,
	Vector<T>? result
)

Parameters

value  T
The value to subtract from.
vector  Vector<T>
The vector to subtract.
result  Vector<T>
The vector that is to hold the result. May be null.

Type Parameters

T

Return Value

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

Remarks

If result is null, the operation chooses the result representation. Otherwise, result is overwritten, returned, and its representation is preserved. The result may alias vector.

Exceptions

ArgumentNullException

vector is null.

DimensionMismatchException

vector and result do not have the same length.

See Also