FloatTriDiagMatrix Class

Class FloatTriDiagMatrix represents a tridiagonal matrix of single-precision floating point values. A tridiagonal matrix is a matrix which has all its non-zero entries on the main diagonal, the super diagonal, and the subdiagonal.

Inheritance Hierarchy

SystemObject
CenterSpace.NMath.CoreFloatTriDiagMatrix

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.3

Syntax

C++

Copy

[SerializableAttribute]
public class FloatTriDiagMatrix : ICloneable

<SerializableAttribute>
Public Class FloatTriDiagMatrix
	Implements ICloneable

[SerializableAttribute]
public ref class FloatTriDiagMatrix : ICloneable

[<SerializableAttribute>]
type FloatTriDiagMatrix =  
    class
        interface ICloneable
    end

The FloatTriDiagMatrix type exposes the following members.

Constructors

	Name	Description
	FloatTriDiagMatrix(FloatBandMatrix)	Constructs a FloatTriDiagMatrix instance by extracting the tridiagonal part of a banded matrix.
	FloatTriDiagMatrix(FloatMatrix)	Constructs a FloatTriDiagMatrix instance by extracting the tridiagonal part of a general matrix.
	FloatTriDiagMatrix(Int32, Int32)	Constructs a FloatTriDiagMatrix instance with the specified number of rows and columns.
	FloatTriDiagMatrix(FloatVector, Int32, Int32)	Constructs a FloatTriDiagMatrix instance with the specified dimensions using the data in the given vector.

Top

Properties

	Name	Description
	Cols	Gets the number of columns in the matrix.
	DataVector	Gets the data vector referenced by this matrix.
	Item	Gets and sets the value at the specified position.
	Rows	Gets the number of rows in the matrix.

Top

Methods

	Name	Description
	Add(Single, FloatTriDiagMatrix)	Adds a scalar to the non-zero elements of a tridiagonal matrix.
	Add(FloatTriDiagMatrix, FloatTriDiagMatrix)	Adds two tridiagonal matrices.
	Add(FloatTriDiagMatrix, Single)	Adds a scalar to the non-zero elements of a tridiagonal matrix.
	Clone	Creates a deep copy 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(Single, FloatTriDiagMatrix)	Divides a scalar by the non-zero elements of a tridiagonal matrix.
	Divide(FloatTriDiagMatrix, FloatTriDiagMatrix)	Divides a tridiagonal matrix by another.
	Divide(FloatTriDiagMatrix, Single)	Divides the non-zero elements of a tridiagonal 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).)
	GetHashCode	Returns an integer hash code for this matrix. (Overrides ObjectGetHashCode.)
	LeadingSubmatrix	Returns the k by k upper left corner of the matrix. The matrix and the submatrix share the same data.
	Multiply(Single, FloatTriDiagMatrix)	Multiplies the non-zero elements of a tridiagonal matrix by a scalar.
	Multiply(FloatTriDiagMatrix, FloatTriDiagMatrix)	Multiplies two tridiagonal matrices.
	Multiply(FloatTriDiagMatrix, Single)	Multiplies the non-zero elements of a tridiagonal matrix and a scalar.
	Negate	Negation operator.
	Resize	Changes the dimensions of this matrix to those specified, adding zeros or truncating as necessary.
	ShallowCopy	Creates a shallow copy of this matrix.
	Subtract(Single, FloatTriDiagMatrix)	Subtracts the non-zero elements of a tridiagonal matrix from a scalar.
	Subtract(FloatTriDiagMatrix, FloatTriDiagMatrix)	Subtracts two tridiagonal matrices.
	Subtract(FloatTriDiagMatrix, Single)	Subtracts a scalar from the non-zero elements of a tridiagonal matrix.
	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.
	ToGeneralMatrix	Converts this tridiagonal matrix to a general 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. ToCommaSeparated ToCommaSeparated(String) ToTabDelimited ToTabDelimited(String)
	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.
	Transpose	Returns the transpose of this matrix.

Top

Operators

	Name	Description
	Addition(Single, FloatTriDiagMatrix)	Adds a scalar to the non-zero elements of a tridiagonal matrix.
	Addition(FloatTriDiagMatrix, FloatTriDiagMatrix)	Adds two tridiagonal matrices.
	Addition(FloatTriDiagMatrix, Single)	Adds a scalar to the non-zero elements of a tridiagonal matrix.
	Division(Single, FloatTriDiagMatrix)	Divides a scalar by the non-zero elements of a tridiagonal matrix.
	Division(FloatTriDiagMatrix, FloatTriDiagMatrix)	Divides a tridiagonal matrix by another.
	Division(FloatTriDiagMatrix, Single)	Divides the non-zero elements of a tridiagonal matrix by a scalar.
	Equality	Tests for equality of two tridiagonal matrices. Two matrices are equal if they have the same dimensions, and all values are equal.
	Inequality	Tests for equality of two tridiagonal matrices. Two matrices are equal if they have the same dimensions, and all values are equal.
	Multiply(Single, FloatTriDiagMatrix)	Multiplies the non-zero elements of a tridiagonal matrix by a scalar.
	Multiply(FloatTriDiagMatrix, FloatTriDiagMatrix)	Multiplies two tridiagonal matrices.
	Multiply(FloatTriDiagMatrix, Single)	Multiplies the non-zero elements of a tridiagonal matrix and a scalar.
	Subtraction(Single, FloatTriDiagMatrix)	Subtracts the non-zero elements of a tridiagonal matrix from a scalar.
	Subtraction(FloatTriDiagMatrix, FloatTriDiagMatrix)	Subtracts two tridiagonal matrices.
	Subtraction(FloatTriDiagMatrix, Single)	Subtracts a scalar from the non-zero elements of a tridiagonal matrix.
	UnaryNegation	Negation operator.
	UnaryPlus	Unary + operator. Just returns the input matrix.

Top

Remarks

The element in the ith row, jth column is defined to be zero whenever j - i > 1. or i - j > 1.
The matrix is stored in a vector column by column. Zero elements are not stored. There are some blank entries in the data vector so the each column takes up the same number of elements, 3, in the vector. For example, the following 8 by 8 matrix,

Copy

    | a11 a12 0   0   0   0   0   0   |
    | a21 a22 a23 0   0   0   0   0   |
    | 0   a32 a33 a34 0   0   0   0   |
A = | 0   0   a43 a44 a45 0   0   0   |
    | 0   0   0   a54 a55 a56 0   0   |
    | 0   0   0   0   a65 a66 a67 0   |
    | 0   0   0   0   0   a76 a77 a78 |
    | 0   0   0   0   0   0   a87 a88 |

is stored in a data vector v as

Copy

v = [x   a11 a21 
     a12 a22 a32 
     a23 a33 a43
     a34 a44 a54
     a45 a55 a65
     a56 a66 a67
     a67 a77 a87
     a78 a88 x ]

where x denotes an unused location.

Reference

CenterSpace.NMath.Core Namespace