Enum Goal 

pub enum Goal {
    Minimize,
    Maximize,
}

Which way is better.

Variants

Minimize

Smaller is better: a loss, an error, a runtime.

Maximize

Larger is better: an accuracy, an F1, a reward.

Implementations

impl Goal

pub fn better(&self, one: f64, than: f64) -> bool

Whether one is better than than. Strictly: equal is not better, so a trial that ties is never pruned for tying.

pub fn best_of(&self, values: &[f64]) -> Option<f64>

The best of them, or None if there are none. Values that are not numbers are skipped: they are not comparable to anything.

Trait Implementations

impl Clone for Goal

fn clone(&self) -> Goal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Goal

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

Formats the value using the given formatter.

impl Display for Goal

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

Formats the value using the given formatter.

impl FromStr for Goal

fn from_str(s: &str) -> Result<Self, Self::Err>

min or max, the way it is written down. A typo is caught where it was typed rather than becoming a search that optimised backwards.

type Err = GoalError

The associated error which can be returned from parsing.

impl Hash for Goal

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Goal

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

impl Eq for Goal

impl StructuralPartialEq for Goal