Vector<T>.AddScaledProductInPlace(T, LinearOperator<T>, Vector<T>) Method

Adds the scaled product of a matrix and a Vector<T> to this Vector<T>.

Definition

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

public virtual Vector<T> AddScaledProductInPlace(
	T factor,
	LinearOperator<T> matrix,
	Vector<T> vector
)

Visual Basic

Public Overridable Function AddScaledProductInPlace ( 
	factor As T,
	matrix As LinearOperator(Of T),
	vector As Vector(Of T)
) As Vector(Of T)

C++/CLI

public:
virtual Vector<T>^ AddScaledProductInPlace(
	T factor, 
	LinearOperator<T>^ matrix, 
	Vector<T>^ vector
)

abstract AddScaledProductInPlace : 
        factor : 'T * 
        matrix : LinearOperator<'T> * 
        vector : Vector<'T> -> Vector<'T> 
override AddScaledProductInPlace : 
        factor : 'T * 
        matrix : LinearOperator<'T> * 
        vector : Vector<'T> -> Vector<'T>

Parameters

factor T: The scale factor for the matrix-vector product.
matrix LinearOperator<T>: A Matrix<T>.
vector Vector<T>: A vector.

Return Value

Vector<T>
A reference to this instance.

Remarks

Using this method is more efficient than evaluating the equivalent expression using overloaded operators. In the latter case, three intermediate vectors are created. This method doesn't create any intermediate vectors.

Exceptions

ArgumentNullException

matrix is null

-or-

vector is null

DimensionMismatchException

The number of rows of matrix does not equal the length of this instance.