Skip to main content

Crate use_volatility

Crate use_volatility 

Source
Expand description

§use-volatility

Primitive volatility vocabulary for RustUse quantitative crates.

use-volatility stores finite non-negative volatility values and descriptive volatility kinds. Its only calculation helper is a small sample standard-deviation helper over return values.

§Example

use use_volatility::{Volatility, VolatilityKind};

let volatility = Volatility::sample_from_returns(&[0.01, -0.02, 0.015])?;
let kind: VolatilityKind = "realized".parse()?;

assert!(volatility.value() > 0.0);
assert_eq!(kind.to_string(), "realized");

§Scope

Use this crate for volatility values and small descriptive helpers. It does not implement options pricing, GARCH models, annualization policy, or risk-engine behavior.

§License

Licensed under either MIT or Apache-2.0.

Modules§

prelude
Common volatility primitives.

Structs§

Volatility
A finite non-negative volatility value.
VolatilityWindow
A simple observation-count volatility window.

Enums§

VolatilityError
Errors returned by volatility helpers.
VolatilityKind
Descriptive volatility kind vocabulary.
VolatilityKindParseError
Errors returned while parsing volatility kinds.