Skip to content

Verification Path

BitCal is header-only, but it still needs an executable path that proves the public surface, the examples, and the current benchmark baseline are all wired together.

Retained command path

bash
cmake -S . -B build-test -DCMAKE_BUILD_TYPE=Release -DBITCAL_BUILD_TESTS=ON -DBITCAL_BUILD_EXAMPLES=ON -DBITCAL_BUILD_BENCHMARKS=ON -DBITCAL_NATIVE_ARCH=ON
cmake --build build-test --config Release -j"$(nproc)"
ctest --test-dir build-test --output-on-failure -C Release
./build-test/benchmarks/bitcal_benchmark

What each step proves

StepWhat it validatesWhy it matters
ConfigureThe repository still builds as a CMake-based header-only package with the current feature toggles.Build posture is part of the contract around <bitcal/bitcal.hpp>.
BuildTests, examples, and benchmark targets still compile together.A clean compile path guards against documentation outrunning integration reality.
ctestThe retained correctness surface still runs through the existing test binary.Claims about public behavior need more than type-checking.
Benchmark binaryThe performance section retains an executable baseline path.Performance numbers without a reproduction route are just decoration.

Benchmark binaries and responsibilities

BitCal intentionally keeps two benchmark executables, and this page still treats only one of them as part of the minimum verification loop.

BinaryPrimary roleRead it here or elsewhere?
bitcal_benchmarkSmoke-level benchmark executable that proves the benchmark target still builds, runs, and reports a backend path.This page keeps it in the retained verification loop.
benchmark_compareRetained BitCal-vs-std::bitset comparison harness for the current vNext public algorithms.Use the Performance section for that evidence chain and its interpretation rules.

Failure interpretation

The purpose of this path is not to prove that every future optimization is already complete. It is to keep a minimum credible loop alive while the redesign evolves.

  • A build failure means the documented public posture and the repository have drifted apart.
  • A test failure means the observable behavior floor is unstable and the reference pages should be treated cautiously.
  • A benchmark failure means the current performance evidence chain is broken, even if the API still compiles.

Evidence hand-off

Once the command path succeeds, keep reading in this order:

  1. Migration Posture for redesign intent.
  2. Whitepaper for the system architecture spine.
  3. Performance for baseline and methodology.

This sequencing matters because BitCal treats verification as the first filter against overclaiming.

Whitepaper-first technical documentation for BitCal vNext.