Skip to main content

RaisedCosine

Struct RaisedCosine 

Source
pub struct RaisedCosine<T> { /* private fields */ }
Expand description

Raised Cosine distribution

Fore more information: https://en.wikipedia.org/wiki/Raised_cosine_distribution

Implementations§

Source§

impl<T> RaisedCosine<T>
where T: Real,

Source

pub fn new(mu: T, s: T) -> RaisedCosine<T>

Creates a probability distribution

§Arguments
  • mu
  • s > 0.0
§Panics

if s < 0.0

§Example
use mathru::statistics::distrib::RaisedCosine;
use std::f64::consts::PI;

let mu: f64 = PI;
let s: f64 = 0.5 * PI;
let distrib: RaisedCosine<f64> = RaisedCosine::new(mu, s);

Trait Implementations§

Source§

impl<T: Clone> Clone for RaisedCosine<T>

Source§

fn clone(&self) -> Self

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<T> Continuous<T> for RaisedCosine<T>
where T: Real,

Source§

fn pdf(&self, x: T) -> T

Probability density function

§Arguments
  • x Random variable x
§Panics
§Example
use mathru::statistics::distrib::{Continuous, RaisedCosine};

let distrib: RaisedCosine<f64> = RaisedCosine::new(-1.2, 1.5);
let x: f64 = 5.0;
let p: f64 = distrib.pdf(x);
Source§

fn cdf(&self, x: T) -> T

Cumulative distribution function

§Arguments
§Example
use mathru::statistics::distrib::{Continuous, RaisedCosine};
use std::f64::consts::PI;

let distrib: RaisedCosine<f64> = RaisedCosine::new(1.0, PI);
let x: f64 = PI / 2.0;
let p: f64 = distrib.cdf(x);
Source§

fn quantile(&self, _p: T) -> T

Quantile function of inverse cdf

Source§

fn mean(&self) -> T

Expected value

§Example
use mathru::statistics::distrib::{Continuous, RaisedCosine};

let distrib: RaisedCosine<f64> = RaisedCosine::new(-2.0, 0.5);
let mean: f64 = distrib.mean();
Source§

fn variance(&self) -> T

Variance

§Example
use mathru::statistics::distrib::{Continuous, RaisedCosine};
use std::f64::consts::PI;

let distrib: RaisedCosine<f64> = RaisedCosine::new(2.0, PI);
let var: f64 = distrib.variance();
Source§

fn median(&self) -> T

Median is the value separating the higher half from the lower half of a probability distribution.

Source§

fn skewness(&self) -> T

Skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable about its mean
Source§

fn entropy(&self) -> T

Source§

impl<T: Copy> Copy for RaisedCosine<T>

Source§

impl<T: Debug> Debug for RaisedCosine<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for RaisedCosine<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for RaisedCosine<T>
where T: RefUnwindSafe,

§

impl<T> Send for RaisedCosine<T>
where T: Send,

§

impl<T> Sync for RaisedCosine<T>
where T: Sync,

§

impl<T> Unpin for RaisedCosine<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for RaisedCosine<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for RaisedCosine<T>
where T: 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V