Struct ColoredNoise

Source

pub struct ColoredNoise<S: Scalar> { /* private fields */ }

Expand description

Spatially colored (correlated) noise.

Noise at nearby points is correlated with correlation function: C(|x - x’|) = exp(-|x - x’| / λ)

where λ is the correlation length.

Implementations§

Source §

impl<S: Scalar> ColoredNoise<S>

Source

pub fn new( dx: S, correlation_length: S, n_points: usize, seed: Option<u64>, ) -> Result<Self, String>

Create colored noise generator.

§Arguments

dx - Spatial grid spacing
correlation_length - Noise correlation length
n_points - Number of spatial grid points
seed - Optional random seed

Returns an error if the resulting correlation matrix is not positive definite or is ill-conditioned for the given parameters.

Trait Implementations§

Source §

impl<S: Scalar> SpaceTimeNoise<S> for ColoredNoise<S>

Source §

fn increment(&mut self, dt: S, n_points: usize, dw: &mut [S])

Generate noise increments at all spatial points. Read more

Source §

fn reseed(&mut self, seed: u64)

Reset the noise generator with a new seed.

Auto Trait Implementations§

§

impl<S> UnwindSafe for ColoredNoise<S>
where S: UnwindSafe,

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> 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 §