STK Components for .NET 2020 r2

## DiagonalMatrix Class |

An implementation of a square Matrix whose diagonal elements are
the only ones with a non-zero value.

Inheritance Hierarchy

SystemObject

AGI.Foundation.InfrastructureDefinitionalObject

AGI.Foundation.CoordinatesMatrix

AGI.Foundation.CoordinatesDiagonalMatrix

AGI.Foundation.InfrastructureDefinitionalObject

AGI.Foundation.CoordinatesMatrix

AGI.Foundation.CoordinatesDiagonalMatrix

Syntax

The DiagonalMatrix type exposes the following members.

Constructors

Name | Description | |
---|---|---|

DiagonalMatrix(Double) |
Initializes a new instance which has the dimension of the length of the given array, and whose diagonal elements
take on the values of the contents of the array.
| |

DiagonalMatrix(Int32) |
Initializes a new instance with the given dimension.
All elements of the matrix will be zero.
| |

DiagonalMatrix(Int32, Double) |
Initializes a new instance with the given dimension.
All diagonal elements are set to the given value.
| |

DiagonalMatrix(DiagonalMatrix, CopyContext) | Initializes a new instance as a copy of an existing instance. |

Properties

Name | Description | |
---|---|---|

ColumnDimension |
Gets the number of columns in this matrix.
(Inherited from Matrix.) | |

IsFrozen |
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an
ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.) | |

Item |
Gets or sets the value of the element at the given location.
(Overrides MatrixItemInt32, Int32.) | |

RowDimension |
Gets the number of rows in this matrix.
(Inherited from Matrix.) |

Methods

Name | Description | |
---|---|---|

CheckForSameDefinition(DefinitionalObject) |
Checks to determine if another instance has the same definition as this instance and
returns if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from Matrix.) | |

CheckForSameDefinition(DiagonalMatrix) |
Checks to determine if another instance has the same definition as this instance and
returns if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
| |

CheckForSameDefinition(Matrix) |
Checks to determine if another instance has the same definition as this instance and
returns if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides MatrixCheckForSameDefinition(Matrix).) | |

Clone |
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).) | |

ComputeCurrentDefinitionHashCode |
Computes a hash code based on the current properties of this object. Derived classes MUST override this
method and compute a hash code that combines: a unique hash code seed, the base implementation result, and
the hash codes of all new fields introduced by the derived class which are used in the
CheckForSameDefinition(DefinitionalObject) method.
(Overrides MatrixComputeCurrentDefinitionHashCode.) | |

EnumerateDependencies |
Enumerates the dependencies of this object by calling
EnumerateT(T) for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.
(Inherited from DefinitionalObject.) | |

Equals |
Indicates whether another object is exactly equal to this instance.
(Overrides ObjectEquals(Object).) | |

EqualsEpsilon |
Indicates whether each cell value of another instance of this type
is within the required tolerance of the corresponding coordinate value of this instance.
(Inherited from Matrix.) | |

Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |

Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) | |

FreezeAggregatedObjects |
Called by Freeze to also freeze any objects that are considered to be a part of this object.
Derived classes which contain additional aggregated objects MUST override this method, call the base
implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be
frozen in this method are frequently created in this object's constructor and are not settable via
properties.
(Inherited from DefinitionalObject.) | |

GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |

GetFrozenCopy |
Gets a frozen copy of this Matrix. If this matrix is already frozen it returns a reference
to itself, otherwise it clones itself, freezes the clone, and returns that object.
(Inherited from Matrix.) | |

GetHashCode |
Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.) | |

GetMatrix(Int32, Int32) |
Gets a new matrix with the values of the specified subset of this matrix.
(Inherited from Matrix.) | |

GetMatrix(Int32, Int32, Int32) |
Gets a new matrix with the values of the specified subset of this matrix.
(Inherited from Matrix.) | |

GetMatrix(Int32, Int32, Int32) |
Gets a new matrix with the values of the specified subset of this matrix.
(Inherited from Matrix.) | |

GetMatrix(Int32, Int32, Matrix) |
Places the values of a subsection of this matrix into the given matrix. The destination
matrix must match the dimensions of the requested submatrix.
(Inherited from Matrix.) | |

GetMatrix(Int32, Int32, Int32, Int32) |
Gets a new matrix with the values of the specified subset of this matrix.
(Inherited from Matrix.) | |

GetMatrix(Int32, Int32, Int32, Matrix) |
Places the values of a subsection of this matrix into the given matrix. The destination
matrix must match the dimensions of the requested submatrix.
(Inherited from Matrix.) | |

GetMatrix(Int32, Int32, Int32, Matrix) |
Places the values of a subsection of this matrix into the given matrix. The destination
matrix must match the dimensions of the requested submatrix.
(Inherited from Matrix.) | |

GetMatrix(Int32, Int32, Int32, Int32, Matrix) | ||

GetType | Gets the Type of the current instance. (Inherited from Object.) | |

IsSameDefinition |
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.) | |

MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |

Multiply |
Creates a new Matrix which has the value of the current matrix multiplied by the given factor.
(Overrides MatrixMultiply(Double).) | |

SetMatrix(Int32, Int32, Matrix) |
Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
The origin matrix must match the dimensions of the requested submatrix.
(Inherited from Matrix.) | |

SetMatrix(Int32, Int32, Int32, Matrix) |
Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
The origin matrix must match the dimensions of the requested submatrix.
(Inherited from Matrix.) | |

SetMatrix(Int32, Int32, Int32, Matrix) |
Sets the contents of a subset of this matrix to equal the values of the given origin matrix.
The origin matrix must match the dimensions of the requested submatrix.
(Inherited from Matrix.) | |

SetMatrix(Int32, Int32, Int32, Int32, Matrix) | ||

SetMatrix(Int32, Int32, Matrix, Int32, Int32) | ||

ThrowIfFrozen |
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.) | |

ToString |
Returns a string representation of the matrix.
(Inherited from Matrix.) | |

Transpose |
Creates a new Matrix which is the transpose of the current matrix.
(Overrides MatrixTranspose.) |

See Also