From c5c900e9a0cfc2a34fcab182882363bf21ac8081 Mon Sep 17 00:00:00 2001 From: Oscar Dowson Date: Mon, 23 Aug 2021 14:46:40 +1200 Subject: [PATCH] [docs] Clarify RelativeGap is solver-dependent --- src/attributes.jl | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/attributes.jl b/src/attributes.jl index 758dab5981..639fba3b5a 100644 --- a/src/attributes.jl +++ b/src/attributes.jl @@ -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