ph-curves 0.3.0

no-std, no-alloc Rust for embedded: curve lookup tables, ADC-to-measurement transfer functions with inverse and calibration, temporal filters, and tickless scheduling
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

//! Host-side TOML → Rust code generation for curves and transfers.
//!
//! Enable with `features = ["gen-lib"]` from a `build.rs` or host tool.
//! Firmware crates should keep the default feature set and `include!`
//! generated source without enabling this module.
//!
//! Host tools that own device evaluation inspect the validated transfer graph
//! (`DefinitionsFile::validate`) and may overlay [`TransferSource`] values or
//! construct families with [`FamilySpec`]. That is a public IR, not a plugin
//! ABI: ph-curves does not load or call device-specific model code.
//! `generate_report` returns the same source as `generate` plus a
//! [`GenerationReport`] of per-transfer metrics, structured provenance/policy,
//! the complete family member/gap graph, named document gaps, and emitted-only
//! resource totals; optional family `max_total_knots` / `max_table_bytes`
//! budgets fail closed on both APIs. [`ValidatedDefinitions::emission_manifest`]
//! is the pre-fit family/selector-to-symbol map.
//!
//! This module is the crate's only `std` consumer. The crate root is
//! unconditionally `#![no_std]` and does not `extern crate std`. Each file
//! under `src/gen` links `std` with a module-local `extern crate std`, imports
//! the prelude by hand, and pulls in `format!` / `vec!` explicitly (those
//! macros are not available without a crate-root `#[macro_use]`). Enabling
//! `gen-lib` therefore cannot add `std` or an allocator to the runtime API.
//!
//! # `build.rs` example
//!
//! ```ignore
//! use std::env;
//! use std::path::PathBuf;
//! use ph_curves::r#gen::{generate_to_path, GenerateOptions};
//!
//! fn main() {
//!     let out = PathBuf::from(env::var_os("OUT_DIR").unwrap()).join("curves.rs");
//!     generate_to_path("assets/curves.toml", &out, &GenerateOptions::default())
//!         .expect("ph-curves gen");
//!     println!("cargo:rerun-if-changed=assets/curves.toml");
//! }
//! ```

#![allow(clippy::std_instead_of_core)]
#![allow(clippy::std_instead_of_alloc)]

// Host-only: crate root stays `#![no_std]` with no crate-wide `std` link.
extern crate std;

mod api;
pub(crate) mod builtin;
pub(crate) mod codegen;
pub(crate) mod curve;
pub(crate) mod formula;
mod ir;
pub(crate) mod points;
mod report;
pub(crate) mod rustdoc;
pub(crate) mod transfer;

pub use api::{
    Error, GenerateOptions, ValueType, generate, generate_from_str, generate_from_str_report,
    generate_from_toml, generate_from_toml_report, generate_report, generate_to_path,
};
pub use curve::{CurveDef, DefinitionsFile};
pub use ir::{
    EmissionEntry, EmissionManifest, ValidatedDefinitions, ValidatedFamily, ValidatedFamilyGap,
    ValidatedMember,
};
pub use report::{
    FamilyGapReport, FamilyMemberReport, FamilyReport, GapReport, GenerationPath, GenerationReport,
    GenerationResult, ResourceTotals, TABLE_BYTES_PER_KNOT, TransferReport,
};
pub use transfer::{
    ApplicabilityDef, BoundaryDef, DeclaredSource, DividerTopology, EvaluatedTruth,
    FamilyCompleteness, FamilyGapDef, FamilyMemberDef, FamilySource, FamilySpec, GapDef, GapStatus,
    GenerationPolicy, InputTransform, MemberStatus, ObservationGuardBehaviorDef,
    ObservationGuardDef, ObservationGuardPolicy, PhysicalPoint, SelectorIdentities,
    SelectorUniverse, SelectorValue, SourceProvenance, SourceProvenanceDisposition,
    SourceProvenanceField, SourceProvenanceOverride, TransferDef, TransferFamilyDef,
    TransferSource, TransferSourceOverlay, TransferSpec,
};