Skip to content

SolidCraft: an open-source parametric 3D CAD application built in pure Rust. Desktop, web, and automation through MCP.

Wave 31/509: kernel: boolean runner grades the seeds against a reference volume (and 1 more)

Brennen Herbruck03e3bee095b3
diff --git a/apps/solidcraft-cli/Cargo.toml b/apps/solidcraft-cli/Cargo.toml
index 4342a14156..e5da188fff 100644
--- a/apps/solidcraft-cli/Cargo.toml
+++ b/apps/solidcraft-cli/Cargo.toml
@@ -24,6 +24,10 @@ default = ["raytrace-cpu"]
bundled-render-library = ["solidcraft-engine/bundled-render-library"]
raytrace-cpu = ["solidcraft-engine/raytrace-cpu"]
+[features]
+# Link SMLib into the kernel, for the regression rig's smlib runs (tests/kernel-cases).
+smlib = ["solidcraft-engine/smlib"]
+
[dependencies]
solidcraft-engine = { workspace = true }
solidcraft-gpu = { workspace = true }
diff --git a/apps/solidcraft-cli/src/kernel_cases.rs b/apps/solidcraft-cli/src/kernel_cases.rs
index aac5612393..cedc81c2e2 100644
--- a/apps/solidcraft-cli/src/kernel_cases.rs
+++ b/apps/solidcraft-cli/src/kernel_cases.rs
@@ -62,7 +62,13 @@ fn check_case(dir: &str) -> Value {
};
if kernel() == "smlib" && !solidcraft_engine::kernel::smlib_built() {
out["status"] = json!("unsupported");
- out["error"] = json!("this build has no SMLib: build solidcraft-cli with --features solidcraft-kernel/smlib");
+ out["error"] = json!("this build has no SMLib: build solidcraft-cli with --features smlib");
+ return out;
+ }
+ let running = solidcraft_engine::kernel::boolean_kernel();
+ if kernel() != running {
+ out["status"] = json!("unsupported");
+ out["error"] = json!(format!("this build runs booleans on the {running} kernel, not {}", kernel()));
return out;
}
let refused = want["outcome"].as_str() == Some("refused");
diff --git a/crates/engine/Cargo.toml b/crates/engine/Cargo.toml
index 4239cc0ae8..cb20407079 100644
--- a/crates/engine/Cargo.toml
+++ b/crates/engine/Cargo.toml
@@ -13,6 +13,8 @@ default = []
# Optional authored texture/HDR bytes; the command registry and metadata remain available.
bundled-render-library = []
raytrace-cpu = ["solidcraft-render/raytrace-cpu"]
+# Link SMLib into the kernel (solidcraft-kernel/smlib; needs scripts/fetch-smlib.sh).
+smlib = ["solidcraft-kernel/smlib"]
# Turns on the parameter-contract audit recorder (`SOLIDCRAFT_PARAM_AUDIT`, see
# `src/schema/record.rs`), for checking a new contract against the whole test suite.
param-audit = []
diff --git a/crates/kernel/examples/smlib_booleans.rs b/crates/kernel/examples/smlib_booleans.rs
index d5da109878..756be11c6d 100644
--- a/crates/kernel/examples/smlib_booleans.rs
+++ b/crates/kernel/examples/smlib_booleans.rs
@@ -690,6 +690,145 @@ mod run {
}
}
+ /// Where `s` holds material along the vertical line through (x, y): one z interval, since
+ /// every fuzz primitive (box, axis-aligned cylinder, sphere, torus about +Z) is convex along
+ /// z. `None` off it; `Err` for a primitive this can't do (a slanted axis).
+ fn z_span(s: &Shape, x: f64, y: f64) -> Result<Option<(f64, f64)>, ()> {
+ let half = |r2: f64| (r2 >= 0.0).then(|| r2.sqrt());
+ Ok(match *s {
+ Shape::Box { a, b } => (x >= a[0] && x <= b[0] && y >= a[1] && y <= b[1]).then_some((a[2], b[2])),
+ Shape::Sphere { center: c, radius: r } => half(r * r - (x - c[0]).powi(2) - (y - c[1]).powi(2)).map(|h| (c[2] - h, c[2] + h)),
+ Shape::Torus { center: c, major, minor } => {
+ let rho = ((x - c[0]).powi(2) + (y - c[1]).powi(2)).sqrt();
+ half(minor * minor - (rho - major).powi(2)).map(|h| (c[2] - h, c[2] + h))
+ }
+ Shape::Cylinder { base: c, axis, radius: r, height: h } => match axis {
+ [0.0, 0.0, 1.0] => half(r * r - (x - c[0]).powi(2) - (y - c[1]).powi(2)).map(|_| (c[2], c[2] + h)),
+ [1.0, 0.0, 0.0] => {
+ if x < c[0] || x > c[0] + h {
+ None
+ } else {
+ half(r * r - (y - c[1]).powi(2)).map(|d| (c[2] - d, c[2] + d))
+ }
+ }
+ [0.0, 1.0, 0.0] => {
+ if y < c[1] || y > c[1] + h {
+ None
+ } else {
+ half(r * r - (x - c[0]).powi(2)).map(|d| (c[2] - d, c[2] + d))
+ }
+ }
+ _ => return Err(()),
+ },
+ })
+ }
+
+ /// The xy box a primitive covers.
+ fn xy_bounds(s: &Shape) -> [f64; 4] {
+ match *s {
+ Shape::Box { a, b } => [a[0], b[0], a[1], b[1]],
+ Shape::Sphere { center: c, radius: r } => [c[0] - r, c[0] + r, c[1] - r, c[1] + r],
+ Shape::Torus { center: c, major, minor } => {
+ let r = major + minor;
+ [c[0] - r, c[0] + r, c[1] - r, c[1] + r]
+ }
+ Shape::Cylinder { base: c, axis, radius: r, height: h } => {
+ let lo = |i: usize| c[i] - if axis[i] > 0.5 { 0.0 } else { r };
+ let hi = |i: usize| c[i] + if axis[i] > 0.5 { h } else { r };
+ [lo(0), hi(0), lo(1), hi(1)]
+ }
+ }
+ }
+
+ /// Cells per side of the reference integration's grid (about; see [`axis_cells`]).
+ const GRID: usize = 1600;
+
+ /// Where a primitive's material starts or stops changing smoothly along x (`i` = 0) or y
+ /// (`i` = 1): box faces, a cylinder's ends, and where a round outline turns.
+ fn breaks(s: &Shape, i: usize) -> Vec<f64> {
+ match *s {
+ Shape::Box { a, b } => vec![a[i], b[i]],
+ Shape::Sphere { center: c, radius: r } => vec![c[i] - r, c[i], c[i] + r],
+ Shape::Torus { center: c, major, minor } => {
+ let (o, n) = (major + minor, major - minor);
+ vec![c[i] - o, c[i] - n, c[i], c[i] + n, c[i] + o]
+ }
+ Shape::Cylinder { base: c, axis, radius: r, height: h } => {
+ if axis[i] > 0.5 {
+ vec![c[i], c[i] + h]
+ } else {
+ vec![c[i] - r, c[i], c[i] + r]
+ }
+ }
+ }
+ }
+
+ /// Midpoints and widths of cells along one axis over `lo..hi`, about `n` of them, with every
+ /// break a cell boundary, so straight faces fall on cell edges and leave no error.
+ fn axis_cells(lo: f64, hi: f64, mut cuts: Vec<f64>, n: usize) -> Vec<(f64, f64)> {
+ cuts.retain(|x| *x > lo && *x < hi);
+ cuts.extend([lo, hi]);
+ cuts.sort_by(f64::total_cmp);
+ cuts.dedup();
+ let step = (hi - lo) / n as f64;
+ let mut cells = Vec::new();
+ for w in cuts.windows(2) {
+ let (a, b) = (w[0], w[1]);
+ let k = ((b - a) / step).ceil().max(1.0) as usize;
+ let d = (b - a) / k as f64;
+ cells.extend((0..k).map(|j| (a + (j as f64 + 0.5) * d, d)));
+ }
+ cells
+ }
+
+ /// The volume of `a op b` on a grid of about `n` × `n` cells (see [`reference_volume`]).
+ fn grid_volume(a: &Shape, b: &Shape, op: BoolOp, n: usize) -> Option<f64> {
+ let (ba, bb) = (xy_bounds(a), xy_bounds(b));
+ let r = [ba[0].min(bb[0]), ba[1].max(bb[1]), ba[2].min(bb[2]), ba[3].max(bb[3])];
+ let cut = |i: usize| [breaks(a, i), breaks(b, i)].concat();
+ let (xs, ys) = (axis_cells(r[0], r[1], cut(0), n), axis_cells(r[2], r[3], cut(1), n));
+ let len = |s: Option<(f64, f64)>| s.map_or(0.0, |(lo, hi)| (hi - lo).max(0.0));
+ let mut v = 0.0;
+ for &(x, dx) in &xs {
+ for &(y, dy) in &ys {
+ let (p, q) = (z_span(a, x, y).ok()?, z_span(b, x, y).ok()?);
+ let both = match (p, q) {
+ (Some(p), Some(q)) => len(Some((p.0.max(q.0), p.1.min(q.1)))),
+ _ => 0.0,
+ };
+ v += dx
+ * dy
+ * match op {
+ BoolOp::Union => len(p) + len(q) - both,
+ BoolOp::Intersect => both,
+ BoolOp::Cut => len(p) - both,
+ };
+ }
+ }
+ Some(v)
+ }
+
+ /// The volume of `a op b` from the primitives' own definitions, by no kernel, and how far it
+ /// may be off: along each vertical line both operands are exact z intervals, combined
+ /// exactly, integrated over a grid whose cell edges include every straight face. What error
+ /// is left comes from curved outlines; the grid at half the resolution bounds it. `None`
+ /// for a primitive [`z_span`] can't do.
+ fn reference_volume(a: &Shape, b: &Shape, op: BoolOp) -> Option<(f64, f64)> {
+ let fine = grid_volume(a, b, op, GRID)?;
+ let coarse = grid_volume(a, b, op, GRID / 2)?;
+ Some((fine, (fine - coarse).abs()))
+ }
+
+ /// Which kernel's volume is off the reference by more than [`VOLUME_REL`].
+ fn graded(o: &Outcome, reference: Option<(f64, f64)>) -> Option<bool> {
+ let (r, uncertain) = reference?;
+ if o.error.is_some() {
+ return None;
+ }
+ let v = if o.empty { 0.0 } else { o.volume };
+ Some((v - r).abs() <= (VOLUME_REL * r.abs()).max(3.0 * uncertain).max(1e-6))
+ }
+
/// How far a measured volume lies from the analytic one, relative; `None` when it made none.
fn off(o: &Outcome, analytic: f64) -> Option<f64> {
if o.error.is_some() {
@@ -751,6 +890,7 @@ mod run {
let mut rows = Vec::new();
let mut md = String::new();
let mut tally = std::collections::BTreeMap::<&str, usize>::new();
+ let mut grades = std::collections::BTreeMap::<(&str, &str), usize>::new();
let (mut truck_ms, mut smlib_ms, mut import_ms, mut export_ms) = (Vec::new(), Vec::new(), Vec::new(), Vec::new());
let (mut truck_fail, mut smlib_fail, mut export_fail) = (0usize, 0usize, 0usize);
let (mut analytic_ops, mut truck_exact, mut smlib_exact) = (0usize, 0usize, 0usize);
@@ -761,6 +901,28 @@ mod run {
let (what, class) = verdict(&t, &s);
*tally.entry(class).or_default() += 1;
let want = analytic.and_then(|v| v.get(k).copied());
+ // Rows without an analytic volume (the seeds): a reference from the primitives'
+ // definitions, each kernel graded against it.
+ let reference = if want.is_none() { reference_volume(a, b, op) } else { None };
+ let grade = |o: &Outcome| match graded(o, reference) {
+ Some(true) => "ok",
+ Some(false) => "WRONG",
+ None => "-",
+ };
+ let (gt, gs) = (grade(&t), grade(&s));
+ if reference.is_some() {
+ *grades.entry(("truck", gt)).or_default() += 1;
+ *grades.entry(("SMLib", gs)).or_default() += 1;
+ }
+ let what = if gt == "WRONG" || gs == "WRONG" {
+ format!(
+ "{what}; volume vs reference {:.3} ± {:.3}: truck {gt}, SMLib {gs}",
+ reference.map_or(f64::NAN, |r| r.0),
+ reference.map_or(f64::NAN, |r| r.1)
+ )
+ } else {
+ what
+ };
if let Some(w) = want {
analytic_ops += 1;
truck_exact += usize::from(off(&t, w).is_some_and(|d| d <= VOLUME_REL));
@@ -795,6 +957,8 @@ mod run {
"case": name, "a": a, "b": b, "op": op_name(op), "analytic": want,
"truck": outcome_json(&t), "smlib": outcome_json(&s),
"verdict": class, "detail": what,
+ "reference_volume": reference.map(|r| r.0), "reference_uncertainty": reference.map(|r| r.1),
+ "truck_volume_grade": gt, "smlib_volume_grade": gs,
}));
}
}
@@ -837,6 +1001,14 @@ mod run {
let mut report = String::new();
let _ = writeln!(report, "# Booleans: truck and SMLib side by side\n");
let _ = writeln!(report, "{} cases × 3 operations: {}.\n", cases.len(), summary.join(", "));
+ let grade_text: Vec<String> = grades.iter().map(|((k, g), n)| format!("{k} {g} {n}")).collect();
+ let _ = writeln!(
+ report,
+ "Rows without an analytic volume, against a reference from the primitives' definitions (exact z \
+ intervals on a grid of about {GRID}² cells with every straight face on a cell edge; within \
+ {VOLUME_REL:e} relative or 3× the grid's own error bound): {}.\n",
+ grade_text.join(", ")
+ );
let _ = writeln!(
report,
"Failed: truck {truck_fail}/{ops}, SMLib {smlib_fail}/{ops}; SMLib results that don't export back to truck \
@@ -874,11 +1046,11 @@ mod run {
report.push_str(&md);
std::fs::create_dir_all(&out).map_err(|e| format!("{}: {e}", out.display()))?;
- let json = json!({ "cases": cases.len(), "tally": tally, "rows": rows, "sequence": seq_json });
+ let json = json!({ "cases": cases.len(), "tally": tally, "reference_grades": grades.iter().map(|((k, g), n)| json!({"kernel": k, "grade": g, "count": n})).collect::<Vec<_>>(), "rows": rows, "sequence": seq_json });
let text = serde_json::to_string_pretty(&json).map_err(|e| e.to_string())?;
std::fs::write(out.join("smlib-booleans.json"), text).map_err(|e| e.to_string())?;
std::fs::write(out.join("smlib-booleans.md"), &report).map_err(|e| e.to_string())?;
- println!("{} cases × 3: {} ({})", cases.len(), summary.join(", "), out.display());
+ println!("{} cases × 3: {}; against the reference: {} ({})", cases.len(), summary.join(", "), grade_text.join(", "), out.display());
Ok(())
}
}
diff --git a/crates/kernel/src/lib.rs b/crates/kernel/src/lib.rs
index c9423410d1..532a62a674 100644
--- a/crates/kernel/src/lib.rs
+++ b/crates/kernel/src/lib.rs
@@ -224,7 +224,7 @@ pub use sweep_path::{RailFit, SweepControl, SweepOrientation, sweep_path, sweep_
pub use topo::{CylinderFace, cylinder_end_at, cylinder_face, cylinder_face_at};
pub use topo::{TopoCounts, merged_topology, seam_flags};
pub use tspline::tspline_sheet;
-pub use validity::{Validity, smlib_built, validity};
+pub use validity::{Validity, boolean_kernel, smlib_built, validity};
pub use whole_face::{WholeFace, cut_takes_only_the_face, cut_tool, face_prism, matching_face};
#[derive(Debug, Clone, PartialEq, thiserror::Error)]
diff --git a/crates/kernel/src/validity.rs b/crates/kernel/src/validity.rs
index 3ccd5f85bf..4945987808 100644
--- a/crates/kernel/src/validity.rs
+++ b/crates/kernel/src/validity.rs
@@ -47,3 +47,11 @@ fn smlib_validity(_: &Body) -> Option<Result<(), String>> {
pub fn smlib_built() -> bool {
cfg!(feature = "smlib")
}
+
+/// The kernel booleans run on in this process: `"default"` or `"smlib"`. The regression rig
+/// refuses to grade a kernel the process isn't running. The SMLib boolean switch
+/// (`SOLIDCRAFT_BOOLEANS=smlib`) answers here once it lands; until then this is always
+/// `"default"`.
+pub fn boolean_kernel() -> &'static str {
+ "default"
+}
diff --git a/tests/kernel-cases/README.md b/tests/kernel-cases/README.md
index ebd03b82f4..4724762b8b 100644
--- a/tests/kernel-cases/README.md
+++ b/tests/kernel-cases/README.md
@@ -10,7 +10,7 @@ cargo xtask kernel-cases --kernel both --cli target/release/solidcraft-cli # a
cargo run -p solidcraft-cli -- kernel-cases tests/kernel-cases/booleans/<id> # one case
```
-For the `smlib` column, build `solidcraft-cli` with `--features solidcraft-kernel/smlib` (after
+For the `smlib` column, build `solidcraft-cli` with `--features smlib` (after
`scripts/fetch-smlib.sh`). The rig sets `SOLIDCRAFT_BOOLEANS=smlib` for those runs.
## Rules
@@ -46,8 +46,8 @@ Each case has:
specification, never a user's file).
- `expected.json`: the right answer, graded by `solidcraft-cli kernel-cases`.
-Each area also has `skipped.json`: every issue and PR looked at that did not become a case, with
-one line each saying why.
+Each area also has `skipped.json` (or several, `skipped-<part>.json`, where an area is triaged in
+parts): every issue and PR looked at that did not become a case, with one line each saying why.
```json
[{"source": "tangency-labs/solidcraft#123", "why": "UI only: the selection highlight, no geometry"}]
diff --git a/xtask/src/kernel_cases.rs b/xtask/src/kernel_cases.rs
index bff77ea9be..f6fa06a41c 100644
--- a/xtask/src/kernel_cases.rs
+++ b/xtask/src/kernel_cases.rs
@@ -189,6 +189,11 @@ fn sources_of(want: &Value) -> Vec<String> {
want["sources"].as_array().into_iter().flatten().filter_map(|s| s.as_str().map(str::to_string)).collect()
}
+/// The number in `owner/repo#123`, for sorting.
+fn source_number(s: &str) -> u64 {
+ s.rsplit('#').next().and_then(|n| n.parse().ok()).unwrap_or(u64::MAX)
+}
+
/// `tangency-labs/solidcraft#123` as a link.
fn link(source: &str) -> String {
match source.split_once('#') {
@@ -274,8 +279,20 @@ fn write_report(o: &Options, dir: &Path, list: &[PathBuf], results: &[Value]) ->
let mut area_dirs: Vec<PathBuf> = std::fs::read_dir(dir).map_err(|e| e.to_string())?.flatten().map(|e| e.path()).filter(|p| p.is_dir()).collect();
area_dirs.sort();
for a in area_dirs {
- let list = read(&a.join("skipped.json"));
- let Some(items) = list.as_array().filter(|l| !l.is_empty()) else { continue };
+ // skipped.json, or several (skipped-<part>.json) where people triage an area in parts.
+ let mut files: Vec<PathBuf> = std::fs::read_dir(&a)
+ .map_err(|e| e.to_string())?
+ .flatten()
+ .map(|e| e.path())
+ .filter(|p| p.file_name().and_then(|n| n.to_str()).is_some_and(|n| n.starts_with("skipped") && n.ends_with(".json")))
+ .collect();
+ files.sort();
+ let mut items: Vec<Value> = files.iter().flat_map(|f| read(f).as_array().cloned().unwrap_or_default()).collect();
+ if items.is_empty() {
+ continue;
+ }
+ items.sort_by_key(|it| source_number(it["source"].as_str().unwrap_or("")));
+ let items = &items;
md += &format!("### {}\n\n| Source | Why skipped |\n|---|---|\n", a.file_name().map(|n| n.to_string_lossy().to_string()).unwrap_or_default());
for it in items {
skipped += 1;