Skip to content
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

Jump to bottom

Update readme with Cbc.Optimizer #113

Merged
merged 2 commits into from
Jun 22, 2019
Merged

Update readme with Cbc.Optimizer #113

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7d33c6
Update readme with Cbc.Optimizer
odow Jun 22, 2019
a28b778
Update README.md
odow Jun 22, 2019
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
15 changes: 5 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,17 @@ If you do not want BinaryProvider to download the default binaries on install se

To switch back to the default binaries clear `JULIA_CBC_LIBRARY_PATH` and call `import Pkg; Pkg.build("Cbc")`.

### Using with **[MathProgBase]**

Cbc provides a solver object that can be passed to ``mixintprog`` in MathProgBase (and used to create instances of the solver-independent ``AbstractMathProgModel`` type):
### Using with **[JuMP](https://github.com/JuMP.jl)**

Use `Cbc.Optimizer` to use Cbc with JuMP:
```julia
using Cbc
using MathProgBase
mixintprog(..., CbcSolver(Option1=value1,Option2=value2,...))
using JuMP
model = Model(with_optimizer(Cbc.Optimizer, logLevel=1))
```

see the MathProgBase documentation for further information.

Options are solver-dependent, and unfortunately not well documented.

The following options are likely to be the most useful:

* ``seconds`` -- Solution timeout limit. (Must be a ``Float64``)
Expand All @@ -59,8 +57,6 @@ The following options are likely to be the most useful:

The complete list of parameters can be found by running the ``cbc`` executable and typing ``?`` at the prompt.

In addition, we provide the julia-specific option ``check_warmstart`` which, if set to ``false``, will tell the wrapper to pass along the warmstart solution regardless of if it satisfies the constraints of the problem. The default value is ``true``.

### Using the C interface

The low-level C interface is available in the ``CbcCInterface`` submodule:
Expand All @@ -71,4 +67,3 @@ using Cbc.CbcCInterface
Using this interface is not recommended.

[Cbc]: https://projects.coin-or.org/Cbc
[MathProgBase]: https://github.com/JuliaOpt/MathProgBase.jl