Skip to content

Commit

Permalink
nlwpy: Format test script with black
Browse files Browse the repository at this point in the history
  • Loading branch information
@fdabrandao
fdabrandao committed Feb 23, 2024
1 parent c1fe7d0 commit dc148dc
Showing 1 changed file with 172 additions and 151 deletions.
323 changes: 172 additions & 151 deletions nl-writer2/nlwpy/tests/test.py
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
'''
"""
NL Writer Python API test.
Copyright (C) 2024 AMPL Optimization Inc.
Expand All @@ -18,175 +18,196 @@
of or in connection with the use or performance of this software.
Author: Gleb Belov
'''
"""

import sys
import numpy as np
from scipy.sparse import csr_matrix

import nlwpy

assert nlwpy.__version__ == "0.0.1"
assert nlwpy.__version__ == "0.0.1b0"

nlwo = nlwpy.MakeNLOptionsBasic_Default()
assert 0 == nlwo.n_text_mode_
assert 0 == nlwo.want_nl_comments_
assert 1 == nlwo.flags_


## ---------------------------------------------------------------
class ModelBuilder:
def GetModel(self):
nlme = nlwpy.NLModel(self.prob_name_)

nlme.SetCols(self.var_lb_, self.var_ub_, self.var_type_)
nlme.SetColNames(self.var_names_)

if self.A_ is not None:
self.A_ = csr_matrix(self.A_)
nlme.SetRows(self.row_lb_, self.row_ub_,
self.A_format_,
self.A_.indptr, self.A_.indices, self.A_.data)
nlme.SetRowNames(self.row_names_)

nlme.SetLinearObjective(self.obj_sense_, self.obj_c0_,
self.obj_c_)

if self.Q_ is not None:
self.Q_ = csr_matrix(self.Q_)
nlme.SetHessian(self.Q_format_,
self.Q_.indptr, self.Q_.indices, self.Q_.data)
nlme.SetObjName(self.obj_name_)

if len(self.ini_x_i_)>0:
nlme.SetWarmstart(self.ini_x_i_, self.ini_x_v_)
if len(self.ini_y_i_)>0:
nlme.SetDualWarmstart(self.ini_y_i_, self.ini_y_v_)
if len(self.bas_x_)>0:
suf = nlwpy.NLSuffix("status", 0, self.bas_x_)
nlme.AddSuffix(suf)
if len(self.bas_y_)>0:
suf = nlwpy.NLSuffix("status", 1, self.bas_y_)
nlme.AddSuffix(suf)

return nlme

def Check(self, sol):
result = True
if not self.ApproxEqual(sol.obj_val_, self.obj_val_ref_):
print("MIQP 1: wrong obj val ({:.17f} !~ {:.17f})".format(
sol.obj_val_, self.obj_val_ref_))
result = False

for i in range(len(sol.x_)):
if not self.ApproxEqual(self.x_ref_[i], sol.x_[i]):
print("MIQP 1: wrong x[{}] ({:.17f} !~ {:.17f})".format(
i+1, sol.x_[i], self.x_ref_[i]))
result = False

### Printing suffixes.
### TODO replace by checking debug suffixes and ini guesses.
suffixes = sol.suffixes_
print("Number of suffixes returned:", len(suffixes))
for suf in suffixes:
print(" SUFFIX '{}' [{}]".format(suf.name_, suf.kind_))
print(" Table: ", suf.table_)
print(" Values: ", *suf.values_)
sufMIPGapObj = suffixes.Find("relmipgap", 2) ## should be 2+4
if sufMIPGapObj is not None:
print("FOUND: SUFFIX '{}' [{}].".format(
sufMIPGapObj.name_, sufMIPGapObj.kind_))
sufVarStatus = suffixes.Find("status", 0)
if sufVarStatus is not None:
print("FOUND: SUFFIX '{}' [{}].".format(
sufVarStatus.name_, sufVarStatus.kind_))
suffixes.clear()

print("MIQP 1: solution check {}, obj={:.17f}.".format(
"ok" if result else "Failed", sol.obj_val_))
return result

def ApproxEqual(self, n, m):
return abs(n-m) \
<= 1e-5 * min(1.0, abs(n)+abs(m))

def __init__(self):
self.prob_name_ = "nlwpy_prob"
self.var_lb_ = [0, -3, 0, -1, -1, -2]
self.var_ub_ = [0, 20, 1, 1e20, -1, 10]
self.var_type_ = [0, 1, 1, 1, 0, 0]
self.var_names_ = \
["x1_4", "x2_6", "x3_5", "x4_3", "x5_1", "x6_2"]
self.A_format_ = nlwpy.MatrixFormat.Rowwise
self.A_ = np.array([
[0,1,1,1,0,1],
[0,1,-1,-1,0,1]])
self.row_lb_ = [15, 10]
self.row_ub_ = [15, np.inf]
self.row_names_ = ["C1", "C2"]
self.obj_sense_ = nlwpy.ObjSense.Minimize
self.obj_c0_ = 3.24
self.obj_c_ = [0,1,0,0,0,0]
self.Q_format_ = nlwpy.HessianFormat.Square
self.Q_ = np.zeros([6, 6])
self.Q_[3, 3] = 10
self.Q_[3, 5] = 12
self.Q_[4, 4] = 14
self.obj_name_ = "obj[1]"

### Extra input
self.ini_x_i_ = [0,2]
self.ini_x_v_ = [5,4]
self.ini_y_i_ = [0]
self.ini_y_v_ = [-12]
self.bas_x_ = [3,4,1,4,1,3] ### Basis statuses
self.bas_y_ = [1,1]

### Solution
self.x_ref_ = [0, 5, 1, -1, -1, 10]
self.obj_val_ref_ = -39.76
def GetModel(self):
nlme = nlwpy.NLModel(self.prob_name_)

nlme.SetCols(self.var_lb_, self.var_ub_, self.var_type_)
nlme.SetColNames(self.var_names_)

if self.A_ is not None:
self.A_ = csr_matrix(self.A_)
nlme.SetRows(
self.row_lb_,
self.row_ub_,
self.A_format_,
self.A_.indptr,
self.A_.indices,
self.A_.data,
)
nlme.SetRowNames(self.row_names_)

nlme.SetLinearObjective(self.obj_sense_, self.obj_c0_, self.obj_c_)

if self.Q_ is not None:
self.Q_ = csr_matrix(self.Q_)
nlme.SetHessian(
self.Q_format_, self.Q_.indptr, self.Q_.indices, self.Q_.data
)
nlme.SetObjName(self.obj_name_)

if len(self.ini_x_i_) > 0:
nlme.SetWarmstart(self.ini_x_i_, self.ini_x_v_)
if len(self.ini_y_i_) > 0:
nlme.SetDualWarmstart(self.ini_y_i_, self.ini_y_v_)
if len(self.bas_x_) > 0:
suf = nlwpy.NLSuffix("status", 0, self.bas_x_)
nlme.AddSuffix(suf)
if len(self.bas_y_) > 0:
suf = nlwpy.NLSuffix("status", 1, self.bas_y_)
nlme.AddSuffix(suf)

return nlme

def Check(self, sol):
result = True
if not self.ApproxEqual(sol.obj_val_, self.obj_val_ref_):
print(
"MIQP 1: wrong obj val ({:.17f} !~ {:.17f})".format(
sol.obj_val_, self.obj_val_ref_
)
)
result = False

for i in range(len(sol.x_)):
if not self.ApproxEqual(self.x_ref_[i], sol.x_[i]):
print(
"MIQP 1: wrong x[{}] ({:.17f} !~ {:.17f})".format(
i + 1, sol.x_[i], self.x_ref_[i]
)
)
result = False

### Printing suffixes.
### TODO replace by checking debug suffixes and ini guesses.
suffixes = sol.suffixes_
print("Number of suffixes returned:", len(suffixes))
for suf in suffixes:
print(" SUFFIX '{}' [{}]".format(suf.name_, suf.kind_))
print(" Table: ", suf.table_)
print(" Values: ", *suf.values_)
sufMIPGapObj = suffixes.Find("relmipgap", 2) ## should be 2+4
if sufMIPGapObj is not None:
print(
"FOUND: SUFFIX '{}' [{}].".format(
sufMIPGapObj.name_, sufMIPGapObj.kind_
)
)
sufVarStatus = suffixes.Find("status", 0)
if sufVarStatus is not None:
print(
"FOUND: SUFFIX '{}' [{}].".format(
sufVarStatus.name_, sufVarStatus.kind_
)
)
suffixes.clear()

print(
"MIQP 1: solution check {}, obj={:.17f}.".format(
"ok" if result else "Failed", sol.obj_val_
)
)
return result

def ApproxEqual(self, n, m):
return abs(n - m) <= 1e-5 * min(1.0, abs(n) + abs(m))

def __init__(self):
self.prob_name_ = "nlwpy_prob"
self.var_lb_ = [0, -3, 0, -1, -1, -2]
self.var_ub_ = [0, 20, 1, 1e20, -1, 10]
self.var_type_ = [0, 1, 1, 1, 0, 0]
self.var_names_ = ["x1_4", "x2_6", "x3_5", "x4_3", "x5_1", "x6_2"]
self.A_format_ = nlwpy.MatrixFormat.Rowwise
self.A_ = np.array([[0, 1, 1, 1, 0, 1], [0, 1, -1, -1, 0, 1]])
self.row_lb_ = [15, 10]
self.row_ub_ = [15, np.inf]
self.row_names_ = ["C1", "C2"]
self.obj_sense_ = nlwpy.ObjSense.Minimize
self.obj_c0_ = 3.24
self.obj_c_ = [0, 1, 0, 0, 0, 0]
self.Q_format_ = nlwpy.HessianFormat.Square
self.Q_ = np.zeros([6, 6])
self.Q_[3, 3] = 10
self.Q_[3, 5] = 12
self.Q_[4, 4] = 14
self.obj_name_ = "obj[1]"

### Extra input
self.ini_x_i_ = [0, 2]
self.ini_x_v_ = [5, 4]
self.ini_y_i_ = [0]
self.ini_y_v_ = [-12]
self.bas_x_ = [3, 4, 1, 4, 1, 3] ### Basis statuses
self.bas_y_ = [1, 1]

### Solution
self.x_ref_ = [0, 5, 1, -1, -1, 10]
self.obj_val_ref_ = -39.76


def SolveAndCheck(solver, sopts, binary, stub):
mb = ModelBuilder()
nlme = mb.GetModel()
nlse = nlwpy.NLSolver()
nlopts = nlwpy.MakeNLOptionsBasic_Default()
nlopts.n_text_mode_ = not binary
nlopts.want_nl_comments_ = 1
nlse.SetNLOptions(nlopts)
nlse.SetFileStub(stub)
sol = nlse.Solve(nlme, solver, sopts)
if sol.solve_result_ > -2: ## Some method for this?
if (not mb.Check(sol)):
print("Solution check failed.")
return False
else:
print(nlse.GetErrorMessage())
return False

return True

argc=len(sys.argv)
argv=sys.argv

if argc<2:
print("AMPL NL Writer Python API example.\n"
"Usage:\n"
" python <this_script> <solver> [\"<solver_options>\" [binary/text [<stub>]]],\n\n"
"where <solver> is ipopt, gurobi, minos, ...;\n"
"binary/text is the NL format (default: binary.)\n"
"Examples:\n"
" python <this_script> ipopt \"\" text /tmp/stub\n"
" python <this_script> gurobi \"nonconvex=2 funcpieces=-2 funcpieceratio=1e-4\"")
sys.exit(0)

solver = argv[1] if (argc>1) else "minos"
sopts = argv[2] if argc>2 else ""
binary = ((argc<=3) or "text" != argv[3])
stub = argv[4] if argc>4 else ""
mb = ModelBuilder()
nlme = mb.GetModel()
nlse = nlwpy.NLSolver()
nlopts = nlwpy.MakeNLOptionsBasic_Default()
nlopts.n_text_mode_ = not binary
nlopts.want_nl_comments_ = 1
nlse.SetNLOptions(nlopts)
nlse.SetFileStub(stub)
sol = nlse.Solve(nlme, solver, sopts)
if sol.solve_result_ > -2: ## Some method for this?
if not mb.Check(sol):
print("Solution check failed.")
return False
else:
print(nlse.GetErrorMessage())
return False

return True


argc = len(sys.argv)
argv = sys.argv

if argc < 2:
print(
"AMPL NL Writer Python API example.\n"
"Usage:\n"
' python <this_script> <solver> ["<solver_options>" [binary/text [<stub>]]],\n\n'
"where <solver> is ipopt, gurobi, minos, ...;\n"
"binary/text is the NL format (default: binary.)\n"
"Examples:\n"
' python <this_script> ipopt "" text /tmp/stub\n'
' python <this_script> gurobi "nonconvex=2 funcpieces=-2 funcpieceratio=1e-4"'
)
sys.exit(0)

solver = argv[1] if (argc > 1) else "minos"
sopts = argv[2] if argc > 2 else ""
binary = (argc <= 3) or "text" != argv[3]
stub = argv[4] if argc > 4 else ""

if not SolveAndCheck(solver, sopts, binary, stub):
print("SolveAndCheck() failed.")
sys.exit(1)
print("SolveAndCheck() failed.")
sys.exit(1)

## ---------------------------------------------------------------
print("Test finished.")

0 comments on commit dc148dc

Please sign in to comment.