Skip to content

Fix StackOverflow with copy_to #1653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 9, 2021
Merged

Fix StackOverflow with copy_to #1653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions src/MathOptInterface.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ abstract type AbstractOptimizer <: ModelLike end

Optimize the problem contained in `optimizer`.

Before calling `optimize!`, the problem should first be constructed using the
Before calling `optimize!`, the problem should first be constructed using the
incremental interface (see [`supports_incremental_interface`](@ref)) or [`copy_to`](@ref).
"""
function optimize! end
Expand All @@ -45,22 +45,22 @@ A "one-shot" call that copies the problem from `src` into `dest` and then uses
Returns a tuple of an [`IndexMap`](@ref) and a `Bool` `copied`.

* The [`IndexMap`](@ref) object translates variable and constraint indices from
the `src` model to the corresponding indices in the `dest` optimizer. See
the `src` model to the corresponding indices in the `dest` optimizer. See
[`copy_to`](@ref) for details.
* If `copied == true`, `src` was copied to `dest` and then cached, allowing
incremental modification if supported by the solver.
* If `copied == false`, a cache of the model was _not_ kept in `dest`.
Therefore, only the solution information (attributes for which
Therefore, only the solution information (attributes for which
[`is_set_by_optimize`](@ref) is true) is available to query.

!!! note
The main purpose of `optimize!` method with two arguments is for use in
The main purpose of `optimize!` method with two arguments is for use in
[`Utilities.CachingOptimizer`](@ref).

!!! warning
The new `optimize!` method with two arguments is an experimental new feature
of MOI v0.10.2 that may break in MOI v1.0.

## Relationship to the single-argument `optimize!`

The default fallback of `optimize!(dest::AbstractOptimizer, src::ModelLike)` is
Expand Down Expand Up @@ -202,13 +202,18 @@ is_valid(dest, index_map[x]) # true
```
"""
function copy_to(dest, src; kwargs...)
if length(kwargs) > 0
@warn(
"copy_to with keyword arguments is deprecated. Now names are " *
"copied by default",
maxlog = 1,
if length(kwargs) == 0
error(
"`copy_to` is not supported by the solver `$(typeof(dest))`. Did " *
"you mean to call " *
"`optimize!(dest::AbstractOptimizer, src::ModelLike)` instead?",
)
end
@warn(
"copy_to with keyword arguments is deprecated. Now names are " *
"copied by default",
maxlog = 1,
)
return copy_to(dest, src)
end

Expand Down
15 changes: 15 additions & 0 deletions test/errors.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,21 @@ function test_errors_InvalidCalbackUsage()
"InvalidCallbackUsage: Cannot submit $(MOI.UserCut(1)) inside a MathOptInterface.LazyConstraintCallback()."
end

struct TestCopyToFallback <: MOI.AbstractOptimizer end

function test_errors_copy_to_fallback()
dest = TestCopyToFallback()
@test_throws(
ErrorException(
"`copy_to` is not supported by the solver `$(typeof(dest))`. Did " *
"you mean to call " *
"`optimize!(dest::AbstractOptimizer, src::ModelLike)` instead?",
),
MOI.copy_to(dest, MOI.Utilities.Model{Float64}()),
)
return
end

function runtests()
for name in names(@__MODULE__; all = true)
if startswith("$name", "test_")
Expand Down