Allow constraint tolerance to be adjusted with a compile-time define #2921
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
Certain advanced usages of the Math library require the tolerance for constraints such a simplex unconstraining to be looser than we normally allow in Stan. This lets those users pass
-DSTAN_MATH_CONSTRAINT_TOLERANCE=1e-4
, for example, to set the value of the tolerance at compile time.As an aside, this also allows these checks to essentially be disabled by setting it to some arbitrarily large value.
Tests
None
Side Effects
None for normal users.
Release notes
The constraint tolerance can now be adjusted by defining the
STAN_MATH_CONSTRAINT_TOLERANCE
macro before including Stan headers. The default value remains1E-8
.Checklist
Math issue: Closes feature request: configurable constraint tolerance #2911
Copyright holder: (fill in copyright holder information)
The copyright holder is typically you or your assignee, such as a university or company. By submitting this pull request, the copyright holder is agreeing to the license the submitted work under the following licenses:
- Code: BSD 3-clause (https://opensource.org/licenses/BSD-3-Clause)
- Documentation: CC-BY 4.0 (https://creativecommons.org/licenses/by/4.0/)
the basic tests are passing
./runTests.py test/unit
)make test-headers
)make test-math-dependencies
)make doxygen
)make cpplint
)the code is written in idiomatic C++ and changes are documented in the doxygen
the new changes are tested