Struct Theta

pub struct Theta { /* private fields */ }

Theta is a structure that holds the support points These represent the joint population parameter distribution

Each row represents a support points, and each column a parameter

Implementations

impl Theta

pub fn new() -> Self

pub fn from_parts(matrix: Mat<f64>, parameters: Parameters) -> Result<Self>

Create a new Theta from a matrix and Parameters

It is important that the number of columns in the matrix matches the number of parameters in the Parameters object

The order of parameters in the Parameters object should match the order of columns in the matrix

pub fn matrix(&self) -> &Mat<f64>

Get the matrix containing parameter values

The matrix is a 2D array where each row represents a support point, and each column a parameter

pub fn matrix_mut(&mut self) -> &mut Mat<f64>

Get a mutable reference to the matrix

pub fn parameters(&self) -> &Parameters

Get the Parameters object associated with this Theta

pub fn parameters_mut(&mut self) -> &mut Parameters

Get a mutable reference to the Parameters object

pub fn nspp(&self) -> usize

Get the number of support points, equal to the number of rows in the matrix

pub fn param_names(&self) -> Vec<String>

Get the parameter names

pub fn add_point(&mut self, spp: &[f64]) -> Result<()>

Forcibly add a support point to the matrix

pub fn write(&self, path: &str)

Write the matrix to a CSV file

pub fn to_csv<W: Write>(&self, writer: W) -> Result<()>

Write the theta matrix to a CSV writer Each row represents a support point, each column represents a parameter

pub fn from_csv<R: Read>(reader: R) -> Result<Self>

Read theta matrix from a CSV reader Each row represents a support point, each column represents a parameter Note: This only reads the matrix values, not the parameter metadata

Trait Implementations

impl Clone for Theta

fn clone(&self) -> Theta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Theta

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

Formats the value using the given formatter.

impl Default for Theta

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Theta

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Theta

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

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 Theta