Skip to main content

Sindy

Struct Sindy 

Source
pub struct Sindy {
    pub names: Vec<String>,
    pub coeffs: DMatrix<f64>,
}
Expand description

A discovered model: the library term names and the sparse coefficient matrix Ξ (one column per state dimension).

Fields§

§names: Vec<String>§coeffs: DMatrix<f64>

coeffs[(term, dim)] — coefficient of library term in the equation for state component dim.

Implementations§

Source§

impl Sindy

Source

pub fn fit( states: &[Vec<f64>], derivs: &[Vec<f64>], degree: usize, lambda: f64, ) -> Sindy

Fit a sparse dynamics model. states[i] is the state at sample i; derivs[i] its time derivative. degree bounds the polynomial library; lambda is the sparsity threshold.

Source

pub fn n_active(&self) -> usize

Number of nonzero terms across all equations.

Source

pub fn equation(&self, dim: usize) -> String

Human-readable equation for state dimension dim, e.g. "ẋ = 1.00 y".

Auto Trait Implementations§

§

impl Freeze for Sindy

§

impl RefUnwindSafe for Sindy

§

impl Send for Sindy

§

impl Sync for Sindy

§

impl Unpin for Sindy

§

impl UnsafeUnpin for Sindy

§

impl UnwindSafe for Sindy

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<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.