Struct RandomWalk 

pub struct RandomWalk<X, Y>
where
    X: Copy + TryInto<Positive> + AddAssign + Display,
    Y: TryInto<Positive> + Display + Clone,
{ /* private fields */ }

A struct that represents a two-dimensional random walk simulation.

RandomWalk stores a sequence of steps that describe a path in a two-dimensional space, typically used for financial modeling, time series analysis, or statistical simulations. It maintains both the steps of the random walk and a descriptive title.

Type Parameters

• X - The type for x-axis values (typically representing time or sequence position), which must implement AddAssign (allowing values to be accumulated), be convertible to Positive, and be Copy.

• Y - The type for y-axis values (typically representing price, value, or position), which must implement AddAssign, be convertible to Positive, be Copy, and implement the Walktypable trait for additional functionality.

Implementations

impl<X, Y> RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display, Y: TryInto<Positive> + Display + Clone,

pub fn new<F, E>( title: String, params: &WalkParams<X, Y>, generator: F, ) -> Result<Self, E>

where F: FnOnce(&WalkParams<X, Y>) -> Result<Vec<Step<X, Y>>, E>, X: Copy + TryInto<Positive> + AddAssign + Display, Y: TryInto<Positive> + Display + Clone,

Creates a new random walk instance with the given title and steps.

This constructor takes a title, walk parameters, and a fallible generator function that produces the steps of the random walk from the provided parameters. Errors from the generator are propagated unchanged.

Parameters

• title - A descriptive title for the random walk
• params - Parameters that define the properties of the random walk
• generator - A fallible function that generates the steps of the random walk

Returns

Ok(RandomWalk) on success, or Err(E) when the generator fails.

Errors

Returns the error type produced by the supplied generator. For chain-backed generators (e.g. crate::simulation::generator_positive) this is crate::error::SimulationError.

pub fn get_title(&self) -> &str

Returns the title of the random walk.

Returns

A string slice containing the title of the random walk.

pub fn set_title(&mut self, title: String)

Updates the title of the random walk.

Parameters

• title - The new title to set

pub fn get_steps(&self) -> Vec<&Step<X, Y>>

Returns a vector of references to all steps in the random walk.

Returns

A vector containing references to all steps in the random walk.

pub fn get_step(&self, index: usize) -> Option<&Step<X, Y>>

Returns a reference to the step at the specified index.

Parameters

• index - The zero-based index of the step to retrieve

Returns

• Some(&Step<X, Y>) - The step at index.
• None - If index is out of bounds.

Named get_*, so it follows slice::get rather than std::ops::Index: an out-of-bounds index is reported, not aborted on. Use the walk[index] operator when the index is an invariant of the caller and a panic is the wanted contract.

pub fn get_step_mut(&mut self, index: usize) -> Option<&mut Step<X, Y>>

Returns a mutable reference to the step at the specified index.

Parameters

• index - The zero-based index of the step to retrieve

Returns

• Some(&mut Step<X, Y>) - The step at index.
• None - If index is out of bounds.

Mutable counterpart of RandomWalk::get_step, with the same out-of-bounds contract.

pub fn first(&self) -> Option<&Step<X, Y>>

Returns a reference to the first step in the random walk, if any.

Returns

• Some(&Step<X, Y>) - A reference to the first step if the random walk is not empty
• None - If the random walk has no steps

pub fn last(&self) -> Option<&Step<X, Y>>

Returns a reference to the last step in the random walk, if any.

Returns

• Some(&Step<X, Y>) - A reference to the last step if the random walk is not empty
• None - If the random walk has no steps

Trait Implementations

impl<X, Y> Clone for RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display + Clone, Y: TryInto<Positive> + Display + Clone + Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<X, Y> Debug for RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display + Debug, Y: TryInto<Positive> + Display + Clone + Debug,

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

Formats the value using the given formatter.

impl<X, Y> Default for RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display + Default, Y: TryInto<Positive> + Display + Clone + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<X, Y> Display for RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display, Y: TryInto<Positive> + Display + Clone,

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

Formats the value using the given formatter.

impl<X, Y> Index<usize> for RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display, Y: TryInto<Positive> + Display + Clone,

Implementation of the Index trait for RandomWalk<X, Y>.

This allows accessing the steps of a random walk using array indexing notation: walk[index].

Type Parameters

• X - The type for x-axis values, with constraints as described above.
• Y - The type for y-axis values, with constraints as described above.

type Output = Step<X, Y>

The type returned when indexing the random walk.

fn index(&self, index: usize) -> &Self::Output

Provides read access to a specific step in the random walk by index.

Parameters

• index - The zero-based index of the step to access.

Returns

A reference to the Step<X, Y> at the specified index.

Panics

Panics if the index is out of bounds, as indexing a Vec does. Use RandomWalk::get_step for the checked form, which returns None instead.

impl<X, Y> IndexMut<usize> for RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display, Y: TryInto<Positive> + Display + Clone,

Implementation of the IndexMut trait for RandomWalk<X, Y>.

This allows modifying steps in a random walk using array indexing notation: walk[index] = new_step.

Type Parameters

• X - The type for x-axis values, with constraints as described above.
• Y - The type for y-axis values, with constraints as described above.

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Provides mutable access to a specific step in the random walk by index.

Parameters

• index - The zero-based index of the step to modify.

Returns

A mutable reference to the Step<X, Y> at the specified index.

Panics

Panics if the index is out of bounds, as indexing a Vec does. Use RandomWalk::get_step_mut for the checked form, which returns None instead.

impl<X, Y> Len for RandomWalk<X, Y>

where X: Copy + TryInto<Positive> + AddAssign + Display, Y: TryInto<Positive> + Display + Clone,

Implementation of the Len trait for RandomWalk<X, Y>.

This implementation provides methods to determine the length and emptiness of a random walk by delegating to the underlying steps collection.

Type Parameters

• X - The type for x-axis values (typically time or sequence position), which must implement AddAssign, be convertible to Positive, and be Copy.

• Y - The type for y-axis values (typically price or value), which must implement AddAssign, be convertible to Positive, be Copy, and implement the Walktypable trait.

fn len(&self) -> usize

Returns the number of steps in the random walk.

Returns

A usize representing the number of steps.

fn is_empty(&self) -> bool

Determines whether the random walk contains any steps.

Returns

true if the random walk has no steps, false otherwise.

impl<X, Y> Profit for RandomWalk<X, Y>

where X: AddAssign + Copy + Display + TryInto<Positive>, Y: TryInto<Positive> + Display + Clone,

fn calculate_profit_at( &self, _price: &Positive, ) -> Result<Decimal, PricingError>

Calculates the profit at a specified price.

fn get_point_at_price( &self, _price: &Positive, ) -> Result<(Decimal, Decimal), PricingError>

Creates a chart point representation of the profit at the given price.