Merge pull request #247 from Manas23601/manas-week-8

GSoC22 : Manas Sivakumar Week 8

Author: Manas23601

.github/workflows/ubuntu.yml

@@ -57,13 +57,9 @@ jobs:
             postgresql-${{ matrix.psql }}-postgis-${{ matrix.postgis }} \
             postgresql-${{ matrix.psql }}-postgis-${{ matrix.postgis }}-scripts \
             postgresql-${{ matrix.psql }}-pgrouting \
-            postgresql-server-dev-${{ matrix.psql }}
-            wget https://github.com/google/or-tools/releases/download/v9.3/or-tools_amd64_ubuntu-20.04_v9.3.10502.tar.gz
-            ls or-tools_amd64_ubuntu-20.04_v9.3.10502.tar.gz
-            mkdir ortools
-            tar xf or-tools_amd64_ubuntu-20.04_v9.3.10502.tar.gz -C ./ortools
-
-
+            postgresql-server-dev-${{ matrix.psql }} \
+            postgresql-plpython3-${{ matrix.psql }}
+            
       - name: Install VROOM dependencies
         run: |
           sudo apt-get install libssl-dev libasio-dev libglpk-dev

sql/or_tools/CMakeLists.txt

@@ -1,5 +1,7 @@
 SET(LOCAL_FILES
-   example.sql
+   knapsack.sql
+   multiple_knapsack.sql
+   bin_packing.sql
   )
 
 foreach (f ${LOCAL_FILES})

sql/or_tools/bin_packing.sql

@@ -1,3 +1,29 @@
+/*PGR-GNU*****************************************************************
+File: bin_packing.sql
+
+Copyright (c) 2022 GSoC-2022 pgRouting developers
+Mail: [email protected]
+
+Function's developer:
+Copyright (c) 2021 Manas Sivakumar
+
+------
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ ********************************************************************PGR-GNU*/
 DROP FUNCTION IF EXISTS vrp_bin_packing CASCADE;
 DROP TABLE IF EXISTS bin_packing_data CASCADE;
 
@@ -9,21 +35,73 @@ VALUES
 (48), (30), (19), (36), (36), (27), (42), (42), (36), (24), (30);
 
 
-CREATE FUNCTION vrp_bin_packing(inner_query text, bin_capacity integer)
-  RETURNS integer
+CREATE OR REPLACE FUNCTION vrp_bin_packing(
+  inner_query TEXT, -- weights SQL
+  bin_capacity INTEGER, -- Bin Capacity
+  max_rows INTEGER = 100000 -- Maximum number of rows to be fetched. Default is value = 100000.
+)
+RETURNS TEXT
 AS $$
-  from ortools.linear_solver import pywraplp
-  inner_query_result = plpy.execute(inner_query, 11)
+  try:
+    from ortools.linear_solver import pywraplp
+  except Exception as err:
+    plpy.error(err)
+    return "Failed"
+  
+  plpy.notice('Entering Bin Packing program')
+  plpy.notice('Starting Execution of inner query')
+
+  try:
+    inner_query_result = plpy.execute(inner_query, max_rows)
+    num_of_rows = inner_query_result.nrows()
+    colnames = inner_query_result.colnames()
+    coltypes = inner_query_result.coltypes()
+    plpy.info("Number of rows processed : ", num_of_rows)
+  except plpy.SPIError as error_msg:
+    plpy.info("Details: ",error_msg)
+    plpy.error("Error Processing Inner Query. The given query is not a valid SQL command")
+    return "Failed"
+
+  if len(colnames) != 1:
+    plpy.error("Expected 1 column, Got ", len(colnames))
+    return "Failed"
+  if ('weight' in colnames):
+    plpy.notice("SQL query returned expected column names")
+  else:
+    plpy.error("Expected column weight, Got ", colnames)
+    return "Failed"  
+  if coltypes == [23]:
+    plpy.notice("SQL query returned expected column types")
+  else:
+    plpy.error("Returned columns of different type. Expected Integer")
+  
+  plpy.notice('Finished Execution of inner query')
   data = {}
   weights = []
