Matrix Class |
Namespace: AGI.Foundation.Coordinates
The Matrix type exposes the following members.
Name | Description | |
---|---|---|
Matrix(Int32, Int32) |
Initializes a new instance with the specified dimensions.
| |
Matrix(Matrix, CopyContext) | Initializes a new instance as a copy of an existing instance. |
Name | Description | |
---|---|---|
ColumnDimension |
Gets the number of columns in this 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.
| |
RowDimension |
Gets the number of rows in this matrix.
|
Name | Description | |
---|---|---|
Add(Matrix, Matrix) | Creates a Matrix which is the sum of the two given matrices. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
Add(Matrix, Matrix3By3) |
Creates a Matrix which is the sum of the two given matrices.
| |
Add(Matrix, Matrix6By6) |
Creates a Matrix which is the sum of the two given matrices.
| |
Add(Matrix3By3, Matrix) |
Creates a Matrix which is the sum of the two given matrices.
| |
Add(Matrix6By6, Matrix) |
Creates a Matrix which is the sum of the two given matrices.
| |
AddAssign |
Sets the sum Matrix to equal the element-wise addition
of the leftAddend and the rightAddend.
| |
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).
(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).) | |
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).
| |
Clone |
Clones this object using the specified context.
(Inherited from DefinitionalObject.) | |
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 DefinitionalObjectComputeCurrentDefinitionHashCode.) | |
ElementDivide(Matrix, Matrix) | Creates a new Matrix which is the element-by-element division of the two given matrices. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
ElementDivide(Matrix, Matrix3By3) |
Creates a new Matrix which is the element-by-element division of
the two given matrices.
| |
ElementDivide(Matrix, Matrix6By6) |
Creates a new Matrix which is the element-by-element division of
the two given matrices.
| |
ElementDivide(Matrix3By3, Matrix) |
Creates a new Matrix which is the element-by-element division of
the two given matrices.
| |
ElementDivide(Matrix6By6, Matrix) |
Creates a new Matrix which is the element-by-element division of
the two given matrices.
| |
ElementDivideAssign |
Sets the quotient Matrix to equal the element-wise division
of the dividend divided by the divisor.
| |
ElementMultiply(Matrix, Matrix) | Creates a new Matrix which is the element-by-element multiplication of the two given matrices. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
ElementMultiply(Matrix, Matrix3By3) |
Creates a new Matrix which is the element-by-element multiplication of
the two given matrices.
| |
ElementMultiply(Matrix, Matrix6By6) |
Creates a new Matrix which is the element-by-element multiplication of
the two given matrices.
| |
ElementMultiply(Matrix3By3, Matrix) |
Creates a new Matrix which is the element-by-element multiplication of
the two given matrices.
| |
ElementMultiply(Matrix6By6, Matrix) |
Creates a new Matrix which is the element-by-element multiplication of
the two given matrices.
| |
ElementMultiplyAssign |
Sets the product Matrix to equal the element-wise multiplication
of the multiplicand times the multiplier.
| |
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(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Equals(Matrix, Matrix) |
Indicates whether the two provided matrices hold the same data. The type of matrix is not examined, only their dimensions
and the value of the elements at each index.
| |
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.
| |
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.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetMatrix(Int32, Int32) |
Gets a new matrix with the values of the specified subset of this matrix.
| |
GetMatrix(Int32, Int32, Int32) |
Gets a new matrix with the values of the specified subset of this matrix.
| |
GetMatrix(Int32, Int32, Int32) |
Gets a new matrix with the values of the specified subset of this 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.
| |
GetMatrix(Int32, Int32, Int32, Int32) |
Gets a new matrix with the values of the specified subset of this 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.
| |
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.
| |
GetMatrix(Int32, 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.
| |
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(Double) |
Creates a new Matrix which has the value of the current matrix multiplied by the given factor.
| |
Multiply(Matrix, Matrix) | Creates a Matrix which is the linear algebra multiplication of the two given matrices. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
Multiply(Matrix, Matrix3By3) |
Creates a Matrix which is the linear algebra multiplication of
the two given matrices.
| |
Multiply(Matrix, Matrix6By6) |
Creates a Matrix which is the linear algebra multiplication of
the two given matrices.
| |
Multiply(Matrix3By3, Matrix) |
Creates a Matrix which is the linear algebra multiplication of
the two given matrices.
| |
Multiply(Matrix6By6, Matrix) |
Creates a Matrix which is the linear algebra multiplication of
the two given matrices.
| |
MultiplyAssign |
Sets the product Matrix to equal the linear algebra multiplication
of the multiplicand times the multiplier.
| |
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.
| |
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.
| |
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.
| |
SetMatrix(Int32, 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.
| |
SetMatrix(Int32, Int32, Matrix, Int32, Int32) |
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.
| |
Subtract(Matrix, Matrix) | Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
Subtract(Matrix, Matrix3By3) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
| |
Subtract(Matrix, Matrix6By6) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
| |
Subtract(Matrix3By3, Matrix) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
| |
Subtract(Matrix6By6, Matrix) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
| |
SubtractAssign |
Sets the difference Matrix to equal the element-wise subtraction
of the minuend by the subtrahend.
| |
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.
(Overrides ObjectToString.) | |
Transpose |
Creates a new Matrix which is the transpose of the current matrix.
|
Name | Description | |
---|---|---|
Addition(Matrix, Matrix) | Creates a Matrix which is the sum of the two given matrices. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
Addition(Matrix, Matrix3By3) |
Creates a Matrix which is the sum of the two given matrices.
| |
Addition(Matrix, Matrix6By6) |
Creates a Matrix which is the sum of the two given matrices.
| |
Addition(Matrix3By3, Matrix) |
Creates a Matrix which is the sum of the two given matrices.
| |
Addition(Matrix6By6, Matrix) |
Creates a Matrix which is the sum of the two given matrices.
| |
Multiply(Double, Matrix) |
Creates a new Matrix which has the value of the given matrix multiplied by the given factor.
| |
Multiply(Matrix, Matrix) | Creates a Matrix which is the linear algebra multiplication of the two given matrices. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
Multiply(Matrix, Matrix3By3) | Creates a Matrix which is the linear algebra multiplication of the two given matrices. | |
Multiply(Matrix, Matrix6By6) | Creates a Matrix which is the linear algebra multiplication of the two given matrices. | |
Multiply(Matrix, Double) |
Creates a new Matrix which has the value of the given matrix multiplied by the given factor.
| |
Multiply(Matrix3By3, Matrix) | Creates a Matrix which is the linear algebra multiplication of the two given matrices. | |
Multiply(Matrix6By6, Matrix) | Creates a Matrix which is the linear algebra multiplication of the two given matrices. | |
Subtraction(Matrix, Matrix) | Creates a Matrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix. The most efficient operation to do this is chosen through double dispatch based on the concrete types of the given matrices. | |
Subtraction(Matrix, Matrix3By3) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
| |
Subtraction(Matrix, Matrix6By6) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
| |
Subtraction(Matrix3By3, Matrix) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
| |
Subtraction(Matrix6By6, Matrix) |
Creates a Matrix whose elements have the values of the elements of the minuend matrix
subtracted by the elements of the subtrahend matrix.
|