 | Float |
Class FloatComplexMatrix represents a general mathematical matrix class
of FloatComplex numbers. Methods are provided for
performing algebraic operations, data manipulation, and slicing.
Inheritance HierarchyNamespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4
SyntaxThe FloatComplexMatrix type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FloatComplexMatrix | An undefined matrix. Must be resized before using. |
| FloatComplexMatrix(FloatComplex) | Constructs a FloatComplexMatrix instance initialized with data in a given two-dimensional array. |
| FloatComplexMatrix(FloatComplexMatrix) | Constructs a deep copy of a FloatComplexMatrix. |
| FloatComplexMatrix(FloatComplexVector) | Constructs a n x 1 FloatComplexMatrix instance from a given vector. |
 | FloatComplexMatrix(String) | Constructs a FloatComplexMatrix instance from a formatted string. |
| FloatComplexMatrix(TextReader) | Constructs a FloatComplexMatrix instance from the given text reader. |
| FloatComplexMatrix(DataRow, DataRow) | Constructs a FloatComplexMatrix instance from two data row arrays. The real parts are specified with the first data row array and the imaginary parts by the second data row array. |
| FloatComplexMatrix(DataRowCollection, DataRowCollection) | Constructs a FloatComplexMatrix instance from two data row collections. The real parts are specified with the first data row collectionn, and the imaginary parts by the second data row collection. |
| FloatComplexMatrix(DataTable, DataTable) | Constructs a FloatComplexMatrix instance from the data tables. The real parts are specified with the first data table, and the imaginary parts by the second data table. |
| FloatComplexMatrix(DataView, DataView) | Constructs a FloatComplexMatrix instance from the data views. The real parts are specified with the first data view, and the imaginary parts by the second data view. |
| FloatComplexMatrix(FloatMatrix, FloatMatrix) | Constructs a FloatComplexMatrix instance from a matrix of real parts and a matrix of imaginary parts. |
| FloatComplexMatrix(Int32, Int32) | Constructs a FloatComplexMatrix instance with the specifed number of rows and columns. |
| FloatComplexMatrix(String, NumberStyles) | Constructs a FloatComplexMatrix instance from a formatted string and a NumberStyles object. |
| FloatComplexMatrix(TextReader, NumberStyles) | Returns a new FloatMatrix instance from the given text reader. |
| FloatComplexMatrix(Int32, Int32, FloatComplex) | Constructs a FloatComplexMatrix instance of the specifed dimensions and initializes all matrix element values to the given value. |
| FloatComplexMatrix(Int32, Int32, FloatComplexDataBlock) | Constructs a FloatComplexMatrix instance from a data block. |
| FloatComplexMatrix(Int32, Int32, RandomNumberGenerator) | Constructs a FloatComplexMatrix instance from a random number generator. |
| FloatComplexMatrix(Int32, Int32, FloatComplex, FloatComplex) | Constructs a FloatComplexMatrix instance of the specifed dimensions. Values are initialized starting with a given initial value, incremented by the specified amount for each element in the matrix. |
| FloatComplexMatrix(Int32, Int32, FloatComplex, StorageType) | Constructs a FloatComplexMatrix instance of the specified dimensions, initialized with the values in a given array. |
| FloatComplexMatrix(Int32, Int32, FloatComplexDataBlock, Int32, Int32) | Constructs a FloatComplexMatrix instance from a data block with the given row and column strides. |
Properties| Name | Description | |
|---|---|---|
 | Cols | Gets number of columns in this matrix. |
| ColStride | Gets the increment between successive elements in a column. |
| DataBlock | Gets a reference to the underly data that this matrix is viewing. |
| IsCompactStride | Returns true if the matrix data is in column major contiguous storage. |
| ItemInt32, Slice | Creates a vector view of the specifed slice of the specified row of this matrix. |
| ItemInt32, Int32 | Indexer for returning the element at a specified row and column position. |
| ItemSlice, Slice | Returns the submatrix determined by the specified slices. |
| ItemSlice, Int32 | Creates a vector view of the specifed slice of the specified column of this matrix. |
| Rows | Gets the number of rows in this matrix. |
| RowStride | Gets the increment between successive elements in a row. |
Methods| Name | Description | |
|---|---|---|
 | Add(FloatComplex, FloatComplexMatrix) | Adds a scalar and a matrix. |
