Struct SemanticExtensionRuleSet 

pub struct SemanticExtensionRuleSet { /* private fields */ }

Explicit clone-on-write set of semantic extension AD rules.

Implementations

impl SemanticExtensionRuleSet

pub fn new() -> Self

Construct an empty rule set.

pub fn register_linearize( &mut self, rule: Arc<dyn SemanticLinearizeRule>, ) -> Result<(), SemanticExtensionRegistryError>

Register one semantic linearize rule.

Errors

Returns SemanticExtensionRegistryError::MalformedFamilyId for an invalid family or SemanticExtensionRegistryError::DuplicateRule for an existing family in this role.

pub fn register_linear_transpose( &mut self, rule: Arc<dyn SemanticLinearTransposeRule>, ) -> Result<(), SemanticExtensionRegistryError>

Register one semantic linear-transpose rule.

Errors

Returns SemanticExtensionRegistryError::MalformedFamilyId for an invalid family or SemanticExtensionRegistryError::DuplicateRule for an existing family in this role.

pub fn register_primal_vjp( &mut self, rule: Arc<dyn SemanticPrimalVjpRule>, ) -> Result<(), SemanticExtensionRegistryError>

Register one direct semantic primal-VJP rule.

Errors

Returns SemanticExtensionRegistryError::MalformedFamilyId for an invalid family or SemanticExtensionRegistryError::DuplicateRule for an existing family in this role.

pub fn with_linearize( self, rule: Arc<dyn SemanticLinearizeRule>, ) -> Result<Self, SemanticExtensionRegistryError>

Return a rule set containing one semantic linearize rule.

Errors

Returns SemanticExtensionRegistryError::MalformedFamilyId for an invalid family or SemanticExtensionRegistryError::DuplicateRule for an existing linearize rule.

pub fn with_linear_transpose( self, rule: Arc<dyn SemanticLinearTransposeRule>, ) -> Result<Self, SemanticExtensionRegistryError>

Return a rule set containing one semantic linear-transpose rule.

Errors

Returns SemanticExtensionRegistryError::MalformedFamilyId for an invalid family or SemanticExtensionRegistryError::DuplicateRule for an existing linear-transpose rule.

pub fn with_primal_vjp( self, rule: Arc<dyn SemanticPrimalVjpRule>, ) -> Result<Self, SemanticExtensionRegistryError>

Return a rule set containing one direct semantic primal-VJP rule.

Errors

Returns SemanticExtensionRegistryError::MalformedFamilyId for an invalid family or SemanticExtensionRegistryError::DuplicateRule for an existing primal-VJP rule.

pub fn merge( &mut self, other: Self, ) -> Result<(), SemanticExtensionRegistryError>

Merge another rule set atomically.

Errors

Returns SemanticExtensionRegistryError::MalformedFamilyId for an invalid family or SemanticExtensionRegistryError::DuplicateRule for a role-equivalent duplicate. The receiver is unchanged on failure.

pub fn lookup_linearize( &self, family_id: &str, ) -> Option<Arc<dyn SemanticLinearizeRule>>

Look up a semantic linearize rule by extension family.

pub fn lookup_linear_transpose( &self, family_id: &str, ) -> Option<Arc<dyn SemanticLinearTransposeRule>>

Look up a semantic linear-transpose rule by extension family.

pub fn lookup_primal_vjp( &self, family_id: &str, ) -> Option<Arc<dyn SemanticPrimalVjpRule>>

Look up a direct semantic primal-VJP rule by extension family.

pub fn linearize_operation( &self, operation: SemanticOperationView<'_>, primal_inputs: &[ProgramValue], primal_outputs: &[ProgramValue], tangent_inputs: &[AdValue], active_outputs: &[bool], builder: &mut SemanticProgramBuilder, ) -> Result<SemanticLinearizeResult, SemanticAdError>

Validate and dispatch one semantic extension linearization.

Errors

Returns SemanticAdError::CoreOperation for a core operation, SemanticAdError::EffectfulExtension before rule dispatch for an effectful extension, or typed rule/arity/ownership/build failures.

pub fn linear_transpose_operation( &self, operation: SemanticOperationView<'_>, primal_inputs: &[ProgramValue], primal_outputs: &[ProgramValue], cotangent_outputs: &[AdValue], active_inputs: &[bool], residuals: &[ProgramValue], builder: &mut SemanticProgramBuilder, ) -> Result<Box<[AdValue]>, SemanticAdError>

Validate and dispatch one semantic extension linear transpose.

Errors

Returns SemanticAdError::EffectfulExtension before rule dispatch, SemanticAdError::MissingRule when no transpose rule exists, SemanticAdError::Arity / SemanticAdError::ForeignValue for an invalid request or result, or a typed family-rule failure.

pub fn primal_vjp_operation( &self, operation: SemanticOperationView<'_>, primal_inputs: &[ProgramValue], primal_outputs: &[ProgramValue], cotangent_outputs: &[AdValue], active_inputs: &[bool], builder: &mut SemanticProgramBuilder, ) -> Result<Box<[AdValue]>, SemanticAdError>

Validate and dispatch one direct semantic primal VJP.

Errors

Returns SemanticAdError::EffectfulExtension before rule dispatch, SemanticAdError::MissingRule when no primal-VJP rule exists, SemanticAdError::Arity / SemanticAdError::ForeignValue for an invalid request or result, or a typed family-rule failure.

Trait Implementations

impl Clone for SemanticExtensionRuleSet

fn clone(&self) -> SemanticExtensionRuleSet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SemanticExtensionRuleSet

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

Formats the value using the given formatter.

impl Default for SemanticExtensionRuleSet

fn default() -> SemanticExtensionRuleSet

Returns the “default value” for a type.