tididi 0.1.0__tar.gz

tididi-0.1.0/CITATION.cff

@@ -0,0 +1,47 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite the paper below."
+type: software
+title: "tididi: Tree Decision Diagrams"
+abstract: "A Rust library for Tree Decision Diagrams: canonical vtree-shaped decision diagrams for Boolean functions, with model counting and semiring evaluation."
+license: Apache-2.0
+repository-code: "https://github.com/Tractables/tididi"
+url: "https://tractables.github.io/tididi/tididi/"
+version: 0.1.0
+authors:
+  - family-names: "Capelli"
+    given-names: "Florent"
+  - family-names: "Choi"
+    given-names: "YooJung"
+  - family-names: "Mengel"
+    given-names: "Stefan"
+  - family-names: "Muñoz"
+    given-names: "Martín"
+  - family-names: "Van den Broeck"
+    given-names: "Guy"
+    affiliation: "Computer Science Department, University of California, Los Angeles"
+keywords:
+  - decision diagram
+  - model counting
+  - knowledge compilation
+  - binary decision diagram
+  - weighted model counting
+preferred-citation:
+  type: article
+  title: "A Canonical Generalization of OBDD"
+  year: 2026
+  journal: "arXiv"
+  number: "2604.05537"
+  doi: "10.48550/arXiv.2604.05537"
+  url: "https://arxiv.org/abs/2604.05537"
+  authors:
+    - family-names: "Capelli"
+      given-names: "Florent"
+    - family-names: "Choi"
+      given-names: "YooJung"
+    - family-names: "Mengel"
+      given-names: "Stefan"
+    - family-names: "Muñoz"
+      given-names: "Martín"
+    - family-names: "Van den Broeck"
+      given-names: "Guy"
+      affiliation: "Computer Science Department, University of California, Los Angeles"

