Struct tract_hir::ops::scan::Scan

pub struct Scan {
    pub skip: usize,
    pub body: ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    pub seq_length_input_slot: Option<usize>,
    pub input_mapping: Vec<InputMapping<TDim>>,
    pub output_mapping: Vec<OutputMapping<TDim, TDim>>,
    pub backward: bool,
    // some fields omitted
}

Fields

skip: usize

body: ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>

seq_length_input_slot: Option<usize>

input_mapping: Vec<InputMapping<TDim>>

output_mapping: Vec<OutputMapping<TDim, TDim>>

backward: bool

Implementations

impl Scan

pub fn to_codegen_op(&self, optimize_inner: bool) -> Result<LirScan, TractError>

pub fn new(
    body: ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    input_mapping: Vec<InputMapping<TDim>>,
    output_mapping: Vec<OutputMapping<TDim, TDim>>,
    seq_length_input_slot: Option<usize>,
    backward: bool
) -> Result<Scan, TractError>

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 DynHash for Scan

fn dyn_hash(&self, state: &mut dyn Hasher)

impl Hash for Scan

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Op for Scan

fn name(&self) -> Cow<str>

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

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

fn nested_models(
    &self
) -> Vec<(Cow<str>, &(dyn Model + 'static), Vec<String>, Vec<String>)>

Nested models, with label (for audit).

fn validation(&self) -> Validation

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

fn op_families(&self) -> &'static [&'static str]

Vector of short strings defining what families the op belongs too. tract-core defines "core", "mir", "lir".

fn is_canonic(&self) -> bool

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

fn as_pulsed(&self) -> Option<&(dyn PulsedOp + 'static)>

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

Compare two ops.

impl PulsedOp for Scan

fn pulsed_output_facts(
    &self,
    inputs: &[&PulsedFact]
) -> Result<SmallVec<[PulsedFact; 4]>, TractError>

Deduce output facts from input facts.

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

Reinterpret the PulsedOp as an Op.

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

Reinterpret the PulsedOp as an Op, mutably.

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

Reinterpret the PulsedOp as an TypedOp.

impl StatefullOp for Scan

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

fn as_stateless(&self) -> Option<&(dyn StatelessOp + 'static)>

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]>, TractError>

Deduce output facts from input facts.

fn invariants(
    &self,
    _model: &ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    _node: &BaseNode<TypedFact, Box<dyn TypedOp + 'static>>
) -> Result<Invariants, TractError>

fn change_axes(
    &self,
    _model: &ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    _node: &BaseNode<TypedFact, Box<dyn TypedOp + 'static>>,
    io: InOut,
    change: &AxisOp
) -> Result<Option<AxisChangeConsequence>, TractError>

fn declutter(
    &self,
    model: &ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    node: &BaseNode<TypedFact, Box<dyn TypedOp + 'static>>
) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp + 'static>>>, TractError>

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

fn pulsify(
    &self,
    _source: &ModelImpl<NormalizedFact, Box<dyn TypedOp + 'static>>,
    node: &BaseNode<NormalizedFact, Box<dyn TypedOp + 'static>>,
    target: &mut ModelImpl<PulsedFact, Box<dyn PulsedOp + 'static>>,
    mapping: &HashMap<OutletId, OutletId, RandomState>,
    _pulse: usize
) -> Result<SmallVec<[OutletId; 4]>, TractError>

Translate an op in a normalized network (no constants) to a pulsing form, if possible.

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

Nested model multipliers, with label (for profiling).

fn codegen(
    &self,
    model: &ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    node: &BaseNode<TypedFact, Box<dyn TypedOp + 'static>>
) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp + 'static>>>, TractError>

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

fn fuse(
    &self,
    _model: &ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    _node: &BaseNode<TypedFact, Box<dyn TypedOp + 'static>>
) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp + 'static>>>, TractError>

Fuse op after codegen to deal with local optimisations.

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

Computes a cost hint of the operation.

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

fn slice_output(
    &self,
    model: &ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    node: &BaseNode<TypedFact, Box<dyn TypedOp + 'static>>,
    patch: &mut ModelPatch<TypedFact, Box<dyn TypedOp + 'static>>,
    output_slot: usize,
    axis: usize,
    start: usize,
    end: usize
) -> Result<Option<OutletId>, TractError>

fn quantize(
    &self,
    model: &ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>,
    node: &BaseNode<TypedFact, Box<dyn TypedOp + 'static>>,
    dt: DatumType,
    scale: f32,
    zero_point: i32
) -> Result<Option<Box<dyn TypedOp + 'static>>, TractError>

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