Enum trane::data::PassingScoreOptions

pub enum PassingScoreOptions {
    ConstantScore(f32),
    IncreasingScore {
        starting_score: f32,
        step_size: f32,
        max_steps: usize,
    },
}

Options to compute the passing score for a unit.

Variants

ConstantScore(f32)

The score will be a fixed value.

IncreasingScore

Fields

starting_score: f32

The initial score. The units at the starting depth will use this value as their passing score.

step_size: f32

The amount by which the score will increase for each additional depth. For example, if the unit is at depth 2, then the passing score will increase by step_size * 2.

max_steps: usize

The maximum number of steps that increase the passing score. Units that are deeper than this will have a passing score of starting_score + step_size * max_steps.

The score will start at a fixed value and increase by a fixed amount based on the depth of the unit relative to the starting unit. This is useful for allowing users to make faster progress at the beginning, so to avoid boredom. Once enough of the graph has been mastered, the passing score will settle to a fixed value.

Implementations

impl PassingScoreOptions

pub fn compute_score(&self, depth: usize) -> f32

Computes the passing score for a unit at the given depth.

pub fn verify(&self) -> Result<()>

Verifies that the options are valid.

Trait Implementations

impl Clone for PassingScoreOptions

fn clone(&self) -> PassingScoreOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PassingScoreOptions

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

Formats the value using the given formatter.

impl Default for PassingScoreOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<PassingScoreOptions> for PassingScoreOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PassingScoreOptions