Struct LogReturn 

pub struct LogReturn { /* private fields */ }

A finite log return value.

Implementations

impl LogReturn

pub fn new(value: f64) -> Result<LogReturn, ReturnError>

Creates a log return from a finite value.

Errors

Returns [ReturnError::NonFiniteReturn] when value is not finite.

pub fn from_prices( start_price: f64, end_price: f64, ) -> Result<LogReturn, ReturnError>

Computes a log return as ln(end_price / start_price).

Errors

Returns [ReturnError] when either price is not finite, the start price is not positive, or the end price is not positive.

pub const fn value(self) -> f64

Returns the stored return value.

Trait Implementations

impl Clone for LogReturn

fn clone(&self) -> LogReturn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogReturn

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

Formats the value using the given formatter.

impl Display for LogReturn

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

Formats the value using the given formatter.

impl PartialEq for LogReturn

fn eq(&self, other: &LogReturn) -> 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 PartialOrd for LogReturn

fn partial_cmp(&self, other: &LogReturn) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for LogReturn

impl StructuralPartialEq for LogReturn