fomtools 0.0.2__tar.gz → 0.0.3__tar.gz

{fomtools-0.0.2 → fomtools-0.0.3}/.github/workflows/docs.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [ main ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, documentation ]
 
 permissions:
   contents: write
@@ -54,13 +54,10 @@ jobs:
       - name: Export marimo notebooks
         env:
           GRB_LICENSE_FILE: ${{ github.workspace }}/gurobi.lic
-        run: |
-          for file in docs/tutorials/*.py; do
-            marimo export html "$file" -o "${file%.py}.html"
-          done
+        run: python scripts/export_marimo.py --force
 
       - name: Verify html generation
-        run: ls docs/tutorials
+        run: ls -R docs/tutorials
 
       - name: Configure Git Credentials
         run: |
@@ -79,11 +76,10 @@ jobs:
             mkdocs-material-
 
       - name: Build MkDocs site
-        run: mkdocs build
+        run: mkdocs build --strict
 
-      - name: Deploy to Cloudflare Pages with Wrangler
-        uses: cloudflare/wrangler-action@v4.0.0
-        with:
-          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          command: deploy
+      # Pull requests only build the site; pushes to main publish it to the gh-pages
+      # branch, which GitHub Pages serves at https://stellatogrp.github.io/fomtools/
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: mkdocs gh-deploy --force

{fomtools-0.0.2 → fomtools-0.0.3}/.gitignore

@@ -385,3 +385,8 @@ fomtools.project
 __marimo__/
 *.npz
 .ruff_cache/
+
+.vscode/
+
+# `marimo export html` output, generated by the docs workflow at build time.
+docs/tutorials/**/*.html

{fomtools-0.0.2 → fomtools-0.0.3}/AGENTS.md

@@ -82,3 +82,29 @@ execution of the CUDA checks; `FOMTOOLS_CODEGEN_BACKEND` selects the agent.
 - When the public API or docs change, the `update-skill` workflow refreshes
   `skills/fomtools/`; check its output rather than editing the skill by hand
   in the same PR.
+
+## Tutorial math notation
+
+All `mo.md` cells in `docs/tutorials/` (verification and codegen notebooks) use one notation per concept, following Boyd-style conventions. Keep new notebooks in sync with this table.
+
+| Concept | Write | Never |
+|---|---|---|
+| Reals, ones | `\mathbf{R}`, `\mathbf{R}^n_+`, `\mathbf{1}` | `{\bf R}`, `\R`, `\mathbb{R}` |
+| Transpose | `A^T` | `A^\top` |
+| Calligraphic | `\mathcal{X}` | `{\cal X}` |
+| Problem keywords | `\text{minimize}`, `\text{maximize}`, `\text{subject to}` | `\textnormal{...}` |
+| Delimiters | inline `$...$`, display `$$...$$`, problems and updates as bare `\begin{array}{ll}`/`{rcl}` | `\(...\)`, `\[...\]` |
+| Soft-thresholding | `\mathbf{soft}_{\lambda\eta}` (`soft_threshold` step) | `{\cal T}_\lambda`, `S_\lambda` |
+| Projection | `\Pi_C`: `\Pi_{\mathbf{R}^n_+}` (`relu` step), `\Pi_{[l,u]}` (`satlin` step / `IndBox`) | `\mathbf{ReLU}`, `\mathbf{prox}_{\mathbb{I}_C}` |
+| Proximal operator | `\mathbf{prox}_f` | `\operatorname{prox}` |
+
+Norms always carry a subscript: `\|v\|_2`, `\|v\|_\infty` (never `\lVert v \rVert` or a bare `\|v\|`).
+Define soft-thresholding where it is first used: `\mathbf{soft}_\kappa(v)_i = \mathbf{sign}(v_i)\max\{|v_i| - \kappa, 0\}`, applied element-wise.
+Matplotlib labels (`label=`, `xlabel`, `ylabel`, `title`) are rendered by mathtext, not KaTeX: write `\geq`/`\leq` there (mathtext rejects `\ge`/`\le`), and keep `\|v\|_2` norms.
+
+Symbol roles: `x` problem parameter in `\mathcal{X}`; `z` decision variable and primal iterate, `z^0 \in \mathcal{Z}`, `z^\star` solution; `v, w` dual or auxiliary iterates; `y` (lasso) or `w` (NNLS) for the un-extrapolated proximal output of a momentum method, matching the helper code; `k` iteration, `K` horizon, `\eta` step size, `L` smoothness constant, `r^k` residual, `R` PEP initial radius.
+Search-box bounds are `x_\mathrm{lb}, x_\mathrm{ub}` and `z^0_\mathrm{lb}, z^0_\mathrm{ub}`; problem-data bounds keep `_{\min}, _{\max}`. Code names such as `x_lb` or `s0_samples` appear only in backticks in prose. When a math letter differs from the code name, say so once.
+
+Iterations are written `k \to k+1` for `k = 0, 1, \dots`. A momentum coefficient `\beta_k` uses the same index as the helper code (slot `k` uses `beta_k`, and `k` starts at 1), so the update reads `z^{k+1} = w^{k+1} + \beta_{k+1}(w^{k+1} - w^k)` with `\beta_1 = 0`. Use "Nesterov-type momentum" for `\beta_k = (k-1)/(k+2)` and reserve "FISTA" for the `t_k` schedule `\beta_k = (t_{k-1}-1)/t_k`.
+
+Known clashes kept on purpose because both uses are standard: control input `u_t` vs. OSQP upper bound `u(x)`, LQR weight `R` vs. PEP radius `R`, and `\mu` as network cost, portfolio return, or strong-convexity constant.