| Add(FloatComplexMatrix, FloatComplex) | Adds a matrix and a scalar. |
| Add(FloatComplexMatrix, FloatComplexMatrix) | Adds two matrices. |
| Add(FloatComplex, FloatComplexMatrix, FloatComplexMatrix) | Adds a scalar and a matrix. |
| Add(FloatComplexMatrix, FloatComplex, FloatComplexMatrix) | Adds a scalar to a matrix |
| Add(FloatComplexMatrix, FloatComplexMatrix, FloatComplexMatrix) | Adds two matrices. |
| Apply(FuncFloatComplex, FloatComplex) | Returns a new matrix with the same size as this matrix, whose values are the result of applying the given unary function to each element of this matrix. |
| Apply(FuncFloatComplex, Single) | Returns a new matrix with the same size as this matrix, whose values are the result of applying the given unary function to each element of this matrix. |
| Apply(FuncFloatComplex, FloatComplex, FloatComplex, FloatComplex) | Returns a new matrix with the same size as this matrix, whose values are the result of applying the given binary function to each element of this matrix. The first parameter to the binary function is the matrix element; the second parameter is the passed FloatComplex value. |
| Apply(FuncFloatComplex, FloatComplex, FloatComplex, FloatComplexMatrix) | Returns a new matrix with the same size as this matrix, whose values are the result of applying the given binary function to each element of this matrix. The first parameter to the binary function is the matrix element; the second parameter is the corresponding element of the passed matrix. |
| Apply(FuncFloatComplex, Int32, FloatComplex, Int32) | Returns a new matrix with the same size as this matrix, whose values are the result of applying the given binary function to each element of this matrix. The first parameter to the binary function is the matrix element; the second parameter is the passed integer value. |
| ApplyColumns | Returns a new vector containing an element for each column in this matrix. The elements are the results of applying a function that takes a vector and returns a single-precision number. |
| Clear | Sets the data elements of this vector to zero. |
| Clear(Int32, Slice) | Sets the values of the submatrix determined by the specified slices to zero. |
| Clear(Slice, Slice) | Sets the values of the submatrix determined by the specified slices to zero. |
| Clear(Slice, Int32) | Sets the values of the submatrix determined by the specified slices to zero. |
| Clone | Creates a deep copy of this matrix. |
| Col | Returns a column of this matrix as a vector. The returned vector and the matrix share the data. |
| ConjTranspose | Returns the conjugate transpose of this matrix. |
| DeepenThisCopy | Guarantees that there is only one reference to the underlying data and that this data is in contiguous storage. |
| Diagonal | Returns a vector view of the main diagonal of this matrix. |
| Diagonal(Int32) | Returns a vector view of a diagonal of this matrix. |
| Divide(FloatComplex, FloatComplexMatrix) | Divide a scalar by a matrix. |
| Divide(FloatComplexMatrix, FloatComplex) | Divide a matrix by a scalar. |
| Divide(FloatComplexMatrix, FloatComplexMatrix) | Divide a matrix by another. |
| Divide(FloatComplex, FloatComplexMatrix, FloatComplexMatrix) | Divide a scalar by a matrix. |
| Divide(FloatComplexMatrix, FloatComplex, FloatComplexMatrix) | Divide a matrix by a scalar. |
| Divide(FloatComplexMatrix, FloatComplexMatrix, FloatComplexMatrix) | Divide a matrix by another. |
| Equals |
Tests for equality of this matrix and another matrix.
Two matrices are equal if they have the same dimensions and all
values are equal.
(Overrides ObjectEquals(Object)) |
| FrobeniusNorm | Computes the Frobenius norm for this matrix. |
| GetEnumerator | Creates an IEnumerator{FloatComplex} out of the data elements in this matrix. |
| GetFloatComplexEnumerator | Creates an IFloatComplexEnumerator out of the data elements in this vector. |
| GetHashCode |
Returns an integer hash code for this matrix.
(Overrides ObjectGetHashCode) |
| GetSchema | The method is reserved and should not be used. |
| Identity | Returns an identity matrix of the specified size. |
| Increment | Adds the specified value to each element in the matrix. |
| InfinityNorm | Computes the infinity-norm of this matrix. |
| Multiply(FloatComplex, FloatComplexMatrix) | Multiple a scalar and a matrix. |
| Multiply(FloatComplexMatrix, FloatComplex) | Multiply a matrix and a scalar. |
| Multiply(FloatComplexMatrix, FloatComplexMatrix) | Multiply two matrices. |
| Multiply(FloatComplex, FloatComplexMatrix, FloatComplexMatrix) | Multiply a scalar and a matrix. |
| Multiply(FloatComplexMatrix, FloatComplex, FloatComplexMatrix) | Multiply a matrix and a scalar. |
| Multiply(FloatComplexMatrix, FloatComplexMatrix, FloatComplexMatrix) | Multiply two matrices. |
| NaNEquals | Tests for equality of this matrix and another matrix. Two matrices are equal if they have the same dimensions and all values are equal. |
| Negate | Negation operator. |
| OneNorm | Computes the 1-norm of this matrix. |
| Parse(String) | Constructs a FloatComplexMatrix instance from a formatted string. |
| Parse(TextReader) | Constructs a FloatComplexMatrix instance from the given text reader. |
| Parse(String, NumberStyles) | Constructs a FloatComplexMatrix instance from a formatted string and a NumberStyles object. |
| Parse(TextReader, NumberStyles) | Returns a new FloatMatrix instance from the given text reader. |
| ReadXml |
Generates a FloatComplexMatrix instance form its XML representation.
Example
The matrix:
| (1,0) (2,0) (3,0) |
| (4,0) (5,0) (6,0) |
| (7,0) (8,0) (9,0) |
would be serialized as:
|
| Resize | Changes the dimensions of this matrix to those specified, adding zeros or truncating as necessary. |
| ResizeAndClear | Changes the dimensions of this matrix to those specified. Matrix values are not preserved during this operation and are reset to zero. |
| Row | Returns a row of this matrix as a vector. The returned vector and the matrix share the data. |
| Scale | Scales each element in the matrix by the specified value. |
| Set(FloatComplex) | Sets the data elements of this vector to the specified value. |
| Set(Int32, Slice, FloatComplex) | Sets the values in the specified row and columns to the given value. |
| Set(Slice, Slice, FloatComplex) | Sets the values of the submatrix determined by the specified slices to a given value. |
| Set(Slice, Int32, FloatComplex) | Sets the values in the specified rows and column to a given value. |
| ShallowCopy | Creates a shallow copy of this matrix. |
| Slice | Returns a vector that views a slice of this matrix. The slice begins at element i,j and extends for n elements. The increment between successive elements in the vector is rowStride rows and colStride columns. |
| Subtract(FloatComplex, FloatComplexMatrix) | Subtracts a matrix from a scalar. |
| Subtract(FloatComplexMatrix, FloatComplex) | Subtracts a scalar from a matrix. |
| Subtract(FloatComplexMatrix, FloatComplexMatrix) | Subtracts one matrix from another. |
| Subtract(FloatComplex, FloatComplexMatrix, FloatComplexMatrix) | Subtracts a matrix from a scalar. |
| Subtract(FloatComplexMatrix, FloatComplex, FloatComplexMatrix) | Subtracts a scalar from a matrix. |
| Subtract(FloatComplexMatrix, FloatComplexMatrix, FloatComplexMatrix) | Subtracts one matrix from another. |
| ToArray | Copies data into an array and returns it. |
| ToImagDataTable | Creates a data table containing the imaginary parts in this matrix. |
| ToImagDataTable(String) | Creates a data table with the specified name containing the imaginary parts in this matrix. |
| ToRealDataTable | Creates a data table containing the real parts in this matrix. |
| ToRealDataTable(String) | Creates a data table with the specified name containing the real parts in this matrix. |
| ToString |
Returns a formatted string representation of this matrix.
(Overrides ObjectToString) |
| ToString(String) | Returns a formatted string representation of this matrix. Numbers are displayed using the specified format. |
| ToTabDelimited | Returns a formatted string representation of this matrix. |
| ToTabDelimited(String) | Returns a formatted string representation of this matrix. Numbers are displayed using the specified format. |
| Transform(FuncFloatComplex) | Modifies the elements of this matrix by applying the given no-argument function to each element. |
| Transform(FuncFloatComplex, FloatComplex) | Modifies the elements of this matrix by applying the given unary function to each element. |
| Transform(FuncFloatComplex, FloatComplex, FloatComplex, FloatComplex) | Modifies the contents of this matrix by applying the given binary function to each element. The first parameter to the binary function is the matrix element; the second parameter is the passed FloatComplex value. |
| Transform(FuncFloatComplex, FloatComplex, FloatComplex, FloatComplexMatrix) | Modifies the contents of this matrix by applying the given binary function to each element. The first parameter to the binary function is the matrix element; the second parameter is the corresponding element of the passed matrix. |
| Transform(FuncFloatComplex, Int32, FloatComplex, Int32) | Modifies the contents of this matrix by applying the given binary function to each element. The first parameter to the binary function is the matrix element; the second parameter is the passed integer value. |
| Transpose | Returns the transpose of this matrix. |
| Write(TextWriter) | Writes a text representation of this matrix to the writer. |
| Write(TextWriter, String) | Writes a formatted text representation of this matrix to the writer using the specified format. |
| WriteXml |
Converts an object into its XML representation.
Example
The matrix:
| (1,0) (2,0) (3,0) |
| (4,0) (5,0) (6,0) |
| (7,0) (8,0) (9,0) |
would be serialized as:
|
Operators| Name | Description | |
|---|---|---|
 | Addition(FloatComplex, FloatComplexMatrix) | Adds a scalar and a matrix. |
