Update proto/ommx/v1/instance.proto

Co-authored-by: Toshiki Teramura <toshiki.teramura@gmail.com>
Jij-Inc · Apr 23, 2024 · 4701e17 · 4701e17
1 parent 2974a19
commit 4701e17
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/proto/ommx/v1/instance.proto b/proto/ommx/v1/instance.proto
@@ -39,5 +39,10 @@ message Instance {
     SENSE_MAXIMIZE = 2;
   }
 
+  // The sense of this problem, i.e. minimize the objective or maximize it.
+  //
+  // Design decision note:
+  // - This is a required field. Most mathematical modeling tools allow for an empty sense and default to minimization. Alternatively, some tools do not create such a field and represent maximization problems by negating the objective function. This project prefers explicit descriptions over implicit ones to avoid such ambiguity and to make it unnecessary for developers to look up the reference for the treatment of omitted cases.
+  //
   Sense sense = 5;
 }