Struct InteractionMatrix 

pub struct InteractionMatrix { /* private fields */ }

Implementations

impl InteractionMatrix

pub fn from_matrix( values: DenseMatrix<f64>, ) -> Result<Self, InteractionMatrixError>

pub fn from_shared( values: Arc<DenseMatrix<f64>>, ) -> Result<Self, InteractionMatrixError>

pub fn from_labeled_matrix( values: DenseMatrix<f64>, label: impl Into<String>, ) -> Result<Self, InteractionMatrixError>

pub fn from_rows(rows: Vec<Vec<f64>>) -> Result<Self, InteractionMatrixError>

pub fn load_json( path: impl Into<PathBuf>, ) -> Result<Self, InteractionMatrixError>

pub fn from_generated( values: DenseMatrix<f64>, generator: GeneratorProvenance, ) -> Result<Self, InteractionMatrixError>

pub fn species(&self) -> usize

pub fn values(&self) -> &DenseMatrix<f64>

pub fn shared_values(&self) -> Arc<DenseMatrix<f64>>

pub fn coefficient(&self, row: usize, column: usize) -> f64

pub fn mul_vector_into( &self, input: &[f64], output: &mut [f64], ) -> Result<(), MatrixError>

pub fn mul_vectors_into( &self, input: &[f64], output: &mut [f64], ) -> Result<(), MatrixError>

Apply this interaction matrix to a contiguous batch of species vectors.

pub const fn provenance(&self) -> &InteractionProvenance

pub fn antisymmetrize(&self) -> Result<Self, InteractionMatrixError>

Return A - A^T from this exact matrix realization.

pub fn scale(&self, scalar: f64) -> Result<Self, InteractionMatrixError>

Return this matrix multiplied by a finite scalar.

pub fn abs(&self) -> Result<Self, InteractionMatrixError>

Return the elementwise absolute value of this matrix.

pub fn clamp_min(&self, minimum: f64) -> Result<Self, InteractionMatrixError>

Raise every entry below minimum to that finite lower bound.

pub fn clamp_max(&self, maximum: f64) -> Result<Self, InteractionMatrixError>

Lower every entry above maximum to that finite upper bound.

pub fn ensure_max_abs_at_most( &self, threshold: f64, ) -> Result<(), InteractionMatrixError>

Require every absolute entry to be at most threshold.

The maximum is reduced by PiP’s backend-native parallel implementation.

pub fn normalize(&self, threshold: f64) -> Result<Self, InteractionMatrixError>

Scale down uniformly until every absolute entry is at most threshold.

A matrix already within the threshold is not enlarged.

pub fn generator_rng_record(&self) -> Result<Option<RngRecord>, RngRecordError>

Trait Implementations

impl Clone for InteractionMatrix

fn clone(&self) -> InteractionMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InteractionMatrix

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

Formats the value using the given formatter.