pub struct CostModel { /* private fields */ }Expand description
Cost-model entrypoint used by the optimizer dispatcher.
Implementations§
Source§impl CostModel
impl CostModel
Sourcepub fn new(parameters: IndexParameters, weights: CostWeights) -> Self
pub fn new(parameters: IndexParameters, weights: CostWeights) -> Self
Construct a cost model with explicit parameters and weights.
Sourcepub fn weights_mut(&mut self) -> &mut CostWeights
pub fn weights_mut(&mut self) -> &mut CostWeights
Return mutable access to the weights for online adaptation.
Sourcepub fn weights(&self) -> &CostWeights
pub fn weights(&self) -> &CostWeights
Borrow the current weights.
Sourcepub fn parameters(&self) -> &IndexParameters
pub fn parameters(&self) -> &IndexParameters
Borrow the current parameters.
Sourcepub fn recall_floor(family: IndexFamily) -> f32
pub fn recall_floor(family: IndexFamily) -> f32
Recall floor that an index family is expected to deliver at its default parameter configuration.
Sourcepub fn estimate(
&self,
family: IndexFamily,
workload: &WorkloadProfile,
) -> CostEstimate
pub fn estimate( &self, family: IndexFamily, workload: &WorkloadProfile, ) -> CostEstimate
Estimate the (cost, recall) pair for executing workload against
family.
cost is in abstract distance-equivalent units (higher = slower);
recall is a 0..1 estimate. Cost is multiplied by the
learned per-family weight.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for CostModel
impl RefUnwindSafe for CostModel
impl Send for CostModel
impl Sync for CostModel
impl Unpin for CostModel
impl UnsafeUnpin for CostModel
impl UnwindSafe for CostModel
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian().Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.