ReadOnlyComplexMatrix Class

Represents a read only collection of complex values arranged in rows and columns. Provides methods to operate algebraically on matrices when operands are both writable and read only.

Definition

Namespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.1.0+428f3840cfab98dda567bb0ed350b302533e273a

C#
public class ReadOnlyComplexMatrix : IEnumerable<Complex>, 
	IEnumerable, IList<Complex>, ICollection<Complex>, 
	IReadOnlyList<Complex>, IReadOnlyCollection<Complex>, IComplexMatrixPatterns, 
	IMatrixPatterns, IReadOnlyTabularCollection<Complex, ComplexMatrix>, ITabularCollection<Complex, ComplexMatrix>

VB
Public Class ReadOnlyComplexMatrix
	Implements IEnumerable(Of Complex), IEnumerable, 
	IList(Of Complex), ICollection(Of Complex), IReadOnlyList(Of Complex), 
	IReadOnlyCollection(Of Complex), IComplexMatrixPatterns, IMatrixPatterns, IReadOnlyTabularCollection(Of Complex, ComplexMatrix), 
	ITabularCollection(Of Complex, ComplexMatrix)

C++
public ref class ReadOnlyComplexMatrix : IEnumerable<Complex>, 
	IEnumerable, IList<Complex>, ICollection<Complex>, 
	IReadOnlyList<Complex>, IReadOnlyCollection<Complex>, IComplexMatrixPatterns, 
	IMatrixPatterns, IReadOnlyTabularCollection<Complex, ComplexMatrix^>, ITabularCollection<Complex, ComplexMatrix^>

F#
type ReadOnlyComplexMatrix = 
    class
        interface IEnumerable<Complex>
        interface IEnumerable
        interface IList<Complex>
        interface ICollection<Complex>
        interface IReadOnlyList<Complex>
        interface IReadOnlyCollection<Complex>
        interface IComplexMatrixPatterns
        interface IMatrixPatterns
        interface IReadOnlyTabularCollection<Complex, ComplexMatrix>
        interface ITabularCollection<Complex, ComplexMatrix>
    end

Inheritance: Object ReadOnlyComplexMatrix

Implements: IComplexMatrixPatterns, IMatrixPatterns, IReadOnlyTabularCollection<Complex, ComplexMatrix>, ITabularCollection<Complex, ComplexMatrix>, ICollection<Complex>, IEnumerable<Complex>, IList<Complex>, IReadOnlyCollection<Complex>, IReadOnlyList<Complex>, IEnumerable

Properties

