Struct Sobol 

pub struct Sobol { /* private fields */ }

A Sobol’ analysis: the factors and the number of rows N of each of the samples A and B. It serializes as its fields, and reads back through Sobol::new’s checks.

Implementations

impl Sobol

pub fn new(factors: Vec<Factor>, rows: usize) -> Result<Self, AnalysisError>

An analysis of factors with rows rows in each of A and B.

Errors

• AnalysisError::TooFew with no factors, or fewer than 2 rows (a standard error needs two).
• AnalysisError::DuplicateFactor for two factors with one name.
• AnalysisError::Count for a design of more than MAX_DESIGN_POINTS points or MAX_DESIGN_VALUES coordinates.

pub fn factors(&self) -> &[Factor]

The factors.

pub fn rows(&self) -> usize

The rows N of each sample.

pub fn design(&self, seed: u64) -> SobolDesign

The design seeded with seed. Row j draws from its own stream, SeededRng::for_stream(seed, &[j]), k uniform deviates for A’s row and then k for B’s, so it is the same however many rows are drawn.

pub fn indices( &self, seed: u64, model: impl FnMut(&[f64]) -> f64, ) -> Result<SobolIndices, AnalysisError>

Draws the design seeded with seed, runs model at each of its points in order, and analyses the outputs (SobolDesign::analyze).

Errors

As SobolDesign::analyze.

Trait Implementations

impl Clone for Sobol

fn clone(&self) -> Sobol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sobol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sobol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sobol

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Sobol

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sobol