Skip to main content

CostEstimator

Struct CostEstimator 

Source
pub struct CostEstimator {
    pub byte_budget: usize,
    pub corpus: usize,
    pub vector_bytes: usize,
}
Expand description

Byte-budget cost model estimator for vector filter strategies (§5.3, D-007).

The 0.4.5–0.5.4 version of this type carried a byte_budget field it never read and branched on candidate_count against two hard-coded thresholds (500, 5000) — D-007’s interface with none of D-007’s mechanism. It now prices both strategies in bytes and takes the minimum, and byte_budget is a hard ceiling on the candidate set rather than an unused field.

Fields§

§byte_budget: usize§corpus: usize

Corpus size: how many vectors the model holds. Sets selectivity, and so the k′ inflation.

§vector_bytes: usize

Bytes per stored vector, from the model’s declared dimension (D-037).

Implementations§

Source§

impl CostEstimator

Source

pub fn new(byte_budget: usize, corpus: usize, vector_bytes: usize) -> Self

Source

pub fn k_prime(&self, k: usize, candidates: usize) -> usize

The k′ PostFilter must request to expect k survivors.

Selectivity is candidates / corpus, so k′ = k × corpus / candidates. Clamped to the corpus: asking the index for more rows than exist is not an error but it is not an estimate either, and letting it run away makes the cost comparison meaningless for tight filters — which is precisely when the comparison matters.

Source

pub fn estimate( &self, k: usize, candidates: CandidateCount, ) -> Result<CostEstimate>

Price both strategies and take the minimum (§5.3, D-007).

StrategyEstimated bytes
PostFilterk′ × (vector_bytes + row_bytes) + the filter pass
PreFilterCTEthe filtered scan + candidates × vector_bytes

The filter pass is common to both — the traversal has to run either way — so it appears in both rows and cancels out of the comparison. It is included anyway, because the budget ceiling is checked against an absolute figure and a cost model that omits a term it “knows” cancels is a cost model that lies the moment someone adds a third strategy.

Trait Implementations§

Source§

impl Clone for CostEstimator

Source§

fn clone(&self) -> CostEstimator

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CostEstimator

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more