Skip to main content

CasDiffRegistry

Struct CasDiffRegistry 

Source
pub struct CasDiffRegistry {
    pub rules: BTreeMap<Symbol, DiffRule>,
}
Expand description

A registry of per-operator differentiation rules.

§Examples

use sim_kernel::Symbol;
use sim_lib_numbers_cas::CasExpr;
use sim_lib_numbers_cas_diff::CasDiffRegistry;

let mut registry = CasDiffRegistry::new();
registry.register_rule(
    Symbol::new("id"),
    Box::new(|args: &[CasExpr], _var: &Symbol| args.first().cloned()),
);

let out = registry.apply(
    &Symbol::new("id"),
    &[CasExpr::Var(Symbol::new("x"))],
    &Symbol::new("x"),
);
assert!(matches!(out, Some(CasExpr::Var(_))));
// An unregistered operator yields `None`.
assert!(registry.apply(&Symbol::new("nope"), &[], &Symbol::new("x")).is_none());

Fields§

§rules: BTreeMap<Symbol, DiffRule>

The registered rules, keyed by operator symbol.

Implementations§

Source§

impl CasDiffRegistry

Source

pub fn new() -> Self

Construct an empty registry.

Source

pub fn register_rule( &mut self, symbol: Symbol, rule: DiffRule, ) -> Option<DiffRule>

Register rule for symbol, returning any rule it replaced.

Source

pub fn apply( &self, symbol: &Symbol, args: &[CasExpr], var: &Symbol, ) -> Option<CasExpr>

Apply the rule registered for symbol, if any, to args and var.

Trait Implementations§

Source§

impl Default for CasDiffRegistry

Source§

fn default() -> CasDiffRegistry

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.