use-volatility 0.1.0

Primitive volatility vocabulary for RustUse quantitative crates
Documentation
  • Coverage
  • 100%
    24 out of 24 items documented1 out of 11 items with examples
  • Size
  • Source code size: 11.29 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 665.51 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 2s Average build duration of successful builds.
  • all releases: 3s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • RustUse/use-quant
    2 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • CloudBranch

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");
# Ok::<(), Box<dyn std::error::Error>>(())

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.