Struct CalculusBuilder 

pub struct CalculusBuilder { /* private fields */ }

Builder for topologically ordered calculus definitions within the size limits.

Implementations

§

impl CalculusBuilder

Signature links:CalculusBuilder

pub fn jvp( &mut self, root: CalculusNodeId, directions: &[(u16, CalculusNodeId)], ) -> Result<CalculusNodeId, PureOperatorError>

Signature links:jvpCalculusNodeIdu16CalculusNodeIdResultCalculusNodeIdPureOperatorError

Apply the scalar output’s Jacobian to ordered, independently typed input blocks. Each direction has its selected input’s units; the result has the output’s units. Formals that are not selected are held fixed. No matrix is assembled.

Errors

Rejects empty, duplicate, or invalid selections, incompatible direction types, unsupported derivatives, and calculus resource limits. On error nothing is appended.

pub fn vjp( &mut self, root: CalculusNodeId, cotangent: CalculusNodeId, formals: &[u16], ) -> Result<Vec<CalculusNodeId>, PureOperatorError>

Signature links:vjpCalculusNodeIdCalculusNodeIdu16ResultVecCalculusNodeIdPureOperatorError

Pull a scalar output cotangent back through ordered, typed input blocks. The real dual pairing is dimensionless: the seed has reciprocal output units, and each returned block has the reciprocal units of its selected input. Uses the same typed map and first-partial transform as jvp.

Errors

Rejects empty or duplicate selections, invalid formals, a seed that is not dual to the output, unsupported derivatives, and calculus resource limits. On error the builder is left unchanged.

§

impl CalculusBuilder

Signature links:CalculusBuilder

pub fn apply_scalar( &mut self, definition: &PureOperatorDefinition, arguments: &[CalculusNodeId], ) -> Result<CalculusNodeId, PureOperatorError>

Signature links:apply_scalarPureOperatorDefinitionCalculusNodeIdResultCalculusNodeIdPureOperatorError

Substitute checked scalar argument expressions into a closed scalar definition. The caller resolves lexical names and rejects recursive definition graphs. No polynomial normalization or reassociation is performed.

§

impl CalculusBuilder

Signature links:CalculusBuilder

pub fn partial( &mut self, root: CalculusNodeId, formal: u16, ) -> Result<CalculusNodeId, PureOperatorError>

Signature links:partialCalculusNodeIdu16ResultCalculusNodeIdPureOperatorError

Append the first partial derivative of an explicit real scalar polynomial with respect to one declared formal, holding all other formals fixed.

The original input occurrences and product-rule order are kept. A constant result is zero, with the quotient dimension. Explicit validity requirements keep their original predicate even when the derivative is zero; predicates are not differentiated. On error nothing is appended, and the existing node and depth limits apply.

Errors

Rejects invalid nodes or formals, unconstrained or non-real scalar input types, unsupported derivative rules, and unrepresentable dimensions.

§

impl CalculusBuilder

Signature links:CalculusBuilder

pub fn value_type( &self, node: CalculusNodeId, ) -> Result<ValueType, PureOperatorError>

Signature links:value_typeCalculusNodeIdResultValueTypePureOperatorError

Resolve the concrete scalar type of a component from the calculus type check. Unconstrained generic dimensions or scalar domains cannot give a concrete type.

§

impl CalculusBuilder

Signature links:CalculusBuilder

pub fn new( formals: impl IntoIterator<Item = PureValueClass>, result: PureValueClass, ) -> Result<CalculusBuilder, PureOperatorError>

Signature links:newIntoIteratorPureValueClassPureValueClassResultCalculusBuilderPureOperatorError

Start a definition.

Errors

Rejects an empty or oversized formal list and invalid result references.

pub fn push( &mut self, node: CalculusNode, ) -> Result<CalculusNodeId, PureOperatorError>

Signature links:pushCalculusNodeResultCalculusNodeIdPureOperatorError

Append one node.

Errors

Rejects forward references, invalid formal/axis use, excessive node count, or excessive expression depth.

pub fn finish( self, root: CalculusNodeId, ) -> Result<PureOperatorDefinition, PureOperatorError>

Signature links:finishCalculusNodeIdResultPureOperatorDefinitionPureOperatorError

Finish a non-empty definition.

Errors

Rejects a missing root or a body whose dimensional type does not match the declared result rule for every admissible formal dimension.

Trait Implementations

§

impl Debug for CalculusBuilder

Signature links:DebugCalculusBuilder

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Signature links:fmtFormatterResult()Error

Formats the value using the given formatter.