Skip to main content

ParameterSweep

Struct ParameterSweep 

Source
pub struct ParameterSweep {
    pub params: Vec<(String, Vec<f64>)>,
}
Expand description

A multi-dimensional parameter sweep specification.

Each entry is a (name, values) pair. The sweep can be evaluated either as a full Cartesian product or via a Latin-hypercube sample.

Fields§

§params: Vec<(String, Vec<f64>)>

Ordered list of (parameter_name, candidate_values) pairs.

Implementations§

Source§

impl ParameterSweep

Source

pub fn new() -> Self

Create an empty sweep.

Source

pub fn add_param(&mut self, name: impl Into<String>, values: Vec<f64>)

Add a parameter with its list of candidate values.

Source

pub fn count(&self) -> usize

Total number of points in the Cartesian product.

Source

pub fn cartesian_product(&self) -> Vec<HashMap<String, f64>>

Enumerate every combination of parameter values (Cartesian product).

Source

pub fn latin_hypercube_sample(&self, n: usize) -> Vec<HashMap<String, f64>>

Draw n samples using a deterministic Latin-hypercube strategy.

Trait Implementations§

Source§

impl Debug for ParameterSweep

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ParameterSweep

Source§

fn default() -> ParameterSweep

Returns the “default value” for a type. 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<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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.