Skip to content

Complete Decoration docstring#757

Merged
OlivierHnt merged 2 commits into
JuliaIntervals:masterfrom
Kolaru:decoration_docstring
May 13, 2026
Merged

Complete Decoration docstring#757
OlivierHnt merged 2 commits into
JuliaIntervals:masterfrom
Kolaru:decoration_docstring

Conversation

@Kolaru
Copy link
Copy Markdown
Member

@Kolaru Kolaru commented May 11, 2026

As discussed in JuliaIntervals/IntervalRootFinding.jl#243 this PR export Decoration and complete the associated docstrings, in order to make clear that com, dac and def are fine in general.

@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.05%. Comparing base (a0575e7) to head (b4008aa).
⚠️ Report is 2 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #757      +/-   ##
==========================================
- Coverage   74.12%   74.05%   -0.07%     
==========================================
  Files          32       32              
  Lines        3026     3026              
==========================================
- Hits         2243     2241       -2     
- Misses        783      785       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 11, 2026

Benchmark Results (Julia v1)

Time benchmarks
master ede672b... master / ede672b...
BigFloat MPFI/basics/* 19.1 ± 3.6 μs 19.3 ± 3.7 μs 0.992 ± 0.27
BigFloat MPFI/basics/+ 10.5 ± 3.4 μs 10.5 ± 3.4 μs 1.01 ± 0.46
BigFloat MPFI/basics/- 13.8 ± 3.5 μs 13.5 ± 3.7 μs 1.02 ± 0.38
BigFloat MPFI/basics// 15.7 ± 3.5 μs 15.7 ± 3.5 μs 1 ± 0.31
BigFloat MPFI/basics/abs 8.7 ± 3.4 μs 8.81 ± 3.4 μs 0.987 ± 0.54
BigFloat MPFI/basics/acos 0.509 ± 0.0083 ms 0.508 ± 0.0083 ms 1 ± 0.023
BigFloat MPFI/basics/asin 0.497 ± 0.0096 ms 0.496 ± 0.0097 ms 1 ± 0.028
BigFloat MPFI/basics/atan 1.63 ± 0.01 ms 1.63 ± 0.011 ms 1 ± 0.0091
BigFloat MPFI/basics/cos 0.278 ± 0.007 ms 0.275 ± 0.0072 ms 1.01 ± 0.036
BigFloat MPFI/basics/cosh 0.344 ± 0.012 ms 0.344 ± 0.012 ms 0.999 ± 0.048
BigFloat MPFI/basics/exp 0.402 ± 0.0086 ms 0.403 ± 0.0089 ms 0.999 ± 0.031
BigFloat MPFI/basics/inv 15.8 ± 3.6 μs 16.1 ± 3.6 μs 0.984 ± 0.31
BigFloat MPFI/basics/log 0.307 ± 0.0074 ms 0.312 ± 0.0071 ms 0.986 ± 0.033
BigFloat MPFI/basics/sin 0.35 ± 0.0077 ms 0.348 ± 0.0073 ms 1.01 ± 0.031
BigFloat MPFI/basics/sinh 0.46 ± 0.0083 ms 0.458 ± 0.008 ms 1 ± 0.025
BigFloat MPFI/basics/sqrt 21.9 ± 7.2 μs 21.8 ± 7.7 μs 1 ± 0.48
BigFloat MPFI/basics/tan 0.293 ± 0.0079 ms 0.291 ± 0.0075 ms 1.01 ± 0.037
BigFloat MPFI/basics/tanh 0.47 ± 0.0086 ms 0.47 ± 0.0085 ms 0.999 ± 0.026
BigFloat bareinterval/basics/* 0.0318 ± 0.0024 ms 0.0328 ± 0.0027 ms 0.97 ± 0.11
BigFloat bareinterval/basics/+ 19.9 ± 3.2 μs 20.6 ± 3.3 μs 0.966 ± 0.22
BigFloat bareinterval/basics/- 19.9 ± 3.4 μs 19.6 ± 3.3 μs 1.02 ± 0.24
BigFloat bareinterval/basics// 16.2 ± 4.7 μs 16.4 ± 4.9 μs 0.985 ± 0.41
BigFloat bareinterval/basics/abs 13.2 ± 3.1 μs 13.2 ± 3.1 μs 1 ± 0.33
BigFloat bareinterval/basics/acos 0.534 ± 0.021 ms 0.535 ± 0.022 ms 0.998 ± 0.058
BigFloat bareinterval/basics/asin 0.525 ± 0.021 ms 0.527 ± 0.02 ms 0.997 ± 0.055
BigFloat bareinterval/basics/atan 1.65 ± 0.014 ms 1.66 ± 0.011 ms 0.992 ± 0.011
BigFloat bareinterval/basics/cos 0.261 ± 0.081 ms 0.262 ± 0.081 ms 0.997 ± 0.44
BigFloat bareinterval/basics/cosh 0.385 ± 0.02 ms 0.385 ± 0.022 ms 0.999 ± 0.077
BigFloat bareinterval/basics/exp 0.411 ± 0.0085 ms 0.412 ± 0.0091 ms 0.998 ± 0.03
BigFloat bareinterval/basics/inv 22.2 ± 3.1 μs 22.6 ± 3 μs 0.981 ± 0.19
BigFloat bareinterval/basics/log 0.352 ± 0.0088 ms 0.355 ± 0.0088 ms 0.993 ± 0.035
BigFloat bareinterval/basics/sin 0.432 ± 0.082 ms 0.431 ± 0.082 ms 1 ± 0.27
BigFloat bareinterval/basics/sinh 0.47 ± 0.0099 ms 0.469 ± 0.0099 ms 1 ± 0.03
BigFloat bareinterval/basics/sqrt 29.9 ± 2.6 μs 30.2 ± 2.8 μs 0.989 ± 0.13
BigFloat bareinterval/basics/tan 0.258 ± 0.052 ms 0.258 ± 0.052 ms 1 ± 0.29
BigFloat bareinterval/basics/tanh 0.48 ± 0.0089 ms 0.48 ± 0.0093 ms 1 ± 0.027
BigFloat interval/basics/* 0.0349 ± 0.0022 ms 0.0349 ± 0.0023 ms 1 ± 0.089
BigFloat interval/basics/+ 22.4 ± 7.6 μs 22.7 ± 7.9 μs 0.988 ± 0.48
BigFloat interval/basics/- 22.1 ± 7.2 μs 22.4 ± 7.4 μs 0.988 ± 0.46
BigFloat interval/basics// 19.9 ± 4.6 μs 21.5 ± 4.7 μs 0.928 ± 0.3
BigFloat interval/basics/abs 13 ± 7.5 μs 13 ± 7.6 μs 0.999 ± 0.82
BigFloat interval/basics/acos 0.529 ± 0.041 ms 0.533 ± 0.042 ms 0.991 ± 0.11
BigFloat interval/basics/asin 0.517 ± 0.034 ms 0.519 ± 0.034 ms 0.997 ± 0.092
BigFloat interval/basics/atan 1.64 ± 0.0078 ms 1.65 ± 0.0077 ms 0.995 ± 0.0066
BigFloat interval/basics/cos 0.259 ± 0.011 ms 0.259 ± 0.011 ms 1 ± 0.059
BigFloat interval/basics/cosh 0.375 ± 0.025 ms 0.375 ± 0.023 ms 1 ± 0.09
BigFloat interval/basics/exp 0.418 ± 0.0099 ms 0.417 ± 0.0096 ms 1 ± 0.033
BigFloat interval/basics/inv 26.2 ± 7.6 μs 26.2 ± 7.8 μs 0.999 ± 0.42
BigFloat interval/basics/log 0.345 ± 0.042 ms 0.349 ± 0.042 ms 0.988 ± 0.17
BigFloat interval/basics/sin 0.366 ± 0.062 ms 0.366 ± 0.047 ms 0.999 ± 0.21
BigFloat interval/basics/sinh 0.474 ± 0.0094 ms 0.471 ± 0.0095 ms 1.01 ± 0.029
BigFloat interval/basics/sqrt 0.033 ± 0.031 ms 0.0317 ± 0.031 ms 1.04 ± 1.4
BigFloat interval/basics/tan 0.218 ± 0.011 ms 0.217 ± 0.01 ms 1 ± 0.069
BigFloat interval/basics/tanh 0.485 ± 0.0099 ms 0.485 ± 0.01 ms 1 ± 0.03
bareinterval/basics/* 1.64 ± 0.05 μs 1.66 ± 0.05 μs 0.988 ± 0.042
bareinterval/basics/+ 0.461 ± 0.01 μs 0.461 ± 0.01 μs 1 ± 0.031
bareinterval/basics/- 0.481 ± 0.011 μs 0.481 ± 0.001 μs 1 ± 0.023
bareinterval/basics// 1.02 ± 0.04 μs 1.02 ± 0.03 μs 1 ± 0.049
bareinterval/basics/abs 0.26 ± 0.011 μs 0.26 ± 0.01 μs 1 ± 0.057
bareinterval/basics/acos 2.45 ± 0.039 μs 2.46 ± 0.039 μs 0.996 ± 0.022
bareinterval/basics/asin 2.69 ± 0.02 μs 2.69 ± 0.02 μs 1 ± 0.01
bareinterval/basics/atan 11 ± 0.14 μs 11 ± 0.14 μs 1 ± 0.018
bareinterval/basics/cos 0.039 ± 0.00088 ms 0.0394 ± 0.00088 ms 0.988 ± 0.031
bareinterval/basics/cosh 6.03 ± 0.04 μs 6.02 ± 0.03 μs 1 ± 0.0083
bareinterval/basics/exp 3.25 ± 0.04 μs 3.23 ± 0.04 μs 1.01 ± 0.018
bareinterval/basics/inv 0.881 ± 0.02 μs 0.861 ± 0.011 μs 1.02 ± 0.027
bareinterval/basics/log 1.76 ± 0.011 μs 1.76 ± 0.011 μs 1 ± 0.0088
bareinterval/basics/sin 0.0541 ± 0.019 ms 0.055 ± 0.019 ms 0.984 ± 0.49
bareinterval/basics/sinh 8.35 ± 0.04 μs 8.33 ± 0.031 μs 1 ± 0.0061
bareinterval/basics/sqrt 0.922 ± 0.011 μs 0.901 ± 0.011 μs 1.02 ± 0.017
bareinterval/basics/tan 22.1 ± 0.28 μs 22.8 ± 0.31 μs 0.97 ± 0.018
bareinterval/basics/tanh 0.22 ± 0.0062 ms 0.221 ± 0.0067 ms 0.998 ± 0.041
interval/basics/* 2.56 ± 0.12 μs 2.55 ± 0.11 μs 1 ± 0.064
interval/basics/+ 1.27 ± 0.06 μs 1.25 ± 0.05 μs 1.02 ± 0.063
interval/basics/- 1.29 ± 0.051 μs 1.28 ± 0.05 μs 1.01 ± 0.056
interval/basics// 2.16 ± 0.13 μs 2.22 ± 0.09 μs 0.973 ± 0.071
interval/basics/abs 0.831 ± 0.049 μs 0.822 ± 0.04 μs 1.01 ± 0.077
interval/basics/acos 4.02 ± 0.1 μs 4.01 ± 0.07 μs 1 ± 0.03
interval/basics/asin 4.16 ± 0.041 μs 4.16 ± 0.051 μs 1 ± 0.016
interval/basics/atan 12.3 ± 0.16 μs 12.2 ± 0.16 μs 1 ± 0.019
interval/basics/cos 0.0574 ± 0.019 ms 0.0569 ± 0.019 ms 1.01 ± 0.47
interval/basics/cosh 7.53 ± 0.1 μs 7.53 ± 0.1 μs 1 ± 0.019
interval/basics/exp 4.89 ± 0.1 μs 4.9 ± 0.11 μs 0.998 ± 0.03
interval/basics/inv 1.78 ± 0.14 μs 1.69 ± 0.081 μs 1.05 ± 0.097
interval/basics/log 3.51 ± 0.089 μs 3.52 ± 0.09 μs 0.997 ± 0.036
interval/basics/sin 0.0553 ± 0.019 ms 0.056 ± 0.019 ms 0.987 ± 0.48
interval/basics/sinh 9.89 ± 0.06 μs 9.87 ± 0.06 μs 1 ± 0.0086
interval/basics/sqrt 1.68 ± 0.05 μs 1.68 ± 0.05 μs 1 ± 0.042
interval/basics/tan 0.0325 ± 0.0018 ms 0.0322 ± 0.0018 ms 1.01 ± 0.079
interval/basics/tanh 0.233 ± 0.0048 ms 0.242 ± 0.0057 ms 0.965 ± 0.03
time_to_load 0.0888 ± 0.00068 s 0.0882 ± 0.0006 s 1.01 ± 0.01
Memory benchmarks
master ede672b... master / ede672b...
BigFloat MPFI/basics/* 0.424 k allocs: 21.3 kB 0.424 k allocs: 21.3 kB 1
BigFloat MPFI/basics/+ 0.302 k allocs: 16.5 kB 0.302 k allocs: 16.5 kB 1
BigFloat MPFI/basics/- 0.402 k allocs: 20.4 kB 0.402 k allocs: 20.4 kB 1
BigFloat MPFI/basics// 0.345 k allocs: 18.2 kB 0.345 k allocs: 18.2 kB 1
BigFloat MPFI/basics/abs 0.324 k allocs: 17.4 kB 0.324 k allocs: 17.4 kB 1
BigFloat MPFI/basics/acos 1.24 k allocs: 0.0445 MB 1.24 k allocs: 0.0445 MB 1
BigFloat MPFI/basics/asin 1.08 k allocs: 0.0355 MB 1.08 k allocs: 0.0355 MB 1
BigFloat MPFI/basics/atan 2.14 k allocs: 0.0543 MB 2.14 k allocs: 0.0543 MB 1
BigFloat MPFI/basics/cos 2.9 k allocs: 0.0975 MB 2.9 k allocs: 0.0975 MB 1
BigFloat MPFI/basics/cosh 0.781 k allocs: 0.0322 MB 0.781 k allocs: 0.0322 MB 1
BigFloat MPFI/basics/exp 0.902 k allocs: 0.036 MB 0.902 k allocs: 0.036 MB 1
BigFloat MPFI/basics/inv 0.351 k allocs: 18.4 kB 0.351 k allocs: 18.4 kB 1
BigFloat MPFI/basics/log 0.407 k allocs: 20.6 kB 0.407 k allocs: 20.6 kB 1
BigFloat MPFI/basics/sin 3.18 k allocs: 0.106 MB 3.18 k allocs: 0.106 MB 1
BigFloat MPFI/basics/sinh 0.915 k allocs: 0.0369 MB 0.915 k allocs: 0.0369 MB 1
BigFloat MPFI/basics/sqrt 0.302 k allocs: 16.5 kB 0.302 k allocs: 16.5 kB 1
BigFloat MPFI/basics/tan 2.8 k allocs: 0.098 MB 2.8 k allocs: 0.098 MB 0.999
BigFloat MPFI/basics/tanh 0.908 k allocs: 0.0362 MB 0.908 k allocs: 0.0362 MB 1
BigFloat bareinterval/basics/* 0.262 k allocs: 26 kB 0.262 k allocs: 26 kB 1
BigFloat bareinterval/basics/+ 0.202 k allocs: 20.4 kB 0.202 k allocs: 20.4 kB 1
BigFloat bareinterval/basics/- 0.202 k allocs: 20.4 kB 0.202 k allocs: 20.4 kB 1
BigFloat bareinterval/basics// 0.1 k allocs: 10.8 kB 0.1 k allocs: 10.8 kB 1
BigFloat bareinterval/basics/abs 0.199 k allocs: 20.1 kB 0.199 k allocs: 20.1 kB 1
BigFloat bareinterval/basics/acos 1.33 k allocs: 0.0741 MB 1.33 k allocs: 0.0741 MB 1
BigFloat bareinterval/basics/asin 1.23 k allocs: 0.0647 MB 1.23 k allocs: 0.0647 MB 1
BigFloat bareinterval/basics/atan 2.04 k allocs: 0.08 MB 2.04 k allocs: 0.08 MB 1
BigFloat bareinterval/basics/cos 2.45 k allocs: 0.185 MB 2.45 k allocs: 0.185 MB 1
BigFloat bareinterval/basics/cosh 1.01 k allocs: 0.0671 MB 1.01 k allocs: 0.0671 MB 1
BigFloat bareinterval/basics/exp 0.802 k allocs: 0.0397 MB 0.802 k allocs: 0.0397 MB 1
BigFloat bareinterval/basics/inv 0.198 k allocs: 20 kB 0.198 k allocs: 20 kB 1
BigFloat bareinterval/basics/log 0.804 k allocs: 0.0694 MB 0.804 k allocs: 0.0694 MB 1
BigFloat bareinterval/basics/sin 2.9 k allocs: 0.197 MB 2.9 k allocs: 0.197 MB 1
BigFloat bareinterval/basics/sinh 0.815 k allocs: 0.0407 MB 0.815 k allocs: 0.0407 MB 1
BigFloat bareinterval/basics/sqrt 0.304 k allocs: 29.9 kB 0.304 k allocs: 29.9 kB 1
BigFloat bareinterval/basics/tan 1.67 k allocs: 0.124 MB 1.67 k allocs: 0.124 MB 1
BigFloat bareinterval/basics/tanh 0.808 k allocs: 0.0399 MB 0.808 k allocs: 0.0399 MB 1
BigFloat interval/basics/* 0.263 k allocs: 26.8 kB 0.263 k allocs: 26.8 kB 1
BigFloat interval/basics/+ 0.203 k allocs: 21.2 kB 0.203 k allocs: 21.2 kB 1
BigFloat interval/basics/- 0.203 k allocs: 21.2 kB 0.203 k allocs: 21.2 kB 1
BigFloat interval/basics// 0.101 k allocs: 11.6 kB 0.101 k allocs: 11.6 kB 1
BigFloat interval/basics/abs 0.2 k allocs: 20.9 kB 0.2 k allocs: 20.9 kB 1
BigFloat interval/basics/acos 1.77 k allocs: 0.115 MB 1.77 k allocs: 0.115 MB 1
BigFloat interval/basics/asin 1.53 k allocs: 0.0929 MB 1.53 k allocs: 0.093 MB 0.999
BigFloat interval/basics/atan 2.04 k allocs: 0.0812 MB 2.04 k allocs: 0.0812 MB 1
BigFloat interval/basics/cos 2.45 k allocs: 0.186 MB 2.45 k allocs: 0.186 MB 1
BigFloat interval/basics/cosh 1.01 k allocs: 0.0681 MB 1.01 k allocs: 0.0681 MB 1
BigFloat interval/basics/exp 0.803 k allocs: 0.0409 MB 0.803 k allocs: 0.0407 MB 1
BigFloat interval/basics/inv 0.199 k allocs: 20.8 kB 0.199 k allocs: 20.8 kB 1
BigFloat interval/basics/log 1.1 k allocs: 0.0977 MB 1.1 k allocs: 0.0977 MB 1
BigFloat interval/basics/sin 2.9 k allocs: 0.198 MB 2.9 k allocs: 0.198 MB 1
BigFloat interval/basics/sinh 0.816 k allocs: 0.042 MB 0.816 k allocs: 0.0417 MB 1.01
BigFloat interval/basics/sqrt 0.758 k allocs: 0.0715 MB 0.758 k allocs: 0.0715 MB 1
BigFloat interval/basics/tan 1.67 k allocs: 0.125 MB 1.67 k allocs: 0.125 MB 1
BigFloat interval/basics/tanh 0.809 k allocs: 0.0411 MB 0.809 k allocs: 0.0411 MB 1
bareinterval/basics/* 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/+ 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/- 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics// 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/abs 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/acos 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/asin 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/atan 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/cos 0.56 k allocs: 0.0423 MB 0.56 k allocs: 0.0423 MB 1
bareinterval/basics/cosh 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/exp 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/inv 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/log 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/sin 0.56 k allocs: 0.0423 MB 0.56 k allocs: 0.0423 MB 1
bareinterval/basics/sinh 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/sqrt 2 allocs: 1.62 kB 2 allocs: 1.62 kB 1
bareinterval/basics/tan 0.29 k allocs: 23 kB 0.29 k allocs: 23 kB 1
bareinterval/basics/tanh 1.03 k allocs: 0.0359 MB 1.03 k allocs: 0.0359 MB 1
interval/basics/* 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/+ 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/- 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics// 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/abs 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/acos 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/asin 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/atan 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/cos 0.561 k allocs: 0.0431 MB 0.561 k allocs: 0.0431 MB 1
interval/basics/cosh 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/exp 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/inv 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/log 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/sin 0.561 k allocs: 0.0431 MB 0.561 k allocs: 0.0431 MB 1
interval/basics/sinh 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/sqrt 3 allocs: 2.45 kB 3 allocs: 2.45 kB 1
interval/basics/tan 0.291 k allocs: 24.4 kB 0.291 k allocs: 24.4 kB 1
interval/basics/tanh 1.03 k allocs: 0.0367 MB 1.03 k allocs: 0.0367 MB 1
time_to_load 0.154 k allocs: 11.4 kB 0.154 k allocs: 11.4 kB 1

Comment thread src/intervals/construction.jl Outdated

Return the decoration of interval x.

Return the default decoration of a `BareInterval`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence feels out of place no?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolutely, I copy pasted too hard.

@OlivierHnt OlivierHnt merged commit e5e1bbd into JuliaIntervals:master May 13, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants