update_algorithms

Go to the documentation of this file.

#!/usr/bin/env python3
 
# Copyright 2019, University of Maryland and the MANGO development team.
#
# This file is part of MANGO.
#
# MANGO is free software: you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# MANGO is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with MANGO.  If not, see
# <https://www.gnu.org/licenses/>.
 
 
# This script uses the database of algorithms in "algorithms.dat" to populate
# several sections of mango.hpp and other files, ensuring they are consistent.
 
print(__file__ + ": Using the database of algorithms to generate code in mango.hpp and other source files.")
 
index_deterministic = 7
 
# Read in the database of algorithms:
database_filename = "algorithms.dat"
try:
    f = open(database_filename)
except:
    print("Error! Unable to open "+database_filename)
    raise
 
lines = f.readlines()
f.close()
 
def TF_to_truefalse(str):
    str = str.strip().upper()
    if str == "T":
        return "true"
    elif str == "F":
        return "false"
    else:
        print("Error! TF_to_truefalse called with argument "+str+", which is neither T nor F")
        exit(1)
 
# Filter out any commented rows or rows that are blank
database = []
for line in lines:
    stripline = line.strip().lower()
    if len(stripline) < 2:
        continue
    if stripline[0] == '!' or stripline[0] == '#' or stripline[0] == '%':
        continue
    splitline = stripline.split(',')
    if len(splitline) != 8:
        print('Error! The following line of '+database_filename+' has the wrong number of entries:')
        print(line)
        exit(1)
    for j in [2,3,4,5,6,7]:
        splitline[j] = TF_to_truefalse(splitline[j])
    # If the algorithm uses derivatives, ensure 'parallel' is true:
    if splitline[3] == 'true':
        splitline[4] = 'true'
    # If an algorithm requires bound constraints, it must allow bound constraints
    if splitline[5] == 'false' and splitline[6] == 'true':
        print('Error! An algorithm requires bound constraints but does not allow bound constraints. Original line:')
        print(line)
        exit(1)
    database.append([s.strip() for s in splitline])
#print(database)
 
# Form the algorithm names:
names = []
for entry in database:
    if len(entry[1]) > 0:
        str = entry[0]+'_'+entry[1]
    else:
        str = entry[0]
    names.append(str)
 
# Form the set of packages:
packages = list(set([entry[0] for entry in database]))
packages_for_least_squares = []
packages_for_non_least_squares = []
for package in packages:
    has_least_squares_algorithm = False
    has_non_least_squares_algorithm = False
    for entry in database:
        if entry[0]==package and entry[2]=='true':
            has_least_squares_algorithm = True
        if entry[0]==package and entry[2]=='false':
            has_non_least_squares_algorithm = True
    packages_for_least_squares.append(has_least_squares_algorithm)
    packages_for_non_least_squares.append(has_non_least_squares_algorithm)
print('Packages: ',packages)
print('Has least-squares algorithm? ',packages_for_least_squares)
print('Has non-least-squares algorithm? ',packages_for_non_least_squares)
 
def find_markup_single(lines,str,comment):
    found_it = 0
    for j in range(len(lines)):
        stripline = lines[j].strip()
        if stripline[:len(comment)] == comment and stripline[len(comment):].strip() == '<'+str+'>':
            found_it += 1
            line = j
    if found_it == 0:
        print("Error! Unable to find a line '"+comment+" <"+str+">'")
        exit(1)
    if found_it > 1:
        print("Error! Found more than 1 line '"+comment+" <"+str+">'")
        exit(2)
    return line
 
def find_markup(lines,str,comment):
    start = find_markup_single(lines,str,comment)
    end   = find_markup_single(lines,'/'+str,comment)
    return start,end
 
##################################################################
# Editing mango.hpp
##################################################################
 
# Read in the file to preprocess
filename = 'api/mango.hpp'
try:
    f = open(filename)
except:
    print("Error! Unable to open "+filename+" for reading")
    raise
 
lines = f.readlines()
f.close()
 
# Replace <enum> .. </enum>
comment_line = ['    // This section was automatically generated by '+__file__+'\n']
start, end = find_markup(lines,'enum','//')
newlines = lines[:start+1] + comment_line
for name in names:
    str1 = '    '+name+',\n'
    newlines.append(str1.upper())
