Struct GenericVmFunction 

pub struct GenericVmFunction<const N: usize>(/* private fields */);

VM-backed shape with a configurable number of registers

You are unlikely to use this directly; VmShape should be used for VM-based evaluation.

Implementations

impl<const N: usize> GenericVmFunction<N>

pub fn size(&self) -> usize

Returns a characteristic size (the length of the inner assembly tape)

pub fn recycle(self) -> Option<VmData<N>>

Reclaim the inner VmData if there’s only a single reference

pub fn data(&self) -> &VmData<N>

Borrows the inner VmData

pub fn tape(&self) -> GenericVmTape<N>

Returns a GenericVmTape for the given function

pub fn choice_count(&self) -> usize

Returns the number of choices (i.e. min and max nodes) in the tape

pub fn output_count(&self) -> usize

Returns the number of outputs in the tape

pub fn simplify_with<const M: usize>( &self, trace: &VmTrace, storage: VmData<M>, workspace: &mut VmWorkspace<M>, ) -> Result<GenericVmFunction<M>, Error>

Simplifies the function with the given trace and a new register count

Trait Implementations

impl<const N: usize> Clone for GenericVmFunction<N>

fn clone(&self) -> GenericVmFunction<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> From<VmData<N>> for GenericVmFunction<N>

fn from(d: VmData<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> Function for GenericVmFunction<N>

type Storage = VmData<N>

Associated type for storage used by the function itself

type Workspace = VmWorkspace<N>

Associated type for workspace used during function simplification

type TapeStorage = EmptyTapeStorage

Associated type for storage used by tapes

type FloatSliceEval = VmFloatSliceEval<N>

Associated type for evaluating many points in one call

type GradSliceEval = VmGradSliceEval<N>

Associated type for evaluating many gradients in one call

type PointEval = VmPointEval<N>

Associated type for single-point tracing evaluation

type IntervalEval = VmIntervalEval<N>

Associated type for single interval tracing evaluation

type Trace = VmTrace

Associated type traces collected during tracing evaluation

fn float_slice_tape(&self, _storage: EmptyTapeStorage) -> GenericVmTape<N>

Returns an evaluation tape for a float slice evaluator

fn grad_slice_tape(&self, _storage: EmptyTapeStorage) -> GenericVmTape<N>

Returns an evaluation tape for a float slice evaluator

fn point_tape(&self, _storage: EmptyTapeStorage) -> GenericVmTape<N>

Returns an evaluation tape for a point evaluator

fn interval_tape(&self, _storage: EmptyTapeStorage) -> GenericVmTape<N>

Returns an evaluation tape for an interval evaluator

fn simplify( &self, trace: &Self::Trace, storage: Self::Storage, workspace: &mut Self::Workspace, ) -> Result<Self, Error>

Computes a simplified tape using the given trace, and reusing storage

fn recycle(self) -> Option<Self::Storage>

Attempt to reclaim storage from this function

fn size(&self) -> usize

Returns a size associated with this function

fn vars(&self) -> &VarMap

Returns the map from Var to input index

fn can_simplify(&self) -> bool

Checks to see whether this function can ever be simplified

fn new_point_eval() -> Self::PointEval

Builds a new point evaluator

fn new_interval_eval() -> Self::IntervalEval

Builds a new interval evaluator

fn new_float_slice_eval() -> Self::FloatSliceEval

Builds a new float slice evaluator

fn new_grad_slice_eval() -> Self::GradSliceEval

Builds a new gradient slice evaluator

impl<const N: usize> MathFunction for GenericVmFunction<N>

fn new(ctx: &Context, nodes: &[Node]) -> Result<Self, Error>

Builds a new function from the given context and node

impl<const N: usize> RenderHints for GenericVmFunction<N>

fn tile_sizes_3d() -> TileSizes

Recommended tile sizes for 3D rendering

fn tile_sizes_2d() -> TileSizes

Recommended tile sizes for 2D rendering

fn simplify_tree_during_meshing(_d: usize) -> bool

Indicates whether we run tape simplification at the given cell depth during meshing.