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

Document custom attributes in the MOI wrapper #230

Merged
merged 1 commit into from
Mar 10, 2024
Merged

Document custom attributes in the MOI wrapper #230

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
28 changes: 18 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,20 @@ to the console ([there might be issues with console output on windows (it is man
If `logfile` is set to a file's path, output is printed to that file.
By default, `logfile = ""` (console).

### Custom options

* `MOI_POST_SOLVE::Bool`: set this attribute to `false` to skip `XPRSpostsolve`.
This is most useful in older versions of Xpress that throw an error if the
model is infeasible.
* `MOI_IGNORE_START::Bool`: set this attribute to `true` to skip setting
`MOI.VariablePrimalStart`
* `MOI_WARNINGS::Bool`: set this attribute to `false` to turn off the various
warnings printed by the MathOptInterface wrapper
* `MOI_SOLVE_MODE::String`: set the `flags` argument to
[`lpoptimize`](https://www.fico.com/fico-xpress-optimization/docs/latest/solver/optimizer/R/HTML/lpoptimize.html)
* `XPRESS_WARNING_WINDOWS::Bool`: set this attribute to `false` to turn of
warnings on Windows.

## Callbacks

Solver specific and solver independent callbacks are working in
Expand All @@ -82,23 +96,17 @@ current implementation should be considered experimental.

## Environment variables

- `XPRESS_JL_SKIP_LIB_CHECK`: Used to skip build lib check as previously described.
- `XPRESS_JL_SKIP_LIB_CHECK`: Used to skip build lib check as previously
described.
- `XPRESS_JL_NO_INFO`: Disable license info log.
- `XPRESS_JL_NO_DEPS_ERROR`: Disable error when do deps.jl file is found.
- `XPRESS_JL_NO_AUTO_INIT`: Disable automatic run of `Xpress.initialize()`.
Specially useful for explicitly loading the dynamic library.

## Skipping Xpress.postsolve

In older versions of Xpress, the command `XPRSpostsolve` throws an error in
infeasible models. In these older versions the post solve should not be
executed. To do this, one can use the `MOI.RawOptimizerAttribute("MOI_POST_SOLVE")`
to skip this routine.
Specially useful for explicitly loading the dynamic library.

## C API

The C API can be accessed via `Xpress.Lib.XPRSxx` functions, where the names and
arguments are identical to the C API.
arguments are identical to the C API.

See the [Xpress documentation](https://www.fico.com/fico-xpress-optimization/docs/latest/solver/optimizer/HTML)
for details.
Expand Down
Loading