Struct PriceSeries 

pub struct PriceSeries { /* private fields */ }

A lightweight insertion-ordered price series.

Implementations

impl PriceSeries

pub const fn new() -> PriceSeries

Creates an empty unnamed price series.

pub const fn named(name: SeriesName) -> PriceSeries

Creates an empty named price series.

pub fn from_points(points: impl IntoIterator<Item = PricePoint>) -> PriceSeries

Creates a series from insertion-ordered points.

pub const fn name(&self) -> Option<&SeriesName>

Returns the optional series name.

pub fn push(&mut self, point: PricePoint)

Appends a point, preserving insertion order.

pub const fn len(&self) -> usize

Returns the number of points.

pub const fn is_empty(&self) -> bool

Returns whether the series contains no points.

pub fn first(&self) -> Option<&PricePoint>

Returns the first point.

pub fn last(&self) -> Option<&PricePoint>

Returns the last point.

pub fn iter(&self) -> Iter<'_, PricePoint>

Iterates over points in insertion order.

pub fn adjacent_simple_returns( &self, ) -> Result<Vec<SimpleReturn>, PriceSeriesError>

Computes adjacent simple returns in insertion order.

Errors

Returns PriceSeriesError::Return when a price pair cannot produce a simple return.

Trait Implementations

impl Clone for PriceSeries

fn clone(&self) -> PriceSeries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PriceSeries

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

Formats the value using the given formatter.

impl Default for PriceSeries

fn default() -> PriceSeries

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a PriceSeries

type Item = &'a PricePoint

The type of the elements being iterated over.

type IntoIter = Iter<'a, PricePoint>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a PriceSeries as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for PriceSeries

type Item = PricePoint

The type of the elements being iterated over.

type IntoIter = IntoIter<PricePoint>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <PriceSeries as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for PriceSeries

fn eq(&self, other: &PriceSeries) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PriceSeries