Struct LineageEntry 

#[non_exhaustive]
pub struct LineageEntry {
    pub trial: TrialId,
    pub number: TrialNumber,
    pub parent: Option<TrialId>,
    pub mutation: Assignment,
    pub value: Option<f64>,
    pub origin: Option<ForkOrigin>,
}

One trial’s place in the fork genealogy.

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.

trial: TrialId

Storage-global identity.

number: TrialNumber

Per-study ordinal — the order fork_lineage returns entries in.

parent: Option<TrialId>

The trial this one forked or restarted from, if any: the donor in its origin when it has one, otherwise FrozenTrial::parent.

mutation: Assignment

The explore perturbation: the parameters whose value differs from the parent’s (the exploit-and-explore mutation the fork applied). Empty for a root trial, or when the parent is not in the view.

value: Option<f64>

The trial’s single objective value, if it has one — handy for a report or a GUI node label. None for a multi-objective study or an unfinished trial.

origin: Option<ForkOrigin>

The trial’s atune.lineage record, or None for a root, a legacy fork, or a reconstruction without side state (fork_lineage).

Implementations

impl LineageEntry

pub fn new( trial: TrialId, number: TrialNumber, parent: Option<TrialId>, mutation: Assignment, value: Option<f64>, origin: Option<ForkOrigin>, ) -> Self

Creates a lineage entry with its full reconstructed data.

pub const fn is_fork(&self) -> bool

true if this trial is a plain fork of another: it records a parent and is not a restart.

pub const fn is_restart(&self) -> bool

true if this trial is a restart child.

Trait Implementations

impl Clone for LineageEntry

fn clone(&self) -> LineageEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineageEntry

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

Formats the value using the given formatter.

impl PartialEq for LineageEntry

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LineageEntry