Add cheat sheet to documentation#750
Open
dpsanders wants to merge 1 commit into
Open
Conversation
Quick-reference page covering the full v1 API: types, constructors, string parsing, ExactReal/NG flag, accessors, decorations, arithmetic, powers, boolean functions, set operations, bisection, display options, configuration, piecewise functions, and common gotchas. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
Benchmark Results (Julia v1)Time benchmarks
Memory benchmarks
|
OlivierHnt
reviewed
Apr 14, 2026
Member
OlivierHnt
left a comment
OlivierHnt
left a comment
There was a problem hiding this comment.
Great idea, thanks for taking the initiative!
| | Function | IEEE 1788? | Domain | Notes | | ||
| |----------|:----------:|--------|-------| | ||
| | [`pown`](@ref)`(x, n)` | Yes | full real line | exact for integer powers | | ||
| | [`pow`](@ref)`(x, y)` | Yes | positive reals | standard power | |
Member
There was a problem hiding this comment.
This is a bit more tricky actually:
julia> pow(interval(-1, 1), 2)
[0.0, 1.0]_trv
julia> pown(interval(-1, 1), 2)
[0.0, 1.0]_com
julia> interval(-1, 1) ^ 2
[0.0, 1.0]_com
julia> fastpow(interval(-1, 1), 2)
[0.0, 1.0]_trv
Member
There was a problem hiding this comment.
IIRC, the behaviour of pow, pown are dictated by the standard. The fast version follow the same guidelines.
For ^, we are trying to do something "more convenient": the functions calls pown or pow depending on the exponent.
| ### Standard functions | ||
|
|
||
| `sqrt`, `cbrt`, `exp`, `exp2`, `exp10`, `expm1`, `log`, `log2`, `log10`, `log1p`, | ||
| `sin`, `cos`, `tan`, `asin`, `acos`, `atan`, `sinh`, `cosh`, `tanh`, etc. |
Member
There was a problem hiding this comment.
We should probably make this list exhaustive? I mean removing "etc."
| (Interval{Float64}[Interval{Float64}(0.0, 0.5, com, true), Interval{Float64}(0.0, 1.0, com, true)], Interval{Float64}[Interval{Float64}(0.5, 1.0, com, true), Interval{Float64}(0.0, 1.0, com, true)]) | ||
| ``` | ||
|
|
||
| ## Display Options |
Member
There was a problem hiding this comment.
This should probably put before, since it is used above.
|
|
||
| Usage: `IntervalArithmetic.configure(numtype=BigFloat, power=:slow)` | ||
|
|
||
| ## The `@interval` Macro |
Member
There was a problem hiding this comment.
Maybe this should be next to the constructors; we should also add something about @exact
Member
|
Looks like the documentation is failing to build. |
Member
|
@dpsanders did you want to discuss some of the feedback I sent? |
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
2 participants
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
docs/src/manual/cheatsheet.md) covering the full v1 API as a quick referenceThe cheat sheet covers: type hierarchy, constructors, string parsing, ExactReal/NG flag, accessors, decorations, arithmetic, powers, boolean functions, set operations, bisection, display options, configuration, piecewise functions, and common gotchas.
All examples use
jldoctestblocks for verification during docs builds.Test plan
julia docs/make.jl🤖 Generated with Claude Code