Merging changes for new version

Author: sertalpbilal

README.md

@@ -77,9 +77,9 @@ Model: [
      y  +  3.0 * x  <=  5.5
   ]
 ]
-NOTE: Converting model demo to data frame
+NOTE: Converting model demo to DataFrame
 NOTE: Added action set 'optimization'.
-NOTE: Uploading the problem data frame to the server.
+NOTE: Uploading the problem DataFrame to the server.
 NOTE: Cloud Analytic Services made the uploaded file available as table TMPLZLOW3J0 in caslib CASUSERHDFS(casuser).
 NOTE: The table TMPLZLOW3J0 has been created in caslib CASUSERHDFS(casuser) from binary data uploaded to Cloud Analytic Services.
 NOTE: The problem demo has 2 variables (0 binary, 1 integer, 0 free, 0 fixed).
@@ -101,10 +101,6 @@ NOTE: The Branch and Cut algorithm is using up to 32 threads.
 NOTE: Optimal.
 NOTE: Objective = 4.
 NOTE: Data length = 18 rows
-NOTE: Conversion to MPS =   0.0010 secs
-NOTE: Upload to CAS time =  0.1344 secs
-NOTE: Solution parse time = 0.2669 secs
-NOTE: Server solve time =   1.0903 secs
 NOTE: Cloud Analytic Services dropped table TMPLZLOW3J0 from caslib CASUSERHDFS(casuser).
 Problem Summary
 

doc/conf.py

@@ -59,17 +59,17 @@
 
 # General information about the project.
 project = 'sasoptpy'
-copyright = '2017, SAS'
-author = 'SAS (Sertalp B. Cay)'
+copyright = '2017-2018, SAS Institute'
+author = 'SAS Institute (Sertalp B. Cay)'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.0'
+version = '0.1.1.dev0'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = '0.1.1.dev0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/index.rst

@@ -3,7 +3,7 @@
 sasoptpy: SAS Viya Optimization Interface for Python
 ****************************************************
 
-`PDF Version <../latex/sasoptpy.pdf>`_
+`PDF Version <sasoptpy.pdf>`_
 
 .. module:: sasoptpy
 

doc/makedocs.sh

@@ -6,3 +6,4 @@ make latex
 sed -i -- 's/CASUSERHDFS([A-Za-z0-9]*)/CASUSERHDFS(casuser)/g' _build/latex/sasoptpy.tex 
 cd _build/latex
 make
+cp sasoptpy.pdf ../html

doc/models.rst

@@ -122,7 +122,7 @@ Linear Optimization) is determined based on variable types.
 
 >>> m.solve()
 NOTE: Initialized model model_1
-NOTE: Converting model model_1 to data frame
+NOTE: Converting model model_1 to DataFrame
 NOTE: Added action set 'optimization'.
 ...
 NOTE: Optimal.

doc/sasoptpy.rst

@@ -23,8 +23,8 @@ Classes
    ConstraintGroup
 
 
-Methods
-=======
+Functions
+=========
 
 .. autosummary::
    :toctree: generated/
@@ -39,6 +39,7 @@ Methods
    get_solution_table
    list_length
    print_model_mps
+   quick_sum
    read_frame
    register_name
    reset_globals

doc/whatsnew.rst

@@ -1,11 +1,48 @@
 
+.. currentmodule:: sasoptpy
+
+.. _whatsnew:
+
+
 What's New
 **********
 
 This page outlines changes from each release.
 
+v0.1.1 (TBD)
+============
+
+New Features
+++++++++++++
+
+- Initial value argument 'init' is added for :class:`Variable` objects
+- :func:`Variable.set_init` method is added for variables
+- Initial value option 'primalin' is added to :func:`Model.solve` method
+- Table name argument 'name', table drop option 'drop' and replace
+  option 'replace' are added to :func:`Model.solve` method
+- Decomposition block implementation is rewritten, block numbers does
+  not need to be consecutive and ordered :func:`Model.upload_user_blocks`
+- :func:`VariableGroup.get_name` and :func:`ConstraintGroup.get_name` methods
+  are added
+- :func:`Model.test_session` method is added for checking if session is defined
+  for models
+- :func:`quick_sum` function is added for faster summation of
+  :class:`Expression` objects
+
+Changes
++++++++
+
+- methods.py is renamed to utils.py
+
+Bug Fixes
++++++++++
+
+- Fixed: Crash in VG and CG when a key not in the list is called
+- Fixed: get_value  of pandas is depreceated
+- Fixed: Variables can be set as temporary expressions
+- Fixed: Ordering in :func:`get_solution_table` is incorrect for multiple entries  
+
 v0.1.0 (December 22, 2017)
 ==========================
 
 - Initial release
