(Issue #291) Prefer identical prefix to group solver indices.

Author: jared321

pounders/m/create_trsp_solver.m

@@ -5,9 +5,12 @@
     % ----- HARDCODED VALUES
     % Ensure that these match the analogous constants implemented for
     % POUNDERS/Python.
-    SIMPLE_TRSP = 1;
-    MINQ5_TRSP = 2;
-    MINQ8_TRSP = 3;
+    %
+    % Both MATLAB and Python implementations should declare the union of all
+    % solvers available even if they don't support one or more of the solvers.
+    TRSP_SOLVER_SIMPLE = 1;
+    TRSP_SOLVER_MINQ5 = 2;
+    TRSP_SOLVER_MINQ8 = 3;
 
     % ----- DEFINE POUNDERS-COMPATIBLE INTERFACES ON SOLVERS
     % Stefan's crappy 10 line solver
@@ -44,12 +47,12 @@
     end
 
     % ----- IDENTIFY DESIRED SOLVER
-    if spsolver == SIMPLE_TRSP
+    if spsolver == TRSP_SOLVER_SIMPLE
         solver = @bqmin_wrapper;
-    elseif spsolver == MINQ5_TRSP
+    elseif spsolver == TRSP_SOLVER_MINQ5
         check_minq_installation(5);
         solver = @minq5_wrapper;
-    elseif spsolver == MINQ8_TRSP
+    elseif spsolver == TRSP_SOLVER_MINQ8
         check_minq_installation(8);
         solver = @minq8_wrapper;
     else

pounders/py/__init__.py

@@ -17,7 +17,7 @@
 # fmt: on
 from .create_squared_diff_from_mean_functions import create_squared_diff_from_mean_functions
 
-from .constants import SIMPLE_TRSP, MINQ5_TRSP
+from .constants import TRSP_SOLVER_SIMPLE, TRSP_SOLVER_MINQ5, TRSP_SOLVER_MINQ8
 from .create_trsp_solver import create_trsp_solver
 
 # -- Python unittest-based test framework

pounders/py/constants.py

@@ -1,6 +1,9 @@
 # ----- TRUST-REGION SUBPROBLEM SOLVERS
 # Ensure that these match the analogous constants implemented for
 # POUNDERS/MATLAB.
-SIMPLE_TRSP = 1
-MINQ5_TRSP = 2
-MINQ8_TRSP = 3
+#
+# Both MATLAB and Python implementations should declare the union of all solvers
+# available even if they don't support one or more of the solvers.
+TRSP_SOLVER_SIMPLE = 1
+TRSP_SOLVER_MINQ5 = 2
+TRSP_SOLVER_MINQ8 = 3

pounders/py/create_trsp_solver.py

@@ -2,7 +2,7 @@
 
 import numpy as np
 
-from .constants import SIMPLE_TRSP, MINQ5_TRSP
+from .constants import TRSP_SOLVER_SIMPLE, TRSP_SOLVER_MINQ5
 from .._get_minq_installation import get_minq_installation
 from .bqmin import bqmin
 
@@ -23,10 +23,10 @@ def create_trsp_solver(spsolver):
     for all components :math:`s_j` of :math:`\svec`.
 
     :param spsolver:
-        * ``ibcdfo.pounders.SIMPLE_TRSP`` - simplistic 10 line solver that is
+        * ``ibcdfo.pounders.TRSP_SOLVER_SIMPLE`` - simplistic 10 line solver that is
           included only for testing and maintenance purposes
-        * ``ibcdfo.pounders.MINQ5_TRSP`` - Arnold Neumaier's minq5 solver
-        * ``ibcdfo.pounders.MINQ8_TRSP`` - Arnold Neumaier's minq8 solver
+        * ``ibcdfo.pounders.TRSP_SOLVER_MINQ5`` - Arnold Neumaier's minq5 solver
+        * ``ibcdfo.pounders.TRSP_SOLVER_MINQ8`` - Arnold Neumaier's minq8 solver
     :return: Python function with the interface
 
         .. code:: python
@@ -47,15 +47,15 @@ def create_trsp_solver(spsolver):
         * ``flag`` communicates the termination condition of the solver with a
           negative value indicating failure.
     """
-    if spsolver == SIMPLE_TRSP:
+    if spsolver == TRSP_SOLVER_SIMPLE:
 
         def __bqmin_wrapper(H, G, Low, Upp):
             Xsp, mdec = bqmin(H, G, Low, Upp)
             return Xsp, mdec, 0
 
         return __bqmin_wrapper
 
-    elif spsolver == MINQ5_TRSP:
+    elif spsolver == TRSP_SOLVER_MINQ5:
         required_minq_SHA, minq_installation = get_minq_installation()
         if not minq_installation["is_valid"]:
             msg = f"Please set MINQ clone to git commit {required_minq_SHA}.\nSee User Guide (https://ibcdfo.readthedocs.io) for more information and instructions."