Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
@lassepe
lassepe committed Apr 17, 2024
1 parent 1ff4e72 commit cf4a9f8
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ParametricMCPs"
uuid = "9b992ff8-05bb-4ea1-b9d2-5ef72d82f7ad"
authors = ["lassepe <[email protected]> and contributors"]
version = "0.1.14"
version = "0.1.15"

[deps]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
Expand Down
6 changes: 3 additions & 3 deletions src/SymbolicUtils.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ module SymbolicUtils
using Symbolics: Symbolics
using FastDifferentiation: FastDifferentiation as FD

export SymbolicsBackend, FastDifferentationBackend, make_variables, build_function
export SymbolicsBackend, FastDifferentiationBackend, make_variables, build_function

struct SymbolicsBackend end
struct FastDifferentationBackend end
struct FastDifferentiationBackend end

"""
make_variables(backend, name, dimension)
Expand All @@ -28,7 +28,7 @@ function make_variables(::SymbolicsBackend, name::Symbol, dimension::Int)
vars
end

function make_variables(::FastDifferentationBackend, name::Symbol, dimension::Int)
function make_variables(::FastDifferentiationBackend, name::Symbol, dimension::Int)
FD.make_variables(name, dimension)
end

Expand Down
2 changes: 1 addition & 1 deletion src/parametric_problem.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ parameter vector `θ` of size `parameter_dimension` to an length `n` vector outp
- `parameter_dimension`: the size of the parameter vector `θ` in `f`.
Keyword arguments:
- `[backend]`: the backend (from `ParametricMCPs.SymbolicUtils`) to be used for compiling callbacks for `f` and its Jacobians needed by PATH. `SymbolicsBackend` (default) is slightly more flexible. `FastDifferentationBackend` has reduced compilation times and reduced runtime in some cases.
- `[backend]`: the backend (from `ParametricMCPs.SymbolicUtils`) to be used for compiling callbacks for `f` and its Jacobians needed by PATH. `SymbolicsBackend` (default) is slightly more flexible. `FastDifferentiationBackend` has reduced compilation times and reduced runtime in some cases.
- `compute_sensitivities`: whether to compile the callbacks needed for sensitivity computation.
- `[problem_size]`: the number of decision variables. If not provided and `lower_bounds` or `upper_bounds` are vectors, the problem size is inferred from the length of these vectors.
Expand Down
2 changes: 1 addition & 1 deletion test/runtests.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ using FiniteDiff: FiniteDiff
using Symbolics: Symbolics

@testset "ParametricMCPs.jl" begin
for backend in [ParametricMCPs.SymbolicUtils.SymbolicsBackend(), ParametricMCPs.SymbolicUtils.FastDifferentationBackend()]
for backend in [ParametricMCPs.SymbolicUtils.SymbolicsBackend(), ParametricMCPs.SymbolicUtils.FastDifferentiationBackend()]
rng = Random.MersenneTwister(1)
parameter_dimension = 2
# setup a dummy MCP which represents a QP with:
Expand Down

2 comments on commit cf4a9f8

@lassepe
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@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/105071

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

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.1.15 -m "<description of version>" cf4a9f8fe3f04c9176211d366c0942b4c0f93685
git push origin v0.1.15

Also, note the warning: Version 0.1.15 skips over 0.1.14
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.