-

examples/economic_planning.py

@@ -1,4 +1,3 @@
-from swat import CAS
 import sasoptpy as so
 import pandas as pd
 
@@ -38,22 +37,24 @@ def test(cas_conn):
     INDUSTRIES = industry_data.index.tolist()
     [init_stocks, init_productive_capacity, demand] = so.read_frame(
         industry_data)
-    INPUTS = production_data.index.tolist()
+    # INPUTS = production_data.index.tolist()
     production_coeff = so.flatten_frame(production_data)
     productive_capacity_coeff = so.flatten_frame(productive_capacity_data)
 
     static_production = m.add_variables(INDUSTRIES, lb=0,
                                         name='static_production')
     m.set_objective(0, sense=so.MIN, name='Zero')
     m.add_constraints((static_production[i] == demand[i] +
-                       sum(production_coeff[i, j] * static_production[j]
+                       so.quick_sum(
+                           production_coeff[i, j] * static_production[j]
                            for j in INDUSTRIES) for i in INDUSTRIES),
                       name='static_con')
 
     m.solve()
     print(so.get_solution_table(static_production))
 
-    final_demand = so.get_solution_table(static_production)['static_production']
+    final_demand = so.get_solution_table(
+        static_production)['static_production']
     # Alternative way
     # final_demand = {}
     # for i in INDUSTRIES:
@@ -69,35 +70,35 @@ def test(cas_conn):
     for i in INDUSTRIES:
         for year in range(1, num_years+2):
             productive_capacity[i, year] = init_productive_capacity[i] +\
-                sum(extra_capacity[i, y] for y in range(2, year+1))
+                so.quick_sum(extra_capacity[i, y] for y in range(2, year+1))
     for i in INDUSTRIES:
         production[i, 0].set_bounds(ub=0)
         stock[i, 0].set_bounds(lb=init_stocks[i], ub=init_stocks[i])
 
     total_productive_capacity = sum(productive_capacity[i, num_years]
                                     for i in INDUSTRIES)
-    total_production = sum(production[i, year] for i in INDUSTRIES
-                           for year in [4, 5])
-    total_manpower = sum(production_coeff['manpower', i] *
-                         production[i, year+1] +
-                         productive_capacity_coeff['manpower', i] *
-                         extra_capacity[i, year+2]
-                         for i in INDUSTRIES for year in YEARS)
+    total_production = so.quick_sum(production[i, year] for i in INDUSTRIES
+                                    for year in [4, 5])
+    total_manpower = so.quick_sum(production_coeff['manpower', i] *
+                                  production[i, year+1] +
+                                  productive_capacity_coeff['manpower', i] *
+                                  extra_capacity[i, year+2]
+                                  for i in INDUSTRIES for year in YEARS)
 
     continuity_con = m.add_constraints((
         stock[i, year] + production[i, year] ==
         (demand[i] if year in YEARS else 0) +
-        sum(production_coeff[i, j] * production[j, year+1] +
-            productive_capacity_coeff[i, j] * extra_capacity[j, year+2]
-            for j in INDUSTRIES) +
+        so.quick_sum(production_coeff[i, j] * production[j, year+1] +
+                     productive_capacity_coeff[i, j] *
+                     extra_capacity[j, year+2] for j in INDUSTRIES) +
         stock[i, year+1]
         for i in INDUSTRIES for year in YEARS0), name='continuity_con')
 
     manpower_con = m.add_constraints((
-        sum(production_coeff['manpower', j] * production[j, year] +
-            productive_capacity_coeff['manpower', j] *
-            extra_capacity[j, year+1]
-            for j in INDUSTRIES)
+        so.quick_sum(production_coeff['manpower', j] * production[j, year] +
+                     productive_capacity_coeff['manpower', j] *
+                     extra_capacity[j, year+1]
+                     for j in INDUSTRIES)
         <= manpower_capacity for year in range(1, num_years+2)),
         name='manpower_con')
 
@@ -137,7 +138,7 @@ def test(cas_conn):
             continuity_con[i, year].set_rhs(0)
     problem2.solve()
     print(so.get_solution_table(production, stock, extra_capacity,
-                                      productive_capacity))
+                                productive_capacity))
     print(so.get_solution_table(manpower_con.get_expressions()))
 
     # Problem 3
