Struct RiskBudget 

pub struct RiskBudget { /* private fields */ }

A simple numeric risk budget value.

Implementations

impl RiskBudget

pub fn new(measure: RiskMeasure, amount: f64) -> Result<Self, RiskError>

Creates a risk budget.

Errors

Returns RiskError when amount is not finite or is negative.

pub const fn measure(&self) -> &RiskMeasure

Returns the risk measure.

pub const fn amount(&self) -> f64

Returns the budget amount.

Trait Implementations

impl Clone for RiskBudget

fn clone(&self) -> RiskBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RiskBudget

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

Formats the value using the given formatter.

impl PartialEq for RiskBudget

fn eq(&self, other: &RiskBudget) -> 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 StructuralPartialEq for RiskBudget