Code for version v0.0.1

CMakeLists.txt

@@ -24,7 +24,7 @@ endif()
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
-project(pgORpy VERSION 0.0.0
+project(pgORpy VERSION 0.0.1
 )
 set(PROJECT_VERSION_DEV "")
 string(TOLOWER "${PROJECT_NAME}" PROJECT_NAME_LOWER)

NEWS.md

@@ -4,6 +4,33 @@
 
 .. current
 
+### pgORpy 0.0.1 Release Notes
+
+To see all issues & pull requests closed by this release see the
+[Git closed milestone for 0.0.1
+](https://github.com/pgRouting/pgorpy/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%200.0.1%22)
+on Github.
+
+**Version functions**
+
+* por_bin_backing
+
+  * New function
+  * Support for or-tools v9.10.4067
+
+
+* por_knapsack
+
+  * New function
+  * Support for or-tools v9.10.4067
+
+
+* por_multiple_knapsack
+
+  * New function
+  * Support for or-tools v9.10.4067
+
+
 ### pgORpy 0.0.0 Release Notes
 
 To see all issues & pull requests closed by this release see the

configuration.conf

@@ -12,3 +12,4 @@ pg_controls         |  Y | N
 # Dependencies must be considered when adding a line
 #----------------------
 version             |  Y | Y
+or_tools            |  Y | Y

doc/_static/page_history.js

@@ -14,9 +14,10 @@ var titles = [
 
 var newpages = [
     {v: '0.0', pages: [
-        'index', 'installation', 'introduction', 'release_notes',
+        'concepts', 'functions', 'index', 'installation', 'introduction', 'release_notes',
         'sampledata', 'support',
-        'por_full_version', 'por_version'
+        'por_full_version', 'por_version',
+        'por_bin_packing', 'por_knapsack', 'por_miltiple_knapsack'
     ] },
 ];
 

doc/general/CMakeLists.txt

@@ -1,5 +1,6 @@
 
 SET(LOCAL_FILES
+  concepts.rst
   functions.rst
   index.rst
   introduction.rst

doc/general/concepts.rst

@@ -0,0 +1,114 @@
+..
+   ****************************************************************************
+    pgORpy Manual
+    Copyright(c) pgORpy Contributors
+
+    This documentation is licensed under a Creative Commons Attribution-Share
+    Alike 3.0 License: https://creativecommons.org/licenses/by-sa/3.0/
+   ****************************************************************************
+
+|
+
+Concepts
+===============================================================================
+
+.. contents::
+
+Synopsis
+-------------------------------------------------------------------------------
+
+OR-Tools is an open source software suite for optimization, tuned for tackling
+the world's toughest problems in vehicle routing, flows, integer and linear
+programming, and constraint programming.
+
+OR-Tools can solve
+
+- VR (Vehicle Routing)
+- Scheduling
+- Bin Packing
+
+Currently only Bin Packing problems can be solved with OR-Tools in pgORpy.
+
+Terminologies
+...............................................................................
+
+- **weight**: For each item, a positive integer weight is associated with it.
+- **cost**: For each item, a positive integer cost(value) is associated with it.
+- **capacity**: Maximum storage capacity of a knapsack or a bin.
+
+Inner Queries
+-------------------------------------------------------------------------------
+
+Weight Costs SQL
+...............................................................................
+
+A ``SELECT`` statement that returns the following columns:
+
+.. weight_costs_start
+
+.. list-table::
+   :width: 81
+   :widths: 14 14 44
+   :header-rows: 1
+
+   * - Column
+     - Type
+     - Description
+   * - ``id``
+     - **ANY-INTEGER**
+     - Unique identifier of the item.
+   * - ``weight``
+     - **ANY-INTEGER**
+     - Weight of the item.
+   * - ``cost``
+     - **ANY-INTEGER**
+     - Cost of the item.
+
+Where:
+
+:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
+
+.. weight_costs_end
+
+Weights SQL
+...............................................................................
+
+.. weights_start
+
+A ``SELECT`` statement that returns the following columns:
+
+.. list-table::
+   :width: 81
+   :widths: 14 14 44
+   :header-rows: 1
+
+   * - Column
+     - Type
+     - Description
+   * - ``id``
+     - **ANY-INTEGER**
+     - Identifier of the item.
+   * - ``weight``
+     - **ANY-INTEGER**
+     - Weight of the item.
+
+Where:
+
+:ANY-INTEGER: ``SMALLINT``, ``INTEGER``, ``BIGINT``
+
+.. weights_end
+
+See Also
+-------------------------------------------------------------------------------
+
+.. see_also_start
+
+* `Wikipedia: Bin Packing problems <https://en.wikipedia.org/wiki/Bin_packing_problem>`__
+* `OR-Tools: Google OR-Tools <https://developers.google.com/optimization>`__
+
+.. see_also_end
+
+.. rubric:: Indices and tables
+
+* :ref:`genindex`
+* :ref:`search`

doc/general/functions.rst

@@ -27,6 +27,20 @@ Utilities
    por_version
    por_full_version
 
+OR-tools
+-------------------------------------------------------------------------------
+
+- :doc:`por_bin_packing`
+- :doc:`por_knapsack`
+- :doc:`por_multiple_knapsack`
+
+.. toctree::
+   :hidden:
+
+   por_bin_packing
+   por_knapsack
+   por_multiple_knapsack
+
 .. functions_end
 
 .. rubric:: Indices and tables

doc/general/index.rst

@@ -40,6 +40,7 @@ General
     introduction
     installation
     support
+    concepts
 
 - :doc:`sampledata` that is used in the examples of this manual.
 
@@ -65,6 +66,7 @@ General
 
 .. include:: release_notes.rst
    :start-after: current
+   :end-before: pgORpy 0.0.0
 
 .. toctree::
    :hidden:

doc/general/introduction.rst

@@ -65,6 +65,12 @@ Individuals (in alphabetical order)
 
   - Github actions for documentation publishing and release
 
+- Manas Sivakumar
+
+  - por_bin_backing
+  - por_knapsack
+  - por_multiple_knapsack
+
 - Virginia Vergara
 
   - Initial version functions
@@ -92,6 +98,15 @@ Individuals past & present (in alphabetical order)
 
   - Github actions for documentation publishing and release
 
+- `Manas Sivakumar <manas23601@gmail.com>`__
+
+  Support for or-tools v9.10.4067 on the following functions
+
+  - por_bin_backing
+  - por_knapsack
+  - por_multiple_knapsack
+
+
 - `Vicky Vergara <vicky@erosion.dev>`__
 
   - Initial version functions

doc/general/release_notes.rst

@@ -35,6 +35,34 @@ pgORpy 0.0
 
 .. current
 
+pgORpy 0.0.1 Release Notes
+-------------------------------------------------------------------------------
+
+To see all issues & pull requests closed by this release see the
+`Git closed milestone for 0.0.1
+<https://github.com/pgRouting/pgorpy/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%200.0.1%22>`_
+on Github.
+
+.. rubric:: Version functions
+
+* por_bin_backing
+
+  .. include:: por_bin_packing.rst
+     :start-after: Version 0.0.1
+     :end-before: Description
+
+* por_knapsack
+
+  .. include:: por_knapsack.rst
+     :start-after: Version 0.0.1
+     :end-before: Description
+
+* por_multiple_knapsack
+
+  .. include:: por_multiple_knapsack.rst
+     :start-after: Version 0.0.1
+     :end-before: Description
+
 pgORpy 0.0.0 Release Notes
 -------------------------------------------------------------------------------
 

doc/general/sampledata.rst

@@ -21,3 +21,8 @@ Function to activate python on a local environment
 .. literalinclude:: ../../tools/testers/sampledata.sql
    :start-after: -- activate_python_start
    :end-before: -- activate_python_end
+
+Sample data
+
+.. literalinclude:: ../../tools/testers/sampledata.sql
+   :start-after: -- activate_python_end

doc/or_tools/CMakeLists.txt

@@ -0,0 +1,13 @@
+SET(LOCAL_FILES
+    por_knapsack.rst
+    por_multiple_knapsack.rst
+    por_bin_packing.rst
+    )
+
+foreach (f ${LOCAL_FILES})
+    configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
+    list(APPEND LOCAL_DOC_FILES  ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
+endforeach()
+
+set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
+set(PROJECT_IMG_FILES ${PROJECT_IMG_FILES} PARENT_SCOPE)