lines = newlines + lines[end:]
 
# Replace <database> .. </database>
start, end = find_markup(lines,'database','//')
newlines = lines[:start+1] + comment_line
newlines += ['    // name,                            package,         least_squares, uses_derivatives, parallel, allows_bound_constraints, requires_bound_constraints\n']
for j in range(len(database)):
    entry = database[j]
    name = ('"'+names[j]+'",').lower()
    package = 'PACKAGE_'+entry[0].upper()+','
    str = '    {' + name.ljust(35) + package.ljust(17) + (entry[2]+',').ljust(15) + (entry[3]+',').ljust(18) + (entry[4]+',').ljust(10) + (entry[5]+',').ljust(26) + entry[6].ljust(5) + '}'
    if j != len(database)-1:
        str += ','
    newlines.append(str+'\n')
lines = newlines + lines[end:]
 
# Replace <packages> .. </packages>
start, end = find_markup(lines,'packages','//')
newlines = lines[:start+1] + comment_line
for package in packages:
    newlines.append('    PACKAGE_'+package.upper()+',\n')
lines = newlines + lines[end:]
 
# Write new file
#filename = 'mango_new.hpp'
try:
    f = open(filename,'w')
except:
    print("Error! Unable to open "+filename+" for writing")
    raise
f.writelines(lines)
f.close()
 
##################################################################
# Editing set_package.cpp
##################################################################
 
# Read in the file to preprocess
filename = 'api/set_package.cpp'
try:
    f = open(filename)
except:
    print("Error! Unable to open "+filename+" for reading")
    raise
 
lines = f.readlines()
f.close()
 
# Replace <includes> .. </includes>
start, end = find_markup(lines,'includes','//')
newlines = lines[:start+1] + comment_line
for j in range(len(packages)):
    newlines.append('#include "Package_'+packages[j]+'.hpp"\n')
lines = newlines + lines[end:]
 
# Replace <packages> .. </packages>
start, end = find_markup(lines,'packages','//')
newlines = lines[:start+1] + comment_line
for j in range(len(packages)):
    newlines.append('  case PACKAGE_'+packages[j].upper()+':\n')
    newlines.append('    package = new Package_'+packages[j]+'();\n')
    newlines.append('    break;\n')
lines = newlines + lines[end:]
 
# Write new file
try:
    f = open(filename,'w')
except:
    print("Error! Unable to open "+filename+" for writing")
    raise
f.writelines(lines)
f.close()
 
##################################################################
# Editing optimize_nlopt.cpp
##################################################################
 
# Read in the file to preprocess
filename = 'api/optimize_nlopt.cpp'
try:
    f = open(filename)
except:
    print("Error! Unable to open "+filename+" for reading")
    raise
 
lines = f.readlines()
f.close()
 
# Replace <nlopt_algorithms> .. </nlopt_algorithms>
start, end = find_markup(lines,'nlopt_algorithms','//')
newlines = lines[:start+1] + comment_line
for j in range(len(database)):
    if database[j][0] == 'nlopt':
        newlines.append('  case mango::'+names[j].upper()+':\n')
        newlines.append('    mango_nlopt_algorithm = nlopt::'+database[j][1].upper()+';\n')
        newlines.append('    break;\n')
lines = newlines + lines[end:]
 
# Write new file
try:
    f = open(filename,'w')
except:
    print("Error! Unable to open "+filename+" for writing")
    raise
f.writelines(lines)
f.close()
 
##################################################################
# Editing optimize_least_squares_mango.cpp
##################################################################
 
# Read in the file to preprocess
filename = 'api/optimize_least_squares_mango.cpp'
try:
    f = open(filename)
except:
    print("Error! Unable to open "+filename+" for reading")
    raise
 
lines = f.readlines()
f.close()
 
# Replace <includes> .. </includes>
start, end = find_markup(lines,'includes','//')
newlines = lines[:start+1] + comment_line
for j in range(len(database)):
    if database[j][0] == 'mango' and database[j][2] == 'true': # If least-squares
        newlines.append('#include "'+database[j][1].capitalize()+'.hpp"\n')
