Struct ComparisonReport 

#[non_exhaustive]
pub struct ComparisonReport {
    pub rows: Vec<ComparisonRow>,
    pub metric: OptimizeMetric,
}

Ranked comparison of multiple backtest results produced by BacktestComparison::ranked_by.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rows: Vec<ComparisonRow>

Rows sorted best-first by the chosen metric.

metric: OptimizeMetric

The metric used for ranking.

Implementations

impl ComparisonReport

pub fn winner(&self) -> &str

Label of the best-performing strategy.

Returns "" when the report contains no entries.

pub fn table(&self) -> &[ComparisonRow]

All rows sorted best-first (rank 1 = winner).

pub fn winner_row(&self) -> Option<&ComparisonRow>

Returns the row for the winning strategy, if any.

pub fn len(&self) -> usize

Returns the number of strategies in the comparison.

pub fn is_empty(&self) -> bool

Returns true when no results were added.

Trait Implementations

impl Clone for ComparisonReport

fn clone(&self) -> ComparisonReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComparisonReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComparisonReport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ComparisonReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.