Click or drag to resize

DoubleSymBandMatrix Class

Class DoubleSymBandMatrix represents a symmetric banded matrix of double-precision floating point values. A symmetric banded matrix is a symmetric matrix that has all its non-zero entries near the diagonal.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CoreDoubleSymBandMatrix

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.4
Syntax
[SerializableAttribute]
public class DoubleSymBandMatrix : ICloneable

The DoubleSymBandMatrix type exposes the following members.

Constructors
  NameDescription
Public methodDoubleSymBandMatrix(DoubleBandMatrix)
Constructs a DoubleSymBandMatrix instance from a square banded matrix.
Public methodDoubleSymBandMatrix(DoubleTriDiagMatrix)
Constructs a DoubleSymBandMatrix instance from a square tridiagonal matrix.
Public methodDoubleSymBandMatrix(Int32, Int32)
Constructs a DoubleSymBandMatrix instance with the specified number of rows, columns, and half bandwidth.
Public methodDoubleSymBandMatrix(DoubleMatrix, Int32)
Constructs a DoubleSymBandMatrix instance by extracting the symmetric part of a band of entries from a square matrix.
Public methodDoubleSymBandMatrix(DoubleVector, Int32, Int32)
Constructs a DoubleSymBandMatrix instance with the specified dimensions and half bandwidth using the data in the passed vector.
Top
Properties
  NameDescription
Public propertyBandwidth
Gets the bandwidth of the matrix.
Public propertyCols
Gets the number of columns in the matrix.
Public propertyDataVector
Gets the data vector referenced by this matrix.
Public propertyHalfBandwidth
Gets the half bandwidth of the matrix.
Public propertyItem
Gets and sets the value at the specified position.
Public propertyOrder
Gets the order of the matrix (the number of rows and columns).
Public propertyRows
Gets the number of rows in the matrix.
Top
Methods
  NameDescription
Public methodStatic memberAdd(Double, DoubleSymBandMatrix)
Adds a scalar to the non-zero elements of a banded matrix.
Public methodStatic memberAdd(DoubleSymBandMatrix, DoubleSymBandMatrix)
Adds two banded matrices.
Public methodStatic memberAdd(DoubleSymBandMatrix, Double)
Adds a scalar to the non-zero elements of a banded matrix.
Public methodClone
Creates a deep copy of this matrix.
Public methodDeepenThisCopy
Guarantees that there is only one reference to the underlying data and that this data is in contiguous storage.
Public methodDiagonal
Returns a vector view of the main diagonal of this matrix.
Public methodDiagonal(Int32)
Returns a vector view of a diagonal of this matrix.
Public methodStatic memberDivide(Double, DoubleSymBandMatrix)
Divides a scalar by the non-zero elements of a banded matrix.
Public methodStatic memberDivide(DoubleSymBandMatrix, DoubleSymBandMatrix)
Divides a banded matrix by another.
Public methodStatic memberDivide(DoubleSymBandMatrix, Double)
Divides the non-zero elements of a banded matrix by a scalar.
Public methodEquals
Tests for equality of this matrix and another matrix. Two matrices are equal if they have the same dimensions, upper bandwidth and all values are equal.
(Overrides ObjectEquals(Object).)
Public methodGetHashCode
Returns an integer hash code for this matrix.
(Overrides ObjectGetHashCode.)
Public methodLeadingSubmatrix
Returns the k by k upper left corner of the matrix.
Public methodStatic memberMultiply(Double, DoubleSymBandMatrix)
Multiplies the non-zero elements of a banded matrix by a scalar.
Public methodStatic memberMultiply(DoubleSymBandMatrix, DoubleSymBandMatrix)
Multiplies two banded matrices.
Public methodStatic memberMultiply(DoubleSymBandMatrix, Double)
Multiplies the non-zero elements of a banded matrix and a scalar.
Public methodStatic memberNegate
Negation operator.
Public methodResize(Int32)
Changes the dimensions of this matrix to those specified, adding zeros or truncating as necessary.
Public methodResize(Int32, Int32)
Changes the dimensions and half bandwidth of this matrix to those specified, adding zeros or truncating as necessary.
Public methodShallowCopy
Creates a shallow copy of this matrix.
Public methodStatic memberSubtract(Double, DoubleSymBandMatrix)
Subtracts the non-zero elements of a banded matrix from a scalar.
Public methodStatic memberSubtract(DoubleSymBandMatrix, DoubleSymBandMatrix)
Subtracts two banded matrices.
Public methodStatic memberSubtract(DoubleSymBandMatrix, Double)
Subtracts a scalar from the non-zero elements of a banded matrix.
Public methodCode exampleToCommaSeparated
Returns a formatted string representation of this matrix using commas and newlines.
Public methodCode exampleToCommaSeparated(String)
Returns a formatted string representation of this matrix using commas and newlines. Numbers are formatted using the specified format string.
Public methodToGeneralMatrix
Converts this symmetric banded matrix to a general matrix.
Public methodCode exampleToString (Overrides ObjectToString.)
Public methodCode exampleToString(String)
Public methodCode exampleToTabDelimited
Returns a formatted string representation of this matrix using tabs and newlines.
Public methodCode exampleToTabDelimited(String)
Returns a formatted string representation of this matrix using tabs and newlines. Numbers are formatted using the specified format string.
Public methodTranspose
Returns this matrix.
Top
Operators
  NameDescription
