Struct TunableSet 

pub struct TunableSet<K: AutotuneKey, F: TuneInputs, Output: 'static> { /* private fields */ }

A set of candidate tunable functions for autotune, sharing a key generator and an input generator. See TuneInputs for the F parameter.

Implementations

impl<K: AutotuneKey, F: TuneInputs, Output: 'static> TunableSet<K, F, Output>

pub fn len(&self) -> usize

The number of tunables in the set.

pub fn is_empty(&self) -> bool

Whether this set contains no tunables.

pub fn new( key_gen: impl KeyGenerator<K, F>, input_gen: impl InputGenerator<K, F>, ) -> Self

Create a tunable set from a key generator and an input generator.

pub fn new_cloning_inputs(key_gen: impl KeyGenerator<K, F>) -> Self

Shorthand for new with a [CloneInputGenerator]: benchmarks run on clones of the real call inputs.

pub fn with(self, tunable: Tunable<K, F, Output>) -> Self

Register a tunable with this tunable set.

pub fn with_bounds( self, bounds: Arc<dyn BoundsGenerator<K, F> + Send + Sync>, ) -> Self

Sets the autotune bounds for this set.

pub fn with_short_circuit(self, enabled: bool) -> Self

Set whether bounds-based short-circuiting is enabled.

pub fn is_short_circuit_enabled(&self) -> bool

Whether short-circuiting is enabled for this set.

pub fn autotunables(&self) -> impl Iterator<Item = &TuneFn<F, Output>>

All candidate operations in this set, in registration order.

pub fn fastest(&self, fastest_index: usize) -> &TuneFn<F, Output>

Returns the operation for the given index, matching the order returned by autotunables. Tunables are tried in order, so index 0 should be a good default.

pub fn compute_checksum(&self) -> String

Compute a checksum that invalidates outdated cached auto-tune results when the set of tunable names changes.

pub fn generate_key<'a>(&self, inputs: &F::At<'a>) -> K

Generate a key from a set of inputs

pub fn generate_inputs<'a>(&self, key: &K, inputs: &F::At<'a>) -> F::At<'a>

Generate a set of test inputs from a key and reference inputs.

pub fn bounds(&self, key: &K, inputs: &F::At<'_>) -> Option<Bounds>

The throughput bounds registered on this set, if any.