LinearOperator<T>.AddProductToVector Method

Note: This API is now obsolete.

Multiplies a Vector<T> by this instance and stores the result in a second vector of type DenseVector<T>.

Definition

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

[ObsoleteAttribute("Use MultiplyAndAddInPlaceAsLeftFactorWith, ScaledMultiplyAsLeftWith, or one of their simpler variants instead.")]
public DenseVector<T> AddProductToVector(
	T alpha,
	Vector<T> vector,
	TransposeOperation trans,
	T beta,
	DenseVector<T> resultVector
)

Visual Basic

<ObsoleteAttribute("Use MultiplyAndAddInPlaceAsLeftFactorWith, ScaledMultiplyAsLeftWith, or one of their simpler variants instead.")>
Public Function AddProductToVector ( 
	alpha As T,
	vector As Vector(Of T),
	trans As TransposeOperation,
	beta As T,
	resultVector As DenseVector(Of T)
) As DenseVector(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use MultiplyAndAddInPlaceAsLeftFactorWith, ScaledMultiplyAsLeftWith, or one of their simpler variants instead.")]
DenseVector<T>^ AddProductToVector(
	T alpha, 
	Vector<T>^ vector, 
	TransposeOperation trans, 
	T beta, 
	DenseVector<T>^ resultVector
)

[<ObsoleteAttribute("Use MultiplyAndAddInPlaceAsLeftFactorWith, ScaledMultiplyAsLeftWith, or one of their simpler variants instead.")>]
member AddProductToVector : 
        alpha : 'T * 
        vector : Vector<'T> * 
        trans : TransposeOperation * 
        beta : 'T * 
        resultVector : DenseVector<'T> -> DenseVector<'T>

Parameters

alpha T: Multiplier for the vector-matrix product of this matrix with the vector vector.
vector Vector<T>: A Vector<T>.
trans TransposeOperation: A TransposeOperation value that specifies the operation, if any, to be performed on this instance before the multiplication.
beta T: Multiplier for the vector resultVector.
resultVector DenseVector<T>: The DenseVector<T> that is to contain the result of the multiplication.

Return Value

DenseVector<T>
The vector resultVector.

Remarks

The length of the vector vector must equal the number of columns in this instance. The length of the vector resultVector must equal the number of rows.

Exceptions

ArgumentNullException

vector is null.

-or-

resultVector is null.

DimensionMismatchException

The length of the vector resultVector does not equal the number of columns of this matrix.