ColumnNames	Exposes the dictionary of column names, keyed by column indexes.
Count	Gets the number of entries in this instance.
HasColumnNames	Gets a value indicating whether this instance has at least a named column.
HasRowNames	Gets a value indicating whether this instance has at least a named row.
IsBidiagonal	Gets a value indicating whether this instance is bidiagonal.
IsColumnVector	Gets a value indicating whether this instance is a column vector.
IsDiagonal	Gets a value indicating whether this instance is diagonal.
IsHermitian	Gets a value indicating whether this instance is Hermitian.
IsHessenberg	Gets a value indicating whether this instance is Hessenberg.
IsLowerBidiagonal	Gets a value indicating whether this instance is lower bidiagonal.
IsLowerHessenberg	Gets a value indicating whether this instance is lower Hessenberg.
IsLowerTriangular	Gets a value indicating whether this instance is lower triangular.
IsReadOnly	Gets a value indicating whether this instance is read-only.
IsRowVector	Gets a value indicating whether this instance is a row vector.
IsScalar	Gets a value indicating whether this instance is scalar.
IsSkewHermitian	Gets a value indicating whether this instance is Skew-Hermitian.
IsSkewSymmetric	Gets a value indicating whether this instance is skew symmetric.
IsSquare	Gets a value indicating whether this instance is square.
IsSymmetric	Gets a value indicating whether this instance is symmetric.
IsTriangular	Gets a value indicating whether this instance is triangular.
IsTridiagonal	Gets a value indicating whether this instance is tridiagonal.
IsUpperBidiagonal	Gets a value indicating whether this instance is upper bidiagonal.
IsUpperHessenberg	Gets a value indicating whether this instance is upper Hessenberg.
IsUpperTriangular	Gets a value indicating whether this instance is upper triangular.
IsVector	Gets a value indicating whether this instance is a vector.
Item[Int32]	Gets the entry of this instance corresponding to the specified linear index.
Item[IndexCollection, IndexCollection]	Gets the elements of this instance corresponding to the specified row and column indexes.
Item[IndexCollection, Int32]	Gets the elements of this instance corresponding to the specified row and column indexes.
Item[IndexCollection, String]	Gets the elements of this instance corresponding to the specified row and column indexes.
Item[Int32, IndexCollection]	Gets the elements of this instance corresponding to the specified row and column indexes.
Item[Int32, Int32]	Gets the element of this instance corresponding to the specified row and column indexes.
Item[Int32, String]	Gets the elements of this instance corresponding to the specified row and column indexes.
Item[String, IndexCollection]	Gets the elements of this instance corresponding to the specified row and column indexes.
Item[String, Int32]	Gets the elements of this instance corresponding to the specified row and column indexes.
Item[String, String]	Gets the elements of this instance corresponding to the specified row and column indexes.
LowerBandwidth	Gets the lower bandwidth of this instance.
Name	Gets or sets the name of this instance.
NumberOfColumns	Gets the number of columns of this instance.
NumberOfRows	Gets the number of rows of this instance.
RowNames	Exposes the dictionary of row names, keyed by row indexes.
StorageOrder	Gets the storage order of this instance.
StorageScheme	Gets the storage scheme of this instance.
UpperBandwidth	Gets the upper bandwidth of this instance.

Methods

