Click or drag to resize

PartialDerivativesFixed Class

An object with fixed partial derivatives.

PartialDerivativesFixed and PartialDerivativesSum are meant as types to be used during the creation of a PartialDerivativesEvaluator. For example a PartialDerivativesFixed is used to represent an identity partial or a partial with zero partial derivatives, and a PartialDerivativesSum is used to aggregate the partial derivatives of different terms of within a type. You generally should not use either of these types as permanent objects which exist outside of a call to produce an evaluator.

Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.NumericalMethods.AdvancedPartialDerivativesFixed

Namespace:  AGI.Foundation.NumericalMethods.Advanced
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 22.2.414.0 (22.2.414.0)
Syntax
public class PartialDerivativesFixed : DefinitionalObject, 
	IPartialDifferentiable, IEquatableDefinition

The PartialDerivativesFixed type exposes the following members.

Constructors
  NameDescription
Protected methodPartialDerivativesFixed
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyDependencies
Gets the read only list of the IPartialDifferentiable representing the objects the PartialDerivatives are with respect to.
Public propertyDimension
Gets the dimension of the values produced by the object. For example, Vectors would have a dimension of three, and Scalars of one. A PartialDerivativesEvaluator created by this type will have a "RowDimension" equal to this property, and a "ColumnDimension equal to the summation of the dimensions of the independent variables that this object is dependent on.
Public propertyIsFrozen
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.)
Public propertyPartialDerivatives
Gets the Matrix of the fixed partial derivatives of the Subject with respect to the Dependencies.
Public propertySubject
Gets the entity whose partials are represented by this fixed object.
Top
Methods
  NameDescription
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).)
Protected methodCheckForSameDefinition(PartialDerivativesFixed)
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).
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 memberCreatePartialDerivativesWithRespectToNothing
Creates a new instance that represents the partials of an entity with respect to nothing. This takes the form of a PartialDerivativesFixed where the Subject is the given partial, the Dependencies list is empty, and the PartialDerivatives are a matrix with the RowDimension of the given partial and a ColumnDimension of zero.
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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from 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
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPartialDerivativesEvaluator
Gets an evaluator that returns the fixed PartialDerivatives with respect to any of the parameters in the provided generalized state.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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.)
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.)
Top
See Also