-  for i in range(11):
-    weights.append(inner_query_result[i]["weight"])
+
+  for i in range(num_of_rows):
+    if type(inner_query_result[i]["weight"]) == int:
+      weights.append(inner_query_result[i]["weight"])
+    else:
+      plpy.error("Type Mismatch. Check Table Data")
+      return "Failed"
+
   data['weights'] = weights
   data['items'] = list(range(len(weights)))
   data['bins'] = data['items']
   data['bin_capacity'] = bin_capacity
-    
-  solver = pywraplp.Solver.CreateSolver('SCIP')  
+  
+  try:
+    solver = pywraplp.Solver.CreateSolver('SCIP')  
+  except:
+    plpy.error("Unable to Initialize solver")
+  
+  if solver is None:
+    plpy.error('SCIP solver unavailable.')
+    return "Failed"
+  
+  plpy.notice('SCIP solver ready!')
+
   x = {}
   for i in data['items']:
     for j in data['bins']:
@@ -37,7 +115,8 @@ AS $$
     solver.Add(sum(x[i, j] for j in data['bins']) == 1)
 
   for j in data['bins']:
-    solver.Add(sum(x[(i, j)] * data['weights'][i] for i in data['items']) <= y[j] * data['bin_capacity'])
+    solver.Add(sum(x[(i, j)] * data['weights'][i] 
+    for i in data['items']) <= y[j] * data['bin_capacity'])
 
   solver.Minimize(solver.Sum([y[j] for j in data['bins']]))
 
@@ -48,20 +127,34 @@ AS $$
     for j in data['bins']:
       if y[j].solution_value() == 1:
         bin_items = []
+        bin_weights = []
+        bin_values = []
         bin_weight = 0
+        bin_value = 0
         for i in data['items']:
           if x[i, j].solution_value() > 0:
             bin_items.append(i)
+            bin_weights.append(data['weights'][i])
             bin_weight += data['weights'][i]
         if bin_weight > 0:
           num_bins += 1
-          plpy.warning('Bin number', j)
-          plpy.warning('  Items packed', bin_items)
-          plpy.warning('  Total weight', bin_weight)
-    plpy.warning('Number of bins used', num_bins)
+          plpy.info('Bin number', j)
+          plpy.info('  Items packed', bin_items)
+          plpy.info('  Item weights', bin_weights)
+          plpy.info('  Total weight', bin_weight)
+    plpy.info('Number of bins used', num_bins)
   else:
-    plpy.error('The problem does not have an optimal solution')
-  return 1
-$$ LANGUAGE plpython3u;
+    plpy.notice('The problem does not have an optimal solution')
+  plpy.notice('Exiting Bin Packing program')
+  return "Success"
+$$ LANGUAGE plpython3u VOLATILE STRICT;
+
+-- SELECT * FROM vrp_bin_packing('SELECT * FROM bin_packing_data', 100);
+
+-- COMMENTS
 
-SELECT * from vrp_bin_packing('SELECT * from bin_packing_data', 100);
+COMMENT ON FUNCTION vrp_bin_packing(TEXT, INTEGER, INTEGER)
+IS 'vrp_bin_packing
+- Documentation:
+  - ${PROJECT_DOC_LINK}/vrp_bin_packing.html
+';

sql/or_tools/knapsack.sql

@@ -1,6 +1,32 @@
+
+/*PGR-GNU*****************************************************************
+File: knapsack.sql
+
+Copyright (c) 2022 GSoC-2022 pgRouting developers
+Mail: [email protected]
+
+Function's developer:
+Copyright (c) 2021 Manas Sivakumar
+
+------
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ ********************************************************************PGR-GNU*/
 DROP FUNCTION IF EXISTS vrp_knapsack;