| Addition(FloatComplexMatrix, FloatComplex) | Adds a matrix and a scalar. |
| Addition(FloatComplexMatrix, FloatComplexMatrix) | Adds two matrices. |
| Division(FloatComplex, FloatComplexMatrix) | Divide a scalar by a matrix. |
| Division(FloatComplexMatrix, FloatComplex) | Divide a matrix by a scalar. |
| Division(FloatComplexMatrix, FloatComplexMatrix) | Divide a matrix by another. |
| Equality(FloatComplexMatrix, FloatComplexMatrix) | Tests for equality of two matrices. Two matrices are equal if they have the same dimensions and all values are equal. |
| (FloatMatrix to FloatComplexMatrix) | Implicitly converts a FloatMatrix instance into a FloatComplexMatrix instance. |
| Inequality(FloatComplexMatrix, FloatComplexMatrix) | Tests for inequality of two matrices. Two matrices are not equal if they have different dimensions or their values are not all equal. |
| Multiply(FloatComplex, FloatComplexMatrix) | Multiple a scalar and a matrix. |
| Multiply(FloatComplexMatrix, FloatComplex) | Multiply a matrix and a scalar. |
| Multiply(FloatComplexMatrix, FloatComplexMatrix) | Multiple two matrices. |
| Subtraction(FloatComplex, FloatComplexMatrix) | Subtracts a matrix from a scalar. |
| Subtraction(FloatComplexMatrix, FloatComplex) | Subtracts a scalar from a matrix. |
| Subtraction(FloatComplexMatrix, FloatComplexMatrix) | Subtracts one matrix from another. |
| UnaryNegation(FloatComplexMatrix) | Negation operator. |
| UnaryPlus(FloatComplexMatrix) | Unary + operator. Just returns the input matrix. |
Fields| Name | Description | |
|---|---|---|
 | XmlColumnsAttribute | XML columns attribute name. |
| XmlDataElement | XML data element name. |
| XmlDatumElement | XML datum element name. |
| XmlRowsAttribute | XML rows attribute name. |
See Also