Skip to main content

TunableSet

Struct TunableSet 

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

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

Implementations§

Source§

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

Source

pub fn len(&self) -> usize

The number of tunables in the set.

Source

pub fn is_empty(&self) -> bool

Whether this set contains no tunables.

Source

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.

Source

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.

Source

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

Register a tunable with this tunable set.

Source

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

All candidate operations in this set, in registration order.

Source

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.

Source

pub fn compute_checksum(&self) -> String

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

Source

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

Generate a key from a set of inputs

Source

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.

Auto Trait Implementations§

§

impl<K, F, Output> Freeze for TunableSet<K, F, Output>

§

impl<K, F, Output> !RefUnwindSafe for TunableSet<K, F, Output>

§

impl<K, F, Output> Send for TunableSet<K, F, Output>

§

impl<K, F, Output> Sync for TunableSet<K, F, Output>

§

impl<K, F, Output> Unpin for TunableSet<K, F, Output>

§

impl<K, F, Output> UnsafeUnpin for TunableSet<K, F, Output>

§

impl<K, F, Output> !UnwindSafe for TunableSet<K, F, Output>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.