Struct Scan

pub struct Scan {
    pub skip: usize,
    pub reset_every_turn: bool,
    pub body: Graph<TypedFact, Box<dyn TypedOp>>,
    pub decluttered: bool,
    pub input_mapping: Vec<InputMapping>,
    pub output_mapping: Vec<OutputMapping<TDim>>,
}

Fields

skip: usize

reset_every_turn: bool

body: Graph<TypedFact, Box<dyn TypedOp>>

decluttered: bool

input_mapping: Vec<InputMapping>

output_mapping: Vec<OutputMapping<TDim>>

Implementations

impl Scan

pub fn to_codegen_op(&self, optimize_inner: bool) -> Result<OptScan, Error>

pub fn new( body: Graph<TypedFact, Box<dyn TypedOp>>, input_mapping: Vec<InputMapping>, output_mapping: Vec<OutputMapping<TDim>>, skip: usize, ) -> Result<Scan, Error>

pub fn iteration_count(&self, inputs: &[&TypedFact]) -> Option<TDim>

Trait Implementations

impl Clone for Scan

fn clone(&self) -> Scan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scan

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

Formats the value using the given formatter.

impl Default for Scan

fn default() -> Scan

Returns the “default value” for a type.

impl EvalOp for Scan

fn is_stateless(&self) -> bool

fn state( &self, session: &mut SessionState, node_id: usize, ) -> Result<Option<Box<dyn OpState>>, Error>

fn eval( &self, inputs: SmallVec<[TValue; 4]>, ) -> Result<SmallVec<[TValue; 4]>, Error>

fn eval_with_session( &self, session: &SessionState, inputs: SmallVec<[TValue; 4]>, ) -> Result<SmallVec<[TValue; 4]>, Error>

impl Op for Scan

fn name(&self) -> Cow<'_, str>

fn info(&self) -> Result<Vec<String>, Error>

Short (one-line) strings giving hints on internal implementation or important configuration details to be displayed in dumps.

fn validation(&self) -> Validation

The kind of accuracy check that should be performed on operation when testing them.

fn as_typed(&self) -> Option<&(dyn TypedOp + 'static)>

fn same_as(&self, _other: &(dyn Op + 'static)) -> bool

Compare two ops.

impl PulsedOp for Scan

fn pulsed_output_facts( &self, inputs: &[&PulsedFact], ) -> TractResult<TVec<PulsedFact>>

Deduce output facts from input facts.

fn as_op(&self) -> &dyn Op

Reinterpret the PulsedOp as an Op.

fn as_op_mut(&mut self) -> &mut dyn Op

Reinterpret the PulsedOp as an Op, mutably.

fn to_typed(&self) -> Box<dyn TypedOp>

Reinterpret the PulsedOp as an TypedOp.

impl TypedOp for Scan

fn as_op(&self) -> &(dyn Op + 'static)

Reinterpret the TypedOp as an Op.

fn as_op_mut(&mut self) -> &mut (dyn Op + 'static)

Reinterpret the TypedOp as an Op, mutably.

fn output_facts( &self, inputs: &[&TypedFact], ) -> Result<SmallVec<[TypedFact; 4]>, Error>

Deduce output facts from input facts.

fn axes_mapping( &self, inputs: &[&TypedFact], outputs: &[&TypedFact], ) -> Result<AxesMapping, Error>

fn suggested_axis_changes( &self, ) -> Result<SmallVec<[(InOut, AxisOp); 4]>, Error>

fn change_axes( &self, model: &Graph<TypedFact, Box<dyn TypedOp>>, node: &Node<TypedFact, Box<dyn TypedOp>>, io: InOut, change: &AxisOp, ) -> Result<Option<AxisChangeConsequence>, Error>

fn declutter_with_session( &self, session: &mut OptimizerSession<'_>, model: &Graph<TypedFact, Box<dyn TypedOp>>, node: &Node<TypedFact, Box<dyn TypedOp>>, ) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp>>>, Error>

Declutter the op to the tract_core operator set as much as possible.

fn concretize_dims( &self, _source: &Graph<TypedFact, Box<dyn TypedOp>>, node: &Node<TypedFact, Box<dyn TypedOp>>, target: &mut Graph<TypedFact, Box<dyn TypedOp>>, mapping: &HashMap<OutletId, OutletId>, values: &SymbolValues, ) -> Result<SmallVec<[OutletId; 4]>, Error>

Transform the op into by providing a value to one or more symbols.

fn codegen( &self, model: &Graph<TypedFact, Box<dyn TypedOp>>, node: &Node<TypedFact, Box<dyn TypedOp>>, ) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp>>>, Error>

Translate the op into the most efficient form possible for execution.

fn fuse( &self, _model: &Graph<TypedFact, Box<dyn TypedOp>>, _node: &Node<TypedFact, Box<dyn TypedOp>>, ) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp>>>, Error>

Fuse op after codegen to deal with local optimisations.

fn declutter( &self, model: &Graph<TypedFact, Box<dyn TypedOp>>, node: &Node<TypedFact, Box<dyn TypedOp>>, ) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp>>>, Error>

Declutter the op to the tract_core operator set as much as possible.

fn cost( &self, _inputs: &[&TypedFact], ) -> Result<SmallVec<[(Cost, TDim); 4]>, Error>

Computes a cost hint of the operation.

fn slice( &self, patch: &mut ModelPatch<TypedFact, Box<dyn TypedOp>>, model: &Graph<TypedFact, Box<dyn TypedOp>>, node: &Node<TypedFact, Box<dyn TypedOp>>, prefix: &str, inputs: &[OutletId], output_axis: usize, start: &TDim, end: &TDim, ) -> Result<Option<SmallVec<[OutletId; 4]>>, Error>

fn quantize( &self, model: &Graph<TypedFact, Box<dyn TypedOp>>, node: &Node<TypedFact, Box<dyn TypedOp>>, dt: DatumType, scale: f32, zero_point: i32, ) -> Result<Option<Box<dyn TypedOp>>, Error>

Transforms the op in an equivalent one, operating on dt (i8 or u8).

fn nested_model_multipliers( &self, inputs: &[&TypedFact], ) -> Vec<(Cow<'_, str>, TDim)>

Nested model multipliers, with label (for profiling).