kip 0.1.1

Pure thread-safe engineering expression evaluator for US imperial units
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! Loaded equation records and registry lookup.

use std::collections::BTreeMap;
use std::sync::Arc;

use crate::dim::Dimension;
use crate::diag::{Diag, Diagnostic, ErrorCode, Span};
use crate::eval::value::EquationProvenance;
use crate::packs::contract::ArgContract;
use crate::parser::Expr;
use crate::quantity::UnitExpr;

/// One equation loaded from a pack (pre-parsed body, frozen contracts).
#[derive(Debug, Clone)]
pub struct EquationRecord {
    /// Lookup key (`ACI.fr`).
    pub path_key: String,
    /// Namespace segment (`ACI`).
    pub namespace: String,
    /// Equation id within namespace (`fr`).
    pub id: String,
    /// Pre-parsed, dimensionally consistent body.
    pub body: Arc<Expr>,
    /// Contract result unit as written.
    pub result_unit: UnitExpr,
    /// Cached result dimension.
    pub result_dim: Dimension,
    /// Named argument contracts in declaration order.
    pub args: BTreeMap<String, ArgContract>,
    /// Citation and pack metadata for calc sheets.
    pub provenance: EquationProvenance,
}

/// Immutable index of equations for one registry generation.
#[derive(Debug, Clone, Default)]
pub struct EquationRegistry {
    by_path: Arc<BTreeMap<String, Arc<EquationRecord>>>,
}

impl EquationRegistry {
    /// Empty registry (no packs loaded).
    pub fn empty() -> Self {
        Self::default()
    }

    /// Build from a map of path key → record.
    pub(crate) fn from_map(map: BTreeMap<String, Arc<EquationRecord>>) -> Self {
        Self {
            by_path: Arc::new(map),
        }
    }

    /// Lookup by path segments (`["ACI", "fr"]`).
    pub fn lookup(&self, path: &[String]) -> Option<&Arc<EquationRecord>> {
        let key = path.join(".");
        self.by_path.get(&key)
    }

    /// Iterate loaded equations.
    pub fn equations(&self) -> impl Iterator<Item = &Arc<EquationRecord>> {
        self.by_path.values()
    }

    /// Insert during pack loading (builder only).
    pub(crate) fn insert(
        map: &mut BTreeMap<String, Arc<EquationRecord>>,
        record: Arc<EquationRecord>,
    ) -> Result<(), Diag> {
        if map.contains_key(&record.path_key) {
            return Err(Diag::new(Diagnostic::error(
                ErrorCode::PackParse,
                format!("duplicate equation `{}`", record.path_key),
                Span::empty(0),
            )));
        }
        map.insert(record.path_key.clone(), record);
        Ok(())
    }
}