Skip to content

Commit

Permalink
Correct inputs in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@Kolaru
Kolaru authored Nov 5, 2024
1 parent 6f65bae commit 321599d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ julia> f(x) = sin(x) - 0.1*x^2 + 1
f (generic function with 1 method)

julia> roots(f, -10..10)
4-element Array{Root{Interval{Float64}},1}:
Root([3.14959, 3.1496], :unique)
Root([-4.42654, -4.42653], :unique)
Root([-1.08205, -1.08204], :unique)
Root([-3.10682, -3.10681], :unique)
4-element Vector{Root{Interval{Float64}}}:
Root([-4.42654, -4.42653]_com_NG, :unique)
Root([-3.10682, -3.10681]_com_NG, :unique)
Root([-1.08205, -1.08204]_com_NG, :unique)
Root([3.14959, 3.1496]_com_NG, :unique)
```

The `:unique` status indicates that each listed interval contains exactly one root. The other possible status is `:unknown`, which corresponds to intervals that may contain zero, one, or more roots (no guarantee is provided for these intervals).
Expand Down

2 comments on commit 321599d

@Kolaru
Copy link
Collaborator Author

@Kolaru Kolaru commented on 321599d Nov 5, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator register

Release notes:

Main change

  • Compatibility with IntervalArithmetic v0.22

Breaking changes

  • Decorated intervals must be used (which is the default Interval in the IntervalArithmetic v0.22)

  • The signature of the roots function changed to roots(f::Function, X::Union{Interval, AbstractVector} ; kwargs...), with the following consequences

    • Manual derivatives and contractors must now always be passed as keyword arguments. This greatly simplify the internal logic of the roots function.
    • No more IntervalBox. Multidimensional problem are specified by returning a vector of intervals, and giving a vector of intervals as initial search region.

  • Features of the packages that were undocumented are now unsupported (e.g. Slopes and quadratic equations). If you were using them, please open an issue.

New feature

  • Standard vectors of intervals are supported. They are significantly (3x) time slower for a simple 2D problem than SVector, but more convenient.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/118729

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.6.0 -m "<description of version>" 321599da464282c585590e78cac7c30a478a61b9
git push origin v0.6.0

Please sign in to comment.