fomtools-0.0.3/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing to FOMTools
+
+## Development setup
+
+Follow the environment instructions in [docs/get_started.md](docs/get_started.md) to create a
+virtual environment and install `fomtools` in editable mode with its `dev` and `docs` extras.
+
+Install the pre-commit hooks once per clone:
+
+    pre-commit install
+
+## Tests and linting
+
+    pytest                      # Run the test suite
+    ruff check                  # Check code style
+    ruff format                 # Auto-format
+    pre-commit run --all-files  # Run all hooks
+
+## Previewing the documentation
+
+Install the documentation dependencies and start the local MkDocs server:
+
+    uv sync --extra docs
+    make docs-serve
+
+The `docs-serve` target recursively discovers marimo notebooks under `docs/tutorials`, exports
+missing or stale notebooks to ignored HTML files, and then starts MkDocs. Restart the server after
+editing a notebook so that its HTML is refreshed.
+
+Use these targets to export or validate the documentation without starting the server:
+
+    make docs-export        # Export only missing or stale notebooks
+    make docs-export-force  # Regenerate every notebook
+    make docs-build         # Force export, then run a strict MkDocs build

fomtools-0.0.3/Makefile

@@ -0,0 +1,13 @@
+.PHONY: docs-export docs-export-force docs-serve docs-build
+
+docs-export:
+	uv run --extra docs python scripts/export_marimo.py
+
+docs-export-force:
+	uv run --extra docs python scripts/export_marimo.py --force
+
+docs-serve: docs-export
+	uv run --extra docs mkdocs serve
+
+docs-build: docs-export-force
+	uv run --extra docs mkdocs build --strict

