Struct SobolDesign 

pub struct SobolDesign { /* private fields */ }

The points of a Sobol’ analysis, row after row: A’s row, B’s, then A_B⁽ⁱ⁾’s for each factor i in order, k + 2 points a row. It is not serialized: Sobol::design rebuilds it, bit for bit, from the analysis and its seed.

Implementations

impl SobolDesign

pub fn rows(&self) -> usize

The rows N of each sample.

pub fn len(&self) -> usize

The number of points, N (k + 2).

pub fn is_empty(&self) -> bool

Whether there are no points; never, as an analysis has at least two rows.

pub fn points(&self) -> Vec<Vec<f64>>

The points, in physical units, row after row: A’s, B’s, then A_B⁽ⁱ⁾’s for each factor i.

pub fn analyze(&self, outputs: &[f64]) -> Result<SobolIndices, AnalysisError>

Each factor’s indices from outputs, the model’s output at each of SobolDesign::points in order (the module’s docs give the estimates).

Errors

• AnalysisError::Length unless there is one output per point.
• AnalysisError::Output for an output that isn’t finite.
• AnalysisError::Domain if the outputs of A and B are all the same, as with no variance there is nothing to share out, or so spread that their variance overflows; or if an index or its standard error overflows, from a mixed point’s output far beyond the others.

Trait Implementations

impl Clone for SobolDesign

fn clone(&self) -> SobolDesign

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SobolDesign

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

Formats the value using the given formatter.

impl PartialEq for SobolDesign

fn eq(&self, other: &SobolDesign) -> 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 StructuralPartialEq for SobolDesign