Skip to main content

Aggregate

Enum Aggregate 

pub enum Aggregate {
    Mean,
    Median,
    Iqm,
    MeanMinusStd(f64),
}
Expand description

How the per-seed values of a fan collapse into one sampler-visible number.

The aggregate is computed identically whatever the study’s Direction — the direction only decides which aggregate wins (via Direction::is_better), never how it is computed.

Variants§

§

Mean

The arithmetic mean of the replicates.

§

Median

The median (the average of the two middle values for an even count).

§

Iqm

The interquartile mean: the mean of the middle 50%, dropping the bottom and top floor(k / 4) replicates each (the rliable estimator, robust to a lucky or unlucky seed).

The trimming rule for small k is documented on Aggregate::apply; for k <= 3 nothing is trimmed and the IQM equals the plain mean.

§

MeanMinusStd(f64)

mean - lambda * std, with the population standard deviation (divided by k, so it is 0 — not undefined — for a single replicate).

A risk-averse aggregate: it prefers configurations that are both good and consistent. It is computed identically regardless of direction, so for a Minimize study — where subtracting the spread rewards inconsistency — the risk-averse choice is a negative lambda.

Implementations§

§

impl Aggregate

pub fn apply(self, values: &[f64]) -> Result<f64>

Collapses values (the per-seed objective values of one objective dimension) into a single number.

§Non-finite values

A NaN or ±inf replicate is a real observation about a diverging run, so it is neither rejected nor rounded: it propagates into the result (a mean containing NaN is NaN), where Direction::is_better then ensures it can never silently win a comparison. Sorting for Median and Iqm uses f64::total_cmp, so it is total even in the presence of NaN.

§The small-k trimming rule for Iqm

With k sorted replicates the IQM drops d = floor(k / 4) from each end and averages the remaining k - 2d (always at least one, since 2d < k). This matches SciPy’s trim_mean(…, 0.25):

kdropped each sideaveraged
10all 1 (= the value)
20all 2 (= the mean)
30all 3 (= the mean)
41the 2 middle
82the 4 middle
§Errors

Error::InvalidSpace if values is empty — an aggregate of no replicates is undefined, and this is reported as a clean error rather than a panic or a silent NaN.

Trait Implementations§

§

impl Clone for Aggregate

§

fn clone(&self) -> Aggregate

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 Copy for Aggregate

§

impl Debug for Aggregate

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for Aggregate

§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl PartialEq for Aggregate

§

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

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

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

Inequality operator !=. Read more
§

impl Serialize for Aggregate

§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl StructuralPartialEq for Aggregate

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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