@@ -151,7 +152,7 @@ def test(cas_conn):
             continuity_con[i, year].set_rhs(demand[i])
     problem3.solve()
     print(so.get_solution_table(production, stock, extra_capacity,
-                                      productive_capacity))
+                                productive_capacity))
     print(so.get_solution_table(manpower_con.get_expressions()))
 
-    return problem3.get_objective_value()
+    return problem3.get_objective_value()

examples/factory_planning_1.py

@@ -73,14 +73,14 @@ def test(cas_conn):
         store[p, 6].set_bounds(lb=final_storage, ub=final_storage+1)
 
     storageCost = storage_cost_per_unit * store.sum('*', '*')
-    revenue = sum(product_data.at[p, 'profit'] * sell[p, t]
-                  for p in PRODUCTS for t in PERIODS)
+    revenue = so.quick_sum(product_data.at[p, 'profit'] * sell[p, t]
+                           for p in PRODUCTS for t in PERIODS)
     m.set_objective(revenue-storageCost, sense=so.MAX, name='total_profit')
 
     production_time = machine_type_product_data
     m.add_constraints((
-        sum(production_time.at[mc, p] * make[p, t] for p in PRODUCTS) <=
-        num_hours_per_period * num_machine_per_period.at[mc, t]
+        so.quick_sum(production_time.at[mc, p] * make[p, t] for p in PRODUCTS)
+        <= num_hours_per_period * num_machine_per_period.at[mc, t]
         for mc in MACHINE_TYPES for t in PERIODS), name='machine_hours')
     m.add_constraints(((store[p, t-1] if t-1 in PERIODS else 0) + make[p, t] ==
                       sell[p, t] + store[p, t] for p in PRODUCTS

examples/factory_planning_2.py

@@ -1,4 +1,3 @@
-from swat import CAS
 import sasoptpy as so
 import pandas as pd
 
@@ -72,21 +71,21 @@ def test(cas_conn):
         store[p, 6].set_bounds(lb=final_storage, ub=final_storage+1)
 
     storageCost = storage_cost_per_unit * store.sum('*', '*')
-    revenue = sum(product_data.at[p, 'profit'] * sell[p, t]
-                  for p in PRODUCTS for t in PERIODS)
+    revenue = so.quick_sum(product_data.at[p, 'profit'] * sell[p, t]
+                           for p in PRODUCTS for t in PERIODS)
     m.set_objective(revenue-storageCost, sense=so.MAX, name='total_profit')
 
     num_machines_needing_maintenance = \
         machine_types_data['num_machines_needing_maintenance']
     numMachinesDown = m.add_variables(MACHINE_TYPES, PERIODS, vartype=so.INT,
                                       lb=0, name='numMachinesDown')
-    m.add_constraints((sum(numMachinesDown[mc, t] for t in PERIODS) ==
-                      num_machines_needing_maintenance.at[mc]
-                      for mc in MACHINE_TYPES), name='maintenance')
+    m.add_constraints((so.quick_sum(numMachinesDown[mc, t] for t in PERIODS) ==
+                       num_machines_needing_maintenance.at[mc]
+                       for mc in MACHINE_TYPES), name='maintenance')
     production_time = machine_type_product_data
     m.add_constraints((
-        sum(production_time.at[mc, p] * make[p, t] for p in PRODUCTS) <=
-        num_hours_per_period *
+        so.quick_sum(production_time.at[mc, p] * make[p, t] for p in PRODUCTS)
+        <= num_hours_per_period *
         (num_machine_per_period.at[mc, t] - numMachinesDown[mc, t])
         for mc in MACHINE_TYPES for t in PERIODS), name='machine_hours')
     m.add_constraints(((store[p, t-1] if t-1 in PERIODS else 0) + make[p, t] ==