ComplexDenseMatrix..::..AddProductToVector Method

ComplexDenseMatrix Class See Also

Multiplies a ComplexVector by this ComplexMatrix and stores the result in a second ComplexVector.

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

Syntax

C#
public override ComplexDenseVector AddProductToVector( DoubleComplex alpha, ComplexVector vector, TransposeOperation trans, DoubleComplex beta, ComplexDenseVector resultVector )

Visual Basic (Declaration)
Public Overrides Function AddProductToVector ( _ alpha As DoubleComplex, _ vector As ComplexVector, _ trans As TransposeOperation, _ beta As DoubleComplex, _ resultVector As ComplexDenseVector _ ) As ComplexDenseVector

Visual Basic (Declaration)

                      Public Overrides Function AddProductToVector ( _
	alpha As DoubleComplex, _
	vector As ComplexVector, _
	trans As TransposeOperation, _
	beta As DoubleComplex, _
	resultVector As ComplexDenseVector _
) As ComplexDenseVector

Visual C++
public: virtual ComplexDenseVector^ AddProductToVector( DoubleComplex alpha, ComplexVector^ vector, TransposeOperation trans, DoubleComplex beta, ComplexDenseVector^ resultVector ) override

F#
abstract AddProductToVector : alpha:DoubleComplex * vector:ComplexVector * trans:TransposeOperation * beta:DoubleComplex * resultVector:ComplexDenseVector -> ComplexDenseVector override AddProductToVector : alpha:DoubleComplex * vector:ComplexVector * trans:TransposeOperation * beta:DoubleComplex * resultVector:ComplexDenseVector -> ComplexDenseVector

                      abstract AddProductToVector : 
        alpha:DoubleComplex * 
        vector:ComplexVector * 
        trans:TransposeOperation * 
        beta:DoubleComplex * 
        resultVector:ComplexDenseVector -> ComplexDenseVector 
override AddProductToVector : 
        alpha:DoubleComplex * 
        vector:ComplexVector * 
        trans:TransposeOperation * 
        beta:DoubleComplex * 
        resultVector:ComplexDenseVector -> ComplexDenseVector

Parameters

alpha: Type: Extreme.Mathematics..::..DoubleComplex
Multiplier for the vector-matrix product of this matrix with vector.

vector: Type: Extreme.Mathematics..::..ComplexVector
A ComplexVector.

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: Extreme.Mathematics..::..DoubleComplex
Multiplier for the resultVector.

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

Return Value

The vector resultVector.

Remarks

This method uses the BLAS routine ZGEMV.

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.