tididi-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,121 @@
+# Contributing
+
+## Checks
+
+```sh
+cargo test --all-targets
+cargo test --doc
+cargo clippy --all-targets -- -D warnings
+cargo clippy --release --all-targets -- -D warnings
+RUSTDOCFLAGS="-D warnings" cargo doc --no-deps
+python3 tests/rendered_docs.py --self-test
+python3 tests/rendered_docs.py target/doc --unbundled
+python3 scripts/prepare_docs.py target/doc
+python3 tests/rendered_docs.py target/doc
+python3 tests/package_examples.py --self-test
+python3 scripts/check_scenarios.py
+python3 -m unittest discover -s tests -p test_scenarios.py
+python3 -m unittest discover -s tests -p test_release.py
+python3 scripts/check_release.py
+```
+
+The README snippet matches the tested crate example; `docs/` is compiled into
+rustdoc. Keep walkthrough excerpts in sync with their runnable programs in
+`examples/`. The `tested-example` code
+block class is reserved for excerpts verified by `tests/example_docs.rs`.
+Follow printing excerpts with `Output:` and a `text` block;
+`tests/package_examples.py` checks those blocks against the programs’ output.
+
+Changes to diagram operations also need the randomized differential suite,
+with and without debug assertions:
+
+```sh
+cargo test --test differential -- --ignored
+cargo test --release --test differential -- --ignored
+```
+
+Set `TIDIDI_FUZZ_SEED` to replay a run and `TIDIDI_FUZZ_SECONDS` to set its duration.
+
+Changes to packaging, examples or their displayed output also need `cargo package`
+followed by `python3 tests/package_examples.py`, which runs each example as a
+standalone consumer of the crate archive.
+
+## Shared teaching scenarios
+
+Hidden `scenario:` comments link teaching material to its script and complete
+instance list in [docs/scenarios.md](docs/scenarios.md). When changing a lesson,
+update that script as needed and review its Rust, Python, C and figure instances.
+Then run `python3 scripts/check_scenarios.py --review <scenario-id>` to record
+that review. CI rejects missing links, unregistered lessons and stale reviews;
+it does not establish semantic agreement. Keep running the example checks.
+
+## Python bindings
+
+The independent package in `bindings/python` calls this crate through its public
+API. Its [README](bindings/python/README.rst) gives the build and test commands.
+Sphinx Gallery executes the narrative scripts in `bindings/python/examples` to
+produce the tutorials and their output; edit those scripts, not generated pages.
+Keep Python signatures in `tididi/__init__.pyi` aligned with the extension.
+CI tests wheels on Linux, macOS, and Windows, and checks a source-archive install.
+
+## C bindings
+
+`bindings/c` calls the public Rust API through an opaque-handle interface. Run
+`python bindings/c/check.py --docs` to verify the generated header, C/C++ consumers,
+installed CMake package and executable guide. Its [README](bindings/c/README.rst)
+lists prerequisites. Edit function contracts in `bindings/c/src`; the header and
+API reference are generated from them. Tutorials include the compiled C sources
+and captured output. CI checks Linux, macOS and Windows.
+
+## Repository conventions
+
+- Do not run rustfmt over the crate; it is not rustfmt-formatted.
+- Tests that build diagrams must call `test_helpers::assert_canonical`:
+  a correct query result alone does not establish a valid representation.
+- Keep algorithms single-threaded. Callers control parallelism, limits and
+  memory probes; the library reads no environment variables and has no
+  process-wide state or native dependencies. Consumers need no Cargo features;
+  `testing` exposes the generators and oracles in `test_helpers` and keeps its
+  invariant checkers in a release build, as stated in the
+  [architecture reference](docs/architecture.md#invariants).
+- Return errors for invalid input and refused work. Named operations are
+  checked; do not add panicking twins or `try_` aliases.
+- Put each operation's contract on its default entry point. Batch methods
+  link to that contract and explain their limit behavior. Guides introduce
+  tasks and link to the items instead of repeating their contracts. Introduce
+  Boolean expressions with `!`, `&` and `|`; introduce checked calls when
+  discussing error handling. Name the shared vtree `vtree`.
+- Public docs describe current behavior; keep benchmark results, development
+  history and implementation debates out of them.
+- Put unit tests in a nearby `tests/` directory: for a standalone `foo.rs`,
+  `tests/foo.rs` (or `tests/foo/` for several files) declared with a `#[path]`
+  module attribute. Implementation directories hold implementation code;
+  integration tests go in the crate-root `tests/`. Use fixed seeds and no
+  timing assertions. `tests/comment_lint.rs` checks comments and test
+  placement; fix a violation rather than adding an exemption.
+- Keep the vtree text format and shared constructors/accessors compatible
+  with [vitri](https://github.com/Tractables/vitri).
+- Commit messages must be suitable for publication: no tool footers, session
+  links or machine-specific details.
+
+[Architecture](docs/architecture.md) documents module responsibilities and
+the representation invariants; add a row to its module table for a new public
+module, and reference its invariants from code rather than restating them.
+
+## Releasing
+
+Use a `v<version>` tag matching `Cargo.toml`. Update the versioned documentation
+URL in that manifest and the example/figure links in `docs/` when bumping the
+version; the documentation checks catch mismatches. Publish the crate to
+crates.io for versioned API docs on docs.rs. Publishing the GitHub release
+runs the checks and attaches a bundled HTML archive; it does not publish the
+crate. The archive is kept when the development Pages site changes.
+
+## Cross-language behavior
+
+`tests/fixtures/conformance*.txt` contains operation traces, stateful query
+sessions and independent answers shared by the Rust, Python and C test suites. Add semantic regressions
+in `tests/conformance_cases.py`, regenerate with `--write`, and run all three
+suites. Each interpreter checks every assignment, cached evidence counts,
+support and implied literals. Session traces also check ownership transfers, invalid observations, resource
+refusals and retries, with each language checking its own handle lifecycle. `python3 tests/conformance_cases.py` checks fixture freshness.

tididi-0.1.0/Cargo.lock

@@ -0,0 +1,79 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
+
+[[package]]
+name = "itoa"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
+
+[[package]]
+name = "num-bigint"
+version = "0.4.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c89e69e7e0f03bea5ef08013795c25018e101932225a656383bd384495ecc367"
+dependencies = [
+ "num-integer",
+ "num-traits",
+]
+
+[[package]]
+name = "num-integer"
+version = "0.1.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ce2d95d4b3734dc35aa2f45e1aa22cd416814592a4f9d9205e11affd5b8e10b"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "num-rational"
+version = "0.4.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f83d14da390562dca69fc84082e73e548e1ad308d24accdedd2720017cb37824"
+dependencies = [
+ "num-bigint",
+ "num-integer",
+ "num-traits",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "rustc-hash"
+version = "2.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d"
+
+[[package]]
+name = "smallvec"
+version = "1.16.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b9be42f50aa861c555654aa3a37f52f4b1074bacf4e48fe0ef7fa584e80f1f0f"
+
+[[package]]
+name = "tididi"
+version = "0.1.0"
+dependencies = [
+ "itoa",
+ "num-bigint",
+ "num-rational",
+ "num-traits",
+ "rustc-hash",
+ "smallvec",
+ "tididi",
+]

tididi-0.1.0/Cargo.toml

@@ -0,0 +1,33 @@
+[package]
+name = "tididi"
+version = "0.1.0"
+edition = "2024"
+rust-version = "1.88"
+description = "Tree Decision Diagrams: canonical vtree-shaped decision diagrams for Boolean functions, with model counting and semiring evaluation"
+license = "Apache-2.0"
+repository = "https://github.com/Tractables/tididi"
+documentation = "https://docs.rs/tididi/0.1.0/tididi/"
+readme = "README.md"
+keywords = ["decision-diagram", "model-counting", "compilation", "bdd", "wmc"]
+categories = ["science", "algorithms", "data-structures"]
+exclude = ["bindings/", ".github/", ".gitignore", "CLAUDE.md", "AGENTS.md", "rust-toolchain.toml"]
+
+[features]
+# The oracles, generators and invariant checkers under `test_helpers`, and
+# the synthetic byte charge `Limits::charge_in_flight`. On for
+# this crate's own tests through the dev-dependency below; off for a consumer,
+# whose release build then does not compile them at all.
+testing = []
+
+[dependencies]
+num-bigint = "0.4"
+num-rational = "0.4"
+num-traits = "0.2"
+rustc-hash = "2"
+itoa = "1"
+smallvec = { version = "1", features = ["union"] }
+
+[dev-dependencies]
+# The crate's own tests, examples and doctests build against it as a consumer
+# would, so this is how they reach `test_helpers`.
+tididi = { path = ".", features = ["testing"] }

tididi-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.