Struct Momentum

pub struct Momentum { /* private fields */ }

A Momentum indicator that calculates the change between the current price and the price from a given number of periods ago.

Implementations

impl Momentum

pub const DEFAULT_PERIOD: usize = 14usize

The default period for the Momentum indicator.

pub fn new(period: usize) -> Self

Creates a new Momentum indicator with the specified period.

Arguments

• period - The number of periods over which to calculate momentum.

Example

use indexes_rs::v1::momentum::main::Momentum;

let momentum = Momentum::new(14);

pub fn calculate(&mut self, price: f64) -> Option<MomentumResult>

Calculates the current momentum and momentum ratio.

The momentum is computed as the difference between the current price and the price from period periods ago. The momentum ratio is computed as (current_price / past_price) * 100.0.

Arguments

• price - The latest price.

Returns

• Some(MomentumResult) if there are enough data points and the past price is not zero.
• None if there aren’t enough values or if the past price is zero (to avoid division by zero).

Example

use indexes_rs::v1::momentum::main::Momentum;
use indexes_rs::v1::momentum::types::MomentumResult;

let mut momentum = Momentum::new(3);
momentum.calculate(100.0); // first value, not enough data
momentum.calculate(102.0);
if let Some(result) = momentum.calculate(104.0) {
    // Past price is 100.0, so momentum = 104.0 - 100.0 = 4.0
    // and momentum ratio = (104.0 / 100.0) * 100 = 104.0%
    assert_eq!(result.value, 4.0);
    assert_eq!(result.ratio, 104.0);
}