Enum InteractionMatrixRecipe

Source

pub enum InteractionMatrixRecipe {
    RandomUniform {
        minimum: f64,
        maximum: f64,
        rng: RngConfig,
    },
    RandomGaussian {
        mean: f64,
        standard_deviation: f64,
        rng: RngConfig,
    },
    CorrelatedGaussian {
        mean: f64,
        standard_deviation: f64,
        reciprocal_correlation: f64,
        connectance: f64,
        diagonal: DiagonalPolicy,
        normalization: MatrixNormalization,
        rng: RngConfig,
    },
    SignStructuredGaussian {
        structure: SignStructure,
        scale: f64,
        connectance: f64,
        diagonal: DiagonalPolicy,
        normalization: MatrixNormalization,
        rng: RngConfig,
    },
}

Expand description

Reproducible scientific instructions for an ecological matrix realization.

Variants§

§

RandomUniform

Independently sample every matrix entry from a uniform distribution.

Fields

§minimum: f64

§maximum: f64

§rng: RngConfig

§

RandomGaussian

Independently sample every matrix entry from a Gaussian distribution.

Fields

§mean: f64

§standard_deviation: f64

§rng: RngConfig

§

CorrelatedGaussian

Gaussian reciprocal pairs with Pearson correlation in [-1,1].

Fields

§mean: f64

§standard_deviation: f64

§reciprocal_correlation: f64

§connectance: f64

§diagonal: DiagonalPolicy

§normalization: MatrixNormalization

§rng: RngConfig

§

SignStructuredGaussian

Pairwise signs constrained to a common ecological relationship class.

Fields

§structure: SignStructure

§scale: f64

§connectance: f64

§diagonal: DiagonalPolicy

§normalization: MatrixNormalization

§rng: RngConfig

Implementations§

Source §

impl InteractionMatrixRecipe

Source

pub fn validate(&self, species: usize) -> Result<(), InteractionRecipeError>

Source

pub fn generate( &self, species: usize, ) -> Result<InteractionMatrix, InteractionRecipeError>

Source

pub const fn rng(&self) -> RngConfig

Trait Implementations§

Source §

impl Clone for InteractionMatrixRecipe

Source §

fn clone(&self) -> InteractionMatrixRecipe

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for InteractionMatrixRecipe

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de> Deserialize<'de> for InteractionMatrixRecipe

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl PartialEq for InteractionMatrixRecipe

Source §

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Source §

impl Serialize for InteractionMatrixRecipe

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Source §

impl StructuralPartialEq for InteractionMatrixRecipe

Auto Trait Implementations§

§

impl UnwindSafe for InteractionMatrixRecipe

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §