HermitianMatrix<T>.AddOuterProduct Method

Definition

Namespace: Numerics.NET.LinearAlgebra
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.6.0

Overload List

AddOuterProduct(Matrix<T>, MatrixOperationSide)	Updates a Hermitian matrix with the product of a matrix and its transpose. Obsolete
AddOuterProduct(Vector<T>, MatrixOperationSide)	Updates a Hermitian matrix with the outer product of a vector and itself. Obsolete
AddOuterProduct(T, Matrix<T>, MatrixOperationSide)	Updates a Hermitian matrix with the scaled outer product of a matrix and its transpose. Obsolete
AddOuterProduct(T, Vector<T>, MatrixOperationSide)	Updates a Hermitian matrix with the scaled outer product of a vector and its transpose. Obsolete

AddOuterProduct(Matrix<T>, MatrixOperationSide)

Note: This API is now obsolete.

Updates a Hermitian matrix with the product of a matrix and its transpose.

[ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")]
public HermitianMatrix<T> AddOuterProduct(
	Matrix<T> matrix,
	MatrixOperationSide side = MatrixOperationSide.Right
)

Visual Basic

<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>
Public Function AddOuterProduct ( 
	matrix As Matrix(Of T),
	Optional side As MatrixOperationSide = MatrixOperationSide.Right
) As HermitianMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use the AddOuterProductInPlace method instead.")]
HermitianMatrix<T>^ AddOuterProduct(
	Matrix<T>^ matrix, 
	MatrixOperationSide side = MatrixOperationSide::Right
)

[<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>]
member AddOuterProduct : 
        matrix : Matrix<'T> * 
        ?side : MatrixOperationSide 
(* Defaults:
        let _side = defaultArg side MatrixOperationSide.Right
*)
-> HermitianMatrix<'T>

Parameters

matrix Matrix<T>: A Matrix<T>.
side MatrixOperationSide (Optional): Optional. Specifies whether the transposed matrix is the left or right operand. The default is Right.

Return Value

HermitianMatrix<T>
A reference to this instance.

Remarks

The number of rows of matrix must equal the number of rows and columns of this instance.

This method uses the level 3 BLAS routine ZHERK.

Exceptions

ArgumentNullException	matrix is null.
DimensionMismatchException	The number of rows of matrix does not equal the number of rows in this HermitianMatrix<T>.

AddOuterProduct(Vector<T>, MatrixOperationSide)

Note: This API is now obsolete.

Updates a Hermitian matrix with the outer product of a vector and itself.

[ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")]
public HermitianMatrix<T> AddOuterProduct(
	Vector<T> vector,
	MatrixOperationSide side = MatrixOperationSide.Right
)

Visual Basic

<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>
Public Function AddOuterProduct ( 
	vector As Vector(Of T),
	Optional side As MatrixOperationSide = MatrixOperationSide.Right
) As HermitianMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use the AddOuterProductInPlace method instead.")]
HermitianMatrix<T>^ AddOuterProduct(
	Vector<T>^ vector, 
	MatrixOperationSide side = MatrixOperationSide::Right
)

[<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>]
member AddOuterProduct : 
        vector : Vector<'T> * 
        ?side : MatrixOperationSide 
(* Defaults:
        let _side = defaultArg side MatrixOperationSide.Right
*)
-> HermitianMatrix<'T>

Parameters

vector Vector<T>: The first (column) vector.
side MatrixOperationSide (Optional): Optional. Specifies whether the transposed vector is the left or right operand. The default is Right.

Return Value

HermitianMatrix<T>
A reference to this instance

Remarks

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

This method uses the level 2 BLAS routine ZHER.

Exceptions

DimensionMismatchException

The length of vector does not equal the number of rows and columns in this HermitianMatrix<T>.

AddOuterProduct(T, Matrix<T>, MatrixOperationSide)

Note: This API is now obsolete.

Updates a Hermitian matrix with the scaled outer product of a matrix and its transpose.

[ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")]
public HermitianMatrix<T> AddOuterProduct(
	T factor,
	Matrix<T> matrix,
	MatrixOperationSide side = MatrixOperationSide.Right
)

Visual Basic

<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>
Public Function AddOuterProduct ( 
	factor As T,
	matrix As Matrix(Of T),
	Optional side As MatrixOperationSide = MatrixOperationSide.Right
) As HermitianMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use the AddOuterProductInPlace method instead.")]
HermitianMatrix<T>^ AddOuterProduct(
	T factor, 
	Matrix<T>^ matrix, 
	MatrixOperationSide side = MatrixOperationSide::Right
)

[<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>]
member AddOuterProduct : 
        factor : 'T * 
        matrix : Matrix<'T> * 
        ?side : MatrixOperationSide 
(* Defaults:
        let _side = defaultArg side MatrixOperationSide.Right
*)
-> HermitianMatrix<'T>

Parameters

factor T: The scale factor.
matrix Matrix<T>: A Matrix<T>.
side MatrixOperationSide (Optional): Optional. Specifies whether the transposed matrix is the left or right operand. The default is Right.

Return Value

HermitianMatrix<T>
A reference to this instance.

Remarks

The number of rows of matrix must equal the number of rows and columns of this instance.

This method uses the level 3 BLAS routine ZHERK.

Exceptions

ArgumentNullException	matrix is null.
DimensionMismatchException	The number of rows of matrix does not equal the number of rows in this HermitianMatrix<T>.

AddOuterProduct(T, Vector<T>, MatrixOperationSide)

Note: This API is now obsolete.

Updates a Hermitian matrix with the scaled outer product of a vector and its transpose.

[ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")]
public HermitianMatrix<T> AddOuterProduct(
	T factor,
	Vector<T> vector,
	MatrixOperationSide side = MatrixOperationSide.Right
)

Visual Basic

<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>
Public Function AddOuterProduct ( 
	factor As T,
	vector As Vector(Of T),
	Optional side As MatrixOperationSide = MatrixOperationSide.Right
) As HermitianMatrix(Of T)

C++/CLI

public:
[ObsoleteAttribute(L"Use the AddOuterProductInPlace method instead.")]
HermitianMatrix<T>^ AddOuterProduct(
	T factor, 
	Vector<T>^ vector, 
	MatrixOperationSide side = MatrixOperationSide::Right
)

[<ObsoleteAttribute("Use the AddOuterProductInPlace method instead.")>]
member AddOuterProduct : 
        factor : 'T * 
        vector : Vector<'T> * 
        ?side : MatrixOperationSide 
(* Defaults:
        let _side = defaultArg side MatrixOperationSide.Right
*)
-> HermitianMatrix<'T>

Parameters

factor T: The scale factor.
vector Vector<T>: A Vector<T>.
side MatrixOperationSide (Optional): Optional. Specifies whether the transposed vector is the left or right operand. The default is Right.

Return Value

HermitianMatrix<T>
A reference to this instance.

Remarks

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

This method uses the level 2 BLAS routine ZHER.

Exceptions

ArgumentNullException	vector is null.
DimensionMismatchException	The length of vector does not equal the number of rows in this HermitianMatrix<T>.

HermitianMatrix<T>.AddOuterProduct Method

Definition

Overload List

AddOuterProduct(Matrix<T>, MatrixOperationSide)

Parameters

Return Value

Remarks

Exceptions

AddOuterProduct(Vector<T>, MatrixOperationSide)

Parameters

Return Value

Remarks

Exceptions

AddOuterProduct(T, Matrix<T>, MatrixOperationSide)

Parameters

Return Value

Remarks

Exceptions

AddOuterProduct(T, Vector<T>, MatrixOperationSide)

Parameters

Return Value

Remarks

Exceptions

See Also

Reference