pub struct RiskAnalyzer { /* private fields */ }Expand description
Risk analyzer
Implementations§
Source§impl RiskAnalyzer
impl RiskAnalyzer
Sourcepub fn initialize(&mut self) -> Result<(), FinancialError>
pub fn initialize(&mut self) -> Result<(), FinancialError>
Initialize RiskAnalyzer; Ok when ready.
Sourcepub fn add_benchmark(&mut self, name: &str, returns: Vec<f64>)
pub fn add_benchmark(&mut self, name: &str, returns: Vec<f64>)
Register a benchmark return series by name. If no benchmark is currently
active, the newly registered one becomes active so that subsequent
calculate_risk_metrics calls produce real beta/alpha.
Sourcepub fn set_active_benchmark(&mut self, name: Option<&str>)
pub fn set_active_benchmark(&mut self, name: Option<&str>)
Select which registered benchmark calculate_risk_metrics should use, or
None to compute beta/alpha-free (NaN) metrics.
Sourcepub fn calculate_risk_metrics(
&self,
portfolio: &Portfolio,
) -> Result<RiskMetrics, FinancialError>
pub fn calculate_risk_metrics( &self, portfolio: &Portfolio, ) -> Result<RiskMetrics, FinancialError>
Compute real risk metrics for portfolio via
portfolio_risk::compute_risk_metrics (volatility, VaR/CVaR,
Sharpe, Sortino, max-drawdown from actual return series). Fails
InsufficientData without price history; beta/alpha are NaN
unless a benchmark is active via set_active_benchmark.
Sourcepub fn add_risk_model(&mut self, model: RiskModel)
pub fn add_risk_model(&mut self, model: RiskModel)
Add risk_model to the RiskAnalyzer.
Sourcepub fn get_risk_model(&self, model_id: &str) -> Option<&RiskModel>
pub fn get_risk_model(&self, model_id: &str) -> Option<&RiskModel>
Look up risk_model by id; None when absent.
Sourcepub fn list_risk_models(&self) -> Vec<String>
pub fn list_risk_models(&self) -> Vec<String>
Ids of every registered risk_model.
Sourcepub fn add_risk_metric(&mut self, metric: RiskMetric)
pub fn add_risk_metric(&mut self, metric: RiskMetric)
Add risk_metric to the RiskAnalyzer.
Sourcepub fn get_risk_metric(&self, metric_id: &str) -> Option<&RiskMetric>
pub fn get_risk_metric(&self, metric_id: &str) -> Option<&RiskMetric>
Look up risk_metric by id; None when absent.
Sourcepub fn list_risk_metrics(&self) -> Vec<String>
pub fn list_risk_metrics(&self) -> Vec<String>
Ids of every registered risk_metric.
Auto Trait Implementations§
impl Freeze for RiskAnalyzer
impl RefUnwindSafe for RiskAnalyzer
impl Send for RiskAnalyzer
impl Sync for RiskAnalyzer
impl Unpin for RiskAnalyzer
impl UnsafeUnpin for RiskAnalyzer
impl UnwindSafe for RiskAnalyzer
Blanket Implementations§
§impl<S, A> Aggregate<Result<S, Error>> for Awhere
A: Aggregate<S>,
impl<S, A> Aggregate<Result<S, Error>> for Awhere
A: Aggregate<S>,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more