Enum ObjectiveScale 

pub enum ObjectiveScale {
    Sum,
    Mean,
}

Scaling convention for the likelihood part of a compiled objective.

Local and global penalties are not scaled. This keeps penalty weights on a stable scale when switching between summed and mean likelihood objectives.

Variants

Sum

Use the weighted likelihood sum.

Mean

Use the weighted likelihood mean.

For weighted observations the denominator is the sum of observation weights. If all weights are zero, the likelihood contribution is left unscaled at zero.

Trait Implementations

impl Clone for ObjectiveScale

fn clone(&self) -> ObjectiveScale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ObjectiveScale

impl Debug for ObjectiveScale

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

Formats the value using the given formatter.

impl Default for ObjectiveScale

fn default() -> ObjectiveScale

Returns the “default value” for a type.

impl Eq for ObjectiveScale

impl PartialEq for ObjectiveScale

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