Home > Extreme Optimization Mathematics Library for .NET > Reference > Extreme.Mathematics.LinearAlgebra Namespace > Matrix Class > Methods


Extreme Optimization Mathematics Library for .NET

Matrix.AddProductToVector Method 

Multiplies a Vector by this Matrix and stores the result in a second vector of type GeneralVector.

[Visual Basic]
Overridable Public Function AddProductToVector( _
   ByVal alpha As Double, _
   ByVal vector As Vector, _
   ByVal trans As TransposeOperation, _
   ByVal beta As Double, _
   ByVal resultVector As GeneralVector _
) As GeneralVector
[C#]
public virtual GeneralVector AddProductToVector(
   double alpha,
   Vector vector,
   TransposeOperation trans,
   double beta,
   GeneralVector resultVector
);

Parameters

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

Return Value

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

Exception TypeCondition
ArgumentNullExceptionvector is a null reference (Nothing in Visual Basic).

-or-

resultVector is a null reference (Nothing in Visual Basic).

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

-or-

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

See Also

Matrix Class | Extreme.Mathematics.LinearAlgebra Namespace