Struct DdxAnalyzer 

pub struct DdxAnalyzer { /* private fields */ }

The ddx analyzer rule: rewrites grad/jvp markers away before execution.

Install it with crate::install, which also registers the marker UDFs so the calls parse in the first place.

Implementations

impl DdxAnalyzer

pub fn new() -> Self

A rule driving the built-in rule set.

pub fn with_engine(ddx: Ddx) -> Self

A rule driving a caller-supplied engine — use this to pick up custom differentiation rules registered via Ddx::register.

pub fn with_engine_and_functions( ddx: Ddx, functions: impl IntoIterator<Item = Arc<ScalarUDF>>, ) -> Self

As DdxAnalyzer::with_engine, plus extra scalar functions that may appear in a re-planned derivative.

You rarely need this. A UDF from your own marker body is handled automatically — it is harvested from the bound expression itself, so grad(my_udf(y) * x, x) works with no setup regardless of when my_udf was registered. What lands outside that is a UDF emitted by a custom differentiation rule you registered with Ddx::register: that function appears only in the output, so it cannot be harvested from the input and must be declared here.

Trait Implementations

impl AnalyzerRule for DdxAnalyzer

fn name(&self) -> &str

A human readable name for this analyzer rule

fn analyze( &self, plan: LogicalPlan, config: &ConfigOptions, ) -> Result<LogicalPlan>

Rewrite plan

impl Debug for DdxAnalyzer

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

Formats the value using the given formatter.

impl Default for DdxAnalyzer

fn default() -> Self

Returns the “default value” for a type.