Extract Method (ComplexGeneralMatrix, Int32, Int32, Int32, MatrixTriangleMode, Boolean) - Extract Overloads - Methods - ComplexHermitianMatrix Class - Extreme.Mathematics.LinearAlgebra.Complex Namespace - Reference - Documentation - .NET, C# (CSharp), VB.NET, F# Math, Statistics and Matrix Libraries

Introduction

Mathematics Library User's Guide

Vector and Matrix Library User's Guide

Statistics Library User's Guide

Reference

Creates a ComplexHermitianMatrix from a part of a ComplexGeneralMatrix.

Namespace: Extreme.Mathematics.LinearAlgebra.Complex
Assembly: Extreme.Numerics.Net20 (in Extreme.Numerics.Net20.dll) Version: 3.6.10055.0 (3.6.10077.0)

Syntax

C#
public static ComplexHermitianMatrix Extract( ComplexGeneralMatrix matrix, int dimension, int startRow, int startColumn, MatrixTriangleMode triangleMode, bool reuseComponentArray )

Visual Basic (Declaration)
Public Shared Function Extract ( _ matrix As ComplexGeneralMatrix, _ dimension As Integer, _ startRow As Integer, _ startColumn As Integer, _ triangleMode As MatrixTriangleMode, _ reuseComponentArray As Boolean _ ) As ComplexHermitianMatrix

Visual Basic (Declaration)

Public Shared Function Extract ( _
	matrix As ComplexGeneralMatrix, _
	dimension As Integer, _
	startRow As Integer, _
	startColumn As Integer, _
	triangleMode As MatrixTriangleMode, _
	reuseComponentArray As Boolean _
) As ComplexHermitianMatrix

Visual C++
public: static ComplexHermitianMatrix^ Extract( ComplexGeneralMatrix^ matrix, int dimension, int startRow, int startColumn, MatrixTriangleMode triangleMode, bool reuseComponentArray )

F#
static member Extract : matrix:ComplexGeneralMatrix * dimension:int * startRow:int * startColumn:int * triangleMode:MatrixTriangleMode * reuseComponentArray:bool -> ComplexHermitianMatrix

Parameters

matrix: Type: Extreme.Mathematics.LinearAlgebra.Complex..::.ComplexGeneralMatrix
The matrix that contains the components of the new matrix.

dimension: Type: System..::.Int32
The number of rows and columns of the new matrix.

startRow: Type: System..::.Int32
The row in matrix of the first component of the new matrix.

startColumn: Type: System..::.Int32
The column in matrix of the first component of the new matrix.

triangleMode: Type: Extreme.Mathematics.LinearAlgebra..::.MatrixTriangleMode
A MatrixTriangleMode value that indicates whether the components of the hermitian matrix are stored in the upper or lower triangular portion of the block specified by startRow and startColumn.

reuseComponentArray: Type: System..::.Boolean
A bool value that indicates whether the data array should be copied or reused for internal storage.

Return Value

A ComplexHermitianMatrix.

Exceptions

Exception	Condition
System..::.ArgumentNullException	matrix is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::.ArgumentOutOfRangeException	dimension is less than zero -or- startRow is less than zero or greater than or equal to the number of rows in matrix. -or- startColumn is less than zero or greater than or equal to the number of columns in matrix.
System..::.ArgumentException	startRow plus dimension is greater than or equal to the number of rows in matrix. -or- startColumn plus dimension is greater than or equal to the number of columns in matrix.

Exception

Condition

System..::.ArgumentNullException

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

System..::.ArgumentOutOfRangeException

dimension is less than zero

-or-

startRow is less than zero or greater than or equal to the number of rows in matrix.

-or-

startColumn is less than zero or greater than or equal to the number of columns in matrix.

System..::.ArgumentException

startRow plus dimension is greater than or equal to the number of rows in matrix.

-or-

startColumn plus dimension is greater than or equal to the number of columns in matrix.

ComplexHermitianMatrix..::..Extract Method (ComplexGeneralMatrix, Int32, Int32, Int32, MatrixTriangleMode, Boolean)

Syntax

Parameters

Return Value

Exceptions

See Also