Skip to main content

GaussianKde

Struct GaussianKde 

Source
pub struct GaussianKde { /* private fields */ }
Expand description

A fitted Gaussian kernel density estimator over a one-dimensional sample.

Holds the observations and the squared bandwidth (kernel variance) derived from them, so density queries reuse a single bandwidth computed once at fit time. Fields are private to keep the sample and its derived bandwidth an invariant pair; query the estimate with GaussianKde::density / GaussianKde::density_at.

Implementations§

Source§

impl GaussianKde

Source

pub const fn variance(&self) -> f64

The kernel variance (squared bandwidth) shared by every kernel.

Source

pub fn bandwidth(&self) -> f64

The kernel bandwidth h (standard deviation of each Gaussian bump).

Source

pub fn density_at(&self, x: f64) -> f64

Evaluates the estimated density at a single query point x.

§Arguments
  • x — the point at which to evaluate the density.
§Returns

The estimated density f(x) ≥ 0.

Source

pub fn density(&self, xs: &[f64]) -> Vec<f64>

Evaluates the estimated density at every query point in xs.

§Arguments
  • xs — the points at which to evaluate the density.
§Returns

One estimated density per query point, in the input order.

Trait Implementations§

Source§

impl Clone for GaussianKde

Source§

fn clone(&self) -> GaussianKde

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 GaussianKde

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for GaussianKde

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for GaussianKde

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.