Skip to main content

Python interface for cpp-pd-code-simplify with runtime C++ compilation.

Project description

cpp-pd-code-simplify-interface

cpp-pd-code-simplify-interface is a Python package for calling the cpp-pd-code-simplify C++ implementation from Python.

The package is designed for PyPI distribution:

pip install cpp-pd-code-simplify-interface

It ships the header-only C++ core and native C wrapper inside the wheel and source distribution. On first use, the package compiles a cached local dynamic library through cpp-simple-interface; later calls reuse that library through ctypes. A C++17 compiler compatible with g++ must be available at runtime.

Runtime dependencies are handled per platform. On Windows, the interface uses objdump -p or dumpbin /DEPENDENTS when available, then caches MinGW runtime DLLs such as libstdc++-6.dll, libgcc_s_*.dll, and libwinpthread-1.dll next to the generated DLL. On Linux it adds $ORIGIN rpath and can inspect ldd; on macOS it adds @loader_path rpath and can inspect otool -L. Load failures are wrapped with platform-specific dependency hints.

The core C++ header is not stored as a permanent generated copy in this subproject. The custom Poetry build backend syncs it from the repository root during poetry build, embeds it in the wheel and sdist beside the native C wrapper, then removes the temporary copy from the working tree.

Calls use the C++ library's default preprocessing pipeline: R1-move removal, true R2-bigon removal, and nugatory-crossing removal, then iterative mid-simplification.

Example

import cpp_pd_code_simplify_interface as simplify

pd_code = "PD[X[1,5,2,4],X[3,1,4,6],X[5,3,6,2]]"
result = simplify.simplify(pd_code)
print(result["final_pd_code"])

Returned final_pd_code strings are normalized for display: each crossing is written from the under-incoming edge, labels are renumbered along oriented components from 1, and crossing rows are sorted lexicographically. This is applied only at the final JSON boundary; the C++ backend keeps its internal numbering unchanged while simplifying.

The default max_paths=-1 uses deterministic heuristic green-path sampling in the C++ backend. Heuristic mode tries longer red arcs first, scores validated witnesses by the actual crossing reduction obtained after temporary application, and uses a fixed bounded lookahead before applying the best candidate. Use ban_heuristic=True to request exhaustive green-path enumeration for a manageable input. Use reduction_round=K to cap applied mid-simplification rounds; the default -1 runs until stable. In default heuristic mode, the C++ backend adaptively orders r3_prepass, heuristic_search, and non_monotone from deterministic success, miss, and soft-timeout counters. If all adaptive stages miss, the backend runs a brute-force proof pass, then the RIII failover before the diagram is treated as stable. Use timeout=K to cap a call at K seconds; the default -1 has no timeout. Use verbose=True to forward timestamped C++ progress logs to stderr. If a call times out, the returned dictionary still contains the best PD code found so far and sets timed_out to True. Use quit_at_crossing=N, or CLI flag --quit-at-crossing N, to stop once the current PD code has at most N crossings; the returned dictionary sets stopped_by_crossing_limit when the threshold is reached. Brute-force green-path enumeration is streamed by the C++ backend; pass bruteforce_budget=N to cap brute-force green-path checks per PD code. The default is 200000, and -1 disables that cap. If the budget is exhausted, the returned dictionary still contains the current best PD code and sets resource_limited to True. Verbose log lines use local wall-clock time in YYYY-MM-DD HH:MM:SS format. When max_thread=-1 reaches a brute-force search phase, verbose logs also include actual_threads, the worker count selected by the C++ backend for that phase. The backend call runs in a helper process, so Ctrl+C can terminate active C++ work and its worker threads cleanly. Use log_file=PATH, or CLI flag --log-file PATH, to tee stdout and stderr into a flushed backup log file. Use reapr=True, or CLI flag --reapr, only for the experimental invariant-guarded projection oracle. It can change the knot or link type; for n current crossings, both the raw candidate and its R1/R2/nugatory cleanup must keep at least n - ceil(n / 4) crossings. Accepted output includes reapr_warning, determinant guard fields, and before/after invariant profile strings. Use reapr_retry_max=N, or CLI flag --reapr-retry-max N, to control the deterministic retry cap. Use show_step_pd=True, or CLI flag --show-step-pd, to print step_pd_code[ROUND]: PD[...] to stdout after each mid-simplification witness is applied and canonicalized, before that round's automatic local cleanup. With reapr=True, every REAPR candidate that passes the full invariant profile and conservative crossing window is also printed with round 0 before the selected candidate's ordinary local cleanup.

Batch use:

results = simplify.simplify_many([pd_code, "PD[]"])

To select a compiler:

CXX=clang++ python your_script.py

Windows PowerShell:

$env:CXX = "C:\path\to\g++.exe"
python your_script.py

On Windows, use a compiler whose target architecture matches Python. A 64-bit Python process needs a 64-bit MinGW-w64/UCRT, Clang, or MSVC-compatible compiler target. Legacy MinGW.org toolchains are not supported because they do not provide the C++ threading runtime used by the simplifier.

Command-line use also supports multi-line PD-code files:

python -m cpp_pd_code_simplify_interface --pd-file inputs.pd --max-paths -1 --verbose

Build And Publish

From this directory:

poetry build
poetry publish

Use poetry publish --build to build and upload in one command.

For local testing:

poetry run python -m cpp_pd_code_simplify_interface "PD[]"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cpp_pd_code_simplify_interface-0.1.36.tar.gz (55.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cpp_pd_code_simplify_interface-0.1.36-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

Details for the file cpp_pd_code_simplify_interface-0.1.36.tar.gz.

File metadata

File hashes

Hashes for cpp_pd_code_simplify_interface-0.1.36.tar.gz
Algorithm Hash digest
SHA256 24552af8ffbd642009a8154eecd4e6cb64396d3c7f7e1f06296df2b3f29e3c6f
MD5 9482c28eac72380f7935274b22272a72
BLAKE2b-256 0d9f90fa0c9c328593f29a3a60f283824d36ca327739aac6ad85b8bc19646fe1

See more details on using hashes here.

File details

Details for the file cpp_pd_code_simplify_interface-0.1.36-py3-none-any.whl.

File metadata

File hashes

Hashes for cpp_pd_code_simplify_interface-0.1.36-py3-none-any.whl
Algorithm Hash digest
SHA256 a234effec519bdcd81cbea8d2b5cd2d5e25839cdcf5cb767f904978ae0d74cc0
MD5 fe985f1d8075dee6deb44b092e09632b
BLAKE2b-256 a79c809e5e80e42b4fe6f8e15b4b3658d78c8ffee2842a710181b06d4d15012c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page