Click or drag to resize

ComplexMatrix Methods

The ComplexMatrix type exposes the following members.

Methods
  NameDescription
Public methodAdd(ComplexMatrix)
Creates a ComplexMatrix which is the sum of this matrix and the given matrix.
Public methodStatic memberAdd(ComplexMatrix, ComplexMatrix)
Creates a ComplexMatrix which is the sum of the two given matrices.
Public methodStatic memberAddAssign
Sets the sumComplexMatrix to equal the element-wise addition of the leftAddend and the rightAddend.
Protected methodCheckForSameDefinition(ComplexMatrix)
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).
Protected methodCheckForSameDefinition(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).)
Public methodClear
Sets the value of every value in the matrix to zero.
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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.)
Public methodStatic memberElementDivide
Creates a new ComplexMatrix which is the element-by-element division of the two given matrices.
Public methodStatic memberElementDivideAssign
Sets the quotient ComplexMatrix to equal the element-wise division of the dividend divided by the divisor.
Public methodElementMultiply(ComplexMatrix)
Creates a ComplexMatrix which is the element-by-element multiplication of this matrix times the given matrix.
Public methodStatic memberElementMultiply(ComplexMatrix, ComplexMatrix)
Creates a new ComplexMatrix which is the element-by-element multiplication of the two given matrices.
Public methodStatic memberElementMultiplyAssign
Sets the product ComplexMatrix to equal the element-wise multiplication of the multiplicand times the multiplier.
Public methodEnumerateDependencies
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.)
Public methodEquals
Indicates whether another object is exactly equal to this instance.
(Overrides ObjectEquals(Object).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.)
Public methodGetMatrix(Int32, Int32)
Gets a new matrix with the values of the specified subset of this matrix.
Public methodGetMatrix(Int32, Int32, Int32)
Gets a new matrix with the values of the specified subset of this matrix.
Public methodGetMatrix(Int32, Int32, Int32)
Gets a new matrix with the values of the specified subset of this matrix.
Public methodGetMatrix(Int32, Int32, ComplexMatrix)
Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.
Public methodGetMatrix(Int32, Int32, Int32, Int32)
Gets a new matrix with the values of the specified subset of this matrix.
Public methodGetMatrix(Int32, Int32, Int32, ComplexMatrix)
Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.
Public methodGetMatrix(Int32, Int32, Int32, ComplexMatrix)
Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.
Public methodGetMatrix(Int32, Int32, Int32, Int32, ComplexMatrix)
Places the values of a subsection of this matrix into the given matrix. The destination matrix must match the dimensions of the requested submatrix.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHermitianTranspose
Creates a new ComplexMatrix which is the Hermitian or conjugate transpose of the current matrix.
Public methodStatic memberIdentity
Generates an identity matrix
Public methodInverse
ComplexMatrix inverse.
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMultiply(Complex)
Returns the result of the multiplication of this matrix and a vector.
Public methodStatic memberMultiply(ComplexMatrix, ComplexMatrix)
Creates a ComplexMatrix which is the linear algebra multiplication of the two given matrices.
Public methodStatic memberMultiplyAssign
Sets the product ComplexMatrix to equal the linear algebra multiplication of the multiplicand times the multiplier.
Public methodPostMultiply
Creates a ComplexMatrix which is the linear algebra multiplication of this matrix times the given matrix.
Public methodPreMultiply
Creates a ComplexMatrix which is the linear algebra multiplication of the given matrix time this matrix.
Public methodStatic memberSubtract
Creates a ComplexMatrix whose elements have the values of the elements of the minuend matrix subtracted by the elements of the subtrahend matrix.
Public methodStatic memberSubtractAssign
Sets the difference ComplexMatrix to equal the element-wise subtraction of the minuend by the subtrahend.
Public methodSubtractFrom
Creates a ComplexMatrix whose elements have the values of the elements of this matrix subtracted by the elements of the given matrix.
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTranspose
Creates a new ComplexMatrix which is the transpose of the current matrix.
Top
See Also