Skip to main content

PriceFeatures

Struct PriceFeatures 

Source
pub struct PriceFeatures {
    pub log_returns: Vec<f64>,
    pub realized_volatility: f64,
    pub momentum: f64,
    pub rsi: f64,
    pub macd_signal: f64,
    pub bollinger_position: f64,
}
Expand description

Price-derived features computed from a close-price series.

§Example

use fin_primitives::ml_features::PriceFeatures;

let closes = vec![100.0, 101.0, 102.0, 101.5, 103.0];
let pf = PriceFeatures::compute(&closes, 3).unwrap();
assert!(pf.log_returns.len() == 4);

Fields§

§log_returns: Vec<f64>

Log returns: ln(close_t / close_{t-1}).

§realized_volatility: f64

Realized volatility: rolling std-dev of log returns over the last window periods.

§momentum: f64

n-period momentum: close[-1] / close[-n-1] - 1.

§rsi: f64

RSI over the last window periods (0–100).

§macd_signal: f64

MACD signal line: EMA(12) − EMA(26) of closes.

§bollinger_position: f64

Bollinger Band position: (close - lower) / (upper - lower), in [0, 1].

Implementations§

Source§

impl PriceFeatures

Source

pub fn compute(closes: &[f64], window: usize) -> Result<Self, FinError>

Compute price features from a close-price series.

Requires at least window + 1 observations for all features.

§Errors

Trait Implementations§

Source§

impl Clone for PriceFeatures

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PriceFeatures

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.