Add(Complex, ReadOnlyComplexMatrix)	Determines the addition of a scalar to a matrix.
Add(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Add(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Add(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the sum of two matrices.
Add(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the sum of two matrices.
Add(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Add(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the sum of two matrices.
Add(ReadOnlyComplexMatrix, Complex)	Determines the addition of a matrix to a scalar.
Add(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Apply	Evaluates the specified function at each entry of this instance, and returns a matrix whose entries are given by the corresponding function values.
AsColumnMajorDenseArray	Returns a column major ordered, dense representation of this instance.
Conjugate	Returns the conjugate of this instance.
ConjugateTranspose	Returns the conjugate transpose of this instance.
Contains	Determines whether the ICollection<T> contains a specific value.
CopyTo	Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
Divide(Complex, ReadOnlyComplexMatrix)	Determines the division of a scalar by a matrix.
Divide(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
Divide(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
Divide(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the division of a matrix by another.
Divide(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the division of a matrix by another.
Divide(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
Divide(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the division of a matrix by another.
Divide(ReadOnlyComplexMatrix, Complex)	Determines the division of a matrix by a scalar.
Divide(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
ElementWiseMultiply(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the element wise product of two matrices.
ElementWiseMultiply(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the element wise product of two matrices.
ElementWiseMultiply(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the element wise product of two matrices.
ElementWiseMultiply(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the element wise product of two matrices.
ElementWiseMultiply(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the element wise product of two matrices.
ElementWiseMultiply(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the element wise product of two matrices.
ElementWiseMultiply(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the element wise product of two matrices.
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
Find	Searches for entries in this instance that equal the specified value, and returns their zero-based linear indexes.
FindNonzero	Searches for nonzero entries in this instance, and returns their zero-based linear indexes.
FindWhile	Searches for entries in this instance that matches the conditions defined by the specified predicate, and returns their zero-based linear indexes.
GetEnumerator	Returns an enumerator that iterates through the collection.
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
IndexOf	Determines the index of a specific item in the IList<T>.
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
Multiply(Complex, ReadOnlyComplexMatrix)	Determines the multiplication of a scalar by a matrix.
Multiply(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Multiply(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, Complex)	Determines the multiplication of a matrix by a scalar.
Multiply(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Negate	Determines the negation of a matrix.
Subtract(Complex, ReadOnlyComplexMatrix)	Determines the subtraction of a matrix from a scalar.
Subtract(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
Subtract(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
Subtract(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the difference between two matrices.
Subtract(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the difference between two matrices.
Subtract(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
Subtract(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the difference between two matrices.
Subtract(ReadOnlyComplexMatrix, Complex)	Determines the subtraction of a scalar from a matrix.
Subtract(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
ToComplex	Converts from ReadOnlyComplexMatrix to Double.
ToString	Returns a String that represents this instance. (Overrides Object.ToString())
Transpose	Returns the transpose of this instance.
TryGetColumnName	Tries to get the name of the specified column.
TryGetRowName	Tries to get the name of the specified row.
Vec()	Returns the vectorization of this instance.
Vec(IndexCollection)	Returns a column vector obtained by stacking the specified elements of this instance.

Operators

Addition(Complex, ReadOnlyComplexMatrix)	Determines the addition of a scalar to a matrix.
Addition(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Addition(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Addition(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the sum of two matrices.
Addition(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the sum of two matrices.
Addition(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Addition(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the sum of two matrices.
Addition(ReadOnlyComplexMatrix, Complex)	Determines the addition of a matrix to a scalar.
Addition(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the sum of two matrices.
Division(Complex, ReadOnlyComplexMatrix)	Determines the division of a scalar by a matrix.
Division(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
Division(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
Division(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the division of a matrix by another.
Division(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the division of a matrix by another.
Division(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
Division(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the division of a matrix by another.
Division(ReadOnlyComplexMatrix, Complex)	Determines the division of a matrix by a scalar.
Division(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the division of a matrix by another.
Explicit(ReadOnlyComplexMatrix to Complex)	Performs an explicit conversion from ReadOnlyComplexMatrix to Double.
Multiply(Complex, ReadOnlyComplexMatrix)	Determines the multiplication of a scalar by a matrix.
Multiply(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Multiply(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the product of two matrices.
Multiply(ReadOnlyComplexMatrix, Complex)	Determines the multiplication of a matrix by a scalar.
Multiply(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the product of two matrices.
Subtraction(Complex, ReadOnlyComplexMatrix)	Determines the subtraction of a matrix from a scalar.
Subtraction(ComplexMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
Subtraction(DoubleMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
Subtraction(ReadOnlyComplexMatrix, ComplexMatrix)	Determines the difference between two matrices.
Subtraction(ReadOnlyComplexMatrix, DoubleMatrix)	Determines the difference between two matrices.
Subtraction(ReadOnlyComplexMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
Subtraction(ReadOnlyComplexMatrix, ReadOnlyDoubleMatrix)	Determines the difference between two matrices.
Subtraction(ReadOnlyComplexMatrix, Complex)	Determines the subtraction of a scalar from a matrix.
Subtraction(ReadOnlyDoubleMatrix, ReadOnlyComplexMatrix)	Determines the difference between two matrices.
UnaryNegation(ReadOnlyComplexMatrix)	Determines the negation of a matrix.

Explicit Interface Implementations

ICollection<Complex>.Add	Adds an item to the ICollection<T>. This implementation always throws a NotSupportedException.
ICollection<Complex>.Clear	Removes all items from the ICollection<T>. This implementation always throws a NotSupportedException.
ICollection<Complex>.Remove	Removes the first occurrence of a specific object from the ICollection<T>. This implementation always throws a NotSupportedException.
IEnumerable.GetEnumerator	Returns an enumerator that iterates through a collection.
IList<Complex>.Insert	Inserts an item to the IList<T> at the specified index. This implementation always throws a NotSupportedException.
IList<Complex>.Item	Gets the element at the specified index. A NotSupportedException occurs if you try to set the item at the specified index.
IList<Complex>.RemoveAt	Removes the IList<T> item at the specified index. This implementation always throws a NotSupportedException.
ITabularCollection<Complex, ComplexMatrix>.Item[IndexCollection, IndexCollection]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[IndexCollection, Int32]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[IndexCollection, String]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[Int32, IndexCollection]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[Int32, Int32]	Gets or sets the element of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[Int32, String]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[String, IndexCollection]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[String, Int32]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.
ITabularCollection<Complex, ComplexMatrix>.Item[String, String]	Gets or sets the elements of this instance corresponding to the specified row and column indexes.