antecedent-core 0.1.0

Core identifiers, schemas, assumptions, provenance, and execution policy for Antecedent
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Stable node identity before dense graph indexing.
//!
//! Shared by sample planning (`antecedent-data`) and graph types (`antecedent-graph`).
//!
//! SPDX-License-Identifier: MIT OR Apache-2.0

use crate::ids::{EnvironmentId, Lag, VariableId};

/// Stable node identity before dense indexing.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum NodeRef {
    /// Static graph node.
    Static(VariableId),
    /// Lagged temporal node (`variable` at `t - lag`).
    Lagged {
        /// Variable.
        variable: VariableId,
        /// Non-negative lag (`0` = contemporaneous).
        lag: Lag,
    },
    /// Context-aware node.
    Context {
        /// Variable.
        variable: VariableId,
        /// Optional environment.
        environment: Option<EnvironmentId>,
    },
}

impl NodeRef {
    /// Variable id carried by this node reference.
    #[must_use]
    pub const fn variable(self) -> VariableId {
        match self {
            Self::Static(v)
            | Self::Lagged { variable: v, .. }
            | Self::Context { variable: v, .. } => v,
        }
    }

    /// Lag if this is a lagged node; `None` for static/context.
    #[must_use]
    pub const fn lag(self) -> Option<Lag> {
        match self {
            Self::Lagged { lag, .. } => Some(lag),
            Self::Static(_) | Self::Context { .. } => None,
        }
    }
}