Struct Volatility 

pub struct Volatility { /* private fields */ }

A finite non-negative volatility value.

Implementations

impl Volatility

pub fn new(value: f64) -> Result<Volatility, VolatilityError>

Creates a volatility value.

Errors

Returns [VolatilityError::NonFinite] or [VolatilityError::Negative] when value is invalid.

pub fn sample_from_returns( returns: &[f64], ) -> Result<Volatility, VolatilityError>

Computes sample standard-deviation volatility from return values.

Errors

Returns [VolatilityError::InsufficientReturns] for fewer than two returns and [VolatilityError::NonFinite] for non-finite inputs.

pub const fn value(self) -> f64

Returns the volatility value.

Trait Implementations

impl Clone for Volatility

fn clone(&self) -> Volatility

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Volatility

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

Formats the value using the given formatter.

impl Display for Volatility

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

Formats the value using the given formatter.

impl PartialEq for Volatility

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Volatility

fn partial_cmp(&self, other: &Volatility) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Volatility

impl StructuralPartialEq for Volatility