{fomtools-0.0.2/fomtools.egg-info → fomtools-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fomtools
-Version: 0.0.2
+Version: 0.0.3
 Summary: FOMTools: A Python Toolbox for Analysis of First-Order Methods
 Author-email: Vinit Ranjan <vranjan1@mit.edu>, Daniel Deza <dd7022@princeton.edu>, Anushka Acharya <aa9078@princeton.edu>, Jisun Park <jisunpark@princeton.edu>, Bartolomeo Stellato <bstellato@princeton.edu>
 License: Apache 2.0
@@ -41,22 +41,40 @@ Provides-Extra: nn
 Requires-Dist: torch; extra == "nn"
 Requires-Dist: jax<0.11.2; extra == "nn"
 Requires-Dist: flax; extra == "nn"
+Provides-Extra: all
+Requires-Dist: fomtools[codegen,cvxpygen,gurobi,nn]; extra == "all"
+Requires-Dist: fomtools[gpu]; sys_platform != "darwin" and extra == "all"
+Requires-Dist: fomtools[cuda]; extra == "all"
 Provides-Extra: docs
 Requires-Dist: fomtools[gurobi]; extra == "docs"
 Requires-Dist: marimo; extra == "docs"
 Requires-Dist: matplotlib; extra == "docs"
-Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs<2,>=1.6; extra == "docs"
 Requires-Dist: mkdocstrings-python; extra == "docs"
 Requires-Dist: mkdocs-marimo; extra == "docs"
 Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: networkx; extra == "docs"
+Requires-Dist: pepit; extra == "docs"
 Requires-Dist: pymdown-extensions; extra == "docs"
 Dynamic: license-file
 
-FOMTools
-========
+<h1>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/stellatogrp/fomtools/main/docs/assets/logo/logo-dark.svg">
+    <img alt="FOMTools" src="https://raw.githubusercontent.com/stellatogrp/fomtools/main/docs/assets/logo/logo.svg" height="72">
+  </picture>
+</h1>
+
+[![PyPI](https://img.shields.io/pypi/v/fomtools.svg)](https://pypi.org/project/fomtools/)
+[![Docs](https://img.shields.io/badge/docs-stellatogrp.github.io%2Ffomtools-blue.svg)](https://stellatogrp.github.io/fomtools/)
 
 **Development, analysis, and code generation for first-order methods.**
 
+[Documentation](https://stellatogrp.github.io/fomtools/) |
+[PyPI](https://pypi.org/project/fomtools/) |
+[Paper](https://arxiv.org/abs/2610.26743) |
+[Benchmarks](https://github.com/stellatogrp/fomtools_experiments)
+
 FOMTools is an open-source Python package for developing, analyzing, and deploying
 first-order methods for parametric linear and convex quadratic optimization. You write the
 iteration in Python, with syntax close to its mathematical description, and FOMTools records
@@ -114,7 +132,7 @@ for k in range(K):
 
 Steps can also be written with proximal operators and projections, e.g.,
 `VP.prox(NormL1(lambd), v, eta)` or `VP.project(Box(l, u), v)`. See the
-[documentation](https://github.com/stellatogrp/fomtools/tree/main/docs) for the full list of proxable functions and sets.
+[documentation](https://stellatogrp.github.io/fomtools/) for the full list of proxable functions and sets.
 
 ## Beyond worst-case verification
 
@@ -174,11 +192,26 @@ Optional extras:
 | `codegen`  | LLM coding-agent backends for code generation      |
 | `cvxpygen` | CVXPYgen integration                               |
 | `nn`       | Neural-network verification (PyTorch, JAX, Flax)   |
+| `all`      | All of the above (GPU packages skipped on macOS)   |
 | `dev`      | Development tools                                  |
 | `docs`     | Documentation build dependencies                   |
 
 For example, `pip install "fomtools[gurobi,codegen]"`, or
-`pip install -e ".[gurobi,codegen]"` from source.
+`pip install -e ".[gurobi,codegen]"` from source. Use `pip install "fomtools[all]"`
+to install every optional feature.
+
+### Agent skill
+
+FOMTools ships an [Agent Skill](https://agentskills.io/) in
+[`skills/fomtools`](skills/fomtools/SKILL.md) that teaches coding agents (Claude
+Code, Codex, Cursor, and others) the FOMTools API. Install it with the
+[`skills` CLI](https://github.com/vercel-labs/skills) (requires Node.js):
+
+```bash
+npx skills add stellatogrp/fomtools -g
+```
+
+See [Get started](https://stellatogrp.github.io/fomtools/get_started/) for details.
 
 FOMTools is not a solver. It relies on mathematical programming solvers such as
 [HiGHS](https://highs.dev) (the default) and [Gurobi](https://www.gurobi.com) to solve
@@ -186,9 +219,14 @@ the verification problems it builds.
 
 ## Examples
 
-The [tutorials](https://github.com/stellatogrp/fomtools/tree/main/docs/tutorials) cover sparse coding (Lasso), nonnegative least squares,
-network optimization, optimal control, and portfolio rebalancing. Code to reproduce the
-experiments in our [paper](https://arxiv.org/abs/2610.26743) is available at
+The [tutorials](https://stellatogrp.github.io/fomtools/tutorials/) cover sparse coding (Lasso), nonnegative least squares,
+network optimization, optimal control, and portfolio rebalancing.
+
+## Benchmarks
+
+The benchmarks and the code to reproduce the experiments in our
+[paper](https://arxiv.org/abs/2610.26743) (verification, simulation, and code generation on
+CPU and GPU) are in a separate repository,
 [stellatogrp/fomtools_experiments](https://github.com/stellatogrp/fomtools_experiments).
 
 ## Contributing
@@ -215,3 +253,6 @@ If you use FOMTools for published work, we encourage you to cite our
   year    = {2026},
 }
 ```
+
+The mixed-integer verification method is described in
+[Exact Verification of First-Order Methods via Mixed-Integer Linear Programming](https://arxiv.org/abs/2412.11330).

{fomtools-0.0.2 → fomtools-0.0.3}/README.md

@@ -1,8 +1,20 @@
-FOMTools
-========
+<h1>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/stellatogrp/fomtools/main/docs/assets/logo/logo-dark.svg">
+    <img alt="FOMTools" src="https://raw.githubusercontent.com/stellatogrp/fomtools/main/docs/assets/logo/logo.svg" height="72">
+  </picture>
+</h1>
+
+[![PyPI](https://img.shields.io/pypi/v/fomtools.svg)](https://pypi.org/project/fomtools/)
+[![Docs](https://img.shields.io/badge/docs-stellatogrp.github.io%2Ffomtools-blue.svg)](https://stellatogrp.github.io/fomtools/)
 
 **Development, analysis, and code generation for first-order methods.**
 
+[Documentation](https://stellatogrp.github.io/fomtools/) |
+[PyPI](https://pypi.org/project/fomtools/) |
+[Paper](https://arxiv.org/abs/2610.26743) |
+[Benchmarks](https://github.com/stellatogrp/fomtools_experiments)
+
 FOMTools is an open-source Python package for developing, analyzing, and deploying
 first-order methods for parametric linear and convex quadratic optimization. You write the
 iteration in Python, with syntax close to its mathematical description, and FOMTools records
@@ -60,7 +72,7 @@ for k in range(K):
 
 Steps can also be written with proximal operators and projections, e.g.,
 `VP.prox(NormL1(lambd), v, eta)` or `VP.project(Box(l, u), v)`. See the
-[documentation](https://github.com/stellatogrp/fomtools/tree/main/docs) for the full list of proxable functions and sets.
+[documentation](https://stellatogrp.github.io/fomtools/) for the full list of proxable functions and sets.
 
 ## Beyond worst-case verification
 
@@ -120,11 +132,26 @@ Optional extras:
 | `codegen`  | LLM coding-agent backends for code generation      |
 | `cvxpygen` | CVXPYgen integration                               |
 | `nn`       | Neural-network verification (PyTorch, JAX, Flax)   |
+| `all`      | All of the above (GPU packages skipped on macOS)   |
 | `dev`      | Development tools                                  |
 | `docs`     | Documentation build dependencies                   |
 
 For example, `pip install "fomtools[gurobi,codegen]"`, or
-`pip install -e ".[gurobi,codegen]"` from source.
+`pip install -e ".[gurobi,codegen]"` from source. Use `pip install "fomtools[all]"`
+to install every optional feature.
+
+### Agent skill
+
+FOMTools ships an [Agent Skill](https://agentskills.io/) in
+[`skills/fomtools`](skills/fomtools/SKILL.md) that teaches coding agents (Claude
+Code, Codex, Cursor, and others) the FOMTools API. Install it with the
+[`skills` CLI](https://github.com/vercel-labs/skills) (requires Node.js):
+
+```bash
+npx skills add stellatogrp/fomtools -g
+```
+
+See [Get started](https://stellatogrp.github.io/fomtools/get_started/) for details.
 
 FOMTools is not a solver. It relies on mathematical programming solvers such as
 [HiGHS](https://highs.dev) (the default) and [Gurobi](https://www.gurobi.com) to solve
@@ -132,9 +159,14 @@ the verification problems it builds.
 
 ## Examples
 
-The [tutorials](https://github.com/stellatogrp/fomtools/tree/main/docs/tutorials) cover sparse coding (Lasso), nonnegative least squares,
-network optimization, optimal control, and portfolio rebalancing. Code to reproduce the
-experiments in our [paper](https://arxiv.org/abs/2610.26743) is available at
+The [tutorials](https://stellatogrp.github.io/fomtools/tutorials/) cover sparse coding (Lasso), nonnegative least squares,
+network optimization, optimal control, and portfolio rebalancing.
+
+## Benchmarks
+
+The benchmarks and the code to reproduce the experiments in our
+[paper](https://arxiv.org/abs/2610.26743) (verification, simulation, and code generation on
+CPU and GPU) are in a separate repository,
 [stellatogrp/fomtools_experiments](https://github.com/stellatogrp/fomtools_experiments).
 
 ## Contributing
@@ -161,3 +193,6 @@ If you use FOMTools for published work, we encourage you to cite our
   year    = {2026},
 }
 ```
+
+The mixed-integer verification method is described in
+[Exact Verification of First-Order Methods via Mixed-Integer Linear Programming](https://arxiv.org/abs/2412.11330).

fomtools-0.0.3/docs/api/canonicalizer.md

@@ -0,0 +1,38 @@
+# Canonicalizers
+
+Canonicalizers translate a verification problem into a solver-ready formulation
+(MIP or SDP), including optimization-based bound tightening (OBBT).
+
+::: fomtools.canonicalizers.Canonicalizer
+
+## MIP canonicalizer
+
+::: fomtools.canonicalizers.mip
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      heading_level: 3
+
+## OBBT handler
+
+::: fomtools.canonicalizers.obbt_handler
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      heading_level: 3
+
+## Simulator
+
+::: fomtools.canonicalizers.simulator
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      heading_level: 3
+
+## SDP canonicalizer
+
+::: fomtools.canonicalizers.sdp
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      heading_level: 3

{fomtools-0.0.2 → fomtools-0.0.3}/docs/api/codegen.md

@@ -5,6 +5,10 @@ methods, plus a tiny Python wrapper. An LLM coding agent translates each step of
 the algorithm into the target language and iterates against a Python reference
 oracle until the generated code is numerically verified.
 
+The [code generation guide](../user_guide/codegen.md) is the narrative reference for
+the symbols below, and the [tutorials](../tutorials/codegen.md) work through five
+complete examples.
+
 ::: fomtools.codegen.generate_code
 
 ::: fomtools.codegen.CodegenConfig

fomtools-0.0.3/docs/api/constraint.md

@@ -0,0 +1,8 @@
+# Constraints
+
+Constraints are equalities and inequalities over linear expressions, used to
+encode assumptions on the problem data and the initial conditions.
+
+::: fomtools.constraint.Constraint
+::: fomtools.constraint.EqualityConstraint
+::: fomtools.constraint.InequalityConstraint

fomtools-0.0.3/docs/api/index.md

@@ -0,0 +1,44 @@
+# API and modules
+
+The FOMTools API is organized around a single entry point, the
+[`Verifier`](verifier.md), and a set of modules that describe the algorithm
+to be verified, the operators it applies, and the numerical backend used
+to analyze it.
+
+A typical workflow is: declare the problem data and iterates on a `Verifier`,
+build up the algorithm from [step operators](steps.md) and
+[proxable functions](proxablefunctions.md), state the assumptions and the
+quantity of interest as [linear expressions](linearexpression.md) and
+[constraints](constraint.md), and then let a
+[canonicalizer](canonicalizer.md) translate everything into a mixed-integer
+program, a semidefinite relaxation, or a sampled simulation; the MIP and SDP
+forms are solved by a [solver](solvers.md) to obtain a worst-case bound.
+
+The source code of every module is in the
+[`fomtools` package on GitHub](https://github.com/stellatogrp/fomtools/tree/main/fomtools).
+
+## Modules
+
+* **[Verifier](verifier.md)** holds the
+  optimization variables and their bounds, applies step operations, propagates
+  interval bounds, and drives the canonicalizers and OBBT handlers.
+* **[Linear expressions](linearexpression.md)** are affine expressions
+  $Ay + b$ of the leaf variables (parameters, initial iterates, and step
+  outputs), with arithmetic and `@` support, used for iterates, objectives, and
+  performance measures.
+* **[Constraints](constraint.md)** are equalities and inequalities over
+  linear expressions, used to encode assumptions on the problem data and the
+  initial conditions.
+* **[Step operators](steps.md)** are the building blocks of a first-order
+  method, covering affine steps, ReLU, saturated linear, and soft thresholding.
+* **[Canonicalizers](canonicalizer.md)** translate a verification problem
+  into a MIP, an SDP relaxation (experimental), or a sampled simulation,
+  including optimization-based bound tightening (OBBT).
+* **[Solvers](solvers.md)** are thin wrappers that put the numerical
+  backends, such as Gurobi and HiGHS, behind a common interface.
+* **[Proxable functions](proxablefunctions.md)** are convex functions whose
+  proximal operators can be used as steps through `vp.prox`, each supplying a
+  numerical prox and the encoding needed by the verification problem. Sets for
+  `vp.project` are on the same page.
+* **[Code generation](codegen.md)** emits low-level solver code for a
+  verified first-order method, together with a small Python wrapper.

fomtools-0.0.3/docs/api/linearexpression.md

@@ -0,0 +1,6 @@
+# Linear expressions
+
+Linear expressions are linear combinations of iterates and function values, with
+arithmetic and `@` support, used to state objectives and performance measures.
+
+::: fomtools.linearexpression.LinearExpression

fomtools-0.0.3/docs/api/proxablefunctions.md

@@ -0,0 +1,35 @@
+# Proxable functions
+
+Proxable functions are convex functions whose proximal operators can be used as
+steps, each supplying a numerical prox and the encoding needed by the
+verification problem. Use `vp.prox(function, arg, gamma=1.0)`; support varies by
+backend, and unsupported operations raise explicitly. They all derive from the
+abstract base class below.
+
+::: fomtools.proxable_functions.ProxableFunction
+    options:
+      show_root_heading: true
+      show_root_toc_entry: true
+
+::: fomtools.proxable_functions
+    options:
+      show_root_heading: false
+      show_root_toc_entry: false
+      filters:
+        - "!^ProxableFunction$"
+
+## Sets and projections
+
+Use `vp.project(set_instance, arg)`.
+
+::: fomtools.sets.Set
+::: fomtools.sets.Polyhedron
+::: fomtools.sets.HalfSpace
+::: fomtools.sets.Simplex
+::: fomtools.sets.Box
+::: fomtools.sets.NonNegative
+::: fomtools.sets.NonPositive
+::: fomtools.sets.Point
+::: fomtools.sets.L1Ball
+::: fomtools.sets.LinfBall
+::: fomtools.sets.AffineSubspace

{fomtools-0.0.2 → fomtools-0.0.3}/docs/api/solvers.md

@@ -1,4 +1,7 @@
-## Solvers
+# Solvers
+
+Solvers are thin wrappers that put the numerical backends, such as Gurobi and
+HiGHS, behind a common interface.
 
 ::: fomtools.solvers.Solver
 ::: fomtools.solvers.gurobi.GurobiSolver

{fomtools-0.0.2 → fomtools-0.0.3}/docs/api/steps.md

@@ -1,4 +1,7 @@
-## Step Operators
+# Step operators
+
+Step operators are the building blocks of a first-order method, covering
+affine steps, ReLU, saturated linear, and soft thresholding.
 
 ::: fomtools.steps.step.Step
 ::: fomtools.steps.affine.Affine

fomtools-0.0.3/docs/api/verifier.md

@@ -0,0 +1,7 @@
+# Verifier
+
+The verifier holds the optimization variables and their bounds, applies step
+operations, propagates interval bounds, and drives the canonicalizers and OBBT
+handlers.
+
+::: fomtools.Verifier

fomtools-0.0.3/docs/assets/logo/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><style>.a{stroke:#2D3748}.b{stroke:#E77500}.c{fill:#E77500}@media (prefers-color-scheme:dark){.a{stroke:#E5E7EB}.b{stroke:#00A6F4}.c{fill:#00A6F4}}</style><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" class="a" stroke-width="7.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28.5 21.5 L20 32 L28.5 42.5 M35.5 21.5 L44 32 L35.5 42.5" fill="none" class="b" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/><circle cx="32" cy="32" r="5" class="c"/></svg>

fomtools-0.0.3/docs/assets/logo/icon-dark.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" stroke="#E5E7EB" stroke-width="7.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28.5 21.5 L20 32 L28.5 42.5 M35.5 21.5 L44 32 L35.5 42.5" fill="none" stroke="#00A6F4" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/><circle cx="32" cy="32" r="5" fill="#00A6F4"/></svg>

fomtools-0.0.3/docs/assets/logo/icon-mono.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" stroke="#131313" stroke-width="7.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28.5 21.5 L20 32 L28.5 42.5 M35.5 21.5 L44 32 L35.5 42.5" fill="none" stroke="#131313" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/><circle cx="32" cy="32" r="5" fill="#131313"/></svg>

fomtools-0.0.3/docs/assets/logo/icon-small.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" stroke="#2D3748" stroke-width="8" stroke-linecap="round" stroke-linejoin="round"/><path d="M30 21 L20 32 L30 43 M34 21 L44 32 L34 43" fill="none" stroke="#E77500" stroke-width="6.5" stroke-linecap="round" stroke-linejoin="round"/></svg>

fomtools-0.0.3/docs/assets/logo/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" stroke="#2D3748" stroke-width="7.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28.5 21.5 L20 32 L28.5 42.5 M35.5 21.5 L44 32 L35.5 42.5" fill="none" stroke="#E77500" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/><circle cx="32" cy="32" r="5" fill="#E77500"/></svg>

fomtools-0.0.3/docs/assets/logo/logo-dark.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 253.93 64" width="253.93" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" stroke="#E5E7EB" stroke-width="7.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28.5 21.5 L20 32 L28.5 42.5 M35.5 21.5 L44 32 L35.5 42.5" fill="none" stroke="#00A6F4" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/><circle cx="32" cy="32" r="5" fill="#00A6F4"/><path d="M82.33 46V18H101.16V22.3H87.29V29.95H100.16V34.16H87.29V46ZM116.17 46.45Q112.42 46.45 109.48 44.66Q106.53 42.86 104.83 39.62Q103.13 36.38 103.13 32.02Q103.13 27.64 104.83 24.39Q106.53 21.14 109.48 19.34Q112.42 17.55 116.17 17.55Q119.91 17.55 122.86 19.34Q125.81 21.14 127.52 24.39Q129.22 27.64 129.22 32.02Q129.22 36.38 127.52 39.63Q125.81 42.88 122.86 44.67Q119.91 46.45 116.17 46.45ZM116.17 42Q118.47 42 120.28 40.83Q122.09 39.67 123.15 37.44Q124.2 35.21 124.2 32.02Q124.2 28.81 123.15 26.57Q122.09 24.33 120.28 23.17Q118.47 22 116.17 22Q113.88 22 112.07 23.17Q110.26 24.33 109.19 26.57Q108.13 28.81 108.13 32.02Q108.13 35.21 109.19 37.44Q110.26 39.67 112.07 40.83Q113.88 42 116.17 42ZM132.9 46V18H140.04L145.49 32.71Q145.88 33.88 146.49 35.75Q147.09 37.62 147.58 39.25Q148.06 37.62 148.66 35.75Q149.25 33.88 149.64 32.71L155 18H162.18V46H157.29V31.72Q157.29 30.23 157.35 28.07Q157.4 25.91 157.46 23.77Q156.71 26.14 156.03 28.29Q155.36 30.44 154.9 31.72L149.57 46H145.51L140.13 31.72Q139.7 30.5 139.03 28.46Q138.37 26.42 137.63 24.16Q137.69 26.23 137.74 28.27Q137.79 30.31 137.79 31.72V46Z" fill="#E5E7EB"/><path d="M165.45 21.01V18H187.06V21.01H177.96V46H174.58V21.01ZM194.05 46.45Q191.3 46.45 189.23 45.13Q187.15 43.8 186 41.47Q184.84 39.14 184.84 36.12Q184.84 33.07 186 30.72Q187.15 28.37 189.23 27.04Q191.3 25.7 194.05 25.7Q196.81 25.7 198.88 27.04Q200.94 28.37 202.1 30.72Q203.26 33.07 203.26 36.12Q203.26 39.14 202.1 41.47Q200.94 43.8 198.88 45.13Q196.81 46.45 194.05 46.45ZM194.05 43.56Q196.87 43.56 198.45 41.52Q200.02 39.48 200.02 36.12Q200.02 32.71 198.44 30.66Q196.85 28.6 194.05 28.6Q191.25 28.6 189.66 30.65Q188.07 32.7 188.07 36.12Q188.07 39.5 189.65 41.53Q191.23 43.56 194.05 43.56ZM215.17 46.45Q212.43 46.45 210.35 45.13Q208.27 43.8 207.12 41.47Q205.96 39.14 205.96 36.12Q205.96 33.07 207.12 30.72Q208.27 28.37 210.35 27.04Q212.43 25.7 215.17 25.7Q217.93 25.7 220 27.04Q222.07 28.37 223.22 30.72Q224.38 33.07 224.38 36.12Q224.38 39.14 223.22 41.47Q222.07 43.8 220 45.13Q217.93 46.45 215.17 46.45ZM215.17 43.56Q217.99 43.56 219.57 41.52Q221.15 39.48 221.15 36.12Q221.15 32.71 219.56 30.66Q217.97 28.6 215.17 28.6Q212.37 28.6 210.78 30.65Q209.19 32.7 209.19 36.12Q209.19 39.5 210.77 41.53Q212.35 43.56 215.17 43.56ZM231.29 18V46H228.1V18ZM242.94 46.45Q240.82 46.45 239.09 45.76Q237.36 45.06 236.29 43.64Q235.22 42.22 235.09 40.06H238.25Q238.59 43.71 242.87 43.71Q244.94 43.71 246.13 42.84Q247.32 41.98 247.32 40.66Q247.32 39.54 246.5 38.86Q245.67 38.18 244.34 37.88L241.14 37.13Q235.54 35.81 235.54 31.49Q235.54 29.8 236.45 28.5Q237.36 27.19 238.99 26.45Q240.61 25.7 242.74 25.7Q244.81 25.7 246.45 26.48Q248.09 27.26 249.06 28.69Q250.03 30.12 250.09 32.09H246.97Q246.95 30.52 245.8 29.48Q244.66 28.45 242.74 28.45Q240.92 28.45 239.83 29.33Q238.74 30.21 238.74 31.49Q238.74 32.62 239.56 33.31Q240.39 33.99 241.82 34.33L245.01 35.08Q247.87 35.76 249.2 37.1Q250.54 38.45 250.54 40.59Q250.54 42.43 249.54 43.74Q248.54 45.06 246.83 45.76Q245.11 46.45 242.94 46.45Z" fill="#E5E7EB"/></svg>

fomtools-0.0.3/docs/assets/logo/logo-mono.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 253.93 64" width="253.93" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" stroke="#131313" stroke-width="7.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28.5 21.5 L20 32 L28.5 42.5 M35.5 21.5 L44 32 L35.5 42.5" fill="none" stroke="#131313" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/><circle cx="32" cy="32" r="5" fill="#131313"/><path d="M82.33 46V18H101.16V22.3H87.29V29.95H100.16V34.16H87.29V46ZM116.17 46.45Q112.42 46.45 109.48 44.66Q106.53 42.86 104.83 39.62Q103.13 36.38 103.13 32.02Q103.13 27.64 104.83 24.39Q106.53 21.14 109.48 19.34Q112.42 17.55 116.17 17.55Q119.91 17.55 122.86 19.34Q125.81 21.14 127.52 24.39Q129.22 27.64 129.22 32.02Q129.22 36.38 127.52 39.63Q125.81 42.88 122.86 44.67Q119.91 46.45 116.17 46.45ZM116.17 42Q118.47 42 120.28 40.83Q122.09 39.67 123.15 37.44Q124.2 35.21 124.2 32.02Q124.2 28.81 123.15 26.57Q122.09 24.33 120.28 23.17Q118.47 22 116.17 22Q113.88 22 112.07 23.17Q110.26 24.33 109.19 26.57Q108.13 28.81 108.13 32.02Q108.13 35.21 109.19 37.44Q110.26 39.67 112.07 40.83Q113.88 42 116.17 42ZM132.9 46V18H140.04L145.49 32.71Q145.88 33.88 146.49 35.75Q147.09 37.62 147.58 39.25Q148.06 37.62 148.66 35.75Q149.25 33.88 149.64 32.71L155 18H162.18V46H157.29V31.72Q157.29 30.23 157.35 28.07Q157.4 25.91 157.46 23.77Q156.71 26.14 156.03 28.29Q155.36 30.44 154.9 31.72L149.57 46H145.51L140.13 31.72Q139.7 30.5 139.03 28.46Q138.37 26.42 137.63 24.16Q137.69 26.23 137.74 28.27Q137.79 30.31 137.79 31.72V46Z" fill="#131313"/><path d="M165.45 21.01V18H187.06V21.01H177.96V46H174.58V21.01ZM194.05 46.45Q191.3 46.45 189.23 45.13Q187.15 43.8 186 41.47Q184.84 39.14 184.84 36.12Q184.84 33.07 186 30.72Q187.15 28.37 189.23 27.04Q191.3 25.7 194.05 25.7Q196.81 25.7 198.88 27.04Q200.94 28.37 202.1 30.72Q203.26 33.07 203.26 36.12Q203.26 39.14 202.1 41.47Q200.94 43.8 198.88 45.13Q196.81 46.45 194.05 46.45ZM194.05 43.56Q196.87 43.56 198.45 41.52Q200.02 39.48 200.02 36.12Q200.02 32.71 198.44 30.66Q196.85 28.6 194.05 28.6Q191.25 28.6 189.66 30.65Q188.07 32.7 188.07 36.12Q188.07 39.5 189.65 41.53Q191.23 43.56 194.05 43.56ZM215.17 46.45Q212.43 46.45 210.35 45.13Q208.27 43.8 207.12 41.47Q205.96 39.14 205.96 36.12Q205.96 33.07 207.12 30.72Q208.27 28.37 210.35 27.04Q212.43 25.7 215.17 25.7Q217.93 25.7 220 27.04Q222.07 28.37 223.22 30.72Q224.38 33.07 224.38 36.12Q224.38 39.14 223.22 41.47Q222.07 43.8 220 45.13Q217.93 46.45 215.17 46.45ZM215.17 43.56Q217.99 43.56 219.57 41.52Q221.15 39.48 221.15 36.12Q221.15 32.71 219.56 30.66Q217.97 28.6 215.17 28.6Q212.37 28.6 210.78 30.65Q209.19 32.7 209.19 36.12Q209.19 39.5 210.77 41.53Q212.35 43.56 215.17 43.56ZM231.29 18V46H228.1V18ZM242.94 46.45Q240.82 46.45 239.09 45.76Q237.36 45.06 236.29 43.64Q235.22 42.22 235.09 40.06H238.25Q238.59 43.71 242.87 43.71Q244.94 43.71 246.13 42.84Q247.32 41.98 247.32 40.66Q247.32 39.54 246.5 38.86Q245.67 38.18 244.34 37.88L241.14 37.13Q235.54 35.81 235.54 31.49Q235.54 29.8 236.45 28.5Q237.36 27.19 238.99 26.45Q240.61 25.7 242.74 25.7Q244.81 25.7 246.45 26.48Q248.09 27.26 249.06 28.69Q250.03 30.12 250.09 32.09H246.97Q246.95 30.52 245.8 29.48Q244.66 28.45 242.74 28.45Q240.92 28.45 239.83 29.33Q238.74 30.21 238.74 31.49Q238.74 32.62 239.56 33.31Q240.39 33.99 241.82 34.33L245.01 35.08Q247.87 35.76 249.2 37.1Q250.54 38.45 250.54 40.59Q250.54 42.43 249.54 43.74Q248.54 45.06 246.83 45.76Q245.11 46.45 242.94 46.45Z" fill="#131313"/></svg>

fomtools-0.0.3/docs/assets/logo/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 253.93 64" width="253.93" height="64" role="img" aria-label="FOMTools"><title>FOMTools</title><path d="M21.5 12 L6 32 L21.5 52 M42.5 12 L58 32 L42.5 52" fill="none" stroke="#2D3748" stroke-width="7.5" stroke-linecap="round" stroke-linejoin="round"/><path d="M28.5 21.5 L20 32 L28.5 42.5 M35.5 21.5 L44 32 L35.5 42.5" fill="none" stroke="#E77500" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/><circle cx="32" cy="32" r="5" fill="#E77500"/><path d="M82.33 46V18H101.16V22.3H87.29V29.95H100.16V34.16H87.29V46ZM116.17 46.45Q112.42 46.45 109.48 44.66Q106.53 42.86 104.83 39.62Q103.13 36.38 103.13 32.02Q103.13 27.64 104.83 24.39Q106.53 21.14 109.48 19.34Q112.42 17.55 116.17 17.55Q119.91 17.55 122.86 19.34Q125.81 21.14 127.52 24.39Q129.22 27.64 129.22 32.02Q129.22 36.38 127.52 39.63Q125.81 42.88 122.86 44.67Q119.91 46.45 116.17 46.45ZM116.17 42Q118.47 42 120.28 40.83Q122.09 39.67 123.15 37.44Q124.2 35.21 124.2 32.02Q124.2 28.81 123.15 26.57Q122.09 24.33 120.28 23.17Q118.47 22 116.17 22Q113.88 22 112.07 23.17Q110.26 24.33 109.19 26.57Q108.13 28.81 108.13 32.02Q108.13 35.21 109.19 37.44Q110.26 39.67 112.07 40.83Q113.88 42 116.17 42ZM132.9 46V18H140.04L145.49 32.71Q145.88 33.88 146.49 35.75Q147.09 37.62 147.58 39.25Q148.06 37.62 148.66 35.75Q149.25 33.88 149.64 32.71L155 18H162.18V46H157.29V31.72Q157.29 30.23 157.35 28.07Q157.4 25.91 157.46 23.77Q156.71 26.14 156.03 28.29Q155.36 30.44 154.9 31.72L149.57 46H145.51L140.13 31.72Q139.7 30.5 139.03 28.46Q138.37 26.42 137.63 24.16Q137.69 26.23 137.74 28.27Q137.79 30.31 137.79 31.72V46Z" fill="#2D3748"/><path d="M165.45 21.01V18H187.06V21.01H177.96V46H174.58V21.01ZM194.05 46.45Q191.3 46.45 189.23 45.13Q187.15 43.8 186 41.47Q184.84 39.14 184.84 36.12Q184.84 33.07 186 30.72Q187.15 28.37 189.23 27.04Q191.3 25.7 194.05 25.7Q196.81 25.7 198.88 27.04Q200.94 28.37 202.1 30.72Q203.26 33.07 203.26 36.12Q203.26 39.14 202.1 41.47Q200.94 43.8 198.88 45.13Q196.81 46.45 194.05 46.45ZM194.05 43.56Q196.87 43.56 198.45 41.52Q200.02 39.48 200.02 36.12Q200.02 32.71 198.44 30.66Q196.85 28.6 194.05 28.6Q191.25 28.6 189.66 30.65Q188.07 32.7 188.07 36.12Q188.07 39.5 189.65 41.53Q191.23 43.56 194.05 43.56ZM215.17 46.45Q212.43 46.45 210.35 45.13Q208.27 43.8 207.12 41.47Q205.96 39.14 205.96 36.12Q205.96 33.07 207.12 30.72Q208.27 28.37 210.35 27.04Q212.43 25.7 215.17 25.7Q217.93 25.7 220 27.04Q222.07 28.37 223.22 30.72Q224.38 33.07 224.38 36.12Q224.38 39.14 223.22 41.47Q222.07 43.8 220 45.13Q217.93 46.45 215.17 46.45ZM215.17 43.56Q217.99 43.56 219.57 41.52Q221.15 39.48 221.15 36.12Q221.15 32.71 219.56 30.66Q217.97 28.6 215.17 28.6Q212.37 28.6 210.78 30.65Q209.19 32.7 209.19 36.12Q209.19 39.5 210.77 41.53Q212.35 43.56 215.17 43.56ZM231.29 18V46H228.1V18ZM242.94 46.45Q240.82 46.45 239.09 45.76Q237.36 45.06 236.29 43.64Q235.22 42.22 235.09 40.06H238.25Q238.59 43.71 242.87 43.71Q244.94 43.71 246.13 42.84Q247.32 41.98 247.32 40.66Q247.32 39.54 246.5 38.86Q245.67 38.18 244.34 37.88L241.14 37.13Q235.54 35.81 235.54 31.49Q235.54 29.8 236.45 28.5Q237.36 27.19 238.99 26.45Q240.61 25.7 242.74 25.7Q244.81 25.7 246.45 26.48Q248.09 27.26 249.06 28.69Q250.03 30.12 250.09 32.09H246.97Q246.95 30.52 245.8 29.48Q244.66 28.45 242.74 28.45Q240.92 28.45 239.83 29.33Q238.74 30.21 238.74 31.49Q238.74 32.62 239.56 33.31Q240.39 33.99 241.82 34.33L245.01 35.08Q247.87 35.76 249.2 37.1Q250.54 38.45 250.54 40.59Q250.54 42.43 249.54 43.74Q248.54 45.06 246.83 45.76Q245.11 46.45 242.94 46.45Z" fill="#2D3748"/></svg>