Public operatorStatic memberAddition(Double, DoubleSymBandMatrix)
Adds a scalar to the non-zero elements of a banded matrix.
Public operatorStatic memberAddition(DoubleSymBandMatrix, DoubleSymBandMatrix)
Adds two symmetric banded matrices.
Public operatorStatic memberAddition(DoubleSymBandMatrix, Double)
Adds a scalar to the non-zero elements of a banded matrix.
Public operatorStatic memberDivision(Double, DoubleSymBandMatrix)
Divides a scalar by the non-zero elements of a symmetric banded matrix.
Public operatorStatic memberDivision(DoubleSymBandMatrix, DoubleSymBandMatrix)
Divides a symmetric banded matrix by another.
Public operatorStatic memberDivision(DoubleSymBandMatrix, Double)
Divides the non-zero elements of a symmetric banded matrix by a scalar.
Public operatorStatic memberEquality
Tests for equality of two symmetric banded matrices. Two matrices are equal if they have the same dimensions, and half bandwidth, and all values are equal.
Public operatorStatic member(FloatSymBandMatrix to DoubleSymBandMatrix)
Implicitly converts a FloatSymBandMatrix instance into a DoubleSymBandMatrix instance.
Public operatorStatic memberInequality
Tests for equality of two symmetric banded matrices. Two matrices are equal if they have the same dimensions, and half bandwidths, and all values are equal.
Public operatorStatic memberMultiply(Double, DoubleSymBandMatrix)
Multiplies the non-zero elements of a symmetric banded matrix by a scalar.
Public operatorStatic memberMultiply(DoubleSymBandMatrix, DoubleSymBandMatrix)
Multiplies two symmetric banded matrices.
Public operatorStatic memberMultiply(DoubleSymBandMatrix, Double)
Multiplies the non-zero elements of a symmetric banded matrix and a scalar.
Public operatorStatic memberSubtraction(Double, DoubleSymBandMatrix)
Subtracts the non-zero elements of a symmetric banded matrix from a scalar.
Public operatorStatic memberSubtraction(DoubleSymBandMatrix, DoubleSymBandMatrix)
Subtracts two symmetric banded matrices.
Public operatorStatic memberSubtraction(DoubleSymBandMatrix, Double)
Subtracts a scalar from the non-zero elements of a symmetric banded matrix.
Public operatorStatic memberUnaryNegation
Negation operator.
Public operatorStatic memberUnaryPlus
Unary + operator. Just returns the input matrix.
Top
Remarks
If hb is the half bandwidth, then the element in the ith row, jth column is defined to be zero whenever j - i > hb. or i - j > hb.
The upper triangular part of the matrix is stored in a vector, column by column (zero elements and the lower triagular part of the matrix are not stored). There are some blank entries in the data vector so the each column takes up the same number of elements, half bandwidth + 1, in the vector. For example, the following 9 by 9 matrix with half bandwidth 2,
    | a11 a12 a13 0   0   0   0   0   0   |
    | a12 a22 a23 a24   0 0   0   0   0   |
    | a13 a23 a33 a34 a35 0   0   0   0   |
A = | 0   a24 a34 a44 a45 a46 0   0   0   |
    | 0   0   a35 a45 a55 a56 a57 0   0   |
    | 0   0   0   a46 a56 a66 a67 a68 0   |
    | 0   0   0   0   a57 a67 a77 a78 a79 |
    | 0   0   0   0   0   a68 a78 a88 a89 |
    | 0   0   0   0   0   0   a79 a89 a99 |
is stored in a data vector v as
v = [x   x   a11
     x   a12 a22
     a13 a23 a33
     a24 a34 a44
     a35 a45 a55
     a46 a56 a66
     a57 a67 a77
     a68 a78 a88
     a79 a89 a99 ]
where x denotes an unused location.
See Also