std.py

Go to the documentation of this file.

# std.py
#
# Some standard methods for running the tutorials
 
import sys
 
import pyconopt as copt
 
class TutMessageHandler(copt.MessageHandler):
   def __init__(self, name):
      self.name = name
      self.fs = open(f'{name}.sta', 'w')
      self.fd = open(f'{name}.lst', 'w')
      super().__init__()
 
   def message(self, smsg, dmsg, nmsg, msgv):
      if smsg > 0:
         print('\n'.join(msgv[:smsg]))
         self.fs.write('{}\n'.format('\n'.join(msgv[:smsg])))
 
      if dmsg > 0:
         self.fd.write('{}\n'.format('\n'.join(msgv[:dmsg])))
 
      return 0
 
   def errorMessage(self, rowno, colno, posno, msg):
      errormsg = ""
      if rowno == -1:
         errormsg += f'Variable {colno} : '
      elif colno == -1:
         errormsg += f'Equation {rowno} : '
      else:
         errormsg += f'Variable {colno} appearing in Equation {rowno} : '
 
      errormsg += f'{msg}\n'
 
      self.fd.write(errormsg)
      self.fs.write(errormsg)
 
      return 0
 
def _log(conopt, msg):
   name = conopt.getName()
   with open(f'{name}.rc', 'w') as fc:
      fc.write(f'{name}: {msg}\n')
 
 
def checkSolve(conopt, expected_objective, coi_error, tol = 0.000001):
   # checking the statuses and objective value
   if conopt.modelStatus() != 2 or conopt.solutionStatus() != 1:
      _log(conopt, "Incorrect Model or Solver Status")
      return -1
   elif abs( conopt.objectiveValue() - expected_objective ) > tol:
      _log(conopt, "Incorrect objective returned")
      return -1
 
   # printing the final status of the optimisation
   conopt.printStatus();
 
   _log(conopt, "Successful Solve");
 
   return coi_error