-drop type if exists knapsack_items;
-drop table if exists knapsack_data;
+DROP TABLE IF EXISTS knapsack_data;
 
 CREATE TABLE knapsack_data(
   weight INTEGER,
@@ -14,48 +40,101 @@ VALUES
 (4, 10),
 (1, 2);
 
-create type knapsack_items as(
-  index integer,
-  weight integer,
-  cost integer
-);
-
-CREATE FUNCTION vrp_knapsack(inner_query text, capacity integer)
-  RETURNS SETOF knapsack_items
+CREATE OR REPLACE FUNCTION vrp_knapsack(
+  inner_query TEXT, -- weights_cost SQL
+  capacity INTEGER, -- Knapsack Capacity
+  max_rows INTEGER = 100000 -- Maximum number of rows to be fetched. Default is 100000.
+)
+RETURNS TEXT
 AS $$
-  from ortools.algorithms import pywrapknapsack_solver
+  try:
+    from ortools.algorithms import pywrapknapsack_solver
+  except Exception as err:
+    plpy.error(err)
+    return "Failed"
 
-  solver = pywrapknapsack_solver.KnapsackSolver(
-  pywrapknapsack_solver.KnapsackSolver.
-  KNAPSACK_MULTIDIMENSION_BRANCH_AND_BOUND_SOLVER, 'KnapsackExample')
+  try:
+    solver = pywrapknapsack_solver.KnapsackSolver(
+    pywrapknapsack_solver.KnapsackSolver.
+    KNAPSACK_MULTIDIMENSION_BRANCH_AND_BOUND_SOLVER, 'KnapsackExample')
+  except:
+    plpy.error('Unable to Initialize Knapsack Solver')
+    return "Failed"
+
 
   capacities = []
   capacities.append(capacity)
-  inner_query_result = plpy.execute(inner_query, 5)
+
+  plpy.notice('Entering Knapsack program')
+  plpy.notice('Starting Execution of inner query')
+
+  try:
+    inner_query_result = plpy.execute(inner_query, max_rows)
+    num_of_rows = inner_query_result.nrows()
+    colnames = inner_query_result.colnames()
+    coltypes = inner_query_result.coltypes()
+    plpy.info("Number of rows processed : ", num_of_rows)
+  except plpy.SPIError as error_msg:
+    plpy.info("Details: ",error_msg)
+    plpy.error("Error Processing Inner Query. The given query is not a valid SQL command")
+    return "Failed"
+  
+  if len(colnames) != 2:
+    plpy.error("Expected 2 columns, Got ", len(colnames))
+    return "Failed"
+  if ('weight' in colnames) and ('cost' in colnames):
+    plpy.notice("SQL query returned expected column names")
+  else:
+    plpy.error("Expected columns weight and cost, Got ", colnames)
+    return "Failed"  
+  if coltypes == [23, 23]:
+    plpy.notice("SQL query returned expected column types")
+  else:
+    plpy.error("Returned columns of different type. Expected Integer, Integer")
+
+  plpy.notice('Finished Execution of inner query')
+
   values = []
   weight1 = []
   weights =[]
-  for i in range(5):
+  for i in range(num_of_rows):
     values.append(inner_query_result[i]["cost"])
     weight1.append(inner_query_result[i]["weight"])
   weights.append(weight1)
-
-  solver.Init(values, weights, capacities)
+  
+  try:
+    solver.Init(values, weights, capacities)
+  except Exception as error_msg:
+    plpy.error(error_msg)
+    return "Failed"
   computed_value = solver.Solve()
 
   packed_items = []
   packed_weights = []
   packed_values = []
   total_weight = 0
-  plpy.warning('Total value =', computed_value)
+
+  plpy.info('Total value =', computed_value)
   for i in range(len(values)):
     if solver.BestSolutionContains(i):
       packed_items.append(i)
       packed_weights.append(weights[0][i])
       packed_values.append(values[i])
       total_weight += weights[0][i]
-      yield (i, weights[0][i], values[i])
-  plpy.warning('Total weight:', total_weight)
-$$ LANGUAGE plpython3u;
+  plpy.info('Total weight:', total_weight)
+  plpy.info("Packed items: ", packed_items)
+  plpy.info("Packed weights: ", packed_weights)
+  plpy.info("Packed values: ", packed_values)
+  plpy.notice("Exiting program")
+  return "Success"
+$$ LANGUAGE plpython3u VOLATILE STRICT;
+
+-- SELECT * FROM vrp_knapsack('SELECT * FROM knapsack_data' , 15);
+
+-- COMMENTS
 
-SELECT * from vrp_knapsack('SELECT * from knapsack_data' , 15);
+COMMENT ON FUNCTION vrp_knapsack(TEXT, INTEGER, INTEGER)
+IS 'vrp_knapsack
+- Documentation:
+  - ${PROJECT_DOC_LINK}/vrp_knapsack.html
+';