Skip to main content

StudySnapshot

Struct StudySnapshot 

pub struct StudySnapshot { /* private fields */ }
Expand description

One immutable, presentation-neutral study observation.

Unlike the sampler-facing StudyView, every trial in this snapshot has its recorded constraints and tune replicate fan attached. Full fans, open-space policies, pending finalizations, and the backend’s consistency guarantee stay alongside that view. Exact built-in backends (Memory, Journal, and SQLite), and a remote wrapper over one of them, batch the requested components through one storage snapshot read. A source-compatible custom backend uses the default Storage::read_snapshot fallback: it is explicitly SnapshotConsistency::BestEffort and may perform one bounded second pass when trial parameters reveal policy names missing from the immutable configuration. The type deliberately does not implement Deref: callers choose the canonical read explicitly. Raw storage snapshots keep explicitly requested scopes verbatim, including foreign study scopes; this typed boundary filters foreign trials, side state, and outbox records before hydration.

Implementations§

§

impl StudySnapshot

pub const fn view(&self) -> &StudyView

The hydrated trial view used by ranking and presentation consumers.

pub fn best_trial(&self) -> Option<&FrozenTrial>

The canonical single-objective winner, feasibility first.

pub fn pareto_front(&self) -> Vec<&FrozenTrial>

The canonical constrained Pareto front in trial-number order.

Single-objective snapshots use the scalar form of the canonical relation: one ordered scan retains every trial tied with the best comparable quality. The raw StudyView keeps its generic multi-objective implementation unchanged.

pub fn nadir_point(&self) -> Option<Vec<f64>>

The canonical nadir point of comparable trials.

pub fn hypervolume(&self, reference: &[f64]) -> Result<f64>

Hypervolume of the canonical feasible front.

§Errors

Everything crate::pareto::hypervolume reports, including an unsupported objective dimension.

pub fn trial_fan(&self, trial: TrialId) -> Option<&ReplicateFan>

One trial’s full tune/test replicate fan, if recorded.

pub fn fans(&self) -> impl Iterator<Item = (TrialId, &ReplicateFan)>

Every hydrated fan, in trial-id order.

pub fn policy_for(&self, name: &str) -> Option<&Open>

One persisted open-space policy, if recorded.

pub const fn policies(&self) -> &SpacePolicy

All persisted open-space policies.

pub fn pending_finalizations(&self) -> &[OutboxRecord]

Pending terminal finalizations, in durable key order.

pub const fn consistency(&self) -> SnapshotConsistency

The backend consistency guarantee for this observation.

Trait Implementations§

§

impl Clone for StudySnapshot

§

fn clone(&self) -> StudySnapshot

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
§

impl Debug for StudySnapshot

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for StudySnapshot

§

fn eq(&self, other: &StudySnapshot) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
§

impl StructuralPartialEq for StudySnapshot

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
§

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

§

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.

§

impl<T> Instrument for T

§

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

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

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.

§

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

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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