 | FloatMatrix Class |
Class FloatMatrix represents a general mathematical matrix class of
floating point numbers. Methods are provided for performing algebraic
operations, data manipulation, and slicing.
Inheritance HierarchyNamespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.3
SyntaxThe FloatMatrix type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FloatMatrix |
An undefined matrix. Must be resized before using.
|
| FloatMatrix(DataRow) |
Constructs a FloatMatrix instance whose values are derived from the entire
contents of the given array of rows.
|
| FloatMatrix(DataRowCollection) |
Constructs a FloatMatrix instance whose values are derived from the entire
contents of the given row collection.
|
| FloatMatrix(DataTable) |
Constructs a FloatMatrix instance whose values are derived from the
entire contents of the given data table.
|
| FloatMatrix(DataView) |
Constructs a FloatMatrix instance whose values are derived from the entire
contents of the given data view.
|
 | FloatMatrix(TextReader) |
Constructs a FloatMatrix instance from the given text reader.
|
| FloatMatrix(Single) |
Constructs a FloatMatrix instance initialized with data in a
given two-dimensional array.
|
| FloatMatrix(String) |
Constructs a FloatMatrix instance from a formatted string.
|
| FloatMatrix(FloatMatrix) |
Constructs a deep copy of a FloatMatrix.
|
| FloatMatrix(FloatVector) |
Constructs a n x 1 FloatMatrix instance from a given vector.
|
| FloatMatrix(Int32, Int32) |
Constructs a FloatMatrix instance with the specifed number of rows and
columns.
|
| FloatMatrix(TextReader, NumberStyles) |
Constructs a FloatMatrix instance from the given text reader.
|
| FloatMatrix(String, Char) |
Constructs a FloatMatrix instance from a formatted string with
a specified delimiter.
|
| FloatMatrix(String, NumberStyles) |
Constructs a FloatMatrix instance from a formatted string and a
NumberStyles object.
|
| FloatMatrix(Int32, Int32, FloatDataBlock) |
Constructs a FloatMatrix instance from a data block.
|
| FloatMatrix(Int32, Int32, RandomNumberGenerator) |
Constructs a FloatMatrix instance from a random number generator.
|
| FloatMatrix(Int32, Int32, Single) |
Constructs a FloatMatrix instance of the specifed dimensions and
initializes all matrix element values to the given value.
|
| FloatMatrix(String, NumberStyles, Char) |
Constructs a FloatMatrix instance from a formatted string with
a specified delimiter and style.
|
| FloatMatrix(Int32, Int32, RandomNumberStream, IRandomNumberDistributionSingle) |
Constructs a FloatMatrix instance from a random number generator.
|
| FloatMatrix(Int32, Int32, TextReader, Char) |
Constructs a FloatMatrix instance from a given text reader with
a specified delimiter.
|
| FloatMatrix(Int32, Int32, Single, Single) |
Constructs a FloatMatrix 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.
|
| FloatMatrix(Int32, Int32, Single, StorageType) |
Constructs a FloatMatrix instance of the specified dimensions,
initialized with the values in a given array.
|
| FloatMatrix(Int32, Int32, String, Char) |
Constructs a FloatMatrix instance from a formatted string with
a specified delimiter.
|
| FloatMatrix(Int32, Int32, FloatDataBlock, Int32, Int32) |
Constructs a FloatMatrix instance from a data block with the given row and column strides.
|
| FloatMatrix(Int32, Int32, TextReader, NumberStyles, Char) |
Constructs a FloatMatrix instance from a given text reader with
specified delimiter and styles.
|
| FloatMatrix(Int32, Int32, String, NumberStyles, Char) |
Constructs a FloatMatrix instance from a formatted string with
a specified delimiter and style.
|
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(Single, FloatMatrix) |
Adds a scalar and a matrix.
|
| Add(FloatMatrix, FloatMatrix) |
Adds two matrices.
|
| Add(FloatMatrix, Single) |
Adds a matrix and a scalar.
|
| Add(Single, FloatMatrix, FloatMatrix) |
Adds a scalar and a matrix.
|
| Add(FloatMatrix, FloatMatrix, FloatMatrix) |
Adds two matrices.
|
| Add(FloatMatrix, Single, FloatMatrix) |
Adds a scalar to a matrix
|
| Apply(FuncSingle, 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(FuncSingle, Int32, Single, 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.
|
| Apply(FuncSingle, Single, Single, FloatMatrix) |
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(FuncSingle, Single, Single, Single) |
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 floating point 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.
|
| Decrement |
Decrements each element of the given 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(Single, FloatMatrix) |
Divide a scalar by a matrix.
|
| Divide(FloatMatrix, FloatMatrix) |
Divide a matrix by another.
|
| Divide(FloatMatrix, Single) |
Divide a matrix by a scalar.
|
| Divide(Single, FloatMatrix, FloatMatrix) |
Divide a scalar by a matrix.
|
| Divide(FloatMatrix, FloatMatrix, FloatMatrix) |
Divide a matrix by another.
|
| Divide(FloatMatrix, Single, FloatMatrix) |
Divide a matrix by a scalar.
|
| 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{float} out of the data elements in this matrix.
|
| GetFloatEnumerator |
Creates an IFloatEnumerator 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(Single) |
Adds the specified value to each element in the matrix.
|
| Increment(FloatMatrix) |
Increments each element of the given matrix.
|
| InfinityNorm |
Computes the infinity-norm of this matrix.
|
| IsNumeric |
Checks every matrix element for NaN or Infinity values, if none are found, true is returned, otherwise false is returned.
|
| Multiply(Single, FloatMatrix) |
Multiple a scalar and a matrix.
|
| Multiply(FloatMatrix, FloatMatrix) |
Multiply two matrices.
|
| Multiply(FloatMatrix, Single) |
Multiply a matrix and a scalar.
|
| Multiply(Single, FloatMatrix, FloatMatrix) |
Multiply a scalar and a matrix.
|
| Multiply(FloatMatrix, FloatMatrix, FloatMatrix) |
Multiply two matrices.
|
| Multiply(FloatMatrix, Single, FloatMatrix) |
Multiply a matrix and a scalar.
|
| 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(TextReader) |
Returns a new FloatMatrix instance from the given text reader.
|
| Parse(String) |
Constructs a FloatMatrix instance from a formatted string.
|
| Parse(TextReader, NumberStyles) |
Returns a new FloatMatrix instance from the given text reader.
|
| Parse(String, NumberStyles) |
Constructs a FloatMatrix instance from a formatted string and a
NumberStyles object.
|
| ReadXml |
Generates a FloatMatrix instance form its XML representation.
Examples
The matrix:
| 1 2 3 |
| 4 5 6 |
| 7 8 9 |
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(Single) |
Sets the data elements of this vector to the specified value.
|
| Set(Int32, Slice, Single) |
Sets the values in the specified row and columns to the
given value.
|
| Set(Slice, Slice, Single) |
Sets the values of the submatrix determined by the specified slices to
a given value.
|
| Set(Slice, Int32, Single) |
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(Single, FloatMatrix) |
Subtracts a matrix from a scalar.
|
| Subtract(FloatMatrix, FloatMatrix) |
Subtracts one matrix from another.
|
| Subtract(FloatMatrix, Single) |
Subtracts a scalar from a matrix.
|
| Subtract(Single, FloatMatrix, FloatMatrix) |
Subtracts a matrix from a scalar.
|
| Subtract(FloatMatrix, FloatMatrix, FloatMatrix) |
Subtracts one matrix from another.
|
| Subtract(FloatMatrix, Single, FloatMatrix) |
Subtracts a scalar from a matrix.
|
| ToArray |
Copies data into a new array and returns it.
|
| ToCommaSeparated |
Returns a formatted string representation of this matrix using commas
and newlines.
|
| ToCommaSeparated(String) |
Returns a formatted string representation of this matrix using commas
and newlines. Numbers are formatted using the specified format string.
|
| ToDataTable |
Creates a data table containing the values in this matrix.
|
| ToDataTable(String) |
Creates a data table with the specified name containing the
values 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 using tabs
and newlines.
|
| ToTabDelimited(String) |
Returns a formatted string representation of this matrix using tabs
and newlines. Numbers are formatted using the specified format string.
|
| Transform(FuncSingle) |
Modifies the elements of this matrix by applying the given no-argument function to
each element.
|
| Transform(FuncSingle, Single) |
Modifies the elements of this matrix by applying the given unary function to
each element.
|
| Transform(FuncSingle, Int32, Single, 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.
|
| Transform(FuncSingle, Single, Single, FloatMatrix) |
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(FuncSingle, Single, Single, Single) |
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 floating point 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.
|
| WriteAsCSV(TextWriter) |
Writes a formatted text representation of this matrix using commas
and newlines.
|
| WriteAsCSV(TextWriter, String) |
Writes a formatted string representation of this matrix using commas
and newlines. Numbers are formatted using the specified format string.
|
| WriteXml |
Converts an object into its XML representation.
Examples
The matrix:
| 1 2 3 |
| 4 5 6 |
| 7 8 9 |
would be serialized as:
|
Operators| Name | Description | |
|---|---|---|
 | Addition(Single, FloatMatrix) |
Adds a scalar and a matrix.
|
| Addition(FloatMatrix, FloatMatrix) |
Adds two matrices.
|
| Addition(FloatMatrix, Single) |
Adds a matrix and a scalar.
|
| Decrement |
Decrements each element of the input matrix.
|
| Division(Single, FloatMatrix) |
Divide a scalar by a matrix.
|
| Division(FloatMatrix, FloatMatrix) |
Divide a matrix by another.
|
| Division(FloatMatrix, Single) |
Divide a matrix by a scalar.
|
| Equality |
Tests for equality of two matrices. Two matrices are equal if they
have the same dimensions and all values are equal.
|
| Increment |
Increments each element of the given matrix.
|
| Inequality |
Tests for inequality of two matrices. Two matrices are not equal if they
have different dimensions or their values are not all equal.
|
| Multiply(Single, FloatMatrix) |
Multiple a scalar and a matrix.
|
| Multiply(FloatMatrix, FloatMatrix) |
Multiple two matrices.
|
| Multiply(FloatMatrix, Single) |
Multiply a matrix and a scalar.
|
| Subtraction(Single, FloatMatrix) |
Subtracts a matrix from a scalar.
|
| Subtraction(FloatMatrix, FloatMatrix) |
Subtracts one matrix from another.
|
| Subtraction(FloatMatrix, Single) |
Subtracts a scalar from a matrix.
|
| UnaryNegation |
Negation operator.
|
| UnaryPlus |
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