Make GMP an optional dependency; add developer documentation#94
Open
loumalouomega wants to merge 9 commits into
Open
Make GMP an optional dependency; add developer documentation#94loumalouomega wants to merge 9 commits into
loumalouomega wants to merge 9 commits into
Conversation
…a structures - Introduced detailed documentation for the following phases: - Phase 1: Input Preprocessing - Phase 2: Incremental Triangle Insertion - Phase 3: Mesh Improvement - Phase 4: Filtering and Boolean Operations - Added a new overview document summarizing the fTetWild algorithm and its key properties. - Documented data structures used in the algorithm, including scalar types, mesh representations, and parameters. - Included information on envelope and AABB structures for proximity queries. - Enhanced library API documentation for integration into C++ projects.
… phases, and build instructions
…rove fallback arithmetic details
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GMP (GNU Multiple Precision) was previously a hard build requirement that caused cmake to abort when the library was not installed. This PR makes GMP opt-in and ships a full documentation set and a convenience configure script.
Changes
GMP is now optional (
FLOAT_TETWILD_USE_GMP)FLOAT_TETWILD_USE_GMP(defaultOFF). When disabled,find_package(GMPfTetWild)is skipped entirely and GMP headers/libraries are never linked. When enabled, the existing GMP path is used and the preprocessor macroFLOAT_TETWILD_USE_GMPis propagated to the library.Rationalclass is now conditionally compiled:-DFLOAT_TETWILD_USE_GMP=ON: full GMP-backedmpq_texact rational arithmetic (previous behaviour).long doublefallback implementation is used for AMIPS energy stabilisation, removing the hard GMP dependency for the common case.New configure script (configure.sh)
A self-contained Bash helper that wraps cmake with a structured argument parser. Features include:
--with-gmp,--no-tbb,--exact-envelope,--use-float, …).--dry-runmode prints the assembled cmake command without executing it.--offlinesetsFETCHCONTENT_UPDATES_DISCONNECTED=ONfor air-gapped builds.Documentation (doc)
Nine new Markdown files documenting the algorithm and codebase:
README.md was updated to reference the new docs, clarify that GMP is optional, and describe the
--with-gmpconfigure flag.Migration / upgrade notes
-DFLOAT_TETWILD_USE_GMP=ONto cmake (or--with-gmptoconfigure.sh) — behaviour is identical to before.long doublefallback.