lines = newlines + lines[end:]
 
# Replace <algorithms> .. </algorithms>
start, end = find_markup(lines,'algorithms','//')
newlines = lines[:start+1] + comment_line
for j in range(len(database)):
    if database[j][0] == 'mango' and database[j][2] == 'true': # If least-squares
        newlines.append('  case '+names[j].upper()+':\n')
        newlines.append('    algorithm = new '+database[j][1].capitalize()+'(solver);\n')
        newlines.append('    break;\n')
lines = newlines + lines[end:]
 
# Write new file
try:
    f = open(filename,'w')
except:
    print("Error! Unable to open "+filename+" for writing")
    raise
f.writelines(lines)
f.close()
 
##################################################################
# Editing optimize_mango.cpp
##################################################################
 
# Read in the file to preprocess
filename = 'api/optimize_mango.cpp'
try:
    f = open(filename)
except:
    print("Error! Unable to open "+filename+" for reading")
    raise
 
lines = f.readlines()
f.close()
 
# Replace <includes> .. </includes>
start, end = find_markup(lines,'includes','//')
newlines = lines[:start+1] + comment_line
for j in range(len(database)):
    if database[j][0] == 'mango' and database[j][2] == 'false': # If not least-squares
        algorithmName = database[j][1].capitalize()
        newlines.append('#include "'+algorithmName+'.hpp"\n')
lines = newlines + lines[end:]
 
# Replace <algorithms> .. </algorithms>
start, end = find_markup(lines,'algorithms','//')
newlines = lines[:start+1] + comment_line
for j in range(len(database)):
    if database[j][0] == 'mango' and database[j][2] == 'false': # If not least-squares
        newlines.append('  case '+names[j].upper()+':\n')
        algorithmName = database[j][1].capitalize()
        newlines.append('    algorithm = new '+algorithmName+'(solver);\n')
        newlines.append('    break;\n')
lines = newlines + lines[end:]
 
# Write new file
try:
    f = open(filename,'w')
except:
    print("Error! Unable to open "+filename+" for writing")
    raise
f.writelines(lines)
f.close()
 
 
##################################################################
# Editing ../examples/tests/nondeterministic_algorithms.py
##################################################################
 
# Read in the file to preprocess
filename = '../examples/tests/nondeterministic_algorithms.py'
try:
    f = open(filename)
except:
    print("Error! Unable to open "+filename+" for reading")
    raise
 
lines = f.readlines()
f.close()
 
# Replace <nondeterministic_algorithms> .. </nondeterministic_algorithms>
comment_line = ['## This section was automatically generated by '+__file__+'\n']
start, end = find_markup(lines,'nondeterministic_algorithms','#')
newlines = lines[:start+1] + comment_line
newline = 'nondeterministic_algorithms = ['
for j in range(len(database)):
    if database[j][index_deterministic] == 'false':
        newline += '"'+names[j]+'",'
newline = newline[:-1] + ']\n'
lines = newlines + [newline] + lines[end:]
 
# Write new file
try:
    f = open(filename,'w')
except:
    print("Error! Unable to open "+filename+" for writing")
    raise
f.writelines(lines)
f.close()
 
##################################################################
# Editing algorithms.md in the documentation
##################################################################
 
# Read in the file to preprocess
filename = '../docs/algorithms.md'
try:
    f = open(filename)
except:
    print("Error! Unable to open "+filename+" for reading")
    raise
 
lines = f.readlines()
f.close()
 
# Replace <algorithms> .. </algorithms>
comment_line = ['--><!-- This section was automatically generated by '+__file__+' -->\n']
start, end = find_markup(lines,'algorithms','<!--')
newlines = lines[:start+1] + comment_line
for j_name in range(len(names)):
    name = names[j_name]
    str1 = '    `'+name+'`'
    if j_name < len(names)-1:
        str1 += ',<br>'
    newlines.append(str1+'\n')
lines = newlines + lines[end:]
 
# Write new file
try:
    f = open(filename,'w')
except:
    print("Error! Unable to open "+filename+" for writing")
    raise
f.writelines(lines)
f.close()