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

Adds a multiple of a vector broadcast along the specified dimension to a matrix and returns the result.

Definition

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

public static Matrix<T> AddScaled<T>(
	Matrix<T> left,
	T factor,
	Vector<T> right,
	Dimension broadcastDimension
)

Visual Basic

Public Shared Function AddScaled(Of T) ( 
	left As Matrix(Of T),
	factor As T,
	right As Vector(Of T),
	broadcastDimension As Dimension
) As Matrix(Of T)

C++/CLI

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

static member AddScaled : 
        left : Matrix<'T> * 
        factor : 'T * 
        right : Vector<'T> * 
        broadcastDimension : Dimension -> Matrix<'T>

Parameters

left Matrix<T>: The left operand of the addition.
factor T: Multiplier for the vector right.
right Vector<T>: A vector.
broadcastDimension Dimension: A value that specifies whether the elements in right should be broadcast across rows or columns.

Type Parameters

T

Return Value

Matrix<T>
A Matrix<T> that is the sum of the specified form of this matrix and the vector right broadcast in the dimension specified by broadcastDimension.

Remarks

The dimensions of the matrix and the length of the vector must be compatible. Otherwise an exception of type DimensionMismatchException is thrown.

Exceptions

ArgumentNullException	right is null.
DimensionMismatchException	The dimensions of this instance and the matrix right are not compatible for the specified operation.