Skip to content

[docs] Clarify RelativeGap is solver-dependent #1545

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
Aug 23, 2021
Merged

[docs] Clarify RelativeGap is solver-dependent #1545

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
8 changes: 7 additions & 1 deletion src/attributes.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1035,7 +1035,13 @@ struct ObjectiveBound <: AbstractModelAttribute end
"""
RelativeGap()

A model attribute for the final relative optimality gap, defined as ``\\frac{|b-f|}{|f|}``, where ``b`` is the best bound and ``f`` is the best feasible objective value.
A model attribute for the final relative optimality gap.

!!! warning
The definition of this gap is solver-dependent. However, most solvers
implementing this attribute define the relative gap as some variation of
``\\frac{|b-f|}{|f|}``, where ``b`` is the best bound and ``f`` is the best
feasible objective value.
"""
struct RelativeGap <: AbstractModelAttribute end

Expand Down