Struct VolatilityAnalysisInput 

pub struct VolatilityAnalysisInput {
    pub returns: TimeSeries,
    pub params: GARCHParams,
    pub forecast_horizon: usize,
}

Input for volatility analysis.

Ring message type_id: 2050 (TemporalAnalysis domain)

Fields

returns: TimeSeries

Time series of returns.

params: GARCHParams

GARCH(p,q) parameters.

forecast_horizon: usize

Forecast horizon.

Implementations

impl VolatilityAnalysisInput

pub const fn message_type_id() -> u64

Get the message type ID.

impl VolatilityAnalysisInput

pub fn new( returns: TimeSeries, params: GARCHParams, forecast_horizon: usize, ) -> Self

Create a new volatility analysis input.

pub fn garch_1_1(returns: TimeSeries, forecast_horizon: usize) -> Self

Create with GARCH(1,1) model.

pub fn garch( returns: TimeSeries, p: usize, q: usize, forecast_horizon: usize, ) -> Self

Create with custom GARCH(p,q).

Trait Implementations

impl BatchKernel<VolatilityAnalysisInput, VolatilityAnalysisOutput> for VolatilityAnalysis

fn execute<'life0, 'async_trait>( &'life0 self, input: VolatilityAnalysisInput, ) -> Pin<Box<dyn Future<Output = Result<VolatilityAnalysisOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the kernel with the given input.

fn validate_input(&self, _input: &I) -> Result<(), KernelError>

Validate the input before execution.

fn execute_with_context<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 ExecutionContext, input: I, ) -> Pin<Box<dyn Future<Output = Result<O, KernelError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, I: 'async_trait, Self: Sync + 'async_trait,

Execute the kernel with execution context.

fn execute_with_timeout<'life0, 'async_trait>( &'life0 self, input: I, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<O, KernelError>> + Send + 'async_trait>>

where 'life0: 'async_trait, I: 'async_trait, Self: Sync + 'async_trait,

Execute the kernel with a timeout.

impl BatchMessage for VolatilityAnalysisInput

fn message_type_id() -> u64

Get the message type ID.

fn to_json(&self) -> Result<Vec<u8>, Error>

Serialize to JSON bytes.

fn from_json(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Deserialize from JSON bytes.

fn size_hint(&self) -> usize

Get the size hint for serialized data.

impl Clone for VolatilityAnalysisInput

fn clone(&self) -> VolatilityAnalysisInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VolatilityAnalysisInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VolatilityAnalysisInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VolatilityAnalysisInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.