BandMatrix..::..AddProductToVector Method

BandMatrix Class See Also

Multiplies a Vector by this Matrix and stores the result in a second Vector.

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 4.2.11333.0 (4.2.12253.0)

Syntax

C#
public override DenseVector AddProductToVector( double alpha, Vector vector, TransposeOperation trans, double beta, DenseVector resultVector )

Visual Basic (Declaration)
Public Overrides Function AddProductToVector ( _ alpha As Double, _ vector As Vector, _ trans As TransposeOperation, _ beta As Double, _ resultVector As DenseVector _ ) As DenseVector

Visual C++
public: virtual DenseVector^ AddProductToVector( double alpha, Vector^ vector, TransposeOperation trans, double beta, DenseVector^ resultVector ) override

F#
abstract AddProductToVector : alpha:float * vector:Vector * trans:TransposeOperation * beta:float * resultVector:DenseVector -> DenseVector override AddProductToVector : alpha:float * vector:Vector * trans:TransposeOperation * beta:float * resultVector:DenseVector -> DenseVector

                      abstract AddProductToVector : 
        alpha:float * 
        vector:Vector * 
        trans:TransposeOperation * 
        beta:float * 
        resultVector:DenseVector -> DenseVector 
override AddProductToVector : 
        alpha:float * 
        vector:Vector * 
        trans:TransposeOperation * 
        beta:float * 
        resultVector:DenseVector -> DenseVector

Parameters

alpha: Type: System..::..Double
Multiplier for the vector-matrix product of this matrix with vector.

vector: Type: Extreme.Mathematics..::..Vector
A Vector.

trans: Type: Extreme.Mathematics..::..TransposeOperation
A TransposeOperation value that specifies the operation, if any, to be performed on this instance before the multiplication.

beta: Type: System..::..Double
Multiplier for the resultVector.

resultVector: Type: Extreme.Mathematics.LinearAlgebra..::..DenseVector
The DenseVector that is to contain the result of the multiplication.

Return Value

The vector resultVector.

Remarks

This method uses the BLAS routine DGEMV.

Exceptions

Exception	Condition
System..::..ArgumentNullException	vector is nullNothingnullptra null reference (Nothing in Visual Basic). -or- resultVector is nullNothingnullptra null reference (Nothing in Visual Basic).
Extreme.Mathematics..::..DimensionMismatchException	The length of the resultVector does not equal the number of columns of this matrix. -or- The length of vector does not equal the number of rows of this matrix.

Exception

Condition

System..::..ArgumentNullException

vector is nullNothingnullptra null reference (Nothing in Visual Basic).

-or-

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

Extreme.Mathematics..::..DimensionMismatchException

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

-or-

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