diff --git a/docs/2.29.245/LICENSE.txt b/docs/2.29.245/LICENSE.txt new file mode 100644 index 0000000..f1ceb9c --- /dev/null +++ b/docs/2.29.245/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [2015] [IBM Corporation] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/2.29.245/README.md b/docs/2.29.245/README.md new file mode 100644 index 0000000..db6f249 --- /dev/null +++ b/docs/2.29.245/README.md @@ -0,0 +1,54 @@ +# IBM® Decision Optimization Modeling for Python (DOcplex) + +Welcome to the IBM® Decision Optimization Modeling for Python. +Licensed under the Apache License v2.0. + +With this library, you can quickly and easily add the power of optimization to +your application. ou need IBM ILOG CPLEX Optimization Studio to solve the models. + +This library is composed of 2 modules: + +* IBM® Decision Optimization CPLEX Optimizer Modeling for Python - with namespace docplex.mp +* IBM® Decision Optimization CP Optimizer Modeling for Python - with namespace docplex.cp + +Solving with CPLEX locally requires that IBM® ILOG CPLEX Optimization Studio V12.8 or later +is installed on your machine. + +This library is numpy friendly. + +## Install the library + +``` + pip install docplex +``` + +## Get the documentation and examples + +* [Documentation](http://ibmdecisionoptimization.github.io/docplex-doc/) +* [Examples](https://github.com/IBMDecisionOptimization/docplex-examples) + +## Get your IBM® ILOG CPLEX Optimization Studio edition + +- You can get a free [Community Edition](https://www.ibm.com/account/reg/us-en/signup?formid=urx-20028) + of CPLEX Optimization Studio, with limited solving capabilities in term of problem size. + +- Faculty members, research professionals at accredited institutions can get access to an unlimited version of CPLEX through the + [IBM® Academic Initiative](http://ibm.biz/cplex-free-for-students). + +## Dependencies + +These third-party dependencies are automatically installed with ``pip`` + +- [enum34](https://pypi.python.org/pypi/enum34) +- [futures](https://pypi.python.org/pypi/futures) +- [requests](https://pypi.python.org/pypi/requests) +- [six](https://pypi.python.org/pypi/six) +- [certifi](https://pypi.python.org/pypi/certifi) +- [chardet](https://pypi.python.org/pypi/chardet) +- [idna](https://pypi.python.org/pypi/idna) +- [urllib3](https://pypi.python.org/pypi/urllib3) + + +## License + +This library is delivered under the Apache License Version 2.0, January 2004 (see LICENSE.txt). diff --git a/docs/2.29.245/docs/CHANGELOG.html b/docs/2.29.245/docs/CHANGELOG.html new file mode 100644 index 0000000..76a57e3 --- /dev/null +++ b/docs/2.29.245/docs/CHANGELOG.html @@ -0,0 +1,910 @@ + + + + + + + + + + Changelog — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

Changelog

+
+

Changed in 2.29.245:

+
    +

  • each record of a solve history use a unique timestamp for its fields

    • +
+
+
+

Changed in 2.28.240 (2024.08):

+
    +

  • In docplex.cp: robustify the handling of callback messages coming from CP Optimizer

    • +

  • Allows to use numpy 2.0

    • +
+
+
+

Changed in 2.27.239 (2024.04):

+
    +

  • Allows to use numpy 2.0

    • +
+
+
+

Changed in 2.27.239 (2024.04):

+
    +

  • PEP517, PEP518 build

    • +

  • Faster PWLs from PR#6.

    • +
+
+
+

Changed in 2.26.237 (2023.07):

+
    +

  • Support for transactional output attachments

    • +
+
+
+

Changed in 2.25.236 (2023.01):

+
    +

  • Support of .ops files for parameter handling.

    • +

  • Improvement on the Nurse example.

    • +
+
+
+

Changed in 2.24.232 (2022.11):

+
    +

  • Optional CPLEX import for qiskit

    • +

  • Fix in cut getter

    • +
+
+
+

Changed in 2.24.231 (2022.11):

+
    +

  • Support for CPLEX Optimization Studio 22.1.1 runtimes.

    • +

  • Cleanup of the code related to Watson Machine Learning.

    • +
  • +
    In docplex.mp:
      +

    • Support for sensitivity analysis in Solution.

      • +

    • Fixes in Solution handling.

      • +
    +
    +
    +
    • +

  • In docplex.cp: +* Support for ‘inferred’ statement. +* Support for ‘sub_circuit’ constraint. +* Fixed conditional module importation in sched_jobshop_blackbox.py

    • +
+
+
+

Changed in 2.23.222 (2022.03):

+
    +

  • Support for CPLEX Optimization Studio 22.1 runtimes.

    • +
  • +
    In docplex.mp:
      +

    • Support of parameter sets for multi objective optimization.

      • +

    • Bug fix for multi objective optimization.

      • +

    • Correct documentation urls to current CPLEX offering.

      • +

    • Removal of the deprecated docloud_context.

      • +

    • Performance improvements for model building with 22.1

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Added a new module blackbox to allow the new blackbox function feature

      • +

    • Wrote full documentation on blackbox functions

      • +

    • Added a new SearchType ‘Neighborhood’

      • +

    • Fixed a bug in modeler.same_common_subsequence

      • +

    • Fixed problem of order of computation of actual solving parameters.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.22.213 (2021.09):

+
    +

  • Removed zeppelin examples

    • +
  • +
    In docplex.mp:
      +

    • Added a variant of Model.sum() with variable number of arguments: Model.sums()

      • +

    • Removed all Python2 compatibility code

      • +

    • Added deterministic time in solve details.

      • +

    • Linear relaxer now relaxes SOS variable sets (linear sum relaxation)

      • +

    • Fixed a bug on Model.solve_with_goals() with quadratic sub-objectives

      • +

    • Fixed a bug in SolveSolution.kpi_value_by_name

      • +

    • Fixed a bug in SolveSolution.get_value_dict() about precision filtering

      • +

    • Fixed a bug when updating a constraint rhs with a NaN value now raises exception.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +
    • +
      Add new methods get_objective_value(), get_objective_bound() and get_objective_gap() on CpoModelSolution

      and CpoSolveResult to access directly the first objective, bound or gap.

      +
      +
      +
      • +

    • Support real call to abort_search() instead of killing the solver.

      • +

    • Add a method get_parameters() to CpoSolver to retrieve actual solving parameters.

      • +

    • Fix problem of order of computation of actual solving parameters.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.21.207 (2021.06):

+
    +
  • +
    In docplex.mp:
      +
    • +
      Add support for importing solution from a different model, provided variables

      can be matched between both models (Model.import_solution)

      +
      +
      +
      • +
    • +
      Added contextual function to temporarily modify aspects of the model:

      model_parameters to change parameters in a block, model_objective to set a temporary objective in a block.

      +
      +
      +
      • +

    • Naming expressions is now deprecated, use a temporary variable if needed.

      • +
    • +
      Display of expressions in constraints is customizable: use a space separator (or not),

      set a maximum length for very long expression.

      +
      +
      +
      • +

    • Fixed documentation references to class Var, moved from linear to dvar

      • +

    • Fixed a bug in LP export for multi-objective models with no priorities passed

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Replace context attribute solve_with_start_next by solve_with_search_next, keeping ascending compatibility.

      • +

    • Support solver parameter ModelAnonymizer to generate random names for all model elements (except KPIs) in the CPO file format.

      • +

    • Optimize generation of CPO expressions from Python expressions

      • +

    • Interval variable solutions tuples are now named tuples.

      • +

    • Method CpoModel.add() now accepts multiple expressions (or lists of expressions) to add to the model.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.20.204 (2021.02):

+
    +
  • +
    In docplex.mp:
      +

    • Add support for exporting solutions and solution pools to SOL format.

      • +
    • +
      Add fast methods for changing batches of variable bounds:

      Model.change_var_lower_bounds, Model.change_var_upper_bounds

      +
      +
      +
      • +

    • Reset random seed value for cplex 12.10 , was different from COS release value.

      • +

    • Improved performance of variable creation

      • +

    • Removed a warning about accessing a deprecated “solve_status” in solve.

      • +
    • +
      docplex.mp.AdvModel now has checker enabled by default to avoid Python errors.

      Is is up to the user to disable type-checking to get maximum performance.

      +
      +
      +
      • +

    • Fixed a bug about not printing updated variable bounds in MPS and SAV

      • +

    • Changed the default rounding behavior: solution values are not rounded by default.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Fix problems on step function operations.

      • +

    • Add status in conflict refiner solution object.

      • +

    • Fix a bug to not send and receive conflict in CPO format if no conflict.

      • +

    • Enhance printing of model solution.

      • +

    • The method search_next(), returns only new solutions of the model. +In particular, no new solution is returned if solve status just change from Feasible to Optimal.

      • +

    • Rework completely model statistics (CpoModelStatistics)

      • +

    • Add a parameter add_cpo to the write method of CpoRefineConflictResult

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.19.202 (2020.12):

+
    +
  • +
    In docplex.mp:
      +

    • Exporting models to SAV.gz format is now supported.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Add a new method remove_expressions() to CpoModel that removes a list of expressions in one shot.

      • +

    • Update documentation to describe how to set private solver parameters.

      • +

    • Add functions to export and import context as flat file.

      • +

    • Fix a bug on the string representation of calls to constant() modeling function.

      • +

    • Add JSON filter in case of double identical value for objective.

      • +

    • Add functions to export and import context as flat file.

      • +

    • Fix a bug on the string representation of calls to constant() modeling function.

      • +

    • Add JSON filter in case of double value for objective.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.18.200 (2020.11.#3):

+
    +
  • +
    In docplex.mp:
      +

    • Latest supported CPLEX Optimization Studio is now 20.1

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.17.196 (2020.11.#2):

+
    +
  • +
    In docplex.mp:
      +

    • Fixed a bug with pickling: edition of a constraint in a pickled model raised an error

      • +

    • Fixed a bug with pickling: models with piecewise-linear constraints could not be pickled

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Add environment variable DOCPLEX_CP_CONTEXT to modify configuration

      • +

    • Add new module check_list that print a report on execution environment

      • +

    • Remove DOcloud from documentation (including code)

      • +

    • Rework customization of configuration and better support of default directory

      • +

    • Add new configuration parameter model.sort_names to drive sort of variable declarations in CPO file format.

      • +

    • Fix a problem that may crash Python in case of abort_search with local solve.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.16.196 (2020.11):

+
    +
  • +
    In docplex.mp:
      +

    • add Model.add_quadratic_constraints() to add a batch of quadratic constraints

      • +

    • add Model.populate_solution_pool() for a native support of solurtion pools

      • +

    • support of CPLEX 20.1

      • +

    • compatible with Python 3.8 (only with CPLEX 20.1)

      • +

    • enable changing absolute and relative tolerances for multi-objectives

      • +

    • Optimization of Model.if_then: when condition is of the form b==1 (or 0), no additional boolean +variable is generated

      • +

    • For solving, docplex.mp now uses the cplex module if it has been installed. If not, docplex.mp +checks for the latest installed version of CPLEX Optimization Studio (COS) (using the CPLEX_STUDIO_DIRXXX +environment variables) and use the cplex if a COS is found, unless the configuration of the engine +states otherwise.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Add pngfile= parameter to visu.show() method to store in a PNG file instead of display on screen.

      • +

    • Make parameters and solver infos also available in refine_conflict solution.

      • +

    • Add a IntegerDomain class used to represent domain of integer variables, with a specific __str__ method

      • +

    • Add new functions ceil(), floor(), trunc(), round() and sgn()

      • +

    • Remove all warnings generated by Python 38

      • +

    • Optimize creation of add expressions with CumulExpr and zero

      • +

    • Implement configurable factorization of common model expressions when generating CPO format

      • +

    • Add checking of scal_prod() array sizes at modeling time

      • +

    • Add strict_lexicographic() and checking of strict_lexicographic() and lexicographic() array sizes at modeling time.

      • +

    • Add failure explanation as new method explain_failure() allowing to log failure tags or get details on one or several failures.

      • +

    • Enhance management of local solve sub-process timeout with detailed error and configurable timeout delay

      • +

    • For solving, docplex.cp now uses the cpoptimizer executable if it has been installed. If not, docplex.cp +checks for the latest installed version of CPLEX Optimization Studio (COS) (using the CPLEX_STUDIO_DIRXXX +environment variables) and use the cpoptimizer if a COS is found, unless the configuration of the engine +states otherwise.

      • +

    • Support last optimal solution in search/next sequence

      • +

    • Support of solver parameters in all next() solutions

      • +

    • Add solver version in process info attached to a run result

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.15.194 (2020.07):

+
    +
  • +
    In docplex.mp:
      +

    • add Model.quadratic_dual_slacks()

      • +

    • Fixed a bug in multi-objectives: objectives were incorrectly rounded

      • +

    • Fixed a bug in Model.report(): multiple objective values were not displayed()

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Add conflict in CPO format in refine conflict result

      • +

    • Fix problem when parsing KPIs section of a CPO model

      • +

    • Add method add_constraint() to model for compatibility with docplex.mp

      • +

    • Comment method get_fail_status() of SolveResult as deprecated.

      • +

    • Fix problem of wrong import of deque in collections.abc

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.14.186 (2020.05):

+
    +

  • Updated tracking events in Watson studio notebooks.

    • +
  • +
    In docplex.mp:
      +

    • Model.solve() will not use solve on cloud unless agent is specifically set to ‘docloud`.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.13.184 (2020.03):

+
    +

  • Removed dependency to the docloud package. Now you need to explicitely install the package using pip install docloud to use DOcplexcloud.

    • +
  • +
    In docplex.mp:
      +

    • added Model.export_as_mps_string(), Model.export_as_sav_string()

      • +
    • +
      fixed a bug with dettime_limit: solving with a deterministic time limit

      was mis-interpreted as a solve failure, returning None.

      +
      +
      +
      • +

    • fixed bug on cplexcloud solve: number of nodes processed was always zero.

      • +

    • repeated solves incorrectly restarted from start of search, now start from where the last solve stopped.

      • +

    • added keyword argument ‘time_limit’ to Model.solve() to set a temporary time limit.

      • +

    • added new method SolveSolution.is_valid_solution()

      • +

    • fixed a bug in ModelReader: ranged constraints bounds were inverted when reading from SAV or MPS.

      • +

    • fixed a bug in Model.set_lex_multiobj(): arguments abstols, reltols were ignored.

      • +

    • added proper type-checking for Model.add_indicator_constraints()

      • +

    • added docplex.mp.check_list/py to check local installation.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Enable reading of #line directives when parsing a CPO file

      • +

    • Remove parameter LogSearchTags from public parameters

      • +

    • Fix a minor problem concerning compilation of KPI expressions in CPO format

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.12.182 (2019.12):

+
    +
  • +
    In docplex.mp:
      +

    • Added a LinearRelaxer class to make a linearized copy of a MIP model (if possible). +see class docplex.mp.relax_linear.LinearRelaxer

      • +

    • Conflict refiner default behavior is now identical to CPLEX interactive +(the new behavior is much faster).

      • +

    • Bug fixed: expressions of the form k*x did not notify constraints when modified.

      • +

    • Fixed: message “ignored keyword argument” was incorrectly printed when setting +cts_by_name=True in model constructor.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.11.176 (2019.11):

+
    +

  • Added support for CPLEX 12.10

    • +
  • +
    In docplex.mp:
      +

    • Logical expressions, binary variables, and constraints can now be freely nested with logical operators.

      • +

    • Fixed a print of ‘CPLEX Error 1217’ in log for multi-objective problems.

      • +

    • Fixed a bug when setting log_output to a file name: file was created, but empty.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.10.155 (2019.08):

+
    +

  • Fixed bug in logical_and() when result var is set to 0.

    • +
+
+
+

Changed in 2.10.154 (2019.07):

+
    +

  • Fixed TypeError occuring in python 3.7 in progressData initialization.

    • +
+
+
+

Changed in 2.10.151 (2019.07):

+
    +
  • +
    In docplex.mp:
      +

    • fixed a bug in ModelReader when reading SAV files with no names

      • +

    • fixed a bug in mip starts, which prevented mip starts with piecewise +functions to work properly.

      • +

    • fixed bug on Model.add_indicators() using comprehensions (len() was called).

      • +

    • Added support for the ‘!=’ (not equals) operator in expressions.

      • +

    • Clarified four types of checker: on, off, numeric and full. +Pass checker=<name> at model creation to specify which checker is used.

      • +

    • fixed a bug in solution JSON encoder for nonconvex QP problems.

      • +

    • Add direct support for lazy constraints, see Model.add_lazy_constraints()

      • +

    • Add direct support for user cuts, see Model.add_user_cut_constraints()

      • +

    • Get basis status of variables in LP problems, see Var.basis_status

      • +

    • Read MIP start files (MST format)

      • +

    • Allow to set the effort level for a MIP solution.

      • +

    • Read basis status files (in BAS format)

      • +

    • Read variable priority orders (in ORD format)

      • +

    • fixed bug in functional KPIs, solution argument was not passed on.

      • +

    • Enable constraint name dictionary at Model creation time: Model(cts_by_name=True)

      • +

    • Multi-objective is now pickled correctly

      • +

    • Multi-objective is now copied in Model.copy()

      • +

    • Wrote full documentation on progress listeners

      • +

    • Added Model.set_lp_start_basis() to provide an initial basis for LP problems.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • When trying to access a solution member that does not exists, an exception is thrown instead of returning None.

      • +

    • Add a new map_solution function that replace in a Python object all model expressions by their value in a solve result.

      • +

    • In CPO parser, fix a problem reading #line statements in startingPoint section.

      • +

    • In CPO parser, skip experimental section ‘expressions’ in ‘startingPoint’ section.

      • +

    • Simplify writing of interval variable domains reduced to a single value.

      • +

    • Adding a second objective function now raises an exception

      • +

    • Add new experimental local solve with a shared library.

      • +

    • Enable iterators to specify the domain of an integer variable

      • +

    • Add global methods get_version_info() and get_solver_verion() in docplex.cp.solver.

      • +

    • By default, generate CPO model without explicit format version.

      • +

    • Add a method reset() on CpoParameters object.

      • +

    • Modeling method allowed_assignments() and forbidden_assignments() can now accept an empty list of tuples.

      • +

    • On CpoModelSolution object, add a function map_solution() thar replace variables by their value in a python object.

      • +

    • Add parser for LP models

      • +

    • Add possibility to import CPO, MZN and LP models in gzip and zip format.

      • +

    • Enhance management of unexpected errors thrown by cpoptimizer.exe

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.9.141 (2019.03):

+
    +
  • +
    In docplex.mp:
      +

    • Removed links to rawgit.com as this service is going end of life.

      • +

    • Model.solve_lexicographic() is deprecated. This method should be used +to perform lexicographic solve with COS 12.8, but with COS 12.9, +Model.set_multi_objective() should be used for solving problems +with multiple objectives.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Add KPIs supported by CPO Solver 12.9

      • +

    • Update CPO parser to read KPIs section for format 12.9

      • +

    • Add new examples with KPIs.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.8.125 (2018.10):

+
    +

  • Solving with solver agent ‘docloud’ is deprecated. +Models are now preferably solved with local solver, or the python source can be submitted to DOcplexcloud solve service. +See https://ibm.biz/BdYhhK.

    • +
  • +
    In docplex.mp:
      +

    • solve_lexicographic is being deprecated. In a future version, a new api will be available to support multi-objectives.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Fix problem with boolean indicators in no_overlap(), always_constant() and always_equal().

      • +

    • Allow model solution to be used directly as a starting point (ignores what is not integer or interval var).

      • +

    • Add methods domain_min(), domain_max(), domain_iterator() and domain_contains() on both CpoIntVar and CpoIntVarSolution.

      • +

    • Default solver agent is now ‘local’ instead of ‘docloud’. All examples modified consequently.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.7.113 (2018.07):

+
    +
  • +
    In docplex.mp:
      +

    • Multiplying a constant expression by a quadratic expression raised an exception. Now returns the +product of the quadratic expression and the constant value.

      • +

    • Model.solve_lexicographic() on cloud now send the previous pass solution as a MIP start (for MIP problems)

      • +

    • The slack of quadratic constraints always returned zero. Now returns the correct value.

      • +

    • Accessing the dual (or slack) of a constraint that is not added to the model returned zero; now it raises an exception. A constraint must belong to a model to return a valid dual (or slack) value

      • +

    • Range constraints with infeasible domain (i.e. lb > ub) did not fail to solve. Now they raise a modeling exception.

      • +

    • Multiplying two absolute value expressions raised an exception. Now fixed.

      • +

    • When using tuples in variable dictionaries, the default name generation used to generate non-LP-compliant names, +because of ( and ). Now the name generator formats the tuples with a “_” separator without parentheses.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Split fzn stuff in a separate package docplex.cp.fzn

      • +

    • Optimize construction of arrays in FZN parser

      • +

    • Enhance FZN parser and save 30% time

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.6.94 (2018.04):

+
    +
  • +
    In docplex.cp:
      +

    • Allow CpoModel.add() to accept list of constraints.

      • +

    • Fix a bug in the conversion of an array of boolean constants into CPO expression.

      • +

    • Extend CpoModel method set_parameters() to accept a dictionary and/or optional list of updates using named arguments.

      • +

    • Method CpoModel.set_parameters() now clone the CpoParameters object given in arguments.

      • +

    • Add a new method CpoModel.add_parameters() that updates parameters associated to the model.

      • +

    • Fix wrong source location (not in real model source) when CpoModel.add() is called from another docplex.cp method.

      • +

    • When constraint auto-naming is on (in particular for refine_conflict(), searchPhases are no more included in the process.

      • +

    • Parameters mean_UB and mean_LB are now optional in standard_deviation()

      • +

    • CpoModel.add() checks that the added expression is limited to constraint, boolean, objective or search phase.

      • +

    • Add documented functions slope_piecewise_linear() and coordinate__piecewise_linear() in modeler.py.

      • +

    • Remove default configuration settings for parameters TimeLimit and Workers.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.5.92 (2018.03):

+
    +
  • +
    docplex.cli gains new features:
      +

    • option --details will display solve details as they are published on +DOcplexcloud.

      • +

    • options --url and -key allow specification of credentials without +using a config file.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • Fix problem with min() and max() that did not support optional key.

      • +

    • Add a Flatzinc parser capable of reading Minizinc Challenge problems.

      • +

    • Move expression dependencies analysis from model to compiler side.

      • +

    • No more constraint to have a unique name for model expressions. Compiler reallocate private names when needed.

      • +

    • Multiple variables or expressions with the same public name is now allowed.

      • +

    • Replace method CpoModel.get_expression() by CpoModel.get_named_expressions_dict().

      • +

    • Make SolverProgressPanelListener work properly with Python 2

      • +

    • Solve is automatically set to start/next loop when SolverProgressPanelListener is used.

      • +

    • In CpoModel, add a method that allows to substitute a function by another in the whole model.

      • +

    • Overwrite method __bool__ to avoid accidental use of CPO expressions as Python booleans.

      • +

    • Add special cases to search for the local CP Optimizer Interactive executable.

      • +

    • Allow methods min(), max(), min_of() and max_of() to support variable number of arguments.

      • +

    • Allow method all_diff() to support variable number of arguments.

      • +

    • Context parameter ‘length_for_rename’ is deprecated. Only length_for_alias is used.

      • +

    • Add a method add_var() in CpoModelSolution as a shortcut to add_integer_var_solution() and add_interval_var_solution()

      • +

    • Overwrite method __contains__() in CpoModelSolution to easily verify that a solution to a given variable is in the solution.

      • +

    • When called on a model, export_model() and get_cpo_string() disable all model optimization options.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.4.61 (2017.11):

+
    +
  • +
    Both docplex.mp & docplex.cp:
      +

    • Support for CPLEX engines 12.8. Some features of docplex2.4 are available only with engines >= 12.8.

      • +

    • Adding new ports (AIX, plinux).

      • +

    • Examples are now available as Zeppelin notebooks.

      • +
    +
    +
    +
    • +
  • +
    In docplex.mp:
      +

    • Express a linear problem as a scikit-learn transformer by providing a numpy, a pandas or scipy matrix.

      • +

    • Logical constraints: constraint equivalence, if-then & rshift operator.

      • +

    • Meta-constraints: allow the use of discrete +linear constraints in expressions, using their truth value.

      • +

    • Solve hook to add a method to be called at each intermediate solution.

      • +

    • KPIS automatically published at each intermediate solution if running on docplexcloud python worker.

      • +

    • Support for scipy coo & csr matrixes.

      • +

    • Fixed a bug in Model.add_constraints() when passing a string instead of a list of strings.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • add new method run_seeds() to execute a model multiple times, available with local solver 12.8.

      • +

    • add support of new solver infos ‘SearchStatus’ and ‘SearchStopCause’.

      • +

    • In method docplex.cp.model.CpoModel.propagate(), add possibility to add an optional constraint to the model.

      • +

    • add domain iterator in integer variables and integer variables solutions, allowing to get domain +as a list of individual integers.

      • +

    • add possibility to identify some model variables as KPIs of the model.

      • +

    • add abort_search() method on solver (not supported everywhere)

      • +

    • Rework code generation to enhance performances and remove unused variables that was pointed by removed expressions.

      • +

    • add possibility to add one or more CpoSolverListener to put some callback functions +when solve is started, ended, or when a solution is found. +Implementation is provided in new python module docplex.cp.solver.solver_listener that also contains sample +listeners SolverProgressPanelListener and AutoStopListener.

      • +

    • Using parameter context.solver.solve_with_start_next, enable solve() method to execute a start/next loop instead +of standard solve. This enables, for optimization problems, usage of SolveListeners with a greater progress accuracy.

      • +

    • Completely remove deprecated ‘angel’ to identify local solver.

      • +

    • Deprecate usage of methods minimize() and maximize() on docplex.cp.CpoModel.

      • +

    • Add methods get_objective_bounds() and get_objective_gaps() in solution objects.

      • +
    +
    +
    +
    • +
+
+
+

Changed in 2.3.44 (2017.09):

+
    +

  • Module docplex.cp.model.solver_angel.py has been renamed solver_local.py. +A shadow copy with previous name still exist to preserve ascending compatibility. +Module docplex.cp.model.config.py is modified to refer this new module.

    • +

  • Class docplex.cp.model.solver_local.SolverAngel has been renamed SolverLocal. +A shadow copy with previous name still exist to preserve ascending compatibility.

    • +

  • Class docplex.cp.model.solver_local.AngelException has been renamed LocalSolverException. +A shadow copy with previous name still exist to preserve ascending compatibility.

    • +

  • Functions logical_and() and logical_or() are able to accept a list of model boolean expressions.

    • +

  • Fix defect on allowed_assignments() and forbiden_assignments() that was wrongly converting +list of tupes into tuple_set.

    • +

  • Update all examples to add comments and split them in sections data / prepare / model / solve

    • +

  • Add new sched_RCPSPMM_json.py example that reads data from JSON file instead of raw data file.

    • +

  • Rename all visu examples with more explicit names.

    • +

  • Remove the object class CpoTupleSet. Tuple sets can be constructed only by calling tuple_set() method, or more +simply by passing directly a Python iterable of iterables when a tupleset is required +(in expressions allowed_assignments() and forbidden_assignments)

    • +

  • Allow logical_and() and logical_or() to accept a list of boolean expressions.

    • +

  • Add overloading of builtin functions all() and any() as other form of logical_and() and logical_or().

    • +

  • In no_overlap() and state_function(), transition matrix can be passed directly as a Python iterable of iterables of integers,

    • +

  • Editable transition matrix, created with a size only, is deprecated. However it is still available for ascending compatibility.

    • +

  • Add conditional() modeling function

    • +

  • Parameter ‘AutomaticReplay’ is deprecated.

    • +

  • Add get_search_status() and get_stop_cause() on object CpoSolveResult, available for solver COS12.8

    • +

  • Improved performance of Var.reduced_cost() in docplex.mp.

    • +
+
+
+

Changed in 2.2.34 (2017.07):

+
    +

  • Methods docplex.cp.model.export_model() and docplex.cp.model.import_model() +have been added to respectively generate or parse a model in CPO format.

    • +

  • Methods docplex.cp.model.minimize() and docplex.cp.model.maximize() +have been added to directly indicate an objective at model level.

    • +

  • Notebook example scheduling_tuto.ipynb contains an extensive tutorial +to solve scheduling problems with CP.

    • +

  • Modeling method sum() now supports sum of cumul expressions.

    • +

  • Methods docplex.cp.model.start_search() allows to start a new +search sequence directly from the model object.

    • +

  • When setting context.solver.auto_publish is set, and using the CPLEX +engine, KPIs and current objective are automatically published when the +script is run on DOcplexcloud Python worker.

    • +

  • When setting context.solver.auto_publish is set, and using the CP +engine, current objective is automatically published when the +script is run on DOcplexcloud Python worker.

    • +

  • docplex.util.environment.Environment.set_stop_callback and +docplex.util.environment.Environment.get_stop_callback are added so that +you can add a callback when the DOcplexcloud job is aborted.

    • +
+
+
+

Changed in 2.1.28:

+
    +

  • New methods Model.logical_or() and Model.logical_and() handle +logical operations on binary variables.

    • +

  • DOcplex now supports CPLEX 12.7.1 and Benders decomposition. Set annotations +on constraints and variables using the benders_annotation property and use +the proper CPLEX parameters governing Benders decomposition.

    • +

  • CPLEX tutorials: in the documentation and as notebooks in the examples.

    • +

  • Fixed a bug in docplex.mp.solution.SolveSolution.display() and in +docplex.mp.solution.Model.report_kpi() when using unicode variable names.

    • +

  • There’s now a simple command line interface for DOcplexcloud. It can be run +in a terminal. python -m docplex.cli help for more info. That command +line reads your DOcplexcloud credentials in your cplex_config.py file. It +allows you to submit, list, delete jobs on DOcplexcloud. The cli is available +in notebooks too, using the %docplex_cli magics. %docplex_cli help for +some help. In a notebook, credentials can be passed using %docplex_url and +%docplex_key magics.

    • +

  • Removing constraints in 1 call

    • +

  • Bug fixes when editing an existing model.

    • +

  • Bug fix in the relaxation mechanism when using docplexcloud.

    • +
+
+
+

Changed in 2.0.15:

+
    +

  • Piecewise linear (PWL) functions are now supported. An API is now available +on docplex.mp.model to create PWL functions and to create constraints using these PWL functions. +PWL functions may be defined with breakpoints (default API) or by using slopes. Some simple arithmetic is +also available to build new PWL functions by adding, subtracting, or scaling existing PWL functions.

    • +

  • DOcplex has undergone a significant overhaul effort that has resulted in an average of 30-50% improvement +of modeling run-time performance. All parts of the API benefit from the performance improvements: creation of variables and constraints, removal of constraints, computation of sums of variables, and so on.

    • +

  • Constraints are now fully editable: +the expressions of a constraint can be modified. +Similarly, the objective expression can also be modified. This allows for complex workflows in which the model is modified after a solve and then solved again.

    • +

  • docplex is now available on Anaconda cloud and can be installed via the conda installation packager. +See the IBM Anaconda home +CPLEX Community Edition for Python is also provided on Anaconda Cloud to get free local solving capabilities with limitations.

    • +

  • Support of ~/.docplexrc configuration files for docplex.mp.context.Context is now dropped. +This feature has been deprecated since 1.0.0.

    • +

  • Known incompatibility: class docplex.mp.model.AbstractModel moved to docplex.mp.absmodel.AbstractModel. +Samples using this class have been updated.

    • +
+
+
+

Changed in 1.0.630:

+
    +

  • Added support for CPLEX 12.7 and Python 3.5.

    • +

  • Upgraded the DOcplexcloud client to version 1.0.202.

    • +

  • Module docplex.mp.advmodel is now officially supported. This module +provides support for efficient, specialized aggregator methods for large +models.

    • +

  • When solving on DOcplexcloud, proxies can now be specified with the +context.solver.docloud.proxies property.

    • +

  • When two constraints are defined with the same name, issue a warning instead of +a fatal exception. The last constraint defined will take over the first one in the name directory.

    • +

  • Fix ValueError when passing a pandas DataFrame as variable keys (using +DataFrame indexes).

    • +

  • Solution.get_values() returns a collection of variable values in one call.

    • +

  • docplex.mp.model no longer imports docloud.status. Any status +previously initialized as JobSolveStatus.UNKNOWN is now initialized as +None.

    • +

  • Minor improvements to notebooks and examples.

    • +
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/README.md.html b/docs/2.29.245/docs/README.md.html new file mode 100644 index 0000000..3fbb333 --- /dev/null +++ b/docs/2.29.245/docs/README.md.html @@ -0,0 +1,131 @@ + + + + + + + + + + README.md — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

README.md

+
 1# IBM&reg; Decision Optimization Modeling for Python (DOcplex)
+ 2
+ 3Welcome to the IBM&reg; Decision Optimization Modeling for Python.
+ 4Licensed under the Apache License v2.0.
+ 5
+ 6With this library, you can quickly and easily add the power of optimization to
+ 7your application. You need IBM ILOG CPLEX Optimization Studio to solve the models.
+ 8
+ 9This library is composed of 2 modules:
+10
+11* IBM&reg; Decision Optimization CPLEX Optimizer Modeling for Python - with namespace docplex.mp
+12* IBM&reg; Decision Optimization CP Optimizer Modeling for Python - with namespace docplex.cp
+13
+14Solving with CPLEX requires that IBM&reg; ILOG CPLEX Optimization Studio V12.10 or later
+15is installed on your machine.
+16
+17This library is numpy friendly.
+18
+19## Install the library
+20
+21```
+22   pip install docplex
+23```
+24
+25## Get the documentation and examples
+26
+27* [Latest documentation](http://ibmdecisionoptimization.github.io/docplex-doc/)
+28* Documentation archives:
+29   * [2.23.222](http://ibmdecisionoptimization.github.io/docplex-doc/2.23.222)
+30   * [2.22.213](http://ibmdecisionoptimization.github.io/docplex-doc/2.22.213)
+31   * [2.21.207](http://ibmdecisionoptimization.github.io/docplex-doc/2.21.207)
+32   * [2.20.204](http://ibmdecisionoptimization.github.io/docplex-doc/2.20.204)
+33   * [2.19.202](http://ibmdecisionoptimization.github.io/docplex-doc/2.19.202)
+34   * [2.18.200](http://ibmdecisionoptimization.github.io/docplex-doc/2.18.200)
+35   * [2.16.195](http://ibmdecisionoptimization.github.io/docplex-doc/2.16.195)
+36* [Examples](https://github.com/IBMDecisionOptimization/docplex-examples)
+37
+38## Get your IBM&reg; ILOG CPLEX Optimization Studio edition
+39
+40- You can get a free [Community Edition](https://www.ibm.com/account/reg/us-en/signup?formid=urx-20028)
+41 of CPLEX Optimization Studio, with limited solving capabilities in term of problem size.
+42
+43- Faculty members, research professionals at accredited institutions can get access to an unlimited version of CPLEX through the
+44 [IBM&reg; Academic Initiative](http://ibm.biz/cplex-free-for-students).
+45
+46## Dependencies
+47
+48These third-party dependencies are automatically installed with ``pip``
+49
+50- [futures](https://pypi.python.org/pypi/futures)
+51- [requests](https://pypi.python.org/pypi/requests)
+52- [six](https://pypi.python.org/pypi/six)
+53- [certifi](https://pypi.python.org/pypi/certifi)
+54
+55
+56
+57## License
+58
+59This library is delivered under the  Apache License Version 2.0, January 2004 (see LICENSE.txt).
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/_images/equ_mathProgr12_default.png b/docs/2.29.245/docs/_images/equ_mathProgr12_default.png new file mode 100644 index 0000000..c4ddece Binary files /dev/null and b/docs/2.29.245/docs/_images/equ_mathProgr12_default.png differ diff --git a/docs/2.29.245/docs/_images/equ_mathProgr23_default.gif b/docs/2.29.245/docs/_images/equ_mathProgr23_default.gif new file mode 100644 index 0000000..6a41eee Binary files /dev/null and b/docs/2.29.245/docs/_images/equ_mathProgr23_default.gif differ diff --git a/docs/2.29.245/docs/_images/ln_docloud-engine.png b/docs/2.29.245/docs/_images/ln_docloud-engine.png new file mode 100644 index 0000000..67e08e6 Binary files /dev/null and b/docs/2.29.245/docs/_images/ln_docloud-engine.png differ diff --git a/docs/2.29.245/docs/_static/background_b01.png b/docs/2.29.245/docs/_static/background_b01.png new file mode 100644 index 0000000..353f26d Binary files /dev/null and b/docs/2.29.245/docs/_static/background_b01.png differ diff --git a/docs/2.29.245/docs/_static/basic.css b/docs/2.29.245/docs/_static/basic.css new file mode 100644 index 0000000..2a1ca75 --- /dev/null +++ b/docs/2.29.245/docs/_static/basic.css @@ -0,0 +1,921 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 210px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/2.29.245/docs/_static/bizstyle.css b/docs/2.29.245/docs/_static/bizstyle.css new file mode 100644 index 0000000..9a6c900 --- /dev/null +++ b/docs/2.29.245/docs/_static/bizstyle.css @@ -0,0 +1,508 @@ +/* + * bizstyle.css_t + * ~~~~~~~~~~~~~~ + * + * Sphinx stylesheet -- business style theme. + * + * :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 14px; + letter-spacing: -0.01em; + line-height: 150%; + text-align: center; + background-color: white; + background-image: url(background_b01.png); + color: black; + padding: 0; + border-right: 1px solid #336699; + border-left: 1px solid #336699; + + margin: 0px 40px 0px 40px; +} + +div.document { + background-color: white; + text-align: left; + background-repeat: repeat-x; + + -moz-box-shadow: 2px 2px 5px #000; + -webkit-box-shadow: 2px 2px 5px #000; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 240px; + border-left: 1px solid #ccc; +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} +div.bodywrapper { + margin: 0 0 0 calc(210px + 30px); +} + +div.related { + font-size: 1em; + + -moz-box-shadow: 2px 2px 5px #000; + -webkit-box-shadow: 2px 2px 5px #000; +} + +div.related ul { + background-color: #336699; + height: 100%; + overflow: hidden; + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; +} + +div.related ul li { + color: white; + margin: 0; + padding: 0; + height: 2em; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + +div.related ul li a { + margin: 0; + padding: 0 5px 0 5px; + line-height: 1.75em; + color: #fff; +} + +div.related ul li a:hover { + color: #fff; + text-decoration: underline; +} + +div.sphinxsidebarwrapper { + padding: 0; +} + +div.sphinxsidebar { + padding: 0.5em 12px 12px 12px; + width: 210px; + font-size: 1em; + text-align: left; +} + +div.sphinxsidebar h3, div.sphinxsidebar h4 { + margin: 1em 0 0.5em 0; + font-size: 1em; + padding: 0.1em 0 0.1em 0.5em; + color: white; + border: 1px solid #336699; + background-color: #336699; +} + +div.sphinxsidebar h3 a { + color: white; +} + +div.sphinxsidebar ul { + padding-left: 1.5em; + margin-top: 7px; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + margin-left: 20px; +} + +div.sphinxsidebar input { + border: 1px solid #336699; +} + +div.footer { + background-color: white; + color: #336699; + padding: 3px 8px 3px 0; + clear: both; + font-size: 0.8em; + text-align: right; + border-bottom: 1px solid #336699; + + -moz-box-shadow: 2px 2px 5px #000; + -webkit-box-shadow: 2px 2px 5px #000; +} + +div.footer a { + color: #336699; + text-decoration: underline; +} + +/* -- body styles ----------------------------------------------------------- */ + +p { + margin: 0.8em 0 0.5em 0; +} + +a { + color: #336699; + text-decoration: none; +} + +a:hover { + color: #336699; + text-decoration: underline; +} + +div.body a { + text-decoration: underline; +} + +h1, h2, h3 { + color: #336699; +} + +h1 { + margin: 0; + padding: 0.7em 0 0.3em 0; + font-size: 1.5em; +} + +h2 { + margin: 1.3em 0 0.2em 0; + font-size: 1.35em; + padding-bottom: .5em; + border-bottom: 1px solid #336699; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.2em; + padding-bottom: .3em; + border-bottom: 1px solid #CCCCCC; +} + +div.body h1 a, div.body h2 a, div.body h3 a, +div.body h4 a, div.body h5 a, div.body h6 a { + color: black!important; +} + +h1 a.anchor, h2 a.anchor, h3 a.anchor, +h4 a.anchor, h5 a.anchor, h6 a.anchor { + display: none; + margin: 0 0 0 0.3em; + padding: 0 0.2em 0 0.2em; + color: #aaa!important; +} + +h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, +h5:hover a.anchor, h6:hover a.anchor { + display: inline; +} + +h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover, +h5 a.anchor:hover, h6 a.anchor:hover { + color: #777; + background-color: #eee; +} + +a.headerlink { + color: #c60f0f!important; + font-size: 1em; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none!important; +} + +a.headerlink:hover { + background-color: #ccc; + color: white!important; +} + +cite, code, tt { + font-family: 'Consolas', 'Deja Vu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.01em; +} + +code { + background-color: #F2F2F2; + border-bottom: 1px solid #ddd; + color: #333; +} + +code.descname, code.descclassname, code.xref { + border: 0; +} + +hr { + border: 1px solid #abc; + margin: 2em; +} + +a code { + border: 0; + color: #CA7900; +} + +a code:hover { + color: #2491CF; +} + +pre { + background-color: transparent !important; + font-family: 'Consolas', 'Deja Vu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.015em; + line-height: 120%; + padding: 0.5em; + border-right: 5px solid #ccc; + border-left: 5px solid #ccc; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +td.linenos pre { + padding: 0.5em 0; +} + +div.quotebar { + background-color: #f8f8f8; + max-width: 250px; + float: right; + padding: 2px 7px; + border: 1px solid #ccc; +} + +nav.contents, +aside.topic, +div.topic { + background-color: #f8f8f8; +} + +table { + border-collapse: collapse; + margin: 0 -0.5em 0 -0.5em; +} + +table td, table th { + padding: 0.2em 0.5em 0.2em 0.5em; +} + +div.admonition { + font-size: 0.9em; + margin: 1em 0 1em 0; + border: 3px solid #cccccc; + background-color: #f7f7f7; + padding: 0; +} + +div.admonition p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition li p { + margin-left: 0; +} + +div.admonition pre, div.warning pre { + margin: 0; +} + +div.highlight { + margin: 0.4em 1em; +} + +div.admonition p.admonition-title { + margin: 0; + padding: 0.1em 0 0.1em 0.5em; + color: white; + border-bottom: 3px solid #cccccc; + font-weight: bold; + background-color: #165e83; +} + +div.danger { border: 3px solid #f0908d; background-color: #f0cfa0; } +div.error { border: 3px solid #f0908d; background-color: #ede4cd; } +div.warning { border: 3px solid #f8b862; background-color: #f0cfa0; } +div.caution { border: 3px solid #f8b862; background-color: #ede4cd; } +div.attention { border: 3px solid #f8b862; background-color: #f3f3f3; } +div.important { border: 3px solid #f0cfa0; background-color: #ede4cd; } +div.note { border: 3px solid #f0cfa0; background-color: #f3f3f3; } +div.hint { border: 3px solid #bed2c3; background-color: #f3f3f3; } +div.tip { border: 3px solid #bed2c3; background-color: #f3f3f3; } + +div.danger p.admonition-title, div.error p.admonition-title { + background-color: #b7282e; + border-bottom: 3px solid #f0908d; +} + +div.caution p.admonition-title, +div.warning p.admonition-title, +div.attention p.admonition-title { + background-color: #f19072; + border-bottom: 3px solid #f8b862; +} + +div.note p.admonition-title, div.important p.admonition-title { + background-color: #f8b862; + border-bottom: 3px solid #f0cfa0; +} + +div.hint p.admonition-title, div.tip p.admonition-title { + background-color: #7ebea5; + border-bottom: 3px solid #bed2c3; +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + +div.versioninfo { + margin: 1em 0 0 0; + border: 1px solid #ccc; + background-color: #DDEAF0; + padding: 8px; + line-height: 1.3em; + font-size: 0.9em; +} + +.viewcode-back { + font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} + +p.versionchanged span.versionmodified { + font-size: 0.9em; + margin-right: 0.2em; + padding: 0.1em; + background-color: #DCE6A0; +} + +dl.field-list > dt { + color: white; + background-color: #82A0BE; +} + +dl.field-list > dd { + background-color: #f7f7f7; +} + +/* -- table styles ---------------------------------------------------------- */ + +table.docutils { + margin: 1em 0; + padding: 0; + border: 1px solid white; + background-color: #f7f7f7; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 1px solid white; + border-bottom: 1px solid white; +} + +table.docutils td p { + margin-top: 0; + margin-bottom: 0.3em; +} + +table.field-list td, table.field-list th { + border: 0 !important; + word-break: break-word; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + color: white; + text-align: left; + padding-right: 5px; + background-color: #82A0BE; +} + +div.literal-block-wrapper div.code-block-caption { + background-color: #EEE; + border-style: solid; + border-color: #CCC; + border-width: 1px 5px; +} + +/* WIDE DESKTOP STYLE */ +@media only screen and (min-width: 1176px) { +body { + margin: 0 40px 0 40px; +} +} + +/* TABLET STYLE */ +@media only screen and (min-width: 768px) and (max-width: 991px) { +body { + margin: 0 40px 0 40px; +} +} + +/* MOBILE LAYOUT (PORTRAIT/320px) */ +@media only screen and (max-width: 767px) { +body { + margin: 0; +} +div.bodywrapper { + margin: 0; + width: 100%; + border: none; +} +div.sphinxsidebar { + display: none; +} +} + +/* MOBILE LAYOUT (LANDSCAPE/480px) */ +@media only screen and (min-width: 480px) and (max-width: 767px) { +body { + margin: 0 20px 0 20px; +} +} + +/* RETINA OVERRIDES */ +@media +only screen and (-webkit-min-device-pixel-ratio: 2), +only screen and (min-device-pixel-ratio: 2) { +} + +/* -- end ------------------------------------------------------------------- */ \ No newline at end of file diff --git a/docs/2.29.245/docs/_static/bizstyle.js b/docs/2.29.245/docs/_static/bizstyle.js new file mode 100644 index 0000000..cade463 --- /dev/null +++ b/docs/2.29.245/docs/_static/bizstyle.js @@ -0,0 +1,30 @@ +// +// bizstyle.js +// ~~~~~~~~~~~ +// +// Sphinx javascript -- for bizstyle theme. +// +// This theme was created by referring to 'sphinxdoc' +// +// :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS. +// :license: BSD, see LICENSE for details. +// +const initialiseBizStyle = () => { + if (navigator.userAgent.indexOf("iPhone") > 0 || navigator.userAgent.indexOf("Android") > 0) { + document.querySelector("li.nav-item-0 a").innerText = "Top" + } + const truncator = item => {if (item.textContent.length > 20) { + item.title = item.innerText + item.innerText = item.innerText.substr(0, 17) + "..." + } + } + document.querySelectorAll("div.related:first ul li:not(.right) a").slice(1).forEach(truncator); + document.querySelectorAll("div.related:last ul li:not(.right) a").slice(1).forEach(truncator); +} + +window.addEventListener("resize", + () => (document.querySelector("li.nav-item-0 a").innerText = (window.innerWidth <= 776) ? "Top" : "IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation") +) + +if (document.readyState !== "loading") initialiseBizStyle() +else document.addEventListener("DOMContentLoaded", initialiseBizStyle) \ No newline at end of file diff --git a/docs/2.29.245/docs/_static/css3-mediaqueries.js b/docs/2.29.245/docs/_static/css3-mediaqueries.js new file mode 100644 index 0000000..59735f5 --- /dev/null +++ b/docs/2.29.245/docs/_static/css3-mediaqueries.js @@ -0,0 +1 @@ +if(typeof Object.create!=="function"){Object.create=function(e){function t(){}t.prototype=e;return new t}}var ua={toString:function(){return navigator.userAgent},test:function(e){return this.toString().toLowerCase().indexOf(e.toLowerCase())>-1}};ua.version=(ua.toString().toLowerCase().match(/[\s\S]+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1];ua.webkit=ua.test("webkit");ua.gecko=ua.test("gecko")&&!ua.webkit;ua.opera=ua.test("opera");ua.ie=ua.test("msie")&&!ua.opera;ua.ie6=ua.ie&&document.compatMode&&typeof document.documentElement.style.maxHeight==="undefined";ua.ie7=ua.ie&&document.documentElement&&typeof document.documentElement.style.maxHeight!=="undefined"&&typeof XDomainRequest==="undefined";ua.ie8=ua.ie&&typeof XDomainRequest!=="undefined";var domReady=function(){var e=[];var t=function(){if(!arguments.callee.done){arguments.callee.done=true;for(var t=0;t=200&&r.status<300||r.status===304||navigator.userAgent.indexOf("Safari")>-1&&typeof r.status==="undefined"){t(r.responseText)}else{n()}document.documentElement.style.cursor="";r=null}};r.send("")};var l=function(t){t=t.replace(e.REDUNDANT_COMPONENTS,"");t=t.replace(e.REDUNDANT_WHITESPACE,"$1");t=t.replace(e.WHITESPACE_IN_PARENTHESES,"($1)");t=t.replace(e.MORE_WHITESPACE," ");t=t.replace(e.FINAL_SEMICOLONS,"}");return t};var c={stylesheet:function(t){var n={};var r=[],i=[],s=[],o=[];var u=t.cssHelperText;var a=t.getAttribute("media");if(a){var f=a.toLowerCase().split(",")}else{var f=["all"]}for(var l=0;l-1&&a.href&&a.href.length!==0&&!a.disabled){r[r.length]=a}}if(r.length>0){var c=0;var d=function(){c++;if(c===r.length){i()}};var v=function(t){var n=t.href;f(n,function(r){r=l(r).replace(e.RELATIVE_URLS,"url("+n.substring(0,n.lastIndexOf("/"))+"/$1)");t.cssHelperText=r;d()},d)};for(u=0;u0){r.setAttribute("media",t.join(","))}document.getElementsByTagName("head")[0].appendChild(r);if(r.styleSheet){r.styleSheet.cssText=e}else{r.appendChild(document.createTextNode(e))}r.addedWithCssHelper=true;if(typeof n==="undefined"||n===true){cssHelper.parsed(function(t){var n=p(r,e);for(var i in n){if(n.hasOwnProperty(i)){g(i,n[i])}}a("newStyleParsed",r)})}else{r.parsingDisallowed=true}return r},removeStyle:function(e){return e.parentNode.removeChild(e)},parsed:function(e){if(n){s(e)}else{if(typeof t!=="undefined"){if(typeof e==="function"){e(t)}}else{s(e);d()}}},stylesheets:function(e){cssHelper.parsed(function(t){e(m.stylesheets||y("stylesheets"))})},mediaQueryLists:function(e){cssHelper.parsed(function(t){e(m.mediaQueryLists||y("mediaQueryLists"))})},rules:function(e){cssHelper.parsed(function(t){e(m.rules||y("rules"))})},selectors:function(e){cssHelper.parsed(function(t){e(m.selectors||y("selectors"))})},declarations:function(e){cssHelper.parsed(function(t){e(m.declarations||y("declarations"))})},properties:function(e){cssHelper.parsed(function(t){e(m.properties||y("properties"))})},broadcast:a,addListener:function(e,t){if(typeof t==="function"){if(!u[e]){u[e]={listeners:[]}}u[e].listeners[u[e].listeners.length]=t}},removeListener:function(e,t){if(typeof t==="function"&&u[e]){var n=u[e].listeners;for(var r=0;r=a||s&&l0}}else if("device-height"===e.substring(r-13,r)){c=screen.height;if(t!==null){if(u==="length"){return i&&c>=a||s&&c0}}else if("width"===e.substring(r-5,r)){l=document.documentElement.clientWidth||document.body.clientWidth;if(t!==null){if(u==="length"){return i&&l>=a||s&&l0}}else if("height"===e.substring(r-6,r)){c=document.documentElement.clientHeight||document.body.clientHeight;if(t!==null){if(u==="length"){return i&&c>=a||s&&c0}}else if("device-aspect-ratio"===e.substring(r-19,r)){return u==="aspect-ratio"&&screen.width*a[1]===screen.height*a[0]}else if("color-index"===e.substring(r-11,r)){var h=Math.pow(2,screen.colorDepth);if(t!==null){if(u==="absolute"){return i&&h>=a||s&&h0}}else if("color"===e.substring(r-5,r)){var p=screen.colorDepth;if(t!==null){if(u==="absolute"){return i&&p>=a||s&&p0}}else if("resolution"===e.substring(r-10,r)){var d;if(f==="dpcm"){d=o("1cm")}else{d=o("1in")}if(t!==null){if(u==="resolution"){return i&&d>=a||s&&d0}}else{return false}};var a=function(e){var t=e.getValid();var n=e.getExpressions();var r=n.length;if(r>0){for(var i=0;i0){u=false;for(var f=0;f0){l[c++]=","}l[c++]=h}}if(l.length>0){r[r.length]=cssHelper.addStyle("@media "+l.join("")+"{"+e.getCssText()+"}",t,false)}};var l=function(e,t){for(var n=0;n0}}var o=[],u=[];for(var f in i){if(i.hasOwnProperty(f)){o[o.length]=f;if(i[f]){u[u.length]=f}if(f==="all"){n=true}}}if(u.length>0){r[r.length]=cssHelper.addStyle(e.getCssText(),u,false)}var c=e.getMediaQueryLists();if(n){l(c)}else{l(c,o)}};var h=function(e){for(var t=0;td||Math.abs(s-t)>d){e=n;t=s;clearTimeout(r);r=setTimeout(function(){if(!i()){p()}else{cssHelper.broadcast("cssMediaQueriesTested")}},500)}};window.onresize=function(){var e=window.onresize||function(){};return function(){e();s()}}()};var m=document.documentElement;m.style.marginLeft="-32767px";setTimeout(function(){m.style.marginLeft=""},5e3);return function(){if(!i()){cssHelper.addListener("newStyleParsed",function(e){c(e.cssHelperParsed.stylesheet)});cssHelper.addListener("cssMediaQueriesTested",function(){if(ua.ie){m.style.width="1px"}setTimeout(function(){m.style.width="";m.style.marginLeft=""},0);cssHelper.removeListener("cssMediaQueriesTested",arguments.callee)});s();p()}else{m.style.marginLeft=""}v()}}());try{document.execCommand("BackgroundImageCache",false,true)}catch(e){} diff --git a/docs/2.29.245/docs/_static/css3-mediaqueries_src.js b/docs/2.29.245/docs/_static/css3-mediaqueries_src.js new file mode 100644 index 0000000..7878620 --- /dev/null +++ b/docs/2.29.245/docs/_static/css3-mediaqueries_src.js @@ -0,0 +1,1104 @@ +/* +css3-mediaqueries.js - CSS Helper and CSS3 Media Queries Enabler + +author: Wouter van der Graaf +version: 1.0 (20110330) +license: MIT +website: http://code.google.com/p/css3-mediaqueries-js/ + +W3C spec: http://www.w3.org/TR/css3-mediaqueries/ + +Note: use of embedded + + + + + + + +
+ + + + +
+ + + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp.html b/docs/2.29.245/docs/mp.html new file mode 100644 index 0000000..e3831f2 --- /dev/null +++ b/docs/2.29.245/docs/mp.html @@ -0,0 +1,254 @@ + + + + + + + + + + Overview of mathematical programming — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

Overview of mathematical programming

+

Linear programming was revolutionized when CPLEX® software was developed over 20 years ago. CPLEX was the first commercial linear optimizer on the market to be written in the C programming language. CPLEX gave operations researchers unprecedented flexibility, reliability, and performance, allowing them to create novel optimization algorithms, models, and applications.

+

The name CPLEX itself is a pun that is built on the concept of a Simplex algorithm that is written in C: C-Simplex resulted in CPLEX.

+

The Simplex algorithm, invented by George Dantzig in 1947, became the basis for the entire field of mathematical optimization and provided the first practical method to solve a linear programming problem.

+

CPLEX evolved over time to embrace, and become a leader in, the children categories of linear programming, such as integer programming, mixed integer programming, and quadratic programming.

+

Depending on how familiar you are with linear programming, you might be interested in various levels of information about linear programming and how they are handled by CPLEX.

+

The information that is presented in the following sections goes from the highest level fundamental explanation of what linear programming is (and how it runs in CPLEX) down to more advanced concepts.

+

Finally, some external references that help with learning operational research techniques are presented.

+
+

Linear programming: An essential optimization technique

+

The concept behind a linear programming problem is simple. It consists for four basic components:

+
+
    +

  • Decision variables represent quantities to be determined.

    • +

  • An objective function represents how the decision variables affect the cost or value to be optimized (minimized or maximized).

    • +

  • Constraints represent how the decision variables use resources, which are available in limited quantities.

    • +

  • Data quantifies the relationships that are represented in the objective function and the constraints.

    • +
+
+

In a linear program, the objective function and the constraints are linear relationships, meaning that the effect of changing a decision variable is proportional to its magnitude. While this requirement might seem overly restrictive, many real-world business problems can be formulated in this manner.

+_images/equ_mathProgr12_default.png +
+
+

Examples of problems solved with linear programming

+ + + + + + + + + + + + + + + + + + + + +

Industry

Problem

Manufacturing

    +

  • Blending

    • +

  • Economic planning

    • +

  • Factory planning

    • +

  • Farm planning

    • +

  • Food manufacturing

    • +

  • Refinery planning

    • +
+

Supply chain

Product deployment

Time tabling

Manpower planning

Transportation

Network flows

+
+
+

Integer programming

+

Sometimes, linear relationships are not enough to capture the essence of a +business problem, particularly when decisions involve discrete choices, such as +whether or not to open a warehouse at a particular location. For these +situations, you need to use integer programming (or, if the problem includes +both discrete and continuous choices, it is a mixed integer program). Mixed +integer programs can have linear or convex quadratic objectives and linear, +convex quadratic or second-order cone constraints.

+_images/equ_mathProgr23_default.gif +
+
+

Examples of mixed integer programming problems

+

Examples of mixed integer programming problems include:

+
+
    +

  • Vehicle routing

    • +

  • Facility location

    • +

  • Personnel scheduling

    • +

  • Power plant commitment

    • +

  • Costs with fixed and variable components

    • +

  • Materials cutting

    • +

  • Network design

    • +
+
+

Integer programs are much harder to solve than linear programs, but they have important business applications. +CPLEX uses sophisticated mathematical techniques to solve hard integer programs. +These techniques involve systematically searching over possible combinations of the discrete decision variables, by using linear or quadratic programming relaxations +to compute bounds on the value of the optimal solution. They also use linear programming and other techniques to compute linear constraints that cut off possible +solutions that violate the discreteness constraints. +CPLEX’s innovative technologies made it possible to solve mixed integer programs that were previously considered intractable, thus enabling use of optimization +in important business applications.

+
+
+

CPLEX algorithms

+

CPLEX is a high-performance mathematical programming solver for linear programming, mixed integer programming, and quadratic programming

+
    +

  • Problem modeling: IBM® ILOG® CPLEX® Optimizer provides a framework to model business issues mathematically.

    • +

  • Improved profits: IBM ILOG CPLEX Optimizer’s mathematical programming provides technology to help improve efficiency, reduce costs, and increase profitability.

    • +

  • Fundamental algorithms: IBM ILOG CPLEX Optimizer provides flexible, high-performance mathematical programming solvers for linear programming, mixed integer programming, quadratic programming, and quadratically constrained programming problems. These include a distributed parallel algorithm for mixed integer programming to leverage multiple computers to solve difficult problems.

    • +

  • Robust algorithms for large problems: IBM ILOG CPLEX Optimizer has solved problems with millions of constraints and variables.

    • +

  • Industry-leading support: IBM has an impressive rate of product improvement and ample support resources to serve you.

    • +

  • High performance: IBM ILOG CPLEX Optimizer delivers the power needed to solve large, real-world optimization problems, as well as the speed required for today’s interactive decision optimization applications.

    • +

  • Robust and reliable: A large installed base helps us make IBM ILOG CPLEX Optimizer better with each release. Every new feature is tested on the biggest, most diverse model library in the world.

    • +
+
+
+

More resources on linear programming, with or without CPLEX

+ +
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/README.md.html b/docs/2.29.245/docs/mp/README.md.html new file mode 100644 index 0000000..acbcc47 --- /dev/null +++ b/docs/2.29.245/docs/mp/README.md.html @@ -0,0 +1,147 @@ + + + + + + + + + + README.md — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

README.md

+
 1# IBM&reg; Decision Optimization Modeling for Python (DOcplex)
+ 2
+ 3Welcome to the IBM&reg; Decision Optimization Modeling for Python.
+ 4Licensed under the Apache License v2.0.
+ 5
+ 6With this library, you can quickly and easily add the power of optimization to
+ 7your application. You need IBM ILOG CPLEX Optimization Studio to solve the models.
+ 8
+ 9This library is composed of 2 modules:
+10
+11* IBM&reg; Decision Optimization CPLEX Optimizer Modeling for Python - with namespace docplex.mp
+12* IBM&reg; Decision Optimization CP Optimizer Modeling for Python - with namespace docplex.cp
+13
+14Solving with CPLEX requires that IBM&reg; ILOG CPLEX Optimization Studio V12.10 or later
+15is installed on your machine.
+16
+17This library is numpy friendly.
+18
+19## Install the library
+20
+21```
+22   pip install docplex
+23```
+24
+25## Get the documentation and examples
+26
+27* [Latest documentation](http://ibmdecisionoptimization.github.io/docplex-doc/)
+28* Documentation archives:
+29   * [2.23.222](http://ibmdecisionoptimization.github.io/docplex-doc/2.23.222)
+30   * [2.22.213](http://ibmdecisionoptimization.github.io/docplex-doc/2.22.213)
+31   * [2.21.207](http://ibmdecisionoptimization.github.io/docplex-doc/2.21.207)
+32   * [2.20.204](http://ibmdecisionoptimization.github.io/docplex-doc/2.20.204)
+33   * [2.19.202](http://ibmdecisionoptimization.github.io/docplex-doc/2.19.202)
+34   * [2.18.200](http://ibmdecisionoptimization.github.io/docplex-doc/2.18.200)
+35   * [2.16.195](http://ibmdecisionoptimization.github.io/docplex-doc/2.16.195)
+36* [Examples](https://github.com/IBMDecisionOptimization/docplex-examples)
+37
+38## Get your IBM&reg; ILOG CPLEX Optimization Studio edition
+39
+40- You can get a free [Community Edition](https://www.ibm.com/account/reg/us-en/signup?formid=urx-20028)
+41 of CPLEX Optimization Studio, with limited solving capabilities in term of problem size.
+42
+43- Faculty members, research professionals at accredited institutions can get access to an unlimited version of CPLEX through the
+44 [IBM&reg; Academic Initiative](http://ibm.biz/cplex-free-for-students).
+45
+46## Dependencies
+47
+48These third-party dependencies are automatically installed with ``pip``
+49
+50- [futures](https://pypi.python.org/pypi/futures)
+51- [requests](https://pypi.python.org/pypi/requests)
+52- [six](https://pypi.python.org/pypi/six)
+53- [certifi](https://pypi.python.org/pypi/certifi)
+54
+55
+56
+57## License
+58
+59This library is delivered under the  Apache License Version 2.0, January 2004 (see LICENSE.txt).
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_images/boxes_35_0.png b/docs/2.29.245/docs/mp/_images/boxes_35_0.png new file mode 100644 index 0000000..d79fb05 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/boxes_35_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/boxes_37_0.png b/docs/2.29.245/docs/mp/_images/boxes_37_0.png new file mode 100644 index 0000000..5d9e422 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/boxes_37_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/boxes_38_0.png b/docs/2.29.245/docs/mp/_images/boxes_38_0.png new file mode 100644 index 0000000..684c6ed Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/boxes_38_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/boxes_39_1.png b/docs/2.29.245/docs/mp/_images/boxes_39_1.png new file mode 100644 index 0000000..b088076 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/boxes_39_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/mining_pandas_61_0.png b/docs/2.29.245/docs/mp/_images/mining_pandas_61_0.png new file mode 100644 index 0000000..6d2447f Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/mining_pandas_61_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/mining_pandas_70_0.png b/docs/2.29.245/docs/mp/_images/mining_pandas_70_0.png new file mode 100644 index 0000000..a3d8f24 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/mining_pandas_70_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/nurses_pandas_72_1.png b/docs/2.29.245/docs/mp/_images/nurses_pandas_72_1.png new file mode 100644 index 0000000..9a8f72a Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/nurses_pandas_72_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/nurses_pandas_74_1.png b/docs/2.29.245/docs/mp/_images/nurses_pandas_74_1.png new file mode 100644 index 0000000..1cfe3d2 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/nurses_pandas_74_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/nurses_pandas_90_1.png b/docs/2.29.245/docs/mp/_images/nurses_pandas_90_1.png new file mode 100644 index 0000000..a57b179 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/nurses_pandas_90_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/nurses_pandas_95_1.png b/docs/2.29.245/docs/mp/_images/nurses_pandas_95_1.png new file mode 100644 index 0000000..bb107ff Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/nurses_pandas_95_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/nurses_scheduling_47_0.png b/docs/2.29.245/docs/mp/_images/nurses_scheduling_47_0.png new file mode 100644 index 0000000..fe19baf Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/nurses_scheduling_47_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/oil_blending_41_0.png b/docs/2.29.245/docs/mp/_images/oil_blending_41_0.png new file mode 100644 index 0000000..53cc893 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/oil_blending_41_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/oil_blending_43_0.png b/docs/2.29.245/docs/mp/_images/oil_blending_43_0.png new file mode 100644 index 0000000..eb1893a Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/oil_blending_43_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/oil_blending_46_0.png b/docs/2.29.245/docs/mp/_images/oil_blending_46_0.png new file mode 100644 index 0000000..b826ce7 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/oil_blending_46_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/ucp_pandas_20_2.png b/docs/2.29.245/docs/mp/_images/ucp_pandas_20_2.png new file mode 100644 index 0000000..1c2a883 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/ucp_pandas_20_2.png differ diff --git a/docs/2.29.245/docs/mp/_images/ucp_pandas_54_1.png b/docs/2.29.245/docs/mp/_images/ucp_pandas_54_1.png new file mode 100644 index 0000000..846ae18 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/ucp_pandas_54_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/ucp_pandas_56_1.png b/docs/2.29.245/docs/mp/_images/ucp_pandas_56_1.png new file mode 100644 index 0000000..e8e3b6e Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/ucp_pandas_56_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/ucp_pandas_58_1.png b/docs/2.29.245/docs/mp/_images/ucp_pandas_58_1.png new file mode 100644 index 0000000..d90209a Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/ucp_pandas_58_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/ucp_pandas_60_1.png b/docs/2.29.245/docs/mp/_images/ucp_pandas_60_1.png new file mode 100644 index 0000000..052354c Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/ucp_pandas_60_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/ucp_pandas_62_1.png b/docs/2.29.245/docs/mp/_images/ucp_pandas_62_1.png new file mode 100644 index 0000000..8be4d8a Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/ucp_pandas_62_1.png differ diff --git a/docs/2.29.245/docs/mp/_images/ucp_pandas_75_0.png b/docs/2.29.245/docs/mp/_images/ucp_pandas_75_0.png new file mode 100644 index 0000000..1d38c23 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/ucp_pandas_75_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/warehouse_38_0.png b/docs/2.29.245/docs/mp/_images/warehouse_38_0.png new file mode 100644 index 0000000..4544862 Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/warehouse_38_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/warehouse_40_0.png b/docs/2.29.245/docs/mp/_images/warehouse_40_0.png new file mode 100644 index 0000000..54e099b Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/warehouse_40_0.png differ diff --git a/docs/2.29.245/docs/mp/_images/warehouse_47_0.png b/docs/2.29.245/docs/mp/_images/warehouse_47_0.png new file mode 100644 index 0000000..cb85edf Binary files /dev/null and b/docs/2.29.245/docs/mp/_images/warehouse_47_0.png differ diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/basic.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/basic.html new file mode 100644 index 0000000..e54ca00 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/basic.html @@ -0,0 +1,603 @@ + + + + + + + + + docplex.mp.basic — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.basic

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from abc import abstractmethod, ABCMeta
+
+from docplex.mp.operand import Operand
+from docplex.mp.sttck import StaticTypeChecker
+
+
+# noinspection PyUnusedLocal,PyPropertyAccess
+
+class _AbstractModelObject(metaclass=ABCMeta):
+    """
+    Abstract API for all classes which have a "model" property.
+    """
+
+    @property
+    @abstractmethod
+    def model(self):  # pragma: no cover
+        raise NotImplementedError
+
+    def is_in_model(self, mdl):
+        return self.model is mdl
+
+    def get_linear_factory(self):
+        return self.model._lfactory
+
+    @property
+    def lfactory(self):
+        return self.model._lfactory
+
+    @property
+    def qfactory(self):
+        return self.model._qfactory
+
+    def _check_model_has_solution(self):
+        self.model._check_has_solution()
+
+    @property
+    def error_handler(self):
+        return self.logger
+
+    @property
+    def logger(self):
+        return self.model.error_handler
+
+    def fatal(self, msg, *args):
+        self.logger.fatal(msg, args)
+
+    def error(self, msg, *args):
+        self.logger.error(msg, args)
+
+    def warning(self, msg, *args):
+        self.logger.warning(msg, args)
+
+
+class _AbstractValuable(_AbstractModelObject):
+    # abstract API for all objects which can be evaluated from a solution.
+
+    __slots__ = ()
+
+    def _round_if_discrete(self, raw_value):
+        return self.model._round_element_value_if_necessary(self, raw_value)
+
+    @abstractmethod
+    def _raw_solution_value(self, s=None):
+        # INTERNAL: compute raw solution value, no rounding, no checking
+        raise NotImplementedError  # pragma: no cover
+
+    @property
+    def solution_value(self):
+        self.model._check_has_solution()
+        raw = self._raw_solution_value()
+        return self._round_if_discrete(raw)
+
+    @property
+    def raw_solution_value(self):
+        self.model._check_has_solution()
+        return self._raw_solution_value()
+
+    @property
+    def sv(self):
+        return self.solution_value
+
+    @property
+    def rsv(self):
+        return self.raw_solution_value
+
+
+class _SubscriptionMixin(object):
+    __slots__ = ()
+
+    # INTERNAL:
+    # This class is absolutely not meant to be directly instantiated
+    # but used as a mixin
+
+    @classmethod
+    def _new_empty_subscribers(cls):
+        return []
+
+    def notify_used(self, user):
+        # INTERNAL
+        self._subscribers.append(user)
+
+    notify_subscribed = notify_used
+
+    def notify_unsubscribed(self, subscriber):
+        # 1 find index
+        for s, sc in enumerate(self._subscribers):
+            if sc is subscriber:
+                del self._subscribers[s]
+                break
+
+    def clear_subscribers(self):
+        self._subscribers = []
+
+    def is_in_use(self):
+        return bool(self._subscribers)
+
+    @property
+    def nb_subscribers(self):
+        return len(self._subscribers)
+
+    def is_shared(self):
+        return self.nb_subscribers >= 2
+
+    def is_used_by(self, obj):
+        # lists are not optimal here, but we favor insertion: append is faster than set.add
+        return any(obj is sc for sc in self.iter_subscribers())
+
+    def notify_modified(self, event):
+        for s in self._subscribers:
+            s.notify_expr_modified(self, event)
+
+    def iter_subscribers(self):
+        return iter(self._subscribers)
+
+    def notify_replaced(self, new_expr):
+        for s in self._subscribers:
+            s.notify_expr_replaced(self, new_expr)
+
+    def grab_subscribers(self, other):
+        # grab subscribers from another expression
+        # typically when an expression is replaced by another.
+        for s in other.iter_subscribers():
+            self._subscribers.append(s)
+        # delete all subscriptions on old
+        other.clear_subscribers()
+
+
+class _AbstractBendersAnnotated(_AbstractModelObject):
+    # a maxin class to group all benders-related code.
+    __slots__ = ()
+
+    def set_benders_annotation(self, group):
+        self.model.set_benders_annotation(self, group)
+
+    def get_benders_annotation(self):
+        return self.model.get_benders_annotation(self)
+
+
+class _AbstractNamable(metaclass=ABCMeta):
+
+    # abstract name API across all modeling objects.
+
+    @property
+    @abstractmethod
+    def name(self):  # pragma: no cover
+        raise NotImplemented
+
+    @abstractmethod
+    def _set_name(self, new_name):  # pragma: no cover
+        raise NotImplementedError
+
+    def check_name(self, new_name):
+        pass
+
+    def get_name(self):
+        # deprecate
+        return self.name
+
+    def set_name(self, new_name):
+        self.check_name(new_name)
+        self._set_name(new_name)
+
+    @property
+    def safe_name(self):
+        return self.name or ''
+
+    def check_lp_name(self, qualifier, new_name, accept_empty, accept_none):
+        return StaticTypeChecker.check_lp_name(logger=self, qualifier=qualifier, obj=self, new_name=new_name,
+                                               accept_empty=accept_empty, accept_none=accept_none)
+
+    def has_name(self):
+        return self.name is not None
+
+    def has_user_name(self):
+        return self.has_name()
+
+
+
[docs]class ModelObject(_AbstractModelObject):
+    # base for all model objects
+    __array_priority__ = 100
+
+    __slots__ = ('_model',)
+
+    def __init__(self, model):
+        self._model = model
+
+    @property
+    def model(self):
+        return self._model
+
+    def repr_str(self):
+        # INTERNAL
+        try:
+            return self.to_string(use_space=False)
+        except (TypeError, AttributeError):
+            return str(self)
+
+    def zero_expr(self):
+        # INTERNAL
+        return self._model._lfactory.new_zero_expr()
+
+    def _unsupported_binary_operation(self, lhs, op, rhs):
+        self.fatal("Unsupported operation: {0!s} {1:s} {2!s}", lhs, op, rhs)
+
+    def __str__(self):
+        return self.to_string(use_space=self._model.str_use_space)

+
+    # def to_string(self):
+    #     raise NotImplementedError
+
+
+
[docs]class ModelingObjectBase(ModelObject, _AbstractNamable):
+    """ModelingObjectBase()
+
+    Parent class for all modeling objects (variables and constraints).
+
+    This class is not intended to be instantiated directly.
+    """
+
+    __array_priority__ = 100
+
+    __slots__ = ('_name',)
+
+    # noinspection PyMissingConstructor
+    def __init__(self, model, name=None):
+        self._name = name
+        self._model = model
+
+    @property
+    def name(self):
+        """ This property is used to get or set the name of the modeling object.
+
+        """
+        return self._name
+
+    @name.setter
+    def name(self, new_name):
+        self.set_name(new_name)
+
+    def _set_name(self, name):
+        self._name = name
+
+
[docs]    def has_name(self):
+        """ Checks whether the object has a name.
+
+        Returns:
+            True if the object has a name.
+
+        """
+        return super().has_name()

+
+
[docs]    def has_user_name(self):
+        """ Checks whether the object has a valid name given by the user.
+
+        Returns:
+            True if the object has a valid name given by the user.
+
+        """
+        return self.has_name()

+
+    @property
+    def model(self):
+        """
+        This property returns the :class:`docplex.mp.model.Model` to which the object belongs.
+        """
+        return super().model

+
+
+
[docs]class IndexableObject(ModelingObjectBase):
+    __slots__ = ("_index",)
+
+    @staticmethod
+    def is_valid_index(idx):
+        # INTERNAL: This is where the valid index check is performed
+        return idx >= 0
+
+    _invalid_index = -2
+
+    # noinspection PyMissingConstructor
+    def __init__(self, model, name=None, index=_invalid_index):
+        #  ModelingObjectBase.__init__(self, model, name)
+        self._model = model
+        self._name = name
+        self._index = index
+
+
[docs]    def is_generated(self):
+        """ Checks whether this object has been generated by another modeling object.
+
+        If so, the origin object is stored in the ``_origin`` attribute.
+
+        Returns:
+            True if the objects has been generated.
+        """
+        return self.origin is not None

+
+    @property
+    def origin(self):
+        return self.model.get_obj_origin(self)
+
+    @origin.setter
+    def origin(self, origin):
+        self.model.set_obj_origin(self, origin)
+
+    def __hash__(self):
+        return id(self)
+
+    @property
+    def model(self):
+        return self._model
+
+    @property
+    def index(self):
+        return self._index
+
+    @property
+    def index1(self):
+        raw = self._index
+        return raw if raw == self._invalid_index else raw + 1
+
+    def _set_index(self, idx):
+        self._index = idx
+
+    def has_valid_index(self):
+        return self._index >= 0
+
+    def _set_invalid_index(self):
+        self._index = self._invalid_index
+
+    @property
+    def safe_index(self):
+        if not self.has_valid_index():
+            self.fatal("Modeling object {0!s} has invalid index: {1:d}", self, self._index)  # pragma: no cover
+        return self._index
+
+    @property
+    def container(self):
+        return self.model.get_var_container(self)
+
+    @container.setter
+    def container(self, ctn):
+        self._model.set_var_container(self, ctn)
+
+    @property
+    @abstractmethod
+    def cplex_scope(self) -> int:
+        return -1  # crash
+
+    def get_scope(self):
+        try:
+            cpx_scope = self.cplex_scope
+            return self.model._get_obj_scope(cpx_scope, error='ignore')
+        except AttributeError:
+            return None
+
+    @property
+    def scope(self):
+        return self.get_scope()

+
+
+
[docs]class Expr(ModelObject, Operand, _AbstractValuable):
+    """Expr()
+
+    Parent class for all expression classes.
+    """
+    __slots__ = ()
+
+    @property
+    def name(self):
+        return None
+
+    def clone(self):  # pragma: no cover
+        raise NotImplementedError  # pragma: no cover
+
+    def iter_variables(self):
+        # internal
+        raise NotImplementedError  # pragma: no cover
+
+    def copy(self, target_model, var_mapping):
+        # internal
+        raise NotImplementedError  # pragma: no cover
+
+
[docs]    def number_of_variables(self):
+        """
+        Returns:
+            integer: The number of variables in the expression.
+        """
+        return sum(1 for _ in self.iter_variables())  # pragma: no cover

+
+
[docs]    def contains_var(self, dvar):
+        """ Checks whether a variable is present in the expression.
+
+        :param: dvar (:class:`docplex.mp.dvar.Var`): A decision variable.
+
+        Returns:
+            Boolean: True if the variable is present in the expression, else False.
+        """
+        return any(dvar is v for v in self.iter_variables())

+
+    def to_string(self, nb_digits=None, use_space=False):
+        from io import StringIO
+        oss = StringIO()
+        if nb_digits is None:
+            nb_digits = self.model.float_precision
+        self.to_stringio(oss, nb_digits=nb_digits, use_space=use_space)
+        return oss.getvalue()
+
+    def to_readable_string(self):
+        return self.to_string(use_space=True)[:self.model.readable_str_len]
+
+    def to_stringio(self, oss, nb_digits, use_space, var_namer=lambda v: v.name):
+        raise NotImplementedError  # pragma: no cover
+
+    def _num_to_stringio(self, oss, num, ndigits=None, print_sign=False, force_plus=False, use_space=False):
+        k = num
+        if print_sign:
+            if k < 0:
+                sign = u'-'
+                k = -k
+            elif k > 0 and force_plus:
+                # force a plus
+                sign = u'+'
+            else:
+                sign = None
+            if use_space:
+                oss.write(u' ')
+            if sign:
+                oss.write(sign)
+            if use_space:
+                oss.write(u' ')
+        # INTERNAL
+        ndigits = ndigits or self.model.float_precision
+        try:
+            if k == int(k):
+                oss.write(u'%d' % k)
+            else:
+                # use second arg as nb digits:
+                oss.write(u"{0:.{1}f}".format(k, ndigits))
+        except ValueError:
+            # possibly a nan
+            oss.write('?')
+
+    # def __pos__(self):
+    #     # + e is identical to e
+    #     return self
+
+    def is_discrete(self):
+        raise NotImplementedError  # pragma: no cover
+
+
[docs]    def is_quad_expr(self):
+        """ Returns True if the expression is quadratic
+
+        """
+        return False

+
+    def get_linear_part(self):
+        return self  # should be not implemented...
+
+    def is_zero(self):
+        return False
+
+    constant = property(Operand.get_constant)
+
+    @property
+    def float_precision(self):
+        return 0 if self.is_discrete() else self.model.float_precision
+
+    def __pow__(self, power):
+        # INTERNAL
+        if 0 == power:
+            return 1
+        elif 1 == power:
+            return self
+        elif 2 == power:
+            return self.square()
+        else:
+            self.model.unsupported_power_error(self, power)
+
+    def square(self):
+        # redefine for each class of expression
+        return None  # pragma: no cover
+
+    def __gt__(self, e):
+        """ The strict > operator is not supported
+        """
+        self.model.unsupported_relational_operator_error(self, ">", e)
+
+    def __lt__(self, e):
+        """ The strict < operator is not supported
+        """
+        self.model.unsupported_relational_operator_error(self, "<", e)

+
+# ---
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/callbacks/cb_mixin.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/callbacks/cb_mixin.html new file mode 100644 index 0000000..61d2754 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/callbacks/cb_mixin.html @@ -0,0 +1,343 @@ + + + + + + + + + docplex.mp.callbacks.cb_mixin — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.callbacks.cb_mixin

+#!/usr/bin/python
+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2017
+# ---------------------------------------------------------------------------
+
+from docplex.mp.cplex_engine import CplexEngine
+
+
+
[docs]class ModelCallbackMixin(object):
+    """
+    This mixin class is intended as a bridge between DOcplex expression and constraints
+    and CPLEX callback API.
+    It is not intended to be instantiated directly, but to be inherited from in custom callbacks
+    , jointly with a CPLEX callback type.
+
+    For example, to define a custom BranchCallback in Docplex, define a new class which
+    inherits both from ModelCallbackMixin and the legacy callback class BranchCallback.
+
+    Note:
+        - `ModelCallbackMixin` should be first in inheritance order,
+        - the constructor of the custom callback class must take an `env` parameter to comply
+            with the CPLEX API
+        - the constructor of the custom callback must call two __init__() methods:
+            - one for the cplex callback class, taking an `env` parameter
+            - one for the mixin class.
+
+    Example:
+
+        class MyBranch(ModelCallbackMixin, cplex.callbacks.BranchCallback):
+
+            def __init__(self, env):
+                cplex.callbacks.BranchCallback.__init__(self, env)
+                ModelCallbackMixin.__init__(self)
+
+    A custom callback must be registered with a `Model` class using Model.register_callback; this method
+    assumes the custom callback has a model setter property to connect the model to the callback.
+
+
+        See Also:
+            :func:`docplex.mp.model.Model.register_callback`
+    """
+    def __init__(self):
+        self._model = None
+
+    @property
+    def model(self):
+        """ This property is used to get the model associated with the mixin.
+
+        An exception is raised if no model has been associated with the mixin.
+
+        :return: an instance of `docplex.mp.Model`
+        """
+        if not self._model:
+            raise ValueError('No model has been attached to the callback.')  # pragma: no cover
+        return self._model
+
+
[docs]    def index_to_var(self, var_index):
+        """ This method converts a variable index to a Var object.
+
+        A model must have been associated withthe mixin, otherwise an error is raised.
+
+        :param var_index: A valid variable index, that is a positive integer.
+
+        :return: A Docplex variable with this index, or None.
+        """
+        assert var_index >= 0
+        dv = self.model.get_var_by_index(var_index)
+        return dv

+
+
[docs]    @staticmethod
+    def linear_ct_to_cplex(linear_ct):
+        """ Converst a DOcplex linear constraint to CPLEX Python data
+
+        :param linear_ct: a DOcplex linear constraint.
+        :return: a 3-tuple containing elements representing the constraint in CPLEX-Python
+            - a list of two lists, indices and coefficients , representing the linear part
+            - a floating point number , the "right hand side" or rhs
+            - a one-letter string (possible values are: 'L', 'E', 'G')  representing the sense of the constraint.
+
+        Example:
+            Assuming variable X has index 1, the constraint (2X <= 7) will be converted to
+
+            ct = 2 * X <= 7
+            linear_ct_cplex(ct)
+            >>> [[1], [2.0]], 7.0, 'L'
+
+        """
+        cpx_lhs = CplexEngine.linear_ct_to_cplex(linear_ct=linear_ct)
+        cpx_rhs = linear_ct.cplex_num_rhs()
+        cpx_sense = linear_ct.sense.cplex_code
+        return cpx_lhs, cpx_sense, cpx_rhs

+
+
[docs]    def make_solution_from_vars(self, dvars):
+        """ Creates an intermediate solution from a list of variables.
+
+        :param dvars: a list of DOcplex variables.
+        :return: a :class:`docplex.mp.solution.SolveSolution` object.
+        """
+        if dvars:
+            indices = [v._index for v in dvars]
+            # this calls the Cplex callback method get_values, which crashes if called with empty list
+            # noinspection PyUnresolvedReferences
+            var_values = super(ModelCallbackMixin, self).get_values(indices)
+            # noinspection PyArgumentList
+            var_value_dict = {v: val for v, val in zip(dvars, var_values)}
+        else:  # pragma: no cover
+            var_value_dict = {}
+        return self.model.new_solution(var_value_dict)

+
+
[docs]    def make_complete_solution(self):
+        """ Creates and returns an intermediate solution with all variables.
+
+        Values are taken from the `get_values()` method of the callback
+
+        :return: a :class:`docplex.mp.solution.SolveSolution` object.
+        """
+        all_vars = list(self.model.iter_variables())
+        return self.make_solution_from_vars(all_vars)

+
+    # compatibility
+    make_solution = make_complete_solution

+
+
+
[docs]class ConstraintCallbackMixin(ModelCallbackMixin):
+
+    def __init__(self):
+        ModelCallbackMixin.__init__(self)
+        self._ct_vars = None
+        self.cts = []
+        self._vars = []
+
+    def register_constraints(self, cts):
+        self.cts.extend(cts)
+        self._ct_vars = None
+
+    def register_constraint(self, ct):
+        self.register_constraints([ct])
+
+
[docs]    def register_watched_var(self, dvar):
+        """ Register one variable.
+
+        Registered variables will be part of the intermediate solutions.
+
+        """
+        self._vars.append(dvar)

+
+
[docs]    def register_watched_vars(self, dvars):
+        """ Register an iterable of  variables.
+
+        Registered variables will be part of the intermediate solutions.
+
+        """
+        self._vars.extend(dvars)

+
+    @staticmethod
+    def _collect_constraint_variables(cts):
+        # collect variables as a set
+        var_set = set(v for c in cts for v in c.iter_variables())
+        # convert to list
+        var_list = list(var_set)
+        var_list.sort(key=lambda dv: dv._index)
+        return var_list
+
+    def _get_or_collect_vars(self):
+        # INTERNAL
+        if self._ct_vars is None:
+            self._ct_vars = self._collect_constraint_variables(self.cts)
+        return self._ct_vars
+
+    @property
+    def watched_vars(self):
+        return self._get_or_collect_vars() + self._vars
+
+
[docs]    def make_solution_from_watched(self):
+        """ Creates and returns a DOcplex solution instance from watched items.
+
+        This method should be called when CPLEX has a new incumbent solution.
+        It builds an intermediate solution from the watched variables and
+        variables mentioned in the registered constraints..
+
+        To build a soluton from all variables, use `make_complete_solution()`
+
+        :return:
+            An instance of SolveSolution.
+        """
+        return self.make_solution_from_vars(self.watched_vars)

+
+
[docs]    def get_cpx_unsatisfied_cts(self, cts, sol, tolerance=1e-6):
+        """ returns the subset of unsatisfied constraints in a given solution.
+        This is used in custom lazy constraints or user cut callbacks.
+
+        :param cts: a list of constraints among which to look for unsatisfied
+        :param sol: A solution object
+        :param tolerance: amn optional numerical value used to determine
+            whether a constraint is satisfied or not. Defaut is 1e-6.
+
+        :return: a list of tuples (ct, lhs, sense, lhs) where:
+            ct is an unsatisfied constraint
+            lhs is the left-hand size, as expected by the cplex callback
+            sense is the constraint sense, as expected by the cplex callback
+            rhs is the rith-and side (a number), as expected by the cplex callback
+
+        """
+        unsatisfied = []
+        for ct in cts:
+            if not ct.is_satisfied(sol, tolerance):
+                # use mixin API to convert to cplex lingo
+                cpx_lhs, cpx_sense, cpx_rhs = self.linear_ct_to_cplex(ct)
+                unsatisfied.append( (ct, cpx_lhs, cpx_sense, cpx_rhs) )
+        return unsatisfied

+
+
+
+
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/conflict_refiner.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/conflict_refiner.html new file mode 100644 index 0000000..0cf99fa --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/conflict_refiner.html @@ -0,0 +1,523 @@ + + + + + + + + + docplex.mp.conflict_refiner — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.conflict_refiner

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+import warnings
+from collections import namedtuple, defaultdict
+
+from docplex.mp.utils import is_string
+from docplex.mp.constants import ComparisonType, VarBoundType
+from docplex.mp.utils import str_maxed
+from docplex.mp.publish import PublishResultAsDf
+
+
+TConflictConstraint = namedtuple("_TConflictConstraint", ["name", "element", "status"])
+
+
+def trim_field(element):
+    return str_maxed(element, maxlen=50)
+
+
+def to_output_table(conflicts, use_df=True):
+    # Returns the output tables, as df if pandas is available or as a list
+    # of named tuple ['Type', 'Status', 'Name', 'Expression']
+    columns = ['Type', 'Status', 'Name', 'Expression']
+    TOutputTables = namedtuple('TOutputTables', columns)
+
+    def convert_to_pandas_df(c):
+        return {'Type': 'Constraint',
+                'Status': c.status.name if c.status is not None else '',
+                'Name': c.name or '',
+                'Expression': trim_field(c.element)}
+
+    def convert_to_namedtuples(c):
+        return TOutputTables('Constraint',
+                             c.status,
+                             c.name or '',
+                             trim_field(c.element))
+
+    pandas = None
+    if use_df:
+        try:
+            import pandas
+        except ImportError:  # pragma: no cover
+            print("pandas module not found...")
+            pandas = None
+
+    data_converter = convert_to_pandas_df if pandas and use_df else convert_to_namedtuples
+    output_data = list(map(data_converter, conflicts))
+
+    if use_df:
+        return pandas.DataFrame(columns=columns, data=output_data)
+    else:
+        return output_data
+
+
+
[docs]class ConflictRefinerResult(object):
+    """ This class contains all conflicts as returned by the conflict refiner.
+
+    A conflict refiner result contains a list of named tuples of type ``TConflictConstraint``,
+    the fields of which are:
+
+        - an enumerated value of type  ``docplex.mp.constants.ConflictStatus`` that indicates the
+                  conflict status type (Excluded, Possible_member, Member...).
+        - the name of the constraint or None if the constraint corresponds to a variable lower or upper bound.
+        - a modeling object involved in the conflict:
+            can be either a constraint or a wrapper representing a variable upper or lower bound.
+
+
+        *New in version 2.11*
+    """
+
+    def __init__(self, conflicts, refined_by=None):
+        self._conflicts = conflicts
+        assert refined_by is None or is_string(refined_by)
+        self._refined_by = refined_by
+
+    @property
+    def refined_by(self):
+        '''
+        Returns a string indicating how the conflicts were produced.
+
+        - If the conflicts are created by a program, this field returns None.
+        - If the conflicts originated from a local CPLEX run, this method returns 'cplex_local'.
+        - If the conflicts originated from a DOcplexcloud run, this method returns 'cplex_cloud'.
+
+        Returns:
+            A string, or None.
+
+        '''
+        return self._refined_by
+
+    def __iter__(self):
+        return self.iter_conflicts()
+
+    def __len__(self):
+        """ Redefintion of maguic method __len__.
+
+        Allows calling len() on an instance of ConflictRefinerResult
+        to get the number of conflicts
+
+        :return: the number of conflicts.
+        """
+        return len(self._conflicts)
+
+
[docs]    def iter_conflicts(self):
+        """ Returns an iterator on conflicts (named tuples)
+
+        :return: an iterator
+        """
+        return iter(self._conflicts)

+
+    @property
+    def number_of_conflicts(self):
+        """ This property returns the number of conflicts. """
+        return len(self._conflicts)
+
+
[docs]    def display(self):
+        """ Displays all conflicts.
+
+        """
+        print('conflict(s): {0}'.format(self.number_of_conflicts))
+        for conflict in self.iter_conflicts():
+            st = conflict.status
+            elt = conflict.element
+            if hasattr(conflict.element, 'as_constraint'):
+                ct = conflict.element.as_constraint()
+                label = elt.short_typename
+            else:
+                ct = elt
+                label = ct.__class__.__name__
+            print("  - status: {1}, {0}: {2!s}".format(label, st.name, ct.to_readable_string()))

+
+
[docs]    def display_stats(self):
+        """ Displays statistics on conflicts.
+
+        Display show many conflict elements per type.
+        """
+        def elt_typename(elt):
+            try:
+                return elt.short_typename.lower()
+            except AttributeError:  # pragma: no cover
+                return elt.__class__.__name__.lower()
+
+        ncf = self.number_of_conflicts
+        print('conflict{1}: {0}'.format(ncf, "s" if ncf > 1 else ""))
+        cf_stats = defaultdict(lambda: 0)
+        for conflict in self.iter_conflicts():
+            elt_type = elt_typename(conflict.element)
+            cf_stats[elt_type] += 1
+        for eltt, count in cf_stats.items():
+            if count:
+                print("  - {0}{2}: {1}".format(eltt, count, ("s" if count > 1 else "")))

+
+    def as_output_table(self, use_df=True):
+        return to_output_table(self, use_df)
+
+
[docs]    def print_information(self):
+        """ Similar as `display_stats`
+        """
+        self.display_stats()

+
+
+class VarBoundWrapper(object):
+    # INTERNAL
+
+    def __init__(self, dvar):
+        self._var = dvar
+
+    @property
+    def var(self):
+        return self._var
+
+    @property
+    def index(self):
+        return self._var.index
+
+    @property
+    def short_typename(self):  # pragma: no cover
+        return "Variable Bound"
+
+    def as_constraint(self):  # pragma: no cover
+        raise NotImplementedError
+
+    def as_constraint_from_symbol(self, op_symbol):
+        self_var = self.var
+        var_lb = self.var.lb
+        op = ComparisonType.cplex_ctsense_to_python_op(op_symbol)
+        ct = op(self_var, var_lb)
+        return ct
+
+    @classmethod
+    def make_wrapper(cls, var, bound_type):
+        if bound_type == VarBoundType.LB:
+            return VarLbConstraintWrapper(var)
+        elif bound_type == VarBoundType.UB:
+            return VarUbConstraintWrapper(var)
+        else:
+            return None
+
+
+
[docs]class VarLbConstraintWrapper(VarBoundWrapper):
+    """
+    This class is a wrapper for a model variable and its associated lower bound.
+
+    Instances of this class are created by the ``refine_conflict`` method when the conflict involves
+    a variable lower bound. Each of these instances is then referenced by a ``TConflictConstraint`` namedtuple
+    in the conflict list returned by ``refine_conflict``.
+
+    To check whether the lower bound of a variable causes a conflict, wrap the variable and
+    include the resulting constraint in a ConstraintsGroup.
+    """
+    @property
+    def short_typename(self):
+        return "Lower Bound"
+
+    def as_constraint(self):
+        return self.as_constraint_from_symbol('G')

+
+
+
[docs]class VarUbConstraintWrapper(VarBoundWrapper):
+    """
+    This class is a wrapper for a model variable and its associated upper bound.
+
+    Instances of this class are created by the ``refine_conflict`` method when the conflict involves
+    a variable upper bound. Each of these instances is then referenced by a ``TConflictConstraint`` namedtuple
+    in the conflict list returned by ``refine_conflict``.
+
+    To check whether the upper bound of a variable causes a conflict, wrap the variable and
+    include the resulting constraint in a ConstraintsGroup.
+    """
+
+    @property
+    def short_typename(self):
+        return "Upper Bound"
+
+    def as_constraint(self):
+        return self.as_constraint_from_symbol('L')

+
+
+
[docs]class ConstraintsGroup(object):
+    """
+    This class is a container for the definition of a group of constraints.
+    A preference for conflict refinement is associated to the group.
+
+    Groups may be assigned preference. A group with a higher preference is more likely to be included in the conflict.
+    A negative value specifies that the corresponding group should not be considered in the computation
+    of a conflict. In other words, such groups are not considered part of the model. Groups with a preference of 0 (zero)
+    are always considered to be part of the conflict.
+
+    Args:
+        preference: A floating-point number that specifies the preference for the group. The higher the number, the
+                    higher the preference.
+    """
+
+    __slots__ = ('_preference', '_cts')
+
+    def __init__(self, preference=1.0, cts=None):
+        self._preference = preference
+        self._cts = []
+        if cts is not None:
+            self.add_constraints(cts)
+
+
[docs]    @classmethod
+    def from_var(cls, dvar, bound_type, pref):
+        """ A class method to build a group fromone variable.
+
+        :param dvar: The variable whose bound is part of the conflict.
+        :param bound_type: An enumerated value of type `VarBoundType`
+        :param pref: a numerical preference.
+
+        :return: an instance of ConstraintsGroup.
+
+        See Also:
+            :class:`docplex.mp.constants.VarBoundType`
+        """
+        cgg = cls(preference=pref, cts=VarBoundWrapper.make_wrapper(dvar, bound_type))
+        return cgg

+
+    @property
+    def preference(self):
+        return self._preference
+
+    def add_one(self, x):
+        if x is not None:
+            self._cts.append(x)
+
+    def add_constraint(self, ct):
+        self._cts.append(ct)
+
+    def add_constraints(self, cts):
+        try:
+            for ct in cts:
+                self.add_one(ct)
+        except TypeError:  # not iterable.
+            self.add_one(cts)
+
+    def iter_constraints(self):
+        return iter(self._cts)

+
+
+
[docs]class ConflictRefiner(PublishResultAsDf, object):
+    ''' This class is an abstract algorithm; it operates on interfaces.
+
+    A conflict is a set of mutually contradictory constraints and bounds within a model.
+    Given an infeasible model, the conflict refiner can identify conflicting constraints and bounds
+    within it. CPLEX refines an infeasible model by examining elements that can be removed from the
+    conflict to arrive at a minimal conflict.
+    '''
+
+    # static variables for output
+    output_table_property_name = 'conflicts_output'
+    default_output_table_name = 'conflicts.csv'
+    output_table_using_df = True
+
+    def __init__(self, output_processing=None):
+        self.output_table_customizer = output_processing
+
+    @classmethod
+    def _make_atomic_ct_groups(cls, mdl_iter, pref):
+        # returns a list of singleton groups from a model iterator and a numerical preference.
+        lcgrps = [ConstraintsGroup(pref, ct) for ct in mdl_iter]
+        return lcgrps
+
+
[docs]    @classmethod
+    def var_bounds(cls, mdl, pref=4.0, include_infinity_bounds=True):
+        """ Returns a list of singleton groups with variable bounds.
+
+        This method a list of ConstraintGroup objects, each of which contains a variabel bound.
+        It replicate sthe behavior of the CPLEX interactive optimizer, that is, it returns
+
+        - lower bounds for non-binary variables if different from 0
+        - upper bound for non-binary-variables if non-default
+
+        For binary variables, bounds are not considered, unless the variable is bound; more precisely:
+            - lower bound is included if >= 0.5
+            - upper bound is included if <= 0.5
+
+        :param mdl: The model being analyzed for conflicts,
+        :param pref: the preference for variable bounds, the defaut is 4.0
+        :param include_infinity_bounds: a flag indicating whether infi
+
+        :return: a list of `ConstraintsGroup` objects.
+        """
+        grps = []
+        mdl_inf = mdl.infinity
+        for dv in mdl.iter_variables():
+            lb, ub = dv.lb, dv.ub
+            if not dv.is_binary():
+                if lb != 0:
+                    if include_infinity_bounds or lb > - mdl_inf:
+                        grps.append(ConstraintsGroup.from_var(dv, VarBoundType.LB, pref))
+                if include_infinity_bounds or ub < mdl_inf:
+                    grps.append(ConstraintsGroup.from_var(dv, VarBoundType.UB, pref))
+            else:
+                if lb >= 0.5:
+                    grps.append(ConstraintsGroup.from_var(dv, VarBoundType.LB, pref))
+                if ub <= 0.5:
+                    grps.append(ConstraintsGroup.from_var(dv, VarBoundType.UB, pref))
+        return grps

+
+    @classmethod
+    def linear_constraints(cls, mdl, pref=2.0):
+        return cls._make_atomic_ct_groups(mdl.iter_linear_constraints(), pref)
+
+    @classmethod
+    def logical_constraints(cls, mdl, pref=1.0):
+        return cls._make_atomic_ct_groups(mdl.iter_logical_constraints(), pref)
+
+    @classmethod
+    def quadratic_constraints(cls, mdl, pref=1.0):
+        return cls._make_atomic_ct_groups(mdl.iter_quadratic_constraints(), pref)
+
+
[docs]    def refine_conflict(self, mdl, preferences=None, groups=None, display=False, **kwargs):
+        """ Starts the conflict refiner on the model.
+
+        Args:
+            mdl: The model to be relaxed.
+            preferences: A dictionary defining constraint preferences.
+            groups: A list of ConstraintsGroups.
+            display: a boolean flag (default is True); if True, displays the result at the end.
+            kwargs: Accepts named arguments similar to solve.
+
+        Returns:
+            An object of type `ConflictRefinerResut` which holds all information about
+            the minimal conflict.
+
+        See Also:
+            :class:`ConflictRefinerResult`
+
+        """
+
+        if mdl.has_multi_objective():
+            mdl.fatal("Conflict refiner is not supported for multi-objective")
+
+        # take into account local argument overrides
+        context = mdl.prepare_actual_context(**kwargs)
+
+        # log stuff
+        saved_context_log_output = mdl.context.solver.log_output
+        saved_log_output_stream = mdl.log_output
+
+        try:
+            mdl.set_log_output(context.solver.log_output)
+            if mdl.environment.has_cplex:
+                results = self._refine_conflict_local(mdl, context, preferences, groups)
+            else:
+                return mdl.fatal("CPLEX runtime not found: cannot run conflict refiner")
+
+            # write conflicts table.write_output_table() handles everything related to
+            # whether the table should be published etc...
+            if self.is_publishing_output_table(mdl.context):
+                self.write_output_table(results.as_output_table(self.output_table_using_df), mdl.context)
+            if display:
+                results.display_stats()
+            return results
+        finally:
+            if saved_log_output_stream != mdl.log_output:
+                mdl.set_log_output_as_stream(saved_log_output_stream)
+            if saved_context_log_output != mdl.context.solver.log_output:
+                mdl.context.solver.log_output = saved_context_log_output

+
+    # noinspection PyMethodMayBeStatic
+    def _refine_conflict_local(self, mdl, context, preferences=None, groups=None):
+        parameters = context.cplex_parameters
+        self_engine = mdl.get_engine()
+        return self_engine.refine_conflict(mdl, preferences, groups, parameters)
+
+
[docs]    @staticmethod
+    def display_conflicts(conflicts):
+        """
+        This method displays a formatted representation of the conflicts that are provided.
+
+        Args:
+           conflicts: An instance of ``ConflictRefinerResult``
+        """
+        warnings.warn("deprecated: use ConflictRefinerresult.display", DeprecationWarning)
+        conflicts.display()

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/constants.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/constants.html new file mode 100644 index 0000000..41264e9 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/constants.html @@ -0,0 +1,743 @@ + + + + + + + + + docplex.mp.constants — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.constants

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+import operator
+from enum import Enum
+
+from docplex.mp.error_handler import docplex_fatal
+from docplex.mp.utils import is_string, is_int
+
+
+
[docs]class VarBoundType(Enum):
+    """This enumerated class describes the two types of variable bounds:
+        - LB is for lower bound
+        - UB is for uupper bound
+
+    This enumerated type is used in conflict refiner.
+    """
+    LB = 0
+    UB = 1

+
+
+
[docs]class ComparisonType(Enum):
+    """This enumerated class defines the various types of linear constraints:
+
+        - LE for e1 <= e2 constraints
+
+        - EQ for e1 == e2 constraints
+
+        - GE for e1 >= e2 constraints
+
+        where e1 and e2 denote linear expressions.
+    """
+    LE = 1, '<=', 'L', operator.le
+    EQ = 2, '==', 'E', operator.eq
+    GE = 3, '>=', 'G', operator.ge
+
+    def __new__(cls, code, operator_symbol, cplex_kw, python_op):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = code
+        obj._cplex_code = cplex_kw
+        obj._op_symbol = operator_symbol
+        obj._pyop = python_op
+        return obj
+
+    # NOTE: Never add a static field in an enum class: it would be interpreted as an other enum
+
+    @property
+    def short_name(self):
+        return self.name
+
+    @property
+    def cplex_code(self):
+        return self._cplex_code
+
+    @property
+    def operator_symbol(self):
+        """ Returns a string operator for the constraint.
+
+        Example:
+            Returns string "<=" for a e1 <= e2 constraint.
+
+        Returns:
+            string: A string describing the logical operator used in the constraint.
+        """
+        return self._op_symbol
+
+    @property
+    def python_operator(self):
+        return self._pyop
+
+    @classmethod
+    def parse(cls, arg, do_raise=True):
+        # INTERNAL
+        # noinspection PyTypeChecker
+        for op in cls:
+            if arg in (op, op.value):
+                return op
+            elif is_string(arg):
+                if arg == op._cplex_code \
+                        or arg == str(op.value) \
+                        or arg.lower() == op.name.lower():
+                    return op
+        # not found
+        if do_raise:
+            docplex_fatal('cannot convert this to a comparison type: {0!r}'.format(arg))
+        else:
+            return None
+
+    @classmethod
+    def cplex_ctsense_to_python_op(cls, cpx_sense):
+        return cls.parse(cpx_sense).python_operator
+
+    @classmethod
+    def almost_compare(cls, lval, op, rval, eps):
+        if op is cls.LE:
+            # lval <= rval with eps tolerance means lval-rval <= e
+            return lval - rval <= eps
+        elif op is cls.GE:
+            # lval >= rval with eps tolerance means lval-rval >= -eps
+            return lval - rval >= -eps
+        elif op is cls.EQ:
+            return abs(lval - rval) <= eps
+        else:
+            raise TypeError
+
+    @classmethod
+    def almost_equal(cls, lval, rval, eps):
+        return cls.almost_compare(lval, cls.EQ, rval, eps)

+
+
+
[docs]class RelaxationMode(Enum):
+    """ This enumerated type describes the different strategies for model relaxation:
+      - MinSum, OptSum,
+      - MinInf, OptInf,
+      - MinQuad, OptQuad.
+
+    A relaxation algorithms works in two phases: In the first phase, it finds a
+    feasible solution while making minimal changes to the model (according to a metric).
+    In the second phase, it
+    searches for an optimal solution while keeping the relaxation at the minimal value found in phase 1.
+
+    Enumerated values work in pairs: MinXXX, OptXXX
+    
+        - MinXXX values stop at phase 1, they look for a feasible soluion, they do not
+          optimize the objective.
+        - OptXXX run the two phases, looking for an optimal relaxed solution. They take longer.
+
+    The metric used to evaluate the quality of the relaxation is determined by the XXX part of
+    the name. There are three metrics:
+    
+        - Inf (MinInf, OptInf) minimizes the number of relaxed constraints.  This metric
+          will prefer to relax one constraint, even with a huge slack, instead of two.
+        - Sum (MinSum, OptSum): minimizes the sum of relaxations.
+        - Quand (MinQuad, OptQuad): minimizes the sum of squares of relaxations.
+          This metric is the most expensive in computation time,
+          but avoids huge discrepancies between relaxations:
+          two constraints with relaxations of 2,2 will have a better quality (2^2 + 2^2 = 8)
+          than relaxations of 3,1 (3^2 +1 = 10).
+    """
+
+    MinSum, OptSum, MinInf, OptInf, MinQuad, OptQuad = range(6)
+
+    @staticmethod
+    def parse(arg):
+        # INTERNAL
+        # noinspection PyTypeChecker
+        for m in RelaxationMode:
+            if arg == m or arg == m.value:
+                return m
+            elif is_string(arg):
+                if arg == str(m.value) or arg.lower() == m.name.lower():
+                    return m
+
+        docplex_fatal('cannot parse this as a relaxation mode: {0!r}'.format(arg))
+
+    @staticmethod
+    def get_no_optimization_mode(mode):
+        assert isinstance(mode, RelaxationMode)
+        # even values are MinXXX modes
+        relax_code = mode.value
+        if 0 == relax_code % 2:
+            return mode
+        else:
+            # OptXXX is 2k+1 when MinXXX is 2k
+            return RelaxationMode(relax_code - 1)
+
+    def __repr__(self):
+        return 'docplex.mp.RelaxationMode.{0}'.format(self.name)

+
+
+
[docs]class ConflictStatus(Enum):
+    """
+    This enumerated class defines the conflict status types.
+    """
+    Excluded, Possible_member, Possible_member_lower_bound, Possible_member_upper_bound, \
+      Member, Member_lower_bound, Member_upper_bound = -1, 0, 1, 2, 3, 4, 5

+
+
+
[docs]class SOSType(Enum):
+    """This enumerated class defines the SOS types:
+
+        - SOS1 for SOS type 1
+
+        - SOS1 for SOS type 2.
+    """
+    SOS1, SOS2 = 1, 2
+
+    def __new__(cls, size):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = size
+        obj.cpx_sos_type = str(size)
+        return obj
+
+    @staticmethod
+    def parse(arg,
+              sos1_tokens=frozenset(['1', 'sos1']),
+              sos2_tokens=frozenset(['2', 'sos2'])):
+        if isinstance(arg, SOSType):
+            return arg
+        elif 1 == arg:
+            return SOSType.SOS1
+        elif 2 == arg:
+            return SOSType.SOS2
+        elif is_string(arg):
+            arg_lower = arg.lower()
+            if arg_lower in sos1_tokens:
+                return SOSType.SOS1
+            elif arg_lower in sos2_tokens:
+                return SOSType.SOS2
+
+        docplex_fatal("Cannot convert to SOS type: {0!s} - expecting 1|2|'sos1'|'sos2'", arg)
+
+    @property
+    def size(self):
+        return self.value
+
+    def __repr__(self):
+        return 'docplex.mp.SOSType.{0}'.format(self.name)

+
+
+
[docs]class SolveAttribute(Enum):
+    duals = 1, False, True
+    slacks = 2, False, True
+    reduced_costs = 3, True, True
+
+    def __new__(cls, code, is_for_vars, requires_solve):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = code
+        obj.is_var_attribute = is_for_vars
+        obj.requires_solve = requires_solve
+        return obj
+
+    @classmethod
+    def parse(cls, arg, do_raise=True):
+        # INTERNAL
+        # noinspection PyTypeChecker
+        for m in cls:
+            if arg == m or arg == m.value:
+                return m
+            elif is_string(arg):
+                if arg == str(m.value) or arg.lower() == m.name.lower():
+                    return m
+
+        if do_raise:
+            docplex_fatal('cannot convert this to a solve attribute: {0!r}'.format(arg))
+        else:
+            return None

+
+
+
[docs]class UpdateEvent(Enum):
+    # INTERNAL
+    NoOp = 0
+    #
+    # Linear constraint events
+    LinearConstraintCoef = 1
+    LinearConstraintRhs = 2
+    LinearConstraintGlobal = 3  # logical and of Coef + Rhs
+    ConstraintSense = 4
+
+    # Range constraint events
+    RangeConstraintBounds = 5
+    RangeConstraintExpr = 6
+
+    # Expression events
+    ExprConstant = 8
+    LinExprCoef = 16
+    LinExprGlobal = 24
+    LinExprPromotedToQuad = 25  # objective is ok, constraint wont support this.
+
+    # Quad
+    QuadExprQuadCoef = 32
+    QuadExprGlobal = 64
+
+    # Ind
+    IndicatorLinearConstraint = 128
+
+    # Quadct
+    QuadraticConstraintGlobal = 256
+
+    def __bool__(self):
+        return bool(self.value)

+
+
+
[docs]class ObjectiveSense(Enum):
+    """
+    This enumerated class defines the two types of objectives, `Minimize` and `Maximize`.
+    """
+    Minimize, Maximize = 1, 2
+
+
[docs]    def is_minimize(self):
+        """ Returns True if objective is a minimizing objective.
+        """
+        return self is ObjectiveSense.Minimize

+
+
[docs]    def is_maximize(self):
+        """ Returns True if objective is a maximizing objective.
+        """
+        return self is ObjectiveSense.Maximize

+
+    @property
+    def verb(self):
+        """ Returns a string describing the objective (in lowercase)
+
+            - 'minimize' for the Minimize objective
+            - 'maximize' for the Maximize objective
+
+        """
+        return self.name.lower()
+
+    @property
+    def short_name(self):
+        """ Returns a short ('min' or 'max') string describing the objective.
+        """
+        return self.verb[:3]
+
+    @property
+    def cplex_coef(self):
+        return 1 if self.is_minimize() else -1
+
+    @classmethod
+    def from_cplex(cls, cpx_sense):
+        if cpx_sense == 1:
+            return cls.Minimize
+        elif cpx_sense == -1:
+            return cls.Maximize
+        else:
+            raise ValueError("expecting +1 or -1, {0} was passed".format(cpx_sense))
+
+
[docs]    @staticmethod
+    def parse(arg, logger=None):
+        """ Converts an argument to an objective sense.
+
+        Accepts either
+        - an objective sense (returns itself)
+        - a string (in  long or short format),
+        - an integer (in CPLEX convention, 1 is for minimize, -1 for maximize).
+
+        :param arg: the argument to convert to a sense
+        :param logger:
+
+        :return: An instance of enumerated `ObjectiveSense` class.
+        """
+        if isinstance(arg, ObjectiveSense):
+            return arg
+
+        elif is_string(arg):
+            lower_text = arg.lower()
+            if lower_text in {"minimize", "min"}:
+                return ObjectiveSense.Minimize
+            elif lower_text in {"maximize", "max"}:
+                return ObjectiveSense.Maximize
+            elif logger:
+                logger.fatal("Not an objective sense: '{0}', expecting 'min|max'", arg)
+            else:
+                docplex_fatal("Not an objective sense: '{0}', expecting 'min|max'".format(arg))
+        elif is_int(arg):
+            if arg == 1:
+                return ObjectiveSense.Minimize
+            elif -1 == arg:
+                return ObjectiveSense.Maximize
+            else:
+                logger.fatal("Not an objective sense: <{}>", (arg,))
+
+        if logger:
+            logger.fatal("Not an objective sense: <{}>", (arg,))
+        else:
+            docplex_fatal("Not an objective sense: <{}>".format(arg))

+
+
+# noinspection PyPep8
+
[docs]class CplexScope(Enum):
+    def __new__(cls, code, prefix, descr):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = code
+        obj.prefix = prefix
+        obj.descr = descr
+        return obj
+
+    # INTERNAL
+    VAR_SCOPE = 0, 'x', 'variables'
+    LINEAR_CT_SCOPE = 1, 'c', 'linear constraints'
+    IND_CT_SCOPE = 2, 'ic', 'indicator constraints'
+    QUAD_CT_SCOPE = 3, 'qc', 'quadratic constraints'
+    PWL_CT_SCOPE = 4, 'pwl', 'piecewise constraints'
+    SOS_SCOPE = 5, 'sos', 'SOS'
+
+    def is_constraint_scope(self):
+        return self._value_ in frozenset([1, 2, 3, 4])

+
+
+
[docs]class QualityMetric(Enum):
+    def __new__(cls, code, has_int, cpx_codename):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = code
+        obj.has_int = has_int
+        obj.codename = cpx_codename
+        return obj
+
+    @property
+    def cpx_codename(self):
+        return 'CPX_' + self.codename
+
+    @property
+    def code(self):
+        return self._value_
+
+    @property
+    def key(self):
+        return self.codename.lower()
+
+    @property
+    def int_key(self):
+        return '%s.int' % self.codename.lower()
+
+    max_primal_infeasibility = 1, 1, 'MAX_PRIMAL_INFEAS'
+    max_scaled_primal_infeasibility = 2, 1, 'MAX_SCALED_PRIMAL_INFEAS'
+    sum_primal_infeasibilities = 3, 0, 'SUM_PRIMAL_INFEAS'
+    sum_scaled_primal_infeasibilities = 4, 0, 'SUM_SCALED_PRIMAL_INFEAS'
+
+    max_dual_infeasibility = 5, 1, 'MAX_DUAL_INFEAS'
+    max_scaled_dual_infeasibility = 6, 1, 'MAX_SCALED_DUAL_INFEAS'
+    sum_dual_infeasibilities = 7, 0, 'SUM_DUAL_INFEAS'
+    sum_scaled_dual_infeasibilities = 8, 0, 'SUM_SCALED_DUAL_INFEAS'
+
+    max_int_infeasibility = 9, 1, 'MAX_INT_INFEAS'
+    sum_integer_infeasibilities = 10, 0, 'SUM_INT_INFEAS'
+
+    max_primal_residual = 11, 1, 'MAX_PRIMAL_RESIDUAL'
+    max_scaled_primal_residual = 12, 1, 'MAX_SCALED_PRIMAL_RESIDUAL'
+    sum_primal_residual = 13, 0, 'SUM_PRIMAL_RESIDUAL'
+    sum_scaled_primal_residual = 14, 0, 'SUM_SCALED_PRIMAL_RESIDUAL'
+
+    max_dual_residual = 15, 1, 'MAX_DUAL_RESIDUAL'
+    max_scaled_dual_residual = 16, 1, 'MAX_SCALED_DUAL_RESIDUAL'
+    sum_dual_residual = 17, 0, 'SUM_DUAL_RESIDUAL'
+    sum_scaled_dual_residual = 18, 0, 'SUM_SCALED_DUAL_RESIDUAL'
+
+    max_comp_slack = 19, 1, 'MAX_COMP_SLACK'  # gap here
+    sum_comp_slack = 21, 0, 'SUM_COMP_SLACK'  # gap here
+
+    max_x = 23, 1, 'MAX_X'
+    max_scaled_x = 24, 1, 'MAX_SCALED_X'
+    max_pi = 25, 1, 'MAX_PI'
+    max_scaled_pi = 26, 1, 'MAX_SCALED_PI'
+    max_slack = 27, 1, 'MAX_SLACK'
+    max_scaled_slack = 28, 1, 'MAX_SCALED_SLACK'
+
+    max_reduced_cost = 29, 1, 'MAX_RED_COST'
+    max_scaled_reduced_cost = 30, 1, 'MAX_SCALED_RED_COST'
+
+    sum_x = 31, 0, 'SUM_X'
+    sum_scaled_x = 32, 0, 'SUM_SCALED_X'
+    sum_pi = 33, 0, 'SUM_PI'
+    sum_scaled_pi = 34, 0, 'SUM_SCALED_PI'
+    sum_slack = 35, 0, 'SUM_SLACK'
+    sum_scaled_slack = 36, 0, 'SUM_SCALED_SLACK'
+
+    sum_reduced_cost = 37, 0, 'SUM_RED_COST'
+    sum_scaled_reduced_cost = 38, 0, 'SUM_SCALED_RED_COST'
+
+    kappa = 39, 0, 'KAPPA'
+    objective_gap = 40, 0, 'OBJ_GAP'
+    dual_objective = 41, 0, 'DUAL_OBJ'
+    primal_objective = 42, 0, 'PRIMAL_OBJ'
+
+    max_quadratic_primal_residual = 43, 1, 'MAX_QCPRIMAL_RESIDUAL'
+    sum_quadratic_primal_residual = 44, 0, 'SUM_QCPRIMAL_RESIDUAL'
+    max_quadratic_slack_infeasibility = 45, 1, 'MAX_QCSLACK_INFEAS'
+    sum_quadratic_slack_infeasibility = 46, 0, 'SUM_QCSLACK_INFEAS'
+    max_quadratic_slack = 47, 1, 'MAX_QCSLACK'
+    sum_quadratic_slack = 48, 0, 'SUM_QCSLACK'
+    max_indicator_slack_infeasibility = 49, 1, 'MAX_INDSLACK_INFEAS'
+    sum_indicator_slack_infeasibility = 50, 0, 'SUM_INDSLACK_INFEAS'
+
+    exact_kappa = 51, 0, 'EXACT_KAPPA'
+    kappa_stable = 52, 0, 'KAPPA_STABLE'
+    kappa_suspicious = 53, 0, 'KAPPA_SUSPICIOUS'
+    kappa_unstable = 54, 0, 'KAPPA_UNSTABLE'
+    kappa_illposed = 55, 0, 'KAPPA_ILLPOSED'
+    kappa_max = 56, 0, 'KAPPA_MAX'
+    kappa_attention = 57, 0, 'KAPPA_ATTENTION'
+
+    @classmethod
+    def parse(cls, txt, raise_on_error=True):
+        for qm in cls:
+            if txt == qm.name:
+                return qm
+            elif txt == qm.value:
+                return qm
+            elif txt == qm.cpx_codename:
+                return qm
+
+        fmt = '* cannot interpret this as a QualityMetric enum: {0!r}'
+        if raise_on_error:
+            docplex_fatal(fmt, txt)
+        else:
+            print(fmt.format(txt))
+            return None

+
+
+
[docs]class BasisStatus(Enum):
+    """ This enumerated type describes the different values for basis status.
+
+    Basis status can be queried for variables and linear constraints in LP problems.
+
+    Possible values are:
+
+    - NotABasisStatus: invalid or unknown status,
+    - Basic, means the variable belongs to the base,
+    - AtLower, means the variable is non-basic, at its lower bound,
+    - AtUpper, means the variable is non-basic, at its upper bound,
+    - FreeNonBasic, means the variable is nonbasic and is not at a bound.
+
+    See Also:
+        The list of possible values for basis status can be found in the CPLEX documentation:
+
+        https://www.ibm.com/support/knowledgecenter/SSSA5P_20.1.0/ilog.odms.cplex.help/refcallablelibrary/cpxapi/getbase.html
+
+    """
+
+    def __new__(cls, code, cpx_codename):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = code
+        obj.codename = cpx_codename
+        return obj
+
+    NotABasisStatus = -1, "NotBasisStatus"
+    AtLowerBound = 0, "CPX_AT_LOWER"
+    Basic = 1, "CPX_BASIC"
+    AtUpperBound = 2, "CPX_AT_UPPER"
+    FreeNonBasic = 3, "CPX_FREE_SUPER"
+
+    @classmethod
+    def parse(cls, code):
+        for bs in cls:
+            if bs.value == code:
+                return bs
+
+        return cls.NotABasisStatus

+
+
+
[docs]class WriteLevel(Enum):
+    """
+    This enumerated class controls what is written in MST mip start files.
+    The numeric value is identical to the CPLEX WriteLevel parameter values.
+
+    The possible values are (in order of decreasing quantity of information written).
+
+        - AllVars (1): all variables are written
+        - DiscreteVars (2): all discrete variables are  written (binary, integer, semi-integer)
+        - NonZeroVars (3): all non-zero vars are written, regardless of their type.
+        - DiscreteNonZeroVars (4): all discrete non-zero vars are written.
+        - Auto (0): automatic value, same as DiscreteVars.
+
+    *New in version 2.10*
+    """
+
+    def __new__(cls, code, short_name):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = code
+        obj.short_name = short_name
+        return obj
+
+    Auto = 0, "auto"  # same as DiscreteVars: filter discrete, keep zeros
+    AllVars = 1, "all"  # write all variables and their value, zero or nonzero
+    DiscreteVars = 2, "discrete"  # write all discrete variables and their value
+    NonZeroVars = 3, "nonzero"  # write only nonzero variables
+    NonZeroDiscreteVars = 4, "nonzero_discrete"  # write nonzero discrete variables
+
+    def filter_zeros(self):
+        return self in {WriteLevel.NonZeroVars, WriteLevel.NonZeroDiscreteVars}
+
+    def filter_nondiscrete(self):
+        return self in {WriteLevel.Auto, WriteLevel.DiscreteVars, WriteLevel.NonZeroDiscreteVars}
+
+    @classmethod
+    def parse(cls, level):
+        if level is None:
+            return cls.Auto
+        elif isinstance(level, cls):
+            return level
+        else:
+            for wl in cls:
+                if wl.value == level:
+                    return wl
+                elif is_string(level):
+                    llevel = level.lower()
+                    if llevel == wl.name.lower() or llevel == wl.short_name:
+                        return wl
+            return cls.Auto

+
+
+
[docs]class EffortLevel(Enum):
+    """
+    This enumerated class controls the effort level used for a MIP start.
+    The numeric value is identical to the CPLEX EffortLevel parameter values.
+
+    See Also:
+        The list of possible values for effort level status can be found in the CPLEX documentation:
+
+https://www.ibm.com/support/knowledgecenter/SSSA5P_20.1.0/ilog.odms.cplex.help/refcppcplex/html/enumerations/IloCplex_MIPStartEffort.html
+
+
+    """
+    Auto = 0
+    CheckFeas = 1
+    SolveFixed = 2
+    SolveMIP = 3
+    Repair = 4
+    NoCheck = 5
+
+    @classmethod
+    def parse(cls, arg):
+        fallback = cls.Auto
+        if arg is None:
+            return fallback
+        elif isinstance(arg, EffortLevel):
+            return arg
+        else:
+            for eff in EffortLevel:
+                if eff.value == arg:
+                    return eff
+                elif is_string(arg) and arg.lower() == eff.name.lower():
+                    return eff
+
+            return fallback

+
+
+# problem type conversion
+_problemtype_map = {0: "LP",
+                    1: "MILP",
+                    3: "fixed_MILP",
+                    4: "nodeLP",
+                    5: "QP",
+                    7: "MIQP",
+                    8: "fixed_MIQP",
+                    9: "node_QP",
+                    10: "QCP",
+                    11: "MIQCP",
+                    12: "node_QCP"}
+
+
+def int_probtype_to_string(probtype, fallback_probtype="unknown"):
+    try:
+        iprobe_type = int(probtype)
+        return _problemtype_map.get(iprobe_type, fallback_probtype)
+    except ValueError:
+        return fallback_probtype
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/constr.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/constr.html new file mode 100644 index 0000000..9e4b8ba --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/constr.html @@ -0,0 +1,1871 @@ + + + + + + + + + docplex.mp.constr — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.constr

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+import warnings
+
+from docplex.mp.basic import IndexableObject, ModelingObjectBase, _AbstractBendersAnnotated
+from docplex.mp.dvar import is_var
+from docplex.mp.priority import Priority
+from docplex.mp.constants import ComparisonType, UpdateEvent
+from docplex.mp.operand import LinearOperand
+from docplex.mp.sttck import StaticTypeChecker
+from docplex.mp.utils import DocplexLinearRelaxationError, str_maxed
+
+
+class _ExtraConstraintUsage(object):
+    # INTERNAL
+    def __init__(self, tag):
+        self.tag = tag
+
+    def __str__(self):
+        return "UsedAs<%s>" % self.tag
+
+    def notify_expr_modified(self, linct, new_expr, engine):
+        tagval = self.tag
+        engine.update_extra_constraint(linct, tagval, new_expr)
+
+
+class _ConstraintLogicalUsage(object):
+    def __init__(self, logct):
+        self._log_ct = logct
+
+    @property
+    def tag(self):
+        return "logical"
+
+    _cannot_modify_linearct_non_discrete_msg = 'Linear constraint: {0} is used in equivalence, cannot be modified with non-discrete expr: {1}'
+
+    def notify_expr_modified(self, linct, new_expr, engine):
+        log_ct = self._log_ct
+        if log_ct.is_equivalence() and not new_expr.is_discrete():
+            linct.fatal(self._cannot_modify_linearct_non_discrete_msg, linct, new_expr)
+        else:
+            engine.update_constraint(log_ct, event=UpdateEvent.IndicatorLinearConstraint)
+
+
+
[docs]class AbstractConstraint(IndexableObject, _AbstractBendersAnnotated):
+    __slots__ = ()
+
+    def __init__(self, model, name=None):
+        IndexableObject.__init__(self, model, name)
+
+
+    @property
+    def priority(self):
+        return self._model.get_constraint_priority(self)
+
+    @priority.setter
+    def priority(self, newprio):
+        self.set_priority(newprio)
+
+    def set_priority(self, newprio):
+        self._model.set_constraint_priority(self, Priority.parse(newprio, logger=self.error_handler, accept_none=True))
+
+
[docs]    def set_mandatory(self):
+        ''' Sets the constraint as mandatory.
+
+        This prevents relaxation from relaxing this constraint.
+        To revert this, set the priority to any non-mandatory priority, or None.
+        '''
+        self.priority = Priority.MANDATORY

+
+    def is_mandatory(self):
+        return Priority.MANDATORY == self.priority
+
+    # noinspection PyUnusedLocal
+    def _unsupported_relational_op(self, op_string, other):
+        self.fatal("Relational operator: {1} is unavailable with constraint: {0!s}", self, op_string)
+
+    def __le__(self, e):
+        self._unsupported_relational_op("<=", e)
+
+    def __ge__(self, e):
+        self._unsupported_relational_op(">=", e)
+
+    def __lt__(self, e):
+        self._unsupported_relational_op("<", e)
+
+    def __gt__(self, e):
+        self._unsupported_relational_op(">", e)
+
+    # py3 needs an eq for hashing
+    # def __eq__(self, e):
+    #     self._unsupported_relational_op("==", e)
+
+    def _no_linear_ct_in_logical_test_error(self):
+        raise TypeError("cannot convert a constraint to boolean: {0!s}".format(self))
+
+    def __nonzero__(self):
+        self._no_linear_ct_in_logical_test_error()
+
+    def __bool__(self):
+        # python 3 version of nonzero
+        self._no_linear_ct_in_logical_test_error()  # pragma: no cover
+
+    def iter_variables(self):
+        raise NotImplementedError  # pragma: no cover
+
+    def iter_exprs(self):
+        raise NotImplementedError  # pragma: no cover
+
+    def get_var_coef(self, dvar):  # pragma: no cover
+        raise NotImplementedError
+
+    @property
+    def size(self):
+        return sum(x.size for x in self.iter_exprs())
+
+    def copy(self, target_model, var_map):
+        raise NotImplementedError  # pragma: no cover
+
+    def relaxed_copy(self, relaxed_model, var_map):
+        return self.copy(relaxed_model, var_map)
+
+    def compute_infeasibility(self, slack):  # pragma: no cover
+        # INTERNAL: only used when json has no infeasibility info.
+        return slack
+
+    # noinspection PyMethodMayBeStatic
+    def notify_deleted(self):
+        # INTERNAL
+        self._set_invalid_index()
+
+    @property
+    def short_typename(self):
+        return "constraint"
+
+    @property
+    def lp_name(self):
+        return self._name or "c%s" % (self.index + 1)
+
+    @property
+    def lpt_name(self):
+        radix = self.cplex_scope.prefix
+        return "%s%d" % (radix, self.index + 1)
+
+    def is_trivial(self):
+        return False
+
+    def is_linear(self):
+        return False
+
+    def is_quadratic(self):
+        return False
+
+
[docs]    def is_added(self):
+        """ Returns True if the constraint has been added to its model.
+
+        Example:
+            c = (x+y == 1)
+            m.add(c)
+            c.is_added()
+            >>> True
+            c2 = (x + 2*y) >= 3
+            c2.is_added()
+            >>> False
+
+        """
+        return self.index >= 0

+
+    @property
+    def cplex_scope(self):
+        return self._get_index_scope().cplex_scope
+
+    def _get_index_scope(self):
+        raise NotImplementedError
+
+    def is_logical(self):
+        return False
+
+    def _get_dual_value(self):
+        # INTERNAL
+        # Note that dual values are only available for LP problems,
+        # so can be calle donly on linear or range constraints.
+        return self._model._dual_value1(self)
+
+    def notify_expr_modified(self, expr, event):
+        # INTERNAL
+        pass  # pragma: no cover
+
+    def notify_expr_replaced(self, old_expr, new_expr):
+        # INTERNAL
+        pass  # pragma: no cover
+
+    def resolve(self):
+        raise NotImplementedError  # pragma: no cover
+
+    def is_satisfied(self, solution, tolerance):
+        raise NotImplementedError  # pragma: no cover
+
+    def lock_discrete(self):
+        # INTERNAL
+        # lock sub expressions
+        for expr in self.iter_exprs():
+            expr.lock_discrete()
+
+    def to_readable_string(self):
+        return str(self)
+
+    def _compute_violation(self, solution, tolerance):
+        # fallback
+        return 0

+
+
+# noinspection PyAbstractClass
+
[docs]class BinaryConstraint(AbstractConstraint):
+    __slots__ = ("_ctsense", "_left_expr", "_right_expr")
+
+    def _internal_set_sense(self, new_sense):
+        self._ctsense = new_sense
+
+    def __init__(self, model, left_expr, ctsense, right_expr, name=None):
+        IndexableObject.__init__(self, model, name)
+        self._ctsense = ctsense
+        # noinspection PyPep8
+        self._left_expr = left_expr
+        self._right_expr = right_expr
+
+    def _iter_usages(self):
+        return iter([])
+
+    @property
+    def type(self):
+        """ This property returns the type of the constraint; type is an enumerated value
+        of type :class:`ComparisonType`, with three possible values:
+
+        - LE for e1 <= e2 constraints
+
+        - EQ for e1 == e2 constraints
+
+        - GE for e1 >= e2 constraints
+
+        where e1 and e2 denote linear expressions.
+
+        """
+        return self._ctsense
+
+    @property
+    def cplex_code(self):
+        return self._ctsense._cplex_code
+
+
[docs]    def get_left_expr(self):
+        """ This property returns the left expression in the constraint.
+
+        Example:
+            (X+Y <= Z+1) has left expression (X+Y).
+        """
+        return self._left_expr

+
+
[docs]    def get_right_expr(self):
+        """ This property returns the right expression in the constraint.
+
+        Example:
+            (X+Y <= Z+1) has right expression (Z+1).
+        """
+        return self._right_expr

+
+    def get_var_coef(self, dvar):
+        return self._left_expr.unchecked_get_coef(dvar) - self._right_expr.unchecked_get_coef(dvar)
+
+
[docs]    def to_string(self, use_space=False):
+        """ Returns a string representation of the constraint.
+
+        The operators in this representation are the usual operators <=, ==, and >=.
+
+        Example:
+            The constraint (X+Y <= Z+1) is represented as "X+Y <= Z+1".
+
+        Returns:
+            A string.
+
+        """
+        mdl_str_len_max = self.model.str_max_len
+        return self._to_string(use_space, mdl_str_len_max)

+
+    def to_readable_string(self):
+        return self._to_string(use_space=True, str_len_max=self.model.readable_str_len)
+
+    def _to_string(self, use_space, str_len_max):
+        left_string  = self._left_expr.to_string(use_space=use_space)
+        right_string = self._right_expr.to_string(use_space=use_space)
+        self_name = self.name
+        s_lhs = str_maxed(left_string, str_len_max)
+        s_rhs = str_maxed(right_string, str_len_max)
+        s_name = "%s: " % self_name if self_name else ""
+        return u"%s%s %s %s" % (s_name, s_lhs, self._ctsense.operator_symbol, s_rhs)
+
+    def cplex_num_rhs(self):
+        # INTERNAL
+        right_cst = self._right_expr.get_constant()
+        left_cst = self._left_expr.get_constant()
+        return float(right_cst - left_cst)
+
+    @property
+    def cplex_net_rhs(self):
+        # returns the net constant (rhs.constant - lhs.constant)
+        # converted to float (no numpy floats)
+        return self.cplex_num_rhs()
+
+    def __repr__(self):
+        classname = self.__class__.__name__
+        user_name = self.safe_name
+        typename = self._ctsense.short_name
+        sleft = self._left_expr.repr_str()
+        sright = self._right_expr.repr_str()
+        return "docplex.mp.{0}[{1}]({2!s},{3},{4!s})". \
+            format(classname, user_name, sleft, typename, sright)
+
+    def _is_trivially_feasible(self):
+        # INTERNAL : assume self is trivial()
+        op_func = self._ctsense.python_operator
+        return op_func(self._left_expr.get_constant(), self._right_expr.get_constant()) if op_func else False
+
+    def _is_trivially_infeasible(self):
+        # INTERNAL: assume self is trivial .
+        op_func = self._ctsense.python_operator
+        return not op_func(self._left_expr.get_constant(), self._right_expr.get_constant()) if op_func else False
+
+    def is_trivial_feasible(self):
+        return self.is_trivial() and self._is_trivially_feasible()
+
+    def is_trivial_infeasible(self):
+        return self.is_trivial() and self._is_trivially_infeasible()
+
+    @staticmethod
+    def _generate_expr_opposite_linear_coefs(expr):
+        for v, k in expr.iter_sorted_terms():
+            yield v, -k
+
+    def _iter_net_linear_coefs_sorted(self, left_expr, right_expr):
+        # INTERNAL
+        if right_expr.is_constant():
+            return left_expr.iter_sorted_terms()
+        elif left_expr.is_constant():
+            return self._generate_expr_opposite_linear_coefs(right_expr)
+        else:
+            return self._generate_net_linear_coefs2_sorted(left_expr, right_expr)
+
+
[docs]    def iter_variables(self):
+        """  Iterates over all variables mentioned in the constraint.
+
+        *Note:* This includes variables that are mentioned with a zero coefficient. For example,
+        the iterator on the following constraint:
+
+         X <= X+Y + 1
+
+        will return X and Y, although X is mentioned with a zero coefficient.
+
+        Returns:
+            An iterator object.
+        """
+        if self._right_expr.is_constant():
+            return self._left_expr.iter_variables()
+        elif self._left_expr.is_constant():
+            return self._right_expr.iter_variables()
+        else:
+            return self.generate_ordered_vars()

+
+    def generate_ordered_vars(self):
+        left_expr = self._left_expr
+        for lv in left_expr.iter_variables():
+            yield lv
+        for rv in self._right_expr.iter_variables():
+            if not left_expr.contains_var(rv):
+                yield rv
+
+    @staticmethod
+    def _generate_net_linear_coefs2_sorted(left_expr, right_expr):
+        # INTERNAL
+        for lv, lk in left_expr.iter_sorted_terms():
+            net_k = lk - right_expr.unchecked_get_coef(lv)
+            if net_k:
+                yield lv, net_k
+        for rv, rk in right_expr.iter_sorted_terms():
+            if not left_expr.contains_var(rv) and rk:
+                yield rv, -rk
+
+    @staticmethod
+    def _generate_net_linear_coefs2_unsorted(left_expr, right_expr):
+        # INTERNAL
+        for lv, lk in left_expr.iter_terms():
+            net_k = lk - right_expr.unchecked_get_coef(lv)
+            yield lv, net_k
+        for rv, rk in right_expr.iter_terms():
+            if not left_expr.contains_var(rv):
+                yield rv, -rk
+
+    def notify_deleted(self):
+        # INTERNAL
+        super(BinaryConstraint, self).notify_deleted()
+        self._left_expr.notify_unsubscribed(self)
+        self._right_expr.notify_unsubscribed(self)
+
+    def iter_exprs(self):
+        return iter([self._left_expr, self._right_expr])
+
+    def get_expr_from_pos(self, pos):
+        if 0 == pos:
+            return self._left_expr
+        elif 1 == pos:
+            return self._right_expr
+        else:  # pragma: no cover
+            self.fatal('Unexpected expression position: {0!r}, expecting 0 or 1', pos)
+
+    def set_expr_from_pos(self, pos, new_expr):
+        if 0 == pos:
+            self._left_expr = new_expr
+        elif 1 == pos:
+            self._right_expr = new_expr
+        else:  # pragma: no cover
+            self.fatal('Unexpected expression position: {0!r}, expecting 0 or 1', pos)
+
+    def is_satisfied(self, solution, tolerance=1e-6):
+        violation = self._compute_violation(solution, tolerance)
+        return violation == 0
+
+    def _compute_violation(self, solution, tolerance, _eps_zero=1e-10):
+        left_value = self._left_expr._raw_solution_value(solution)
+        right_value = self._right_expr._raw_solution_value(solution)
+        net_value = left_value - right_value
+        ctsense = self._ctsense
+        violation = 0
+        raw_violation = 0
+        if ctsense == ComparisonType.EQ:
+            violation = max(0, abs(net_value) - tolerance)
+            raw_violation = abs(net_value)
+        elif ctsense == ComparisonType.LE:
+            violation = max(0, net_value - tolerance)
+            raw_violation = max(0, net_value)
+        elif ctsense == ComparisonType.GE:
+            violation = max(0, - (net_value + tolerance))
+            raw_violation = max(0, -net_value)
+
+        return raw_violation if violation >= _eps_zero else 0
+
+    def resolve(self):
+        self._left_expr.resolve()
+        self._right_expr.resolve()
+
+    def is_discrete(self):
+        return self.get_left_expr().is_discrete() and self.get_right_expr().is_discrete()
+
+    @property
+    def sense_string(self):
+        return self._ctsense.name

+
+
+
[docs]class LinearConstraint(BinaryConstraint, LinearOperand):
+    """ The class that models all constraints of the form `<expr1> <OP> <expr2>`,
+            where <expr1> and <expr2> are linear expressions.
+    """
+    __slots__ = ('_status_var', '_usages')
+
+    def __init__(self, model, left_expr, ctsense, right_expr, name=None):
+        BinaryConstraint.__init__(self, model, left_expr, ctsense, right_expr, name)
+        left_expr.notify_used(self)
+        right_expr.notify_used(self)
+
+    def check_name(self, new_name):
+        self.check_lp_name('constraint', new_name, accept_empty=True, accept_none=True)
+
+    def set_name(self, new_name):
+        # INTERNAL
+        self.check_name(new_name)
+        if self.is_added():
+            self._model.set_linear_constraint_name(self, new_name)
+        else:
+            self._set_name(new_name)
+
+    def notify_used_in_logical_ct(self, lct):
+        self._add_usage(_ConstraintLogicalUsage(lct))
+
+    def _add_usage(self, usage):
+        if hasattr(self, '_usages'):
+            self._usages.append(usage)
+        else:
+            self._usages = [usage]
+
+    def _get_usages(self):
+        return getattr(self, '_usages', [])
+
+    def _iter_usages(self):
+        # INTERNAL
+        return iter(self._get_usages())
+
+    def is_linear(self):
+        return True
+
+    @property
+    def short_typename(self):
+        return "linear constraint"
+
+    # noinspection PyMethodMayBeStatic
+    def cplex_range_value(self):
+        return 0.0
+
+    def is_lazy_constraint(self):
+        return self.model._is_lazy_constraint(self)
+
+    def is_user_cut_constraint(self):
+        return self.model._is_user_cut_constraint(self)
+
+    def copy(self, target_model, var_map):
+        copied_left = self.left_expr.copy(target_model, var_map)
+        copied_right = self.right_expr.copy(target_model, var_map)
+        copy_name = None if target_model.ignore_names else self.name
+        return self.__class__(target_model, copied_left, self.sense, copied_right, copy_name)
+
+    def relaxed_copy(self, relaxed_model, var_map):
+        copied_left = self.left_expr.relaxed_copy(relaxed_model, var_map)
+        copied_right = self.right_expr.relaxed_copy(relaxed_model, var_map)
+        copy_name = self.name
+        return self.__class__(relaxed_model, copied_left, self.sense, copied_right, copy_name)
+
+    @property
+    def sense(self):
+        """ This property is used to get or set the sense of the constraint; sense is an enumerated value
+        of type :class:`ComparisonType`, with three possible values:
+
+        - LE for e1 <= e2 constraints
+
+        - EQ for e1 == e2 constraints
+
+        - GE for e1 >= e2 constraints
+
+        where e1 and e2 denote linear expressions.
+
+        """
+        return self._ctsense
+
+    @sense.setter
+    def sense(self, new_sense):
+        self.set_sense(new_sense)
+
+    def set_sense(self, new_sense):
+        self.get_linear_factory().set_linear_constraint_sense(self, new_sense)
+
+    # compatibility
+    @property
+    def type(self):  # pragma: no cover
+        warnings.warn(
+            "ct.type is deprecated, use ct.sense instead.",
+            DeprecationWarning, stacklevel=2)
+        return self._ctsense
+
+    @property
+    def left_expr(self):
+        """ This property returns the left expression in the constraint.
+
+        Example:
+            (X+Y <= Z+1) has left expression (X+Y).
+        """
+        return self._left_expr
+
+    @property
+    def right_expr(self):
+        """ This property returns the right expression in the constraint.
+
+        Example:
+            (X+Y <= Z+1) has right expression (Z+1).
+        """
+        return self._right_expr
+
+    @right_expr.setter
+    def right_expr(self, new_rexpr):
+        self.set_right_expr(new_rexpr)
+
+    def set_right_expr(self, new_rexpr):
+        self.get_linear_factory().set_linear_constraint_right_expr(ct=self, new_rexpr=new_rexpr)
+
+    @left_expr.setter
+    def left_expr(self, new_lexpr):
+        self.set_left_expr(new_lexpr)
+
+    def set_left_expr(self, new_lexpr):
+        self.get_linear_factory().set_linear_constraint_left_expr(ct=self, new_lexpr=new_lexpr)
+
+    # aliases
+    lhs = left_expr
+    rhs = right_expr
+
+    def _no_linear_ct_in_logical_test_error(self):
+        # if self.sense == ComparisonType.EQ:
+        #     # for equality testing there -is- a workaround
+        #     msg = "Cannot use == to test expression equality, try using Python is operator or method equals: {0!s}".format(self)
+        # else:
+        msg = "Cannot convert linear constraint to a boolean value: {0!s}".format(self)
+        if self.sense == ComparisonType.EQ:
+            # for equality testing there -is- a workaround
+            msg += "\n  try using Python 'is' operator or method 'equals' for expression equality"
+
+        raise TypeError(msg)
+
+    def _cannot_promote_from_linear_to_quadratic(self, old_expr, new_expr):
+        msg = 'Cannot change linear constraint expr from linear to quadratic'
+        if new_expr is None:
+            self.fatal('{0}: {1}', msg, old_expr)
+        else:
+            self.fatal('{0}: was: {1!s}, new: {2!s}', msg, old_expr, new_expr)
+
+    def _check_editable(self, new_expr, engine):
+        for usage in self._iter_usages():
+            usage.notify_expr_modified(self, new_expr, engine)
+
+    def notify_expr_modified(self, expr, event):
+        # INTERNAL
+        if event:
+            if event is UpdateEvent.LinExprPromotedToQuad:
+                self._cannot_promote_from_linear_to_quadratic(old_expr=expr, new_expr=None)
+            else:
+                self.get_linear_factory().update_linear_constraint_exprs(ct=self, expr_event=event)
+
+    def notify_expr_replaced(self, old_expr, new_expr):
+        # INTERNAL
+        if new_expr.is_quad_expr() and not old_expr.is_quad_expr():
+            self._cannot_promote_from_linear_to_quadratic(old_expr, new_expr)
+        if old_expr is self._left_expr:
+            self.get_linear_factory().set_linear_constraint_expr_from_pos(lct=self, pos=0, new_expr=new_expr,
+                                                                          update_subscribers=False)
+        elif old_expr is self._right_expr:
+            self.get_linear_factory().set_linear_constraint_expr_from_pos(lct=self, pos=1, new_expr=new_expr,
+                                                                          update_subscribers=False)
+        else:
+            # should not happen
+            pass
+        # new expr takes al subscribers from old expr
+        if not is_var(new_expr):
+            new_expr.grab_subscribers(old_expr)
+
+
[docs]    def to_string(self, use_space=False):
+        """ Returns a string representation of the constraint.
+
+        The operators in this representation are the usual operators <=, ==, and >=.
+
+        Example:
+            The constraint (X+Y <= Z+1) is represented as "X+Y <= Z+1".
+
+        Returns:
+            A string.
+
+        """
+        return BinaryConstraint.to_string(self, use_space=use_space)

+
+    def compute_infeasibility(self, slack):  # pragma: no cover
+        ctsense = self._ctsense
+        if ctsense == ComparisonType.EQ:
+            infeas = slack
+        elif ComparisonType.LE == ctsense:
+            infeas = slack if slack <= 0 else 0
+        elif ComparisonType.GE == ctsense:
+            infeas = slack if slack >= 0 else 0
+        else:
+            infeas = 0
+        return infeas
+
+    def _get_index_scope(self):
+        return self._model._linct_scope
+
+    def is_trivial(self):
+        # Checks whether the constraint is equivalent to a comparison between numbers.
+        # For example, x <= x+1 is trivial, but 1.5 X <= X + 1 is not.
+        def has_nonzero_coef(term_iter):
+            return any(tk for _, tk in term_iter)
+
+        self_left_expr = self._left_expr
+        self_right_expr = self._right_expr
+        if self_right_expr.is_constant():
+            return not has_nonzero_coef(self.left_expr.iter_terms())
+        elif self_left_expr.is_constant():
+            return not has_nonzero_coef(self.right_expr.iter_terms())
+        else:
+            return not has_nonzero_coef(
+                BinaryConstraint._generate_net_linear_coefs2_unsorted(self_left_expr, self_right_expr))
+
+    def _post_meta_constraint(self, rhs, ctsense):
+        status_var = self.get_resolved_status_var()
+        return self._model._new_xconstraint(lhs=status_var, rhs=rhs, comparaison_type=ctsense)
+
+
[docs]    def le(self, rhs):
+        return self._post_meta_constraint(rhs, ComparisonType.LE)

+
+
[docs]    def eq(self, rhs):
+        return self._post_meta_constraint(rhs, ComparisonType.EQ)

+
+
[docs]    def ge(self, rhs):
+        return self._post_meta_constraint(rhs, ComparisonType.GE)

+
+    def __le__(self, rhs):
+        return self.le(rhs)
+
+    def __ge__(self, rhs):
+        return self.ge(rhs)
+
+    def __hash__(self):
+        return id(self)
+
+    def unchecked_get_coef(self, dvar):
+        return 1 if dvar is self._get_status_var() else 0
+
+    def contains_var(self, dvar):
+        # only user vars
+        return dvar is self._get_status_var()
+
+    def iter_terms(self):
+        yield self.get_resolved_status_var(), 1
+
+    iter_sorted_terms = iter_terms
+
+    @property
+    def dual_value(self):
+        """ This property returns the dual value of the constraint.
+
+        Note:
+            This method will raise an exception if the model has not been solved successfully.
+            This method is OK with small numbers of constraints. For large numbers of constraints (>100),
+            consider using Model.dual_values() with a sequence of constraints.
+            
+        See Also:
+            `func:docplex.mp.model.Model.dual_values()`
+        """
+        return self._get_dual_value()
+
+    @property
+    def slack_value(self):
+        """ This property returns the slack value of the constraint.
+
+        Note:
+            This method will raise an exception if the model has not been solved successfully.
+            
+                        
+            This method is OK with small numbers of constraints. For large numbers of constraints (>100),
+            consider using Model.slack_values() with a sequence of constraints.
+            
+        See Also:
+            `func:docplex.mp.model.Model.slack_values()`
+        """
+        return self._model._slack_value1(self)
+
+    @property
+    def basis_status(self):
+        """ This property returns the basis status of the slack variable of the constraint, if any.
+
+        Returns:
+            An enumerated value from the enumerated type `docplex.constants.BasisStatus`.
+
+        Note:
+            for the model to hold basis information, the model must have been solved as a LP problem.
+            In some cases, a model which failed to solve may still have a basis available. Use
+            `Model.has_basis()` to check whether the model has basis information or not.
+
+        See Also:
+            :func:`docplex.mp.model.Model.has_basis`
+            :class:`docplex.mp.constants.BasisStatus`
+
+        *New in version 2.10*
+
+        """
+        return self._model._linearct_basis_status([self])[0]
+
+    def iter_net_linear_coefs(self):
+        # INTERNAL
+        left_expr = self._left_expr
+        right_expr = self._right_expr
+        if right_expr.is_constant():
+            return left_expr.iter_sorted_terms()
+        elif left_expr.is_constant():
+            return self._generate_expr_opposite_linear_coefs(right_expr)
+        else:
+            return self._generate_net_linear_coefs2_sorted(left_expr, right_expr)
+
+    def _get_status_var(self):
+        # this call does -not- create the variable. Returns None if not present.
+        return getattr(self, '_status_var', None)
+
+    @property
+    def status_var(self):
+        return self.get_resolved_status_var()
+
+    as_var = status_var
+
+    def as_logical_operand(self):
+        if not self.is_discrete():
+            return None
+        else:
+            return self.get_resolved_status_var(caller_msg=
+                                                'Conversion to logical operand is available only for discrete constraints')
+
+    def _check_is_discrete(self, ct, msg=None):
+        err_msg = msg or "Conversion from constraint to expression is available only for discrete constraints"
+        StaticTypeChecker.typecheck_discrete_constraint(self, ct, msg=err_msg)
+
+    def get_resolved_status_var(self, caller_msg=None):
+        status_var = self._get_status_var()  # always use the getter!
+        if status_var is not None:
+            return status_var
+
+        self._model._check_logical_constraint_support()
+
+        # TODO: issue a meaningful message on why the ct is not discrete
+        self._check_is_discrete(self, msg=caller_msg)
+        # lock it discrete
+        self.lock_discrete()
+
+        # lazy allocation of a new status variable...:
+        lfactory = self.get_linear_factory()
+        status_var = lfactory.new_constraint_status_var(self)
+        if self.is_added():
+            # status variable is bound
+            status_var.lb = 1
+        self._status_var = status_var
+        # store ct in model
+        eqct = lfactory.new_equivalence_constraint(status_var, linear_ct=self)
+        eqct.origin = self
+        engine = self._model.get_engine()
+        eqx = engine.create_logical_constraint(eqct, is_equivalence=True)
+        self._model._register_implicit_equivalence_ct(eqct, eqx)
+        return status_var
+
+    def to_linear_expr(self):
+        return self.status_var
+
+    def notify_deleted(self):
+        super(LinearConstraint, self).notify_deleted()
+        svar = self._get_status_var()  # possibly not resolved
+        if svar:
+            svar.lb = 0
+
+    @property
+    def benders_annotation(self):
+        """
+        This property is used to get or set the Benders annotation of a constraint.
+        The value of the annotation must be a positive integer
+
+        """
+        return self.get_benders_annotation()
+
+    @benders_annotation.setter
+    def benders_annotation(self, new_anno):
+        self.set_benders_annotation(new_anno)
+
+    # -- arithmetic operators
+    def times(self, e):
+        # TODO: dow e limit numbers here, otherwise non-convex errors may creep in
+        return self.to_linear_expr().__mul__(e)
+
+    def __mul__(self, e):
+        return self.times(e)
+
+    def __rmul__(self, e):
+        return self.times(e)
+
+    def __div__(self, e):
+        return self.quotient(e)
+
+    def __truediv__(self, e):
+        # for py3
+        # INTERNAL
+        return self.quotient(e)  # pragma: no cover
+
+    def quotient(self, e):
+        svar = self.get_resolved_status_var()
+        self._model._typecheck_as_denominator(e, svar)
+        inverse = 1.0 / float(e)
+        return self.times(inverse)
+
+    def __add__(self, e):
+        return self.to_linear_expr().__add__(e)
+
+    def __radd__(self, e):
+        return self.to_linear_expr().__add__(e)
+
+    def __sub__(self, e):
+        return self.to_linear_expr().__sub__(e)
+
+    def __rsub__(self, e):
+        return self.to_linear_expr().__rsub__(e)
+
+    def __or__(self, other):
+        return self.logical_or(other)
+
+    def __and__(self, other):
+        return self.logical_and(other)
+
+    def _check_logical_operator(self, other, caller=None):
+        self._check_is_discrete(self, msg="Logical operators require discrete constraints")
+        StaticTypeChecker.typecheck_logical_op(self, other, caller=caller)
+
+    def logical_or(self, other):
+        self._check_logical_operator(other, "LinearConstraint.or")
+        return self.get_linear_factory().new_binary_constraint_or(self, other)
+
+    def logical_and(self, other):
+        self._check_logical_operator(other, "LinearConstraint.and")
+        return self.get_linear_factory().new_binary_constraint_and(self, other)
+
+    def __rshift__(self, other):
+        """ Redefines the right-shift operator to define if-then constraints.
+
+            This operator allows to create if-then constraint with the `>>` operator.
+            It expects a linear constraint as second argument.
+
+            :param other: the linear constraint used to build a new if-then constraint.
+
+            :return:
+                an instance of IfThenConstraint, that is not added to the model.
+                Use `Model.add()` to add it to the model.
+
+            Note:
+                The constraint must be discrete, otherwise an exception is raised.
+
+            Example:
+
+                m.add((x >= 3) >> (y == 5))
+
+                creates  an if-then constraint which links the satisfaction of constraint (x >= 3) to the satisfaction
+                of (y ==5).
+
+            """
+        return self._model.if_then(if_ct=self, then_ct=other)
+
+    def _tag_as_extra_ct(self, qualifier):
+        # INTERNAL
+        self._add_usage(_ExtraConstraintUsage(qualifier))
+
+    def _untag_as_extra_ct(self, qualifier):
+        usages = self._get_usages()
+        upos = -1
+        for u, used in enumerate(usages):
+            if used.tag == qualifier:
+                upos = u
+                break
+        if upos >= 0:
+            del usages[upos]
+
+    _user_cut_tag = "user-cut constraint"
+    _lazy_constraint_tag = "lazy constraint"
+
+    def notify_used_as_user_cut(self):
+        # INTERNAL
+        self._tag_as_extra_ct(self._user_cut_tag)
+
+    def notify_used_as_lazy_constraint(self):
+        # INTERNAL
+        self._tag_as_extra_ct(self._lazy_constraint_tag)
+
+    def notify_unused_as_user_cut(self):
+        # INTERNAL
+        self._untag_as_extra_ct(self._user_cut_tag)
+
+    def notify_unused_as_lazy_constraint(self):
+        # INTERNAL
+        self._untag_as_extra_ct(self._lazy_constraint_tag)

+
+
+
[docs]class RangeConstraint(AbstractConstraint):
+    """ This class models range constraints.
+
+    A range constraint states that an expression must stay between two
+    values, `lb` and `ub`.
+
+    This class is not meant to be instantiated by the user.
+    To create a range constraint, use the factory method :func:`docplex.mp.model.Model.add_range`
+    defined on :class:`docplex.mp.model.Model`.
+
+    """
+
+    def __init__(self, model, expr, lb, ub, name=None):
+        AbstractConstraint.__init__(self, model, name)
+        self._ub = ub
+        self._lb = lb
+        self._expr = expr
+
+    def is_linear(self):
+        return True
+
+    # noinspection PyMethodMayBeStatic
+    @property
+    def cplex_code(self):
+        return 'R'
+
+    def _get_index_scope(self):
+        return self._model._linct_scope
+
+    @property
+    def short_typename(self):
+        return "range constraint"
+
+    def is_trivial(self):
+        return self._expr.is_constant()
+
+    def _is_trivially_feasible(self):
+        # INTERNAL : assume self is trivial()
+        expr_num = self._expr.constant
+        return self._lb <= expr_num <= self._ub
+
+    def _is_trivially_infeasible(self):
+        # INTERNAL : assume self is trivial()
+        expr_num = self._expr.constant
+        return expr_num < self._lb or expr_num > self._ub
+
+    def compute_infeasibility(self, slack):  # pragma: no cover
+        # compatible with cplex...
+        return -slack
+
+    def get_var_coef(self, dvar):
+        return self._expr.unchecked_get_coef(dvar)
+
+    def is_satisfied(self, solution, tolerance=1e-6):
+        expr_value = self._expr._raw_solution_value(solution)
+        return self._lb - tolerance <= expr_value <= self._ub + tolerance
+
+    @property
+    def expr(self):
+        """ This property returns the linear expression of the range constraint.
+        """
+        return self._expr
+
+    @expr.setter
+    def expr(self, new_expr):
+        self.get_linear_factory().set_range_constraint_expr(self, new_expr)
+
+    @property
+    def lb(self):
+        """ This property is used to get or set the lower bound of the range constraint.
+
+        """
+        return self._lb
+
+    @lb.setter
+    def lb(self, new_lb):
+        self._model._typecheck_num(new_lb)
+        self.get_linear_factory().set_range_constraint_lb(self, new_lb)
+
+    @property
+    def ub(self):
+        """ This property is used to get or set the upper bound of the range constraint.
+
+        """
+        return self._ub
+
+    @ub.setter
+    def ub(self, new_ub):
+        self._model._typecheck_num(new_ub)
+        self.get_linear_factory().set_range_constraint_ub(self, new_ub)
+
+    @property
+    def bounds(self):
+        """ This property is used to get or set the (lower, upper) bounds of a range constraint.
+
+        """
+        return self._lb, self._ub
+
+    @bounds.setter
+    def bounds(self, new_bounds):
+        try:
+            new_lb, new_ub = new_bounds
+            self._model._typecheck_num(new_lb)
+            self._model._typecheck_num(new_ub)
+            self.get_linear_factory().set_range_constraint_bounds(self, new_lb, new_ub)
+        except ValueError:
+            self.fatal('RangeConstraint.bounds expects a 2-tuple of numbers, {0!r} was passed', new_bounds)
+
+    def _internal_set_lb(self, new_lb):
+        self._lb = new_lb
+
+    def _internal_set_ub(self, new_ub):
+        self._ub = new_ub
+
+    def is_feasible(self):
+        return self._ub >= self._lb
+
+    @property
+    def dual_value(self):
+        """ This property returns the dual value of the constraint.
+
+        Note:
+            This method will raise an exception if the model has not been solved successfully.
+        """
+        return self._get_dual_value()
+
+    @property
+    def slack_value(self):
+        """ This property returns the slack value of the constraint.
+
+        Note:
+            This method will raise an exception if the model has not been solved successfully.
+        """
+        return self._model._slack_value1(self)
+
+    @property
+    def basis_status(self):
+        """ This property returns the basis status of the slack variable of the constraint, if any.
+
+        Returns:
+            An enumerated value from the enumerated type `docplex.constants.BasisStatus`.
+
+        Note:
+            for the model to hold basis information, the model must have been solved as a LP problem.
+            In some cases, a model which failed to solve may still have a basis available. Use
+            `Model.has_basis()` to check whether the model has basis information or not.
+
+        See Also:
+            :func:`docplex.mp.model.Model.has_basis`
+            :class:`docplex.mp.constants.BasisStatus`
+
+        *New in version 2.10*
+        """
+        return self._model._linearct_basis_status([self])[0]
+
+
[docs]    def iter_variables(self):
+        """Iterates over all the variables of the range constraint.
+
+        Returns:
+           An iterator object.
+        """
+        return self._expr.iter_variables()

+
+    def iter_exprs(self):
+        yield self._expr
+
+    def cplex_range_value(self, do_raise=True):
+        return self.static_cplex_range_value(self, self._lb, self._ub,
+                                             lambda: "Range has infeasible domain: {0!s}".format(self),
+                                             do_raise=do_raise)
+
+    @classmethod
+    def static_cplex_range_value(cls, logger, lbval, ubval, msg_fun, do_raise=True):
+        rangeval = float(lbval - ubval)
+        # this should be negative, otherwise fails....
+        # no way to model infeasible ranges with cplex rngval.
+        if rangeval >= 1e-6 and do_raise:
+            logger.fatal(msg_fun())
+        return rangeval
+
+    def cplex_num_rhs(self):
+        # force conversion to float for numpy, etc...
+        return float(self._ub - self._expr.get_constant())
+
+    def get_left_expr(self):
+        return self._expr
+
+    # noinspection PyMethodMayBeStatic
+    def get_right_expr(self):
+        return None
+
+    def copy(self, target_model, var_map):
+        copied_expr = self.expr.copy(target_model, var_map)
+        copy_name = None if target_model.ignore_names else self.name
+        copied_range = RangeConstraint(target_model, copied_expr, self.lb, self.ub, copy_name)
+        return copied_range
+
+    def to_string(self, use_space=False):
+        np = self.model._num_printer
+        s_expr = self._expr.to_string(use_space=use_space)
+        return "{0} <= {1!s} <= {2}".format(np.to_string(self._lb), s_expr, np.to_string(self._ub))
+
+    def to_readable_string(self):
+        np = self.model._num_printer
+        s_expr = self._expr.to_string(use_space=True)[:self.model.readable_str_len]
+        return "{0} <= {1!s} <= {2}".format(np.to_string(self._lb), s_expr, np.to_string(self._ub))
+
+    def __str__(self):
+        """ Returns a string representation of the range constraint.
+
+        Example:
+            1 <= x+y+z <= 3 represents the range constraint where the expression (x+y+z) is
+            constrained to stay between 1 and 3.
+
+        Returns:
+            A string.
+        """
+        return self.to_string(use_space=self.model.str_use_space)
+
+    def __repr__(self):
+        printable_name = self.safe_name
+        return "docplex.mp.RangeConstraint[{0}]({1},{2!s},{3})". \
+            format(printable_name, self.lb, self._expr, self.ub)
+
+    def resolve(self):
+        self._expr.resolve()
+
+    @property
+    def benders_annotation(self):
+        """
+        This property is used to get or set the Benders annotation of a constraint.
+        The value of the annotation must be a positive integer
+
+        """
+        return self.get_benders_annotation()
+
+    @benders_annotation.setter
+    def benders_annotation(self, new_anno):
+        self.set_benders_annotation(new_anno)

+
+
+
[docs]class NotEqualConstraint(LinearConstraint):
+
+    def __init__(self, model, negated_eqct, name=None):
+        # assume negated_eqct is the equality constraint we want to negate
+        self._negated_ct = negated_eqct
+        aux_eq_ct_status = self._negated_ct.get_resolved_status_var()
+        zero = model._lfactory.new_zero_expr()
+        LinearConstraint.__init__(self, model, aux_eq_ct_status, ComparisonType.EQ, zero, name)
+        self.lock_discrete()
+
+
[docs]    def to_string(self, use_space=False):
+        eqct = self._negated_ct
+        s_lhs = eqct._left_expr.to_string(use_space=use_space)
+        s_rhs = eqct._right_expr.to_string(use_space=use_space)
+        return "{0} != {1}".format(s_lhs, s_rhs)

+
+    def set_sense(self, new_sense):
+        self.fatal("cannot modify sense of a not_equal constraint: {0!s}", self)
+
+    @property
+    def negated_constraint(self):
+        return self._negated_ct
+
+    def __str__(self):
+        """ Returns a string representation of the not equals constraint.
+
+        Returns:
+            A string.
+        """
+        return self.to_string(use_space=self.model.str_use_space)
+
+    def __repr__(self):
+        return "docplex.mp.NotEquals({0}, {1})". \
+            format(self._left_expr, self._right_expr)

+
+
+
[docs]class LogicalConstraint(AbstractConstraint):
+    """ This class models logical constraints.
+
+    An equivalence constraint links (both ways) the value of a binary variable
+    to the satisfaction of a linear constraint.
+    
+    If the binary variable equals the truth value (default is 1),
+    then the constraint is satisfied, conversely if the constraint
+    is satisfied, the value of the variable is set to the truth value.
+
+    This class is not meant to be instantiated by the user.
+
+    """
+    __slots__ = ('_binary_var', '_linear_ct', '_active_value')
+
+    def __init__(self, model, binary_var, linear_ct, active_value=1, name=None):
+        AbstractConstraint.__init__(self, model, name)
+        self._binary_var = binary_var
+        self._linear_ct = linear_ct
+        self._active_value = active_value
+        # connect exprs
+        for expr in linear_ct.iter_exprs():
+            expr.notify_used(self)
+
+        linear_ct.notify_used_in_logical_ct(self)
+
+    def resolve(self):
+        self._linear_ct.resolve()
+
+    def _get_index_scope(self):
+        return self._model._logical_scope
+
+    def iter_exprs(self):
+        return self._linear_ct.iter_exprs()
+
+    def is_equivalence(self):
+        raise NotImplementedError  # pragma: no cover
+
+    def cplex_num_rhs(self):
+        return self._linear_ct.cplex_num_rhs()
+
+    @property
+    def active_value(self):
+        return self._active_value
+
+    @property
+    def binary_var(self):
+        return self._binary_var
+
+    @property
+    def linear_constraint(self):
+        return self._linear_ct
+
+    @property
+    def lct(self):
+        return self.linear_constraint
+
+    @property
+    def benders_annotation(self):
+        """
+        This property is used to get or set the Benders annotation of a constraint.
+        The value of the annotation must be a positive integer
+
+        """
+        return self.get_benders_annotation()
+
+    @benders_annotation.setter
+    def benders_annotation(self, new_anno):
+        self.set_benders_annotation(new_anno)
+
+    def get_linear_constraint(self):
+        return self._linear_ct
+
+    @property
+    def cpx_complemented(self):
+        return 1 - self._active_value
+
+    def copy(self, target_model, var_map):
+        copied_binary = var_map[self.binary_var]
+        copied_linear_ct = self.linear_constraint.copy(target_model, var_map)
+        copy_name = None if target_model.ignore_names else self.name
+        copied_equiv = self.__class__(target_model,
+                                      copied_binary,
+                                      copied_linear_ct,
+                                      self._active_value,
+                                      copy_name)
+        return copied_equiv
+
+    def relaxed_copy(self, relaxed_model, var_map):
+        raise DocplexLinearRelaxationError(self, cause='logical')
+
+    def is_logical(self):
+        return True
+
+    def iter_variables(self):
+        yield self._binary_var
+        for v in self._linear_ct.iter_variables():
+            yield v
+
+    def get_var_coef(self, dvar):
+        if dvar is self._binary_var:
+            return 1
+        else:
+            return self._linear_ct.get_var_coef(dvar)
+
+    def __str__(self):
+        return self.to_string(use_space=self.model.str_use_space)
+
+    def __repr__(self):
+        printable_name = self.safe_name
+        clazzname = self.__class__.__name__
+        s_lc = self._linear_ct.to_string(use_space=False).replace(' ', '')
+
+        return "docplex.mp.constr.{0:s}[{1}]({2!s},{3!s},true={4})" \
+            .format(clazzname, printable_name, self._binary_var, s_lc, self._active_value)
+
+    def notify_expr_modified(self, expr, event):
+        # INTERNAL
+        self.get_linear_factory().update_indicator_constraint_expr(self, event, expr)
+
+    @property
+    def slack_value(self):
+        return self._model._slack_value1(self)
+
+    def _symbol(self):
+        return '<->' if self.is_equivalence() else '->'
+
+
[docs]    def to_string(self, use_space=False):
+        """
+        Displays the equivalence constraint in a (shortened) LP style:
+        z <-> x+y+z == 2
+
+        Returns:
+            A string.
+        """
+      
+        return self._to_string(use_space, self.model.str_max_len)

+
+    def _to_string(self, use_space, max_str_len):
+        eqname = self.name
+        name_part = '{0}: '.format(eqname) if eqname else ''
+        eq_var = self._binary_var
+        if eq_var.is_generated():
+            varname = 'x%d' % eq_var._index
+        else:
+            varname = str(eq_var)
+        s_active_value = '' if self._active_value else '=0'
+        s_symbol = self._symbol()
+        s_lc = self.linear_constraint._to_string(use_space, max_str_len)
+        return "{0}{1}{2} {4} [{3}]".format(name_part, varname, s_active_value, s_lc, s_symbol)
+
+    def to_readable_string(self):
+        return self._to_string(use_space=True, max_str_len=self.model.readable_str_len)

+
+
+
[docs]class IndicatorConstraint(LogicalConstraint):
+    """ This class models indicator constraints.
+
+    An indicator constraint links (one-way) the value of a binary variable to the satisfaction of a linear constraint.
+    If the binary variable equals the active value, then the constraint is satisfied, but otherwise the constraint
+    may or may not be satisfied.
+
+    This class is not meant to be instantiated by the user.
+
+    To create an indicator constraint, use the factory method :func:`docplex.mp.model.Model.add_indicator`
+    defined on :class:`docplex.mp.model.Model`.
+
+    """
+    __slots__ = ()
+
+    def __init__(self, model, binary_var, linear_ct, active_value=1, name=None):
+        LogicalConstraint.__init__(self, model, binary_var, linear_ct, active_value, name)
+
+    @property
+    def short_typename(self):
+        return "indicator constraint"
+
+    def is_equivalence(self):
+        return False
+
+    def is_logical(self):
+        return True
+
+
[docs]    def invalidate(self):
+        """
+        Sets the binary variable to the opposite of its active value.
+        Typically used by indicator constraints with a trivial infeasible linear part.
+        For example, z=1 -> 4 <= 3 sets z to 0 and
+        z=0 -> 4 <= 3 sets z to 1.
+        This is equivalent to if z=a => False, then z *cannot* be equal to a.
+        """
+        if 0 == self.active_value:
+            # set to 1 : lb = 1
+            self.binary_var.lb = 1
+        elif 1 == self.active_value:
+            # set to 0 ub = 0
+            self.binary_var.ub = 0
+        else:
+            self.fatal("Unexpected active value for indicator constraint: {0!s}, value is: {1!s}, expecting 0 or 1",
+                       # pragma: no cover
+                       self, self.active_value)  # pragma: no cover

+
+    def is_satisfied(self, solution, tolerance=1e-6):
+        binary_value = solution.get_value(self._binary_var)
+        if abs(binary_value - self._active_value) <= tolerance:
+            is_ct_satisfied = self._linear_ct.is_satisfied(solution, tolerance)
+            # only active if binary is active value:
+            return abs(1 - is_ct_satisfied) <= tolerance
+        else:
+            # when binary var is not equal to active_value, indicator has no effect
+            return True

+
+
+
[docs]class EquivalenceConstraint(LogicalConstraint):
+    """ This class models equivalence constraints.
+
+    An equivalence constraint links (both ways) the value of a binary variable
+    to the satisfaction of a linear constraint.
+
+    If the binary variable equals the truth value (default is 1),
+    then the constraint is satisfied, conversely if the constraint
+    is satisfied, the value of the variable is set to the truth value.
+
+    This class is not meant to be instantiated by the user.
+
+    """
+    __slots__ = ()
+
+    def __init__(self, model, binary_var, linear_ct, truth_value=1, name=None):
+        LogicalConstraint.__init__(self, model, binary_var, linear_ct, truth_value, name)
+        # connect exprs
+        linear_ct.lock_discrete()
+
+    @property
+    def short_typename(self):
+        return "equivalence constraint"
+
+    def is_equivalence(self):
+        return True
+
+    def is_logical(self):
+        return True
+
+    def is_satisfied(self, solution, tolerance=1e-6):
+        bvar = self._binary_var
+        if bvar.is_generated() and bvar not in solution:
+            # bvar is not mentioned, ok
+            return True
+
+        is_ct_satisfied = self._linear_ct.is_satisfied(solution, tolerance)
+        binary_value = solution.get_value(bvar)
+        expected_value = self._active_value if is_ct_satisfied else 1 - self._active_value
+        ok =  ComparisonType.almost_equal(binary_value, expected_value, tolerance)
+        return ok

+
+
+
[docs]class IfThenConstraint(IndicatorConstraint):
+
+    def __init__(self, model, if_ct, then_ct, negate=False):
+        if_ct_status_var = if_ct.status_var
+        self._if_ct = if_ct
+        # if negated, then the then constraint is satisfied if not(if_ct) is satisfied
+        # this is actually an if-else ...
+        true_value = 0 if negate else 1
+        IndicatorConstraint.__init__(self, model, binary_var=if_ct_status_var,
+                                     linear_ct=then_ct, active_value=true_value, name=None)
+
+
[docs]    def to_string(self, use_space=False):
+        return "{0!s} -> {1}".format(self._if_ct, self.linear_constraint.to_string(use_space=use_space))

+
+
+
[docs]class QuadraticConstraint(BinaryConstraint):
+    """ The class models quadratic constraints.
+
+        Quadratic constraints are of the form `<qexpr1> <OP> <qexpr2>`,
+        where at least one of <qexpr1> or <qexpr2> is a quadratic expression.
+
+    """
+
+    def copy(self, target_model, var_map):
+        # noinspection PyPep8
+        copied_left_expr = self.left_expr.copy(target_model, var_map)
+        copied_right_expr = self.right_expr.copy(target_model, var_map)
+        copy_name = None if target_model.ignore_names else self.name
+        return QuadraticConstraint(target_model, copied_left_expr, self.type, copied_right_expr, copy_name)
+
+    def relaxed_copy(self, relaxed_model, var_map):
+        raise DocplexLinearRelaxationError(self, cause='quadratic')
+
+    def is_quadratic(self):
+        return True
+
+    @property
+    def short_typename(self):
+        return "quadratic constraint"
+
+    def _get_index_scope(self):
+        return self._model._quadct_scope
+
+    __slots__ = ()
+
+    def is_trivial(self):
+        for _, nqk in self.iter_net_quads():
+            if nqk:
+                return False
+        # now check linear parts
+
+        for _, lk in self.iter_net_linear_coefs():
+            if lk:
+                return False
+        return True
+
+    def iter_net_linear_coefs(self):
+        linear_left = self._left_expr.get_linear_part()
+        linear_right = self._right_expr.get_linear_part()
+        return self._iter_net_linear_coefs_sorted(linear_left, linear_right)
+
+    def iter_net_quads(self):
+        # INTERNAL
+        left_expr = self._left_expr
+        right_expr = self._right_expr
+        if not right_expr.is_quad_expr():
+            return left_expr.iter_sorted_quads()
+        elif not left_expr.is_quad_expr():
+            return right_expr.iter_opposite_ordered_quads()
+        else:
+            return self.generate_ordered_net_quads(left_expr, right_expr)
+
+    @classmethod
+    def generate_ordered_net_quads(cls, qleft, qright):
+        # left first, then right
+        for lqv, lqk in qleft.iter_sorted_quads():
+            net_k = lqk - qright._get_quadratic_coefficient_from_var_pair(lqv)
+            if 0 != net_k:
+                yield lqv, net_k
+        for rqv, rqk in qright.iter_sorted_quads():
+            if not qleft.contains_quad(rqv) and rqk:
+                yield rqv, -rqk
+
+    def _set_left_expr(self, new_left_expr):
+        self.qfactory.set_quadratic_constraint_expr_from_pos(self, pos=0, new_expr=new_left_expr)
+
+    @property
+    def left_expr(self):
+        return BinaryConstraint.get_left_expr(self)
+
+    @left_expr.setter
+    def left_expr(self, new_left_expr):
+        self._set_left_expr(new_left_expr)
+
+    def _set_right_expr(self, new_right_expr):
+        self.qfactory.set_quadratic_constraint_expr_from_pos(self, pos=1, new_expr=new_right_expr)
+
+    @property
+    def right_expr(self):
+        return BinaryConstraint.get_right_expr(self)
+
+    @right_expr.setter
+    def right_expr(self, new_right_expr):
+        self._set_right_expr(new_right_expr)
+
+    # aliases
+    rhs = right_expr
+    lhs = left_expr
+
+    @property
+    def benders_annotation(self):
+        """
+        This property is used to get or set the Benders annotation of a constraint.
+        The value of the annotation must be a positive integer
+
+        """
+        return self.get_benders_annotation()
+
+    @benders_annotation.setter
+    def benders_annotation(self, new_anno):
+        self.set_benders_annotation(new_anno)
+
+    @property
+    def slack_value(self):
+        """ This property returns the slack value of the constraint.
+
+        Note:
+            This method will raise an exception if the model has not been solved successfully.
+        """
+        return self._model._slack_value1(self)
+
+    @property
+    def sense(self):
+        """ This property is used to get or set the sense of the constraint; sense is an enumerated value
+        of type :class:`ComparisonType`, with three possible values:
+
+        - LE for e1 <= e2 constraints
+
+        - EQ for e1 == e2 constraints
+
+        - GE for e1 >= e2 constraints
+
+        where e1 and e2 denote quadratic expressions.
+
+        """
+        return self._ctsense
+
+    @sense.setter
+    def sense(self, new_sense):
+        self.set_sense(new_sense)
+
+    def set_sense(self, new_sense):
+        self.qfactory.set_quadratic_constraint_sense(self, new_sense)
+
+    # compat
+    @property
+    def type(self):
+        return self._ctsense
+
+    def has_net_quadratic_term(self):
+        # INTERNAL
+        return any(nk for _, nk in self.iter_net_quads())
+
+    def notify_expr_modified(self, expr, event):
+        # INTERNAL
+        self.qfactory.update_quadratic_constraint(self, expr, event)
+
+    def notify_expr_replaced(self, old_expr, new_expr):
+        qfact = self.qfactory
+        if old_expr is self._left_expr:
+            qfact.set_quadratic_constraint_expr_from_pos(qct=self, pos=0, new_expr=new_expr,
+                                                         supdate_subscribers=False)
+        elif old_expr is self._right_expr:
+            qfact.set_quadratic_constraint_expr_from_pos(qct=self, pos=1, new_expr=new_expr,
+                                                         update_subscribers=False)
+        else:
+            # should not happen
+            pass
+        # new expr takes al subscribers from old expr
+        if not is_var(new_expr):
+            new_expr.grab_subscribers(old_expr)

+
+
+
[docs]class PwlConstraint(AbstractConstraint):
+    """ This class models piecewise linear constraints.
+
+    This class is not meant to be instantiated by the user.
+    To create a piecewise constraint, use the factory method :func:`docplex.mp.model.Model.piecewise`
+    defined on :class:`docplex.mp.model.Model`.
+
+    """
+
+    __slots__ = ('_pwl_expr', '_input_var', '_y')
+
+    def __init__(self, model, pwl_expr, name=None):
+        AbstractConstraint.__init__(self, model, name)
+        self._pwl_expr = pwl_expr
+        self._input_var = pwl_expr._x_var
+        self._y = None
+
+    def resolve(self):
+        self._pwl_expr.resolve()
+
+    def is_satisfied(self, solution, tolerance):
+        expr_value = self._input_var._raw_solution_value(solution)
+        y_value = solution._get_var_value(self._y)
+        computed_f_expr_value = self.pwl_func.evaluate(expr_value)
+        return ComparisonType.almost_equal(y_value, computed_f_expr_value, tolerance)
+
+    @property
+    def expr(self):
+        """ This property returns the linear expression of the piecewise linear constraint.
+        """
+        return self._input_var
+
+    @property
+    def pwl_func(self):
+        """ This property returns the piecewise linear function of the piecewise linear constraint.
+        """
+        return self._pwl_expr.pwl_func
+
+    @property
+    def y(self):
+        """ This property returns the output variable associated with the piecewise linear constraint.
+        """
+        if self._y is None:
+            self._y = self._pwl_expr._get_allocated_f_var()
+        return self._y
+
+    def _get_index_scope(self):
+        return self._model._pwl_scope
+
+    def iter_exprs(self):
+        yield self._pwl_expr
+
+
[docs]    def iter_variables(self):
+        """Iterates over all the variables of the piecewise linear constraint.
+
+        Returns:
+           An iterator object.
+        """
+        yield self.y
+        yield self._input_var

+
+    def iter_extended_variables(self):
+        # iterates on all extended variables involved in the computation
+        # yvar, xavr, plus all argument rexpr vars
+        # if argument var is identical to the input var, it is returned twice...?
+        yield self.y
+        yield self._input_var
+        for v in self._pwl_expr._argument_expr.iter_variables():
+            yield v
+
+    def get_var_coef(self, dvar):
+        if dvar is self.y:
+            return 1
+        else:
+            return self.expr.unchecked_get_coef(dvar)
+
+    def copy(self, target_model, var_map):
+        # Internal: copy must not be invoked on PwlConstraint.
+        raise NotImplementedError  # pragma: no cover
+
+    def relaxed_copy(self, relaxed_model, var_map):
+        raise DocplexLinearRelaxationError(self, cause='pwl')
+
+    def to_string(self, use_space=False):
+        pwlf = self.pwl_func
+        pwlf_s = pwlf.name or 'pwl?'
+        s_expr = self.expr.to_string(use_space=use_space)
+        return "{0} == {1!s}({2!s})".format(self.y, pwlf_s, s_expr)
+
+    def __str__(self):
+        """ Returns a string representation of the piecewise linear constraint.
+
+        Example:
+            `y == pwl_name(x + z)` represents the piecewise linear constraint where the variable `y` is
+            constrained to be equal to the value of the piecewise linear function whose name is 'pwl_name'
+            applied to the expression (x + z).
+
+        Returns:
+            A string.
+        """
+        return self.to_string(use_space=self.model.str_use_space)
+
+    def __repr__(self):
+        return "docplex.mp.PwlConstraint({0},{1!s},{2})". \
+            format(self.y, self.pwl_func, self.expr)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/context.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/context.html new file mode 100644 index 0000000..5f13bd3 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/context.html @@ -0,0 +1,859 @@ + + + + + + + + + docplex.mp.context — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.context

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2019
+# --------------------------------------------------------------------------
+'''Configuration of Mathematical Programming engine.
+
+The :class:`~Context` is the base class to control the behaviour of solve
+engine.
+
+It is not advised to instanciate a Context in your code.
+
+Instead, you should obtain a Context by the following ways:
+
+    * create one using Context.make_default_context()
+    * use the one in your :class:`docplex.mp.model.Model`
+
+``docplex.mp`` configuration files are stored in files named:
+
+    * cplex_config.py
+    * cplex_config_<hostname>.py
+
+When obtaining a Context with make_default_context(), the PYTHONPATH is
+searched for the configuration files and read.
+
+Configuration files are evaluated with a `context` object in their
+scope, and you set values from this context::
+
+    context.cplex_parameters.emphasis.memory = 1
+    context.cplex_parameters.emphasis.mip = 2
+'''
+import os
+
+from copy import deepcopy
+
+import shlex
+import socket
+import sys
+import warnings
+from os.path import isfile, isabs
+
+from docplex.util.environment import get_environment
+
+from docplex.mp.utils import is_string, open_universal_newline
+from docplex.mp.params.cplex_params import get_params_from_cplex_version
+from docplex.mp.params.parameters import RootParameterGroup
+from docplex.mp.utils import DOcplexException
+from docplex.mp.error_handler import docplex_fatal
+
+try:
+    from docplex_wml.worker.solvehook import get_solve_hook
+except ImportError:
+    get_solve_hook = None
+
+
+def init_cplex_parameters(x):
+    return x.init_cplex_parameters()
+
+
+class StreamWithCustomClose(object):
+    # wrapper for streams, so that we can keep track of those who need
+    # to be closed by us.
+    def __init__(self, target):
+        self._target = target
+
+    def __getattr__(self, name):
+        return getattr(self._target, name)
+
+    def custom_close(self):
+        return self._target.close()
+
+    def __str__(self):
+        return "<{0}>".format(self._target.name or "input")
+
+
+# some utility methods
+# def _get_value_as_int(d, option):
+#     try:
+#         value = int(d[option])
+#     except Exception:
+#         value = None
+#     return value
+#
+#
+# def _convert_to_int(value):
+#     if str(value).lower() == 'none':
+#         return None
+#     try:
+#         value = int(value)
+#     except Exception:
+#         value = None
+#     return value
+#
+#
+# def _get_value_as_string(d, option):
+#     return d.get(option, None)
+#
+#
+# def _get_value_as_boolean(d, option):
+#     try:
+#         value = _convert_to_bool(d[option])
+#     except Exception:
+#         value = None
+#     return value
+
+
+_boolean_map = {'1': True, 'yes': True, 'true': True, 'on': True,
+                '0': False, 'no': False, 'false': False, 'off': False}
+
+
+def _convert_to_bool(value):
+    if value is None:
+        return None
+    elif is_string(value):
+        svalue = str(value).lower()
+        if svalue == "none":
+            return None
+        else:
+            bvalue = _boolean_map.get(svalue)
+            if bvalue is not None:
+                return bvalue
+            else:
+                raise ValueError('Not a boolean: {0}'.format(value))
+    else:
+        raise ValueError('Not a boolean: {0}'.format(value))
+
+
+
[docs]class InvalidSettingsFileError(Exception):
+    '''The error raised when an error occured when reading a settings file.
+
+    *New in version 2.8*
+    '''
+
+    def __init__(self, mesg, filename=None, source=None, *args, **kwargs):
+        super(InvalidSettingsFileError, self).__init__(mesg)
+        self.filename = filename
+        self.source = source

+
+
+def is_auto_publishing_solve_details(context):
+    try:
+        auto_publish_details = context.solver.auto_publish.solve_details
+    except AttributeError:
+        try:
+            auto_publish_details = context.solver.auto_publish
+        except AttributeError:
+            auto_publish_details = False
+    return auto_publish_details
+
+
+def check_credentials(context):
+    #     Checks if the context has syntactically valid credentials. The context
+    #     has valid credentials when it has an `url` and a `key` fields and that
+    #     both fields are string.
+    #
+    #     If the credentials are not defined, `message` contains a message describing
+    #     the cause.
+    #
+    #     Returns:
+    #         (has_credentials, message): has_credentials` - True if the context contains syntactical credentials.
+    #            and `message`  - contains a message if applicable.
+    credentials_ok = True
+    message = None
+    if not context.url or not context.key:
+        credentials_ok = False
+    elif not is_string(context.url):
+        message = "DOcplexcloud: URL is not a string: {0!s}".format(context.url)
+        credentials_ok = False
+    elif not is_string(context.key):
+        message = "API key is not a string: {0!s}".format(context.key)
+        credentials_ok = False
+    if context.key and credentials_ok:
+        credentials_ok = isinstance(context.key, str)
+    return credentials_ok, message
+
+
+def has_credentials(context):
+    # Checks if the context has valid credentials.
+    #
+    # Returns:
+    #    True if the context has valid credentials.
+    # ignore message
+    has_credentials_, _ = check_credentials(context)
+    return has_credentials_
+
+
+def print_context(context):
+    # prints the context.
+    def print_r(node, prefix):
+        for n in sorted(node):
+            if not n.startswith('_'):
+                path = ".".join([prefix, n] if prefix else [n])
+                if isinstance(node.get(n), (dict, SolverContext)):
+                    print("%s  # type: %s" % (path, type(node.get(n)).__name__))
+                    print_r(node.get(n), path)
+                else:
+                    print("%s = %s # type: %s" % (path, node.get(n), type(node.get(n)).__name__))
+
+    print_r(context, "context")
+
+
+
[docs]class BaseContext(dict):
+    # Class for handling the list of parameters.
+
+    def __init__(self, **kwargs):
+        """ Create a new context.
+
+        Args:
+            List of ``key=value`` to initialize context with.
+        """
+        super(BaseContext, self).__init__()
+        for k, v in kwargs.items():
+            self.set_attribute(k, v)
+
+    def __setattr__(self, name, value):
+        self.set_attribute(name, value)
+
+    def __getattr__(self, name):
+        return self.get_attribute(name)
+
+    def set_attribute(self, name, value):
+        self[name] = value
+
+    def get_attribute(self, name, default=None):
+        if name.startswith('__'):
+            raise AttributeError
+        res = self.get(name, default)
+        return res
+
+    def display(self):
+        # prints the context.
+        def print_r(node, prefix):
+            for n in sorted(node):
+                if not n.startswith('_'):
+                    path = ".".join([prefix, n] if prefix else [n])
+                    if isinstance(node.get(n), (dict, SolverContext)):
+                        print("%s  # type: %s" % (path, type(node.get(n)).__name__))
+                        print_r(node.get(n), path)
+                    else:
+                        print("%s = %s # type: %s" % (path, node.get(n), type(node.get(n)).__name__))
+
+        print_r(self, "context")

+
+
+
[docs]class SolverContext(BaseContext):
+    # for internal use
+
+    def __init__(self, **kwargs):
+        super(SolverContext, self).__init__(**kwargs)
+        self.log_output = False
+        self.max_threads = get_environment().get_available_core_count()
+        self.auto_publish = create_default_auto_publish_context()
+        self.kpi_reporting = BaseContext()
+        from docplex.mp.progress import ProgressClock
+        self.kpi_reporting.filter_level = ProgressClock.Gap
+
+    def __deepcopy__(self, memo):
+        # We override deepcopy here just to make sure that we don't deepcopy
+        # file descriptors...
+        cls = self.__class__
+        result = cls.__new__(cls)
+        memo[id(self)] = result
+        for k, v in self.items():
+            # do not duplicate those (io like objects)
+            if k == "log_output" and hasattr(v, "write"):
+                value = v
+            else:
+                value = deepcopy(v, memo)
+            setattr(result, k, value)
+        return result
+
+    @property
+    def log_output_as_stream(self):
+        try:
+            log_output = self.log_output
+        except AttributeError:  # pragma: no cover
+            return None
+
+        output_stream = None
+        # if log_output is an object with a lower attribute, let's use it
+        # as string.lower and check for some known string values
+        if hasattr(log_output, "lower"):
+            k = log_output.lower()
+            if k in _boolean_map:
+                if _convert_to_bool(k):
+                    output_stream = sys.stdout
+                else:
+                    output_stream = None
+            elif k in ["stdout", "sys.stdout"]:
+                output_stream = sys.stdout
+            elif k in ["stderr", "sys.stderr"]:
+                output_stream = sys.stderr
+            else:
+                output_stream = open(log_output, 'w')
+                output_stream = StreamWithCustomClose(output_stream)
+        # if log_output is == to True, just use stdout
+        if log_output is True:
+            output_stream = sys.stdout
+        # if it has a write() attribute, just return it
+        elif hasattr(log_output, "write"):
+            output_stream = log_output
+
+        return output_stream

+
+
+
[docs]class Context(BaseContext):
+    """ The context used to control the behavior of solve engine.
+
+    Attributes:
+        cplex_parameters: A
+           :class:`docplex.mp.params.parameters.RootParameterGroup` to store
+           CPLEX parameters.
+        solver.auto_publish: If ``True``, a model being solved will automatically
+            publish all publishable items (``solve_details``,
+            ``result_output``, ``kpis_output``).
+        solver.auto_publish.solve_details: if ``True``, solve details are
+            published automatically.
+        solver.auto_publish.result_output: if not None, the filename where
+            solution is saved. This can be a list of filenames if multiple
+            solutions are to be published. If True, ``solution.json`` is used.
+        solver.auto_publish.kpis_output: if not None, the filename where KPIs
+            are saved as a table with KPI name and values. Currently only
+            csv files are supported. This can be a list of filenames if
+            multiple KPIs files are to be published.
+        context.solver.auto_publish.kpis_output_field_name: Name of field for KPI names in KPI output
+            table. Defaults to 'Name'
+        context.solver.auto_publish.kpis_output_field_value: Name of field for KPI values for KPI output
+            table. Defaults to 'Value'
+        solver.log_output: This attribute can have the following values:
+
+            * True: When True, logs are printed to sys.out.
+            * False: When False, logs are not printed.
+            * A file-type object: Logs are printed to that file-type object.
+
+        solver.kpi_reporting.filter_level: Specify the filtering level for kpi reporting.
+            If None, no filtering is done. Can take values of
+            docplex.mp.progress.KpiFilterLevel or a string representation of
+            one of the values of this enum (Unfiltered, FilterObjectiveAndBound,
+            FilterObjective)
+    """
+
+    def __init__(self, **kwargs):
+        # store env used for initialization
+        self['_env_at_init'] = kwargs.get('_env')
+        # map lazy members to f(model) (actually f(self) ) returning the
+        # initial value
+        self['_lazy_members'] = \
+            {'cplex_parameters': init_cplex_parameters}
+        # initialize fields
+        if 'solver_context' in kwargs:
+            solver_context = kwargs.pop('solver_context')
+        else:
+            solver_context = SolverContext() #create_default_auto_publish_context(defaults=False) #Context.make_default_context()
+
+        super(Context, self).__init__(solver=solver_context,
+                                      cos=BaseContext(),
+                                      docplex_tests=BaseContext())
+        # update will also ensure compatibility with older kwargs like
+        # 'url' and 'api_key'
+        self.update(kwargs, create_missing_nodes=True)
+
+        self.model_build_hook = None
+
+    def init_cplex_parameters(self):
+        # we need a local import here so that docplex.mp.environment
+        # does not depend on context
+        from docplex.mp.environment import Environment
+        local_env = self.get('_env_at_init') or Environment.get_default_env()
+        cplex_version = local_env.cplex_version
+        local_env.check_cplex_version()
+        cplex_parameters = get_params_from_cplex_version(cplex_version)
+        return cplex_parameters
+
+    def __getattr__(self, name):
+        if name not in self:
+            lazy_members = self.get('_lazy_members')
+            if lazy_members and name in lazy_members:
+                evaluated = lazy_members[name](self)
+                self[name] = evaluated
+        return self.get_attribute(name)
+
+    def _get_raw_cplex_parameters(self):
+        # NON LAZY: may return None
+        return self.get('cplex_parameters')
+
+
[docs]    @staticmethod
+    def make_default_context(file_list=None, logger=None, **kwargs):
+        """Creates a default context.
+
+        If `file_list` is a string, then it is considered to be the name
+        of a config file to be read.
+
+        If `file_list` is a list, it is considered to be a list of names
+        of a config files to be read.
+
+        if `file_list` is None or not specified, the following files are
+        read if they exist:
+
+            * the PYTHONPATH is searched for the following files:
+
+                * cplex_config.py
+                * cplex_config_<hostname>.py
+
+        Args:
+            file_list: The list of config files to read.
+            kwargs: context parameters to override. See :func:`docplex.mp.context.Context.update`
+        """
+        context = Context(**kwargs)
+        context.read_settings(file_list=file_list, logger=logger)
+        if 'DOCPLEX_CONTEXT' in os.environ:
+            values_pairs = []
+            for v in shlex.split(os.environ['DOCPLEX_CONTEXT']):
+                s = v.split('=', 1)  # max 1 split
+                # convert values to bool if relevant
+                value = _boolean_map.get(s[1].strip().lower(), s[1])
+                values_pairs.append((s[0], value))
+                if logger:
+                    logger.info('Setting context value %s to %s (from DOCPLEX_CONTEXT env)' % (s[0], value))
+            context.update_from_list(values_pairs, logger=logger)
+        return context

+
+
[docs]    def copy(self):
+        # Makes a deep copy of the context.
+        #
+        # Returns:
+        #   A deep copy of the context.
+        return deepcopy(self)

+
+    def clone(self):
+        # Makes a deep copy of the context.
+        #
+        # Returns:
+        #   A deep copy of the context.
+        return deepcopy(self)
+
+    def override(self):
+        return ContextOverride(self)
+
+    def update_from_list(self, values, logger=None):
+        # For each pair of `(name, value)` in values, try to set the
+        # attribute.
+        for name, value in values:
+            try:
+                self._set_value(self, name, value)
+            except AttributeError:
+                if logger is not None:
+                    logger.warning("Ignoring undefined attribute : {0}".format(name))
+
+    def _set_value(self, root, property_spec, property_value):
+        property_list = property_spec.split('.')
+        property_chain = property_list[:-1]
+        to_be_set = property_list[-1]
+        o = root
+        for c in property_chain:
+            o = getattr(o, c)
+        try:
+            target_attribute = getattr(o, to_be_set)
+        except AttributeError:
+            target_attribute = None
+        if target_attribute is None:
+            # Simply set the attribute
+            try:
+                setattr(o, to_be_set, property_value)
+            except DOcplexException:
+                pass  # ignore this
+        else:
+            # try a set_converted_value if it's a Parameter
+            try:
+                target_attribute.set(property_value)
+            except (AttributeError, TypeError):
+                # no set(), just setattr
+                setattr(o, to_be_set, property_value)
+
+
[docs]    def update(self, kwargs, create_missing_nodes=False):
+        """ Updates this context from child parameters specified in ``kwargs``.
+
+        The following keys are recognized:
+
+            - cplex_parameters: A set of CPLEX parameters to use instead of the parameters defined as ``context.cplex_parameters``.
+            - agent: Changes the ``context.solver.agent`` parameter.
+                Supported agents include:
+                - ``local``: forces the solve operation to use native CPLEX
+
+            - log_output: if ``True``, solver logs are output to stdout.
+                If this is a stream, solver logs are output to that stream object.
+                Overwrites the ``context.solver.log_output`` parameter.
+
+        Args:
+            kwargs: A ``dict`` containing keyword args to use to update this context.
+            create_missing_nodes: When a keyword arg specify a parameter that is not already member of this context,
+                creates the parameter if ``create_missing_nodes`` is True.
+
+        """
+        for k in kwargs:
+            value = kwargs.get(k)
+            if value is not None:
+                self.update_key_value(k, value,
+                                      create_missing_nodes=create_missing_nodes)

+
+    cplex_parameters_key = "cplex_parameters"
+
+    def update_cplex_parameters(self, arg_params):
+        # INTERNAL
+        if isinstance(arg_params, RootParameterGroup):
+            self.cplex_parameters = arg_params
+        else:
+            new_params = self.cplex_parameters.copy()
+            # try a dictionary of parameter qualified names, parameter values
+            # e.g. cplex_parameters={'mip.tolerances.mipgap': 0.01, 'timelimit': 180}
+            try:
+                for pk, pv in arg_params.items():
+                    p = new_params.find_parameter(key=pk)
+                    if not p:
+                        docplex_fatal('Cannot find matching parameter from: {0!r}'.format(pk))
+                    else:
+                        p.set(pv)
+                self.cplex_parameters = new_params
+
+            except (TypeError, AttributeError):
+                docplex_fatal('Expecting CPLEX parameters or dict, got: {0!r}'.format(arg_params))
+
+    def update_key_value(self, k, value, create_missing_nodes=False, warn=True):
+        if k == 'cplex_parameters':
+            if isinstance(value, RootParameterGroup):
+                self.cplex_parameters = value
+            else:
+                self.update_cplex_parameters(value)
+        elif k == 'log_output':
+            self.solver.log_output = value
+        elif k == 'override':
+            self.update_from_list(value.items())
+        elif k == '_env':
+            # do nothing this is just here to avoid creating too many envs
+            pass
+        elif k == 'agent':
+            self.solver.agent = value
+        else:
+            if create_missing_nodes:
+                self[k] = value
+            elif warn:
+                warnings.warn("Unknown quick-setting in Context: {0:s}, value: {1!s}".format(k, value),
+                              stacklevel=2)
+
+
[docs]    def read_settings(self, file_list=None, logger=None):
+        """Reads settings for a list of files.
+
+        If `file_list` is a string, then it is considered to be the name
+        of a config file to be read.
+
+        If `file_list` is a list, it is considered to be a list of names
+        of config files to be read.
+
+        if `file_list` is None or not specified, the following files are
+        read if they exist:
+
+            * the PYTHONPATH is searched for the following files:
+
+                * cplex_config.py
+                * cplex_config_<hostname>.py
+
+        Args:
+            file_list: The list of config files to read.
+
+        Raises:
+            InvalidSettingsFileError: If an error occurs while reading a config
+                file. *(Since version 2.8)*
+        """
+        if file_list is None:
+            file_list = []
+            targets = ['cplex_config.py',
+                       'cplex_config_{0}.py'.format(socket.gethostname())
+                       ]
+            for target in targets:
+                if isabs(target) and isfile(target) and target not in file_list:
+                    file_list.append(target)
+                else:
+                    for d in sys.path:
+                        f = os.path.join(d, target)
+                        if os.path.isfile(f):
+                            abs_name = os.path.abspath(f)
+                            if abs_name not in file_list:
+                                file_list.append(f)
+
+            if len(file_list) == 0:
+                file_list = None  # let read_settings use its default behavior
+
+        if isinstance(file_list, str):
+            file_list = [file_list]
+
+        if file_list is not None:
+            for f in file_list:
+                if os.path.isfile(f):
+                    if logger:
+                        logger.info("Reading settings from %s" % f)
+                    if f.endswith(".py"):
+                        self.read_from_python_file(f)

+
+    def read_from_python_file(self, filename):
+        # Evaluates the content of a Python file containing code to set up a
+        # context.
+        #
+        # Args:
+        #    filename (str): The name of the file to evaluate.
+        try:
+            if os.path.isfile(filename):
+                with open_universal_newline(filename, 'r') as f:
+                    l = {'context': self,
+                         '__file__': os.path.abspath(filename)}
+                    exec(f.read(), globals(), l)
+        except Exception as exc:
+            raise InvalidSettingsFileError('Error occured while reading file: %s' % filename,
+                                           filename=filename, source=exc)
+        return self

+
+
+def create_default_auto_publish_context(defaults=True):
+    auto_publish = BaseContext()
+    # in a future version, we might want to be able to set individual
+    # default values with a dict => that's why we compare to True and False
+    if defaults is True and get_solve_hook:
+        # Set default values when in a worker
+        auto_publish.solve_details = True
+        auto_publish.result_output = 'solution.json'
+        auto_publish.kpis_output = 'kpis.csv'
+        auto_publish.kpis_output_field_name = 'Name'
+        auto_publish.kpis_output_field_value = 'Value'
+        auto_publish.relaxations_output = 'relaxations.csv'
+        auto_publish.conflicts_output = 'conflicts.csv'
+    else:
+        auto_publish.solve_details = False
+        auto_publish.result_output = None
+        auto_publish.kpis_output = None
+        auto_publish.kpis_output_field_name = None
+        auto_publish.kpis_output_field_value = None
+        auto_publish.relaxations_output = None
+        auto_publish.conflicts_output = None
+    return auto_publish
+
+
+
[docs]class ContextOverride(Context):
+
+    def __init__(self, initial_context):
+        soc2 = deepcopy(initial_context.solver)
+        super(ContextOverride, self).__init__(solver_context=soc2)
+        self._initial_context = initial_context  # unchanged
+        self.cplex_parameters = initial_context.cplex_parameters
+
+    # @property
+    # def solver(self):
+    #     if self._solver is None:
+    #         self._solver = deepcopy(self._initial_context.solver)
+    #     return self._solver
+
+    def update_key_value(self, k, value, create_missing_nodes=False, warn=True):
+        if k == 'cplex_parameters':
+            if isinstance(value, RootParameterGroup):
+                self.cplex_parameters = value
+            else:
+                self.update_cplex_parameters(value)
+        elif k == 'time_limit':
+            time_limit_failed = True
+            try:
+                time_limit = int(value)
+                if time_limit >= 0:
+                    # this method makes a local copy for the duration of solve()
+                    self.update_cplex_parameters({"timelimit": time_limit})
+                    time_limit_failed = False
+
+            except ValueError:
+                pass
+            if time_limit_failed:
+                print("Invalid time limit: {0!r} - ignored".format(value))
+        elif k == 'log_output':
+            self.solver.log_output = value
+        elif k == 'override':
+            self.update_from_list(value.items())
+        elif k == '_env':
+            # do nothing this is just here to avoid creating too many envs
+            pass
+        elif k == 'agent':
+            self.solver.agent = value
+        else:
+            if create_missing_nodes:
+                self.k = value
+            elif warn:
+                warnings.warn("Unknown quick-setting in Context: {0:s}, value: {1!s}".format(k, value),
+                              stacklevel=2)
+
+    def update_cplex_parameters(self, arg_params):
+        # INTERNAL
+        new_params = self.cplex_parameters.copy()
+        # try a dictionary of parameter qualified names, parameter values
+        # e.g. cplex_parameters={'mip.tolerances.mipgap': 0.01, 'timelimit': 180}
+        try:
+            for pk, pv in arg_params.items():
+                p = new_params.find_parameter(key=pk)
+                if not p:
+                    docplex_fatal('Cannot find matching parameter from: {0!r}'.format(pk))
+                else:
+                    p.set(pv)
+            self.cplex_parameters = new_params
+
+        except (TypeError, AttributeError):
+            docplex_fatal('Expecting CPLEX parameters or dict, got: {0!r}'.format(arg_params))
+
+    def update_from_list(self, key_value_pairs, logger=None):
+        # For each pair of `(name, value)` in values, try to set the
+        # attribute.
+        for name, value in key_value_pairs:
+            try:
+                self._set_value(self, name, value)
+            except AttributeError:
+                if logger is not None:
+                    logger.warning("Ignoring undefined attribute : {0}".format(name))
+
+    def _set_value(self, root, property_spec, property_value):
+        property_list = property_spec.split('.')
+        property_chain = property_list[:-1]
+        to_be_set = property_list[-1]
+        o = root
+        for c in property_chain:
+            o = getattr(o, c)
+        try:
+            target_attribute = getattr(o, to_be_set)
+        except AttributeError:
+            target_attribute = None
+        if target_attribute is None:
+            # Simply set the attribute
+            try:
+                setattr(o, to_be_set, property_value)
+            except DOcplexException:
+                print('attribute not found: {0}'.format(to_be_set))
+        else:
+            # try a set_converted_value if it's a Parameter
+            try:
+                target_attribute.set(property_value)
+            except (AttributeError, TypeError):
+                # no set(), just setattr
+                setattr(o, to_be_set, property_value)

+
+
+class OverridenOutputContext(object):
+
+    def __init__(self, mdl, stream):
+        self._model = mdl
+        self._stream = stream
+        self._saved_context_log_output = mdl.context.solver.log_output
+        self._saved_log_output_stream = mdl.log_output
+
+    def __enter__(self):
+        mdl = self._model
+        # change stream
+        mdl.set_log_output(self._stream)
+        return mdl
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        mdl = self._model
+        log_stream = mdl.log_output
+        if log_stream:
+            try:
+                log_stream.flush()
+            except AttributeError:
+                pass
+            try:
+                log_stream.custom_close()
+            except AttributeError:
+                pass
+
+        saved_log_output_stream = self._saved_log_output_stream
+        saved_context_log_output = self._saved_context_log_output
+        if self._saved_log_output_stream != mdl.log_output:
+            mdl.set_log_output_as_stream(saved_log_output_stream)
+        if saved_context_log_output != mdl.context.solver.log_output:
+            mdl.context.solver.log_output = saved_context_log_output
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/dvar.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/dvar.html new file mode 100644 index 0000000..109c7f5 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/dvar.html @@ -0,0 +1,760 @@ + + + + + + + + + docplex.mp.dvar — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.dvar

+
+from docplex.mp.constants import CplexScope
+
+from docplex.mp.basic import IndexableObject, _AbstractBendersAnnotated, _AbstractValuable
+from docplex.mp.operand import LinearOperand
+from docplex.mp.utils import is_number, is_quad_expr
+
+from docplex.mp.sttck import StaticTypeChecker
+
+
+
[docs]class Var(IndexableObject, LinearOperand, _AbstractBendersAnnotated, _AbstractValuable):
+    """Var()
+
+    This class models decision variables.
+    Decision variables are instantiated by :class:`docplex.mp.model.Model` methods such as :func:`docplex.mp.model.Model.var`.
+
+    """
+
+    __slots__ = ('_vartype', '_lb', '_ub')
+
+    def __init__(self, model, vartype, name,
+                 lb=None, ub=None,
+                 _safe_lb=False, _safe_ub=False):
+        IndexableObject.__init__(self, model, name)
+        self._vartype = vartype
+
+        if _safe_lb:
+            #assert lb is not None
+            self._lb = lb
+        else:
+            self._lb = vartype._compute_lb(lb, model)
+        if _safe_ub:
+            #assert ub is not None
+            self._ub = ub
+        else:
+            self._ub = vartype._compute_ub(ub, model)
+
+    @property
+    def cplex_scope(self):
+        return CplexScope.VAR_SCOPE
+
+    # noinspection PyUnusedLocal
+    def copy(self, new_model, var_mapping):
+        return var_mapping[self]
+
+    relaxed_copy = copy
+
+    # linear operand api
+
+    def as_variable(self):
+        return self
+
+    def iter_terms(self):
+        yield self, 1
+
+    def clone(self):
+        return self
+
+    def negate(self):
+        return self.lfactory._new_monomial_expr(self, -1, safe=True)
+
+    iter_sorted_terms = iter_terms
+
+    def number_of_variables(self):
+        return 1
+    def number_of_terms(self):
+        return 1
+
+    def unchecked_get_coef(self, dvar):
+        return 1 if dvar is self else 0
+
+    def contains_var(self, dvar):
+        return self is dvar
+
+    def accepts_value(self, candidate_value, tolerance=1e-6):
+        # INTERNAL
+        return self.vartype.accept_domain_value(candidate_value, lb=self._lb, ub=self._ub, tolerance=tolerance)
+
+    def check_name(self, new_name):
+        self.check_lp_name(qualifier='variable', new_name=new_name, accept_empty=False, accept_none=False)
+
+    def __hash__(self):
+        return self._index
+
+    def set_name(self, new_name):
+        # INTERNAL
+        self.check_name(new_name)
+        self.model.set_var_name(self, new_name)
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, new_name):
+        self.set_name(new_name)
+
+    @property
+    def lb(self):
+        """ This property is used to get or set the lower bound of the variable.
+
+        Possible values for the lower bound depend on the variable type. Binary variables
+        accept only 0 or 1 as bounds. An integer variable will convert the lower bound value to the
+        ceiling integer value of the argument.
+        """
+        return self._lb
+
+    @lb.setter
+    def lb(self, new_lb):
+        self.set_lb(new_lb)
+
+    def set_lb(self, lb):
+        if lb != self._lb:
+            self._model.set_var_lb(self, lb)
+            return self._lb
+
+    def _internal_set_lb(self, lb):
+        # Internal, used only by the model
+        self._lb = lb
+
+    def _internal_set_ub(self, ub):
+        # INTERNAL
+        self._ub = ub
+
+    @property
+    def ub(self):
+        """ This property is used to get or set the upper bound of the variable.
+
+        Possible values for the upper bound depend on the variable type. Binary variables
+        accept only 0 or 1 as bounds. An integer variable will convert the upper bound value to the
+        floor integer value of the argument.
+
+        To reset the upper bound to its default infinity value, use :func:`docplex.mp.model.Model.infinity`.
+        """
+        return self._ub
+
+    @ub.setter
+    def ub(self, new_ub):
+        self.set_ub(new_ub)
+
+    def set_ub(self, ub):
+        if ub != self._ub:
+            self._model.set_var_ub(self, ub)
+            return self._ub
+
+    def has_free_lb(self):
+        return self.lb <= - self._model.infinity
+
+    def has_free_ub(self):
+        return self.ub >= self._model.infinity
+
+    def is_free(self):
+        return self.has_free_lb() and self.has_free_ub()
+
+    def _reset_bounds(self):
+        vartype = self._vartype
+        vtype_lb, vtype_ub = vartype.default_lb, vartype.default_ub
+        self.set_lb(vtype_lb)
+        self.set_ub(vtype_ub)
+
+    @property
+    def vartype(self):
+        """ This property returns the variable type, an instance of :class:`VarType`.
+
+        """
+        return self._vartype
+
+    def set_vartype(self, new_vartype):
+        # INTERNAL
+        self._model._set_var_type(self, new_vartype)
+
+    def _set_vartype_internal(self, new_vartype):
+        # INTERNAL
+        self._vartype = new_vartype
+
+    def _has_type(self, vartype_code):
+        # internal
+        return self.cplex_typecode == vartype_code
+
+
[docs]    def is_binary(self):
+        """ Checks if the variable is binary.
+
+        Returns:
+            Boolean: True if the variable is of type Binary.
+        """
+        return self._has_type('B')

+
+
[docs]    def is_integer(self):
+        """ Checks if the variable is integer.
+
+        Returns:
+            Boolean: True if the variable is of type Integer.
+        """
+        return self._has_type('I')

+
+
[docs]    def is_continuous(self):
+        """ Checks if the variable is continuous.
+
+        Returns:
+            Boolean: True if the variable is of type Continuous.
+        """
+        return self._has_type('C')

+
+
[docs]    def is_discrete(self):
+        """  Checks if the variable is discrete.
+
+        Returns:
+            Boolean: True if the variable is of  type Binary or Integer.
+        """
+        return self._vartype.is_discrete()

+
+    @property
+    def float_precision(self):
+        return 0 if self.is_discrete() else self._model.float_precision
+
+    def get_value(self):
+        # for compatibility only: use solution_value instead
+        print("* get_value() is deprecated, use property solution_value instead")  # pragma: no cover
+        return self.solution_value  # pragma: no cover
+
+    @property
+    def solution_value(self):
+        """ This property returns the solution value of the variable.
+
+        Raises:
+            DOCplexException
+                if the model has not been solved succesfully.
+
+        """
+        self.model._check_has_solution()
+        return self._raw_solution_value()
+
+    @property
+    def sv(self):
+        """ Same as `solution_value` but shorter"""
+        return super().sv
+
+    def _raw_solution_value(self, s=None):
+        sol = s or self.model._get_solution()
+        return sol._get_var_value(self)
+
+
[docs]    def get_key(self):
+        """ Returns the key used to create the variable, or None.
+
+        When the variable is part of a list or dictionary of variables created from a sequence of keys,
+        returns the key associated with the variable.
+
+        Example:
+            xs = m.continuous_var_dict(keys=['a', 'b', 'c'])
+            xa = xs['a']
+            assert xa.get_key() == 'a'
+
+        :return:
+            a Python object, possibly None.
+        """
+        container = self.container
+        return container.get_var_key(self) if container else None

+
+    def __mul__(self, e):
+        return self.times(e)
+
+    @classmethod
+    def is_zero_op(cls, other):
+        try:
+            return other.is_zero()
+        except AttributeError:
+            return False
+
+    def times(self, e):
+        if is_number(e):
+            return self.lfactory._new_monomial_expr(dvar=self, coeff=e, safe=False)
+
+        elif self.is_zero_op(e):
+            return self.lfactory.new_zero_expr()
+        elif isinstance(e, LinearOperand):
+            return self._model._qfactory.new_var_product(self, e)
+        else:
+            return self.to_linear_expr().multiply(e)
+
+    def __rmul__(self, e):
+        return self.times(e)
+
+    def __add__(self, e):
+        return self.plus(e)
+
+    @staticmethod
+    def _extract_calling_ct_xhs():
+        _searched_patterns = [("lhs", 0), ("left_expr", 0), ("rhs", 1), ("right_expr", 1)]
+        import inspect
+        # need to get 2 steps higher to find caller to add/sub
+        frame = inspect.stack()[2]
+        code_context = frame.code_context # if PY3 else frame[4]
+
+        def find_in_line(line_):
+            for xhs_s, xhs_p in _searched_patterns:
+                if xhs_s in line_:
+                    return line_.find(xhs_s), xhs_p
+
+            return -1, -1
+
+        if code_context:
+            line = code_context[0]
+            if line:
+                spos, lr = find_in_line(line)
+
+                if spos > 1:
+                    assert lr >= 0
+                    # strip whitespace before code...
+                    ct_varname = line[:spos - 1].lstrip()
+                    # evaluate ct in caller locals dict
+                    subframe = frame.frame # if PY3 else frame[0]
+                    ct_object = subframe.f_locals.get(ct_varname)
+                    # returns a constraint (or None if that fails), plus 0-1 (0 for lhs, 1 for rhs)
+                    return ct_object, lr
+        return None, -1
+
+    # def _perform_arithmetic_to_self(self, self_arithmetic_method, e):
+    #     # INTERNAL
+    #     res = self_arithmetic_method(e)
+    #     ct, xhs_pos = self._extract_calling_ct_xhs()
+    #     if ct is not None:
+    #         self.get_linear_factory().set_linear_constraint_expr_from_pos(ct, xhs_pos, res)
+    #     return res
+
+    def add(self, e):
+        res = self.plus(e)
+        ct, xhs_pos = self._extract_calling_ct_xhs()
+        if ct is not None:
+            self.lfactory.set_linear_constraint_expr_from_pos(ct, xhs_pos, res)
+        return res
+
+    def subtract(self, e):
+        res = self.minus(e)
+        ct, xhs_pos = self._extract_calling_ct_xhs()
+        if ct is not None:
+            self.lfactory.set_linear_constraint_expr_from_pos(ct, xhs_pos, res)
+        return res
+
+    def plus(self, e):
+        if isinstance(e, Var):
+            expr = self._make_linear_expr()
+            expr._add_term(e)
+            return expr
+
+        elif is_number(e):
+            return self._make_linear_expr(constant=e, safe=False)
+        elif is_quad_expr(e):
+            return e.plus(self)
+        else:
+            return self.to_linear_expr().add(e)
+
+    def to_linear_expr(self):
+        # INTERNAL
+        return self._make_linear_expr()
+
+    def _make_linear_expr(self, constant=0, safe=True):
+        return self.lfactory.linear_expr(self, constant, safe=safe, transient=True)
+
+    def __radd__(self, e):
+        return self.plus(e)
+
+    def __sub__(self, e):
+        return self.minus(e)
+
+    def minus(self, e):
+        if isinstance(e, LinearOperand):
+            return self.to_linear_expr().subtract(e)
+
+        elif is_number(e):
+            # v -k -> expression(v,-1) -k
+            return self._make_linear_expr(constant=-e, safe=False)
+
+        elif is_quad_expr(e):
+            return e.rminus(self)
+        else:
+            return self.to_linear_expr().subtract(e)
+
+    def __rsub__(self, e):
+
+        expr = self.lfactory._to_linear_operand(e, force_clone=True)  # makes a clone.
+        return expr.subtract(self)
+
+    def divide(self, e):
+        return self.to_linear_expr().divide(e)
+
+    def __div__(self, e):
+        return self.divide(e)
+
+    def __truediv__(self, e):
+        # for py3
+        # INTERNAL
+        return self.divide(e)  # pragma: no cover
+
+    def __rtruediv__(self, e):
+        # for py3
+        self.fatal("Variable {0!s} cannot be used as denominator of {1!s}", self, e)  # pragma: no cover
+
+    def __rdiv__(self, e):
+        self.fatal("Variable {0!s} cannot be used as denominator of {1!s}", self, e)
+
+    def __pos__(self):
+        # the "+e" unary plus is syntactic sugar
+        return self
+
+    def __neg__(self):
+        # the "-e" unary minus returns a linear expression
+        return self.negate()
+
+    def __pow__(self, power):
+        # INTERNAL
+        if 0 == power:
+            return 1
+        elif 1 == power:
+            return self
+        elif 2 == power:
+            return self.square()
+        else:
+            self.model.unsupported_power_error(self, power)
+
+    def __rshift__(self, other):
+        """ Redefines the right-shift operator to create indicators.
+
+        This operator allows to create indicators with the `>>` operator.
+        It expects a linear constraint as second argument.
+
+        :param other: a linear constraint used to create the indicator
+
+        :return:
+            an instance of IndicatorConstraint, that is not added to the model.
+            Use `Model.add()` to add it to the model.
+
+        Note:
+            The variable must be binary, otherwise an exception is raised.
+
+        Example:
+
+            >>> m.add(b >> (x >=3)
+
+            creates an indicator which links the satisfaction of the constraint (x >= 3)
+            to the value of binary variable b.
+        """
+        return self._model.indicator_constraint(self, other)
+
+    def square(self):
+        return self._model._qfactory.new_var_square(self)
+
+    def __int__(self):
+        """ Converts a decision variable to a integer number.
+
+        This is only possible for discrete variables,
+        and when the model has been solved successfully.
+        If the model has been solved, returns the variable's solution value.
+
+        Returns:
+            int: The variable's solution value.
+
+        Raises:
+            DOCplexException
+                if the model has not been solved successfully.
+            DOCplexException
+                if the variable is not discrete.
+        """
+
+        if self.is_continuous():
+            self.fatal("Cannot convert continuous variable value to int: {0!s}", self)
+        return int(self.solution_value)
+
+    def __float__(self):
+        """ Converts a decision variable to a floating-point number.
+
+        This is only possible when the model has been solved successfully,
+        otherwise an exception is raised.
+        If the model has been solved, it returns the variable's solution value.
+
+        Returns:
+            float: The variable's solution value.
+        Raises:
+            DOCplexException
+                if the model has not been solved successfully.
+        """
+        return float(self.solution_value)
+
+
[docs]    def to_bool(self, precision=1e-6):
+        """ Converts a variable value to True or False.
+
+        Assuming the variable is discrete (integer or binary), returns True if the variable value is
+        set a non-zero integer, taking into account precision.
+        For binary variables, returns TRue if the variable value equals 1, taking into account precision.
+
+        Raises:
+            DOCplexException
+                if the model has not been solved successfully.
+            DOCplexException
+                if the variable is not discrete
+
+        Returns:
+            Boolean: True if the variable value is nonzero, else False.
+        """
+        if not self.is_discrete():
+            self.fatal("boolean conversion only for discrete variables, type is {0!s}", self.vartype)
+        value = self.solution_value  # this property checks for a solution.
+        return abs(value) >= precision

+
+    def __str__(self):
+        """
+        Returns:
+            string: A string representation of the variable.
+
+        """
+        return self.to_string()
+
+    def to_string(self, use_space=False):
+        return self.lp_name
+
+    @property
+    def lp_name(self):
+        return self._name or "x%s" % self.index1
+
+    @property
+    def lpt_name(self):
+        # 'c1', 'b2', 'i3' ... first letter of cplex code + index
+        cpx_typecode = self.cplex_typecode.lower()
+        radix = 'x' if cpx_typecode == 'c' else cpx_typecode[0]
+        return "%s%d" % (radix, self.index1)
+
+    @property
+    def cplex_typecode(self):
+        return self._vartype.cplex_typecode
+
+    def _must_print_lb(self):
+        return self.cplex_typecode not in 'SN' and self.lb == self._vartype.default_lb
+
+    def __repr__(self):
+        self_vartype, self_lb, self_ub = self._vartype, self.lb, self.ub
+        # print lb for semi-xx
+        if self._must_print_lb():
+            repr_lb = ''
+        else:
+            repr_lb = ',lb={0:g}'.format(self_lb)
+        if self_vartype.default_ub == self_ub:
+            repr_ub = ''
+        else:
+            repr_ub = ',ub={0:g}'.format(self_ub)
+        if self.has_name():
+            repr_name = ",name='{0}'".format(self.name)
+        else:
+            repr_name = ''
+        cpxc = self.cplex_typecode
+        return "docplex.mp.Var(type={0}{1}{2}{3})". \
+            format(cpxc, repr_name, repr_lb, repr_ub)
+
+    @property
+    def reduced_cost(self):
+        """ Returns the reduced cost of the variable.
+
+       This method will raise an exception if the model has not been solved as a LP.
+
+        Note:
+            For a large number of variables (> 100), using the `Model.reduced_costs()` method can be much faster.
+
+        Returns:
+            The reduced cost of the variable (a float value).
+
+        See Also:
+
+            :func:`docplex.mp.model.Model.reduced_costs`
+        """
+        return self._model._reduced_cost1(self)
+
+    @property
+    def basis_status(self):
+        """ This property returns the basis status of the variable, if any.
+        The variable must be continuous, otherwise an exception is raised.
+
+        Returns:
+            An enumerated value from the enumerated type `docplex.constants.BasisStatus`.
+
+        Note:
+            for the model to hold basis information, the model must have been solved as a LP problem.
+            In some cases, a model which failed to solve may still have a basis available. Use
+            `Model.has_basis()` to check whether the model has basis information or not.
+
+        See Also:
+            :func:`docplex.mp.model.Model.has_basis`
+            :class:`docplex.mp.constants.BasisStatus`
+
+        """
+        if not self.is_continuous():
+            self.fatal("Basis status is for continuous variables, {0!s} has type {1!s}", self, self.vartype.short_name)
+        return self._model._var_basis_status1(self)
+
+    @property
+    def benders_annotation(self):
+        """
+        This property is used to get or set the Benders annotation of a variable.
+        The value of the annotation must be a positive integer
+
+        """
+        return self.get_benders_annotation()
+
+    @benders_annotation.setter
+    def benders_annotation(self, new_anno):
+        self.set_benders_annotation(new_anno)
+
+
[docs]    def iter_constraints(self):
+        """ Returns an iterator traversing all constraints in which the variable is used.
+
+        :return:
+            An iterator.
+        """
+        for ct in self._model.iter_constraints():
+            for ctv in ct.iter_variables():
+                if ctv is self:
+                    yield ct
+                    break

+
+
[docs]    def equals(self, other):
+        """
+        This method is used to test equality to an expression.
+        Because of the overloading of operator `==` through the redefinition of
+        the `__eq__` method, you cannot use `==` to test for equality.
+        In order to test that two decision variables ar ethe same, use th` Python `is` operator;
+        use the `equals` method to test whether a given expression is equivalent to a variable:
+        for example, calling `equals` with a linear expression which consists of this variable only,
+        with a coefficient of 1, returns True.
+
+        Args:
+            other: an expression or a variable.
+
+        :return:
+            A boolean value, True if the passed variable is this very variable, or
+            if the passed expression is equivalent to the variable, else False.
+
+        """
+        # noinspection PyPep8
+        return self is other or \
+               (isinstance(other, LinearOperand) and
+                other.get_constant() == 0 and
+                other.number_of_terms() == 1 and
+                other.unchecked_get_coef(self) == 1)

+
+    def as_logical_operand(self):
+        # INTERNAL
+        return self if self.is_binary() else None
+
+    def _check_binary_variable_for_logical_op(self, op_name):
+        if not self.is_binary():
+            self.fatal("Logical {0} is available only for binary variables, {1} has type {2}",
+                       op_name, self, self.vartype.short_name)
+
+    def logical_and(self, other):
+        self._check_binary_variable_for_logical_op(op_name="and")
+        StaticTypeChecker.typecheck_logical_op(self, other, caller="Var.logical_and")
+        return self.lfactory.new_logical_and_expr([self, other])
+
+    def logical_or(self, other):
+        self._check_binary_variable_for_logical_op(op_name="or")
+        StaticTypeChecker.typecheck_logical_op(self, other, caller="Var.logical_or")
+        return self.lfactory.new_logical_or_expr([self, other])
+
+    def logical_not(self):
+        self._check_binary_variable_for_logical_op(op_name="not")
+        return self.lfactory.new_logical_not_expr(self)
+
+    def __and__(self, other):
+        return self.logical_and(other)
+
+    def __or__(self, other):
+        return self.logical_or(other)

+
+    # no unary not in magic methods...
+
+
+def is_var(x):
+    return isinstance(x, Var)
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/environment.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/environment.html new file mode 100644 index 0000000..7c0668b --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/environment.html @@ -0,0 +1,558 @@ + + + + + + + + + docplex.mp.environment — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.environment

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+'''Provides utility functions about the runtime environment.
+
+You can display information about your runtime environment using::
+
+    $ python
+    >>> from docplex.mp.environment import Environment
+    >>> Environment().print_information()
+
+or by invoking the `docplex.mp.environment` package on your shell command line::
+
+    $ python -m docplex.mp.environment
+    * system is: Linux 64bit
+    * Python version 3.6.1, located at: /usr/bin/python
+    * docplex is present, version is (2, 9, 0)
+    * CPLEX library is present, version is 12.9.0.0, located at: /usr/local/CPLEX_Studio129/cplex/python/3.6/x86-64_linux
+'''
+try:
+    import importlib.util as importlib_util
+except ImportError:  # pragma: no cover
+    importlib_util = None  # Python 2
+import platform
+import os
+import sys
+import warnings
+
+from docplex.mp.error_handler import docplex_fatal
+
+min_cplex_major = 12
+min_cplex_minor = 8
+
+
+def env_is_64_bit():
+    return sys.maxsize > 2 ** 32
+
+
+
[docs]class UnsupportedPlatformError(Exception):
+    pass

+
+
+# maps paths to modules for already loaded cplexes
+# for path == None, key is "__NONE__"
+_loaded_cplexes = {}
+
+
+# noinspection PyPep8
+
[docs]class Environment(object):
+    """ This class detects and contains information regarding other modules of interest, such as
+        whether CPLEX, `numpy`, and `matplotlib` are installed.
+    """
+    _default_env = None  # The default env singleton
+
+    """ This class detects and contains information regarding other modules of interest, such as
+        whether CPLEX, `numpy`, and `matplotlib` are installed.
+    """
+    def __init__(self, start_auto_configure=True, logger=None):
+        """
+        __init__(self)
+        """
+        self._found_cplex = False
+        self._cplex_version = ''
+        self._cplex_location = None
+
+        self._found_numpy = None
+        self._numpy_version = None
+        self._numpy_hook = None
+
+        self._found_pandas = None
+        self._pandas_version = ''
+        self._found_matplotlib = None
+        self._matplotlib_version = None
+
+        self._python_version = platform.python_version()
+        self._system = platform.system()
+        self._machine = platform.machine()
+        self._bitness = platform.architecture()[0]
+        self._is64bit = sys.maxsize > 2 ** 32
+
+        if start_auto_configure:
+            self.auto_configure(logger=logger)
+
+    # class variable
+    # Must be true if python versin is > 3.6
+    env_is_python36 = (sys.version_info.major >= 3) and (sys.version_info.minor >= 6)
+
+    def _get_numpy_hook(self):
+        return self._numpy_hook
+
+    def _set_numpy_hook(self, hook):
+        self._numpy_hook = hook
+        if hook is not None:
+            if self.has_numpy:  # now that we have set a hook, do check for numpy
+                hook()          # if numpy is present, do call the hook
+
+    numpy_hook = property(_get_numpy_hook, _set_numpy_hook)
+
+    def equals(self, other):
+        if type(other) != Environment:
+            return False
+        if self.has_cplex != other.has_cplex:
+            return False
+        if self.cplex_version != other.cplex_version:
+            return False
+
+        if self.has_numpy != other.has_numpy:
+            return False
+        if self.has_matplotlib != other.has_matplotlib:
+            return False
+        if self.has_pandas != other.has_pandas:
+            return False
+
+        return True
+
+    @property
+    def has_cplex(self):
+        """True if the CPLEX libraries are available.
+
+        The cplex libraries search order is:
+
+            - import the module `import cplex` if the import is sucessful
+            - import the module in location $CPLEX_STUDIO_DIR1210/cplex/python/<python.version>/<platform>
+            - import the module in location $CPLEX_STUDIO_DIR129/cplex/python/<python.version>/<platform>
+            - import the module in location $CPLEX_STUDIO_DIR128/cplex/python/<python.version>/<platform>
+        """
+        return self._found_cplex
+
+    def hash_cplex_with_version_min(self, min_version):
+        return self.has_cplex and self._cplex_version >= min_version
+
+    def check_cplex_version(self):
+        cpx_version = self.cplex_version_as_tuple
+
+        if self.has_cplex and cpx_version < (min_cplex_major, min_cplex_minor):
+            s_min_version = "{0}.{1}".format(min_cplex_major, min_cplex_minor)
+            docplex_fatal("DOcplex supports Cplex from {0} up, unsupported version {1} was found"
+                          .format(s_min_version, self.cplex_version))
+
+    @property
+    def cplex_lp_obj_kw(self):
+        if self.has_cplex and self.cplex_version_as_tuple >= (12, 10):
+            obj_kw = "obj1"
+        else:
+            obj_kw = "obj"
+        return obj_kw
+
+    @staticmethod
+    def cplex_platform():
+        sys_platform = platform.system()
+        machine = platform.machine()
+        if sys_platform == 'Windows':
+            return 'x64_win64'
+        elif sys_platform == 'Darwin':
+            if machine == 'x86_64':
+                return 'x86-64_osx'
+            else:
+                return 'arm64_osx'
+        elif sys_platform == 'Linux':
+            if machine == 'x86_64':
+                return 'x86-64_linux'
+            else:
+                # different flavors of linux (ppc64le_linux, s390x_linux)
+                return machine + "_linux"
+        return None
+
+    @staticmethod
+    def cplex_distribname():
+        distribname = Environment.cplex_platform()
+        if distribname == 'x64_win64':
+            distribname = 'x64_windows'
+        return distribname
+
+    @property
+    def cplex_version(self):
+        return self._cplex_version
+
+    @property
+    def cplex_version_as_tuple(self):
+        cpxv = self._cplex_version
+        return self.parse_cplex_version(cpxv, fallback=None)
+
+    @property
+    def has_matplotlib(self):
+        """True if the `matplotlib` libraries are available.
+        """
+        if self._found_matplotlib is None:
+            self.check_matplotlib()
+        return self._found_matplotlib
+
+    @property
+    def has_pandas(self):
+        """True if the `pandas` libraries are available.
+        """
+        self.check_pandas()
+        return self._found_pandas
+
+    @property
+    def pandas_version(self):
+        self.check_pandas()
+        return self._pandas_version
+
+    @property
+    def cplex_location(self):
+        """The system path where CPLEX is located, if present. Otherwise, returns None.
+        """
+        return self._cplex_location
+
+    @property
+    def has_numpy(self):
+        """True if the `numpy` libraries are available.
+        """
+        self.check_numpy()
+        return self._found_numpy
+
+
[docs]    def is_64bit(self):
+        """True if running on a 64-bit platform.
+        """
+        return self._is64bit

+
+    @property
+    def python_version(self):
+        """ Returns the Python version as a string"""
+        return platform.python_version()
+
+    def auto_configure(self, logger=None):
+        self.check_cplex(logger=logger)
+        # check for pandas (docplex_wml studio)
+        self.check_pandas()
+
+    def check_all(self):
+        self.check_cplex()
+        self.check_pandas()
+        self.check_numpy()
+        self.check_matplotlib()
+
+
[docs]    def get_cplex_module(self, default_location=None, logger=None):
+        '''Returns the cplex module.
+
+        If `default_location` is None, this method will try to import the cplex module in the following order:
+
+            - by importing the module `import cplex` if the import is sucessful
+            - by importing the module in location $CPLEX_STUDIO_DIR20101/cplex/python
+            - by importing the module in location $CPLEX_STUDIO_DIR201/cplex/python
+            - by importing the module in location $CPLEX_STUDIO_DIR1210/cplex/python
+            - by importing the module in location $CPLEX_STUDIO_DIR129/cplex/python
+            - by importing the module in location $CPLEX_STUDIO_DIR128/cplex/python
+
+        If `default_location` is a valid path and contains a valid python package,
+        `cplex` is imported from the specified location.
+
+        If `default_location` is a valid path and
+        `<default_location>/cplex/python/<python_version>/<platform>` exists, `cplex`
+        is imported from that location
+
+        If `cplex` could not be found, this method returns `None`
+        '''
+        cplex = None
+
+        def load_cplex(location, version=""):
+            # we cache loaded modules as we want to make sure that modules are loaded
+            # only once (same behaviour than 'import')
+            # example location: C:\Program Files\IBM\ILOG\CPLEX_Studio1210\cplex\python\3.7\x64_win64\
+            cplex = _loaded_cplexes.get(location, None)
+            if cplex is None:
+                absolute_name = "cplex%s" % version
+                module_location = os.path.join(location, "cplex", "__init__.py")
+                if not os.path.isfile(module_location):
+                    return None
+                if importlib_util:
+                    spec = importlib_util.spec_from_file_location(absolute_name,
+                                                                  module_location)
+                    cplex = importlib_util.module_from_spec(spec)
+                    # TODO: Error out if one was already loaded
+                    previous = sys.modules.get(absolute_name, None)
+                    if previous is not None:
+                        lo = location if location else "default sys.path"
+                        raise RuntimeError("Cannot load cplex from %s, a previous version has already been loaded from %s" % (lo, previous.__file__))
+                    sys.modules[absolute_name] = cplex
+                    spec.loader.exec_module(cplex)
+                else:
+                    import imp
+                    cplex = imp.load_source(absolute_name.split('.')[-1], module_location)
+                _loaded_cplexes[location] = cplex
+            return cplex
+
+        def load_cplex_from_cos_root(cos_root, version=""):
+            platform = Environment.cplex_platform()
+            if platform is None:
+                raise UnsupportedPlatformError("Platform not supported, please install cplex python module")
+            python_version = '%s.%s' % (sys.version_info[0],
+                                        sys.version_info[1])
+            full_path = os.path.join(cos_root, 'cplex', 'python', python_version, platform)
+            return load_cplex(full_path, version=version)
+
+        if default_location is None:
+            try:
+                import cplex   # @UnresolvedImport
+                if logger is not None:
+                    logger.info("Found cplex with 'import cplex'")
+            except (ImportError, ModuleNotFoundError):
+                # in py3.7, ModuleNotFoundError is raised
+                user_cos_location = os.environ.get('DOCPLEX_COS_LOCATION', None)
+                if user_cos_location is not None:
+                    cplex = load_cplex_from_cos_root(user_cos_location)
+                    if cplex is None:
+                        # user provided a cos location that was not right, raise warning
+                        warnings.warn("Could not load CPLEX from Location provided by DOCPLEX_COS_LOCATION=%s. Using default locations." % user_cos_location)
+                if cplex is None:
+                    try_environs = ['CPLEX_STUDIO_DIR2211',
+                                    'CPLEX_STUDIO_DIR221',
+                                    'CPLEX_STUDIO_DIR20101',
+                                    'CPLEX_STUDIO_DIR201',
+                                    'CPLEX_STUDIO_DIR1210',
+                                    'CPLEX_STUDIO_DIR129',
+                                    'CPLEX_STUDIO_DIR128']
+                    for t in try_environs:
+                        loc = os.environ.get(t, None)
+                        # version = t[len('CPLEX_STUDIO_DIR'):] if loc else ""
+                        # currently, there are some import in CPLEX, like:
+                        #   File "C:\Program Files\IBM\ILOG\CPLEX_Studio1210\cplex\python\3.7\x64_win64\cplex\_internal\_pycplex_platform.py", line 24, in <module>
+                        #     from cplex._internal.py37_cplex12100 import *
+                        # that prevent us from loading multiples instances of cplex
+                        # so for now, let's just ignore this version
+                        cplex = load_cplex_from_cos_root(loc) if loc else None
+                        if logger is not None:
+                            logger.info("Looking into location %s, found = %s" % (loc, (cplex is not None)))
+                        if cplex is not None:
+                            return cplex
+        else:
+            if os.path.isfile(os.path.join(default_location, "__init__.py")):
+                cplex = load_cplex(default_location)
+            else:
+                cplex = load_cplex_from_cos_root(default_location)
+        return cplex

+
+    def check_cplex(self, logger=None):
+        # detecting CPLEX using default search location
+        cplex = self.get_cplex_module(logger=logger)
+        self._found_cplex = (cplex is not None)
+        if self.has_cplex:
+            cplex_module_file = cplex.__file__
+            if cplex_module_file:
+                self._cplex_location = os.path.dirname(os.path.dirname(cplex_module_file))
+            try:
+                self._cplex_version = cplex.__version__
+            except AttributeError:
+                # older version: use an instance
+                cpx = cplex.Cplex()
+                # format: MM.mm.rr.ff e.g.e 12.6.2.0
+                self._cplex_version = cpx.get_version()
+                # terminate the dummy instance...
+                del cpx
+
+    def check_numpy(self):
+        if self._found_numpy is None:
+            try:
+                import numpy.version as npv
+                self._found_numpy = True
+                self._numpy_version = npv.version
+
+                self_numpy_hook = self._numpy_hook
+                if self_numpy_hook is not None:
+                    # lazy call the hook once at first check time.
+                    self_numpy_hook()
+
+            except ImportError:  # pragma: no cover
+                self._found_numpy = False
+                self._numpy_version = None
+
+        return self._found_numpy
+
+    def check_matplotlib(self):
+        try:
+            from matplotlib import __version__ as matplotlib_version
+            self._found_matplotlib = True
+            self._matplotlib_version = matplotlib_version
+        except ImportError:  # pragma: no cover
+            self._found_matplotlib = False
+
+    def check_pandas(self):
+        if self._found_pandas is None:
+            try:
+                import pandas
+                self._found_pandas = True
+                self._pandas_version = pandas.__version__
+            except ImportError:  # pragma: no cover
+                self._found_pandas = False
+
+    @staticmethod
+    def _display_feature(is_present, feature_name, feature_version, location=None):
+        safe_feature_version = feature_version or "?"
+        if is_present is None:
+            pass  # we dont know yet
+        elif is_present:
+            if location:
+                print("* {0} is present, version is {1}, located at: {2}".format(feature_name, safe_feature_version,
+                                                                                 location))
+            else:
+                print("* {0} is present, version is {1}".format(feature_name, safe_feature_version))
+        else:
+            print("* {0} is not available".format(feature_name))
+
+    @property
+    def max_nb_digits(self):
+        # source: https://en.wikipedia.org/wiki/IEEE_floating_point
+        return 17 if self.is_64bit() else 9
+
+    @property
+    def bitness(self):
+        return 64 if self.is_64bit() else 32
+
+    def print_information(self):
+        print("* system is: {0} {1}".format(self._system, self._bitness))
+        from sys import version_info
+        from docplex.mp import __version_info__
+
+        python_version = '%s.%s.%s' % (version_info[0], version_info[1], version_info[2])
+        print("* Python version %s, located at: %s" % (python_version, sys.executable))
+        self._display_feature(True, "docplex", "%d.%d.%d" % __version_info__)
+        self._display_feature(self.has_cplex, "CPLEX library", self._cplex_version, self._cplex_location)
+        self._display_feature(self._found_pandas, "pandas", self._pandas_version)
+        self._display_feature(self._found_numpy, "numpy", self._numpy_version)
+        self._display_feature(self._found_matplotlib, "matplotlib", self._matplotlib_version)
+
+    @staticmethod
+    def closed_env():
+        closed = Environment(start_auto_configure=False)
+        # force matplotlib absent
+        closed._found_matplotlib = False
+        closed._found_numpy = False
+        closed._found_pandas = False
+        return closed
+
+    @staticmethod
+    def make_new_configured_env():
+        # returns a fresh new environment
+        return Environment(start_auto_configure=True)
+
+    @staticmethod
+    def get_default_env():
+        if not Environment._default_env:
+            Environment._default_env = Environment.make_new_configured_env()
+        return Environment._default_env
+
+    @staticmethod
+    def parse_cplex_version(version_text, fallback=None):
+        # parse such strings as: 20.1.0.0 | 2020-11-10 | 9bedb6d68
+        if not version_text:
+            return fallback
+        barpos = version_text.find('|')
+        if barpos > 0:
+            assert barpos >= 2
+            before_bar = barpos-1
+            baseline_version = version_text[:before_bar]
+        else:
+            baseline_version = version_text
+        return tuple(float(x) for x in baseline_version.split('.'))
+
+    # for pickling: recreate a fresh environment at the other end of pickle.
+    def __reduce__(self):
+        return Environment.make_new_configured_env, ()

+
+
+def get_closed_environment():
+    # This instance assumes nothing is found, CPLEX, numpy, etc, to be used for tests
+    return Environment.closed_env()
+
+
+if __name__ == '__main__':
+    Environment().print_information()
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/error_handler.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/error_handler.html new file mode 100644 index 0000000..48b1a54 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/error_handler.html @@ -0,0 +1,389 @@ + + + + + + + + + docplex.mp.error_handler — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.error_handler

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from docplex.mp.utils import DOcplexException, DOcplexLimitsExceeded, resolve_pattern, is_int, is_string
+
+from enum import Enum
+import os
+
+##########################
+# Error handling
+
+
+class IErrorHandler(object):
+    def __init__(self):
+        pass  # pragma: no cover
+
+    def info(self, msg, args=None):
+        pass  # pragma: no cover
+
+    def warning(self, msg, args=None):
+        pass  # pragma: no cover
+
+    def error(self, msg, args=None):
+        pass  # pragma: no cover
+
+    def fatal(self, msg, args=None):
+        pass  # pragma: no cover
+
+    def ok(self):
+        return False  # pragma: no cover
+
+    def get_output_level(self):
+        return 0  # pragma: no cover
+
+    def set_output_level(self, new_level):
+        pass  # pragma: no cover
+
+    def ensure(self, condition, msg, *args):
+        if not condition:
+            self.fatal(msg, args)
+
+
+
[docs]class InfoLevel(Enum):
+    """ Enumerated type for the possible output levels.
+
+    Info levels are sorted in increasing order of severity: `INFO`, `WARNING`, `ERROR`, `FATAL`.
+    Setting a level enables the printing of all messages from that severity and above.
+
+    Example:
+        Setting the level to `WARNING` enables the printing of `WARNING`, `ERROR`, and `FATAL` messages, but not
+        `INFO` level messages.
+        Setting the level to `FATAL` suppresses all messages, except for fatal errors.
+    """
+    INFO, WARNING, ERROR, FATAL = 1, 10, 100, 9999999
+
+    @classmethod
+    def parse(cls, arg, default_level=INFO):
+        # INTERNAL
+        if not arg:
+            return cls.INFO
+        elif isinstance(arg, cls):
+            return arg
+        elif is_string(arg):
+            return cls._name2level_map().get(arg.lower(), default_level)
+        elif is_int(arg):
+            if arg < 10:
+                # anything below 10 is INFO
+                return cls.INFO
+            elif arg < 100:
+                return cls.WARNING
+            elif arg < 1000:
+                return cls.ERROR
+            else:
+                # level fatal prints nothing except fatal errors
+                return cls.FATAL
+        else:
+            raise DOcplexException("Cannot convert this to InfoLevel: {0!r}".format(arg))
+
+    def __str__(self):
+        return self.name
+
+    @staticmethod
+    def _headers():
+        return {InfoLevel.FATAL: "FATAL",
+                InfoLevel.INFO: "*",
+                InfoLevel.WARNING: "Warning:",
+                InfoLevel.ERROR: "Error:"
+                }
+
+    @staticmethod
+    def _name2level_map():
+        return {"fatal": InfoLevel.FATAL,
+                "error": InfoLevel.ERROR,
+                "warning": InfoLevel.WARNING,
+                "info": InfoLevel.INFO}
+
+    def header(self):
+        # cannot put the dict in the class
+        # as it willbe interpreted as another enum value.
+        return self._headers().get(self, "???")

+
+
+class AbstractErrorHandler(IErrorHandler):
+    TRACE_HEADER = "--"
+
+    def __init__(self, output_level=InfoLevel.INFO):
+        IErrorHandler.__init__(self)
+        self._trace_enabled = False
+
+        self._number_of_errors = 0
+        self._number_of_warnings = 0
+        self._number_of_fatals = 0
+        self._output_level = InfoLevel.INFO
+        self._is_print_suspended = False
+        self._postponed = []
+        self.set_output_level(output_level)
+
+    @property
+    def number_of_warnings(self):
+        """ Returns the number of warnings.
+        """
+        return self._number_of_warnings
+
+    @property
+    def number_of_errors(self):
+        """ Returns the number of errors.
+        """
+        return self._number_of_errors
+
+    @property
+    def number_of_fatals(self):
+        return self._number_of_fatals
+
+    def get_output_level(self):
+        return self._output_level
+
+    def set_output_level(self, output_level_arg):
+        output_level = InfoLevel.parse(output_level_arg)
+        if output_level != self._output_level:
+            self._output_level = output_level
+
+    def set_trace_mode(self, trace_mode):
+        self._trace_enabled = trace_mode
+
+    def enable_trace(self):
+        self.set_trace_mode(True)
+
+    def disable_trace(self):
+        self.set_trace_mode(False)
+
+    def is_trace_enabled(self):
+        return self._trace_enabled
+
+    def set_quiet(self):
+        """ Changes the output level to enable only error messages.
+        """
+        self.set_output_level(InfoLevel.ERROR)
+
+    def reset(self):
+        self._number_of_errors = 0
+        self._number_of_warnings = 0
+        self._number_of_fatals = 0
+
+    def _internal_is_printed(self, level):
+        return self._output_level.value <= level.value
+
+    def _internal_print_if(self, level, msg, args):
+        if self._internal_is_printed(level):
+            self._internal_print(level, msg, args)
+
+    def _internal_print(self, level, msg, args):
+        # resolve message w/ args
+        header = level.header()
+        self._internal_print_header(header, msg, args)
+
+    def _internal_print_header(self, header, msg, args):
+        resolved_message = resolve_pattern(msg, args)
+        mline = '%s %s' % (header, resolved_message)
+        if self._is_print_suspended:
+            self._postponed.append(mline)
+        else:
+            print(mline)
+
+    def trace_header(self):
+        return self.TRACE_HEADER
+
+    def trace(self, msg, args=None):
+        if self.is_trace_enabled():
+            self._internal_print_header(self.trace_header(), msg, args)
+
+    def info(self, msg, args=None):
+        self._internal_print_if(InfoLevel.INFO, msg, args)
+
+    def warning(self, msg, args=None):
+        self._number_of_warnings += 1
+        self._internal_print_if(InfoLevel.WARNING, msg, args)
+
+    def error(self, msg, args=None):
+        docplex_error_stop_here()
+        self._number_of_errors += 1
+        self._internal_print_if(InfoLevel.ERROR, msg, args)
+
+    def fatal(self, msg, args=None):
+        self._number_of_fatals += 1
+        resolved_message = resolve_pattern(msg, args)
+        docplex_error_stop_here()
+        raise DOcplexException(resolved_message)
+
+    def fatal_limits_exceeded(self, nb_vars, nb_constraints):
+        docplex_error_stop_here()
+        raise DOcplexLimitsExceeded(nb_vars, nb_constraints)
+
+
+    def ok(self):
+        """ Checks whether the handler has not recorded any error.
+        """
+        return self._number_of_errors == 0 and self._number_of_fatals == 0
+
+    def prints_trace(self):
+        return self.is_trace_enabled()
+
+    def prints_info(self):
+        return self._internal_is_printed(InfoLevel.INFO)
+
+    def prints_warning(self):
+        return self._internal_is_printed(InfoLevel.WARNING)
+
+    def prints_error(self):
+        return self._internal_is_printed(InfoLevel.ERROR)
+
+    def suspend(self):
+        self._is_print_suspended = True
+
+    def flush(self):
+        self._is_print_suspended = False
+        for m in self._postponed:
+            print(m)
+        self._postponed = []
+
+
+def docplex_error_stop_here():
+    # INTERNAL, use to set breakpoints
+    pass
+
+
+def docplex_add_trivial_infeasible_ct_here():
+    # INTERNAL: set breakpoint here to inspect ct
+    pass
+
+def docplex_fatal(msg, *args):
+    resolved_message = resolve_pattern(msg, args)
+    docplex_error_stop_here()
+    raise DOcplexException(resolved_message)
+
+def is_docplex_debug():
+    return not not os.environ.get('DOCPLEX_DEBUG')
+
+
+def docplex_debug_msg(*args):
+    if is_docplex_debug():
+        msg = ' '.join(str(x) for x in args)
+        #print(f"-- {msg}")
+        print("-- {0}".format(msg))
+
+
+
[docs]class DefaultErrorHandler(AbstractErrorHandler):
+    """ The default error handler class.
+
+    """
+
+    def __init__(self, output_level=InfoLevel):
+        AbstractErrorHandler.__init__(self, output_level)

+
+
+class SilentErrorHandler(AbstractErrorHandler):
+    def __init__(self, output_level=InfoLevel):
+        AbstractErrorHandler.__init__(self, output_level)
+
+    def _internal_print(self, level, msg, args):
+        # nothing out, this is the point!
+        pass
+
+    def suspend(self):
+        pass
+
+    def flush(self):
+        pass
+
+
+def handle_error(logger, error, msg):
+    if error == "raise":
+        raise logger.fatal(msg)
+    elif error == "warn":
+        logger.warn(msg)
+    elif error =="ignore":
+        pass
+    else:
+        print("unknown error directive: {0}, expecting ignore|warn|raise, msg is: {1}".format(error, msg))
+
+
+
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/kpi.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/kpi.html new file mode 100644 index 0000000..29ccf0f --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/kpi.html @@ -0,0 +1,300 @@ + + + + + + + + + docplex.mp.kpi — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.kpi

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from docplex.mp.operand import Operand
+from docplex.mp.error_handler import docplex_fatal, DOcplexException
+
+from docplex.mp.utils import is_number, is_string, is_function, str_maxed
+from docplex.mp.basic import _AbstractNamable, _AbstractValuable
+
+
+
[docs]class KPI(_AbstractNamable, _AbstractValuable):
+    """ Base class for key performance indicators (KPIs).
+
+    Each KPI has a unique name. A KPI is attached to a model instance and can compute a numerical value,
+    using the :func:`compute` method. The `compute` method takes an optional solution argument;
+    if passed a valid SolveSolution object, this solution is used to evaluate the KPI, else compute()
+    will attempt to access th emodel's solution. If the model has no attached solution, then an exception
+    is raised by `compute`.
+
+    """
+    def __init__(self, name=None):
+        self._name = name
+
+    def _set_name(self, new_name):
+        self._name = new_name
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, new_name):
+        self.set_name(new_name)
+
+
[docs]    def get_model(self):
+        """
+        Returns:
+           The model instance on which the KPI is defined.
+        :rtype: :class:`docplex.mp.model.Model`
+        """
+        raise NotImplementedError   # pragma: no cover

+
+    @property
+    def model(self):
+        return self.get_model()
+
+    def compute(self, s=None):
+        raise NotImplementedError   # pragma: no cover
+
+    # def _get_solution_value(self, s=None):  # pragma: no cover
+    #     # to be removed
+    #     return self._raw_solution_value(s)
+
+    def _raw_solution_value(self, s=None):  # pragma: no cover
+        return self.compute(s)
+
+    def _ensure_solution(self, s, do_raise=True):
+        # INTERNAL
+        if s is not None:
+            return s
+        else:
+            ms = self.get_model()._solution
+            if ms is not None:
+                return ms
+            elif do_raise:
+                self.get_model().fatal("KPI.compute() requires a solution, but model is not solved and no solution was passed")
+            else:
+                return None
+
+    def check_name(self, name_arg):
+        self.model._checker.typecheck_string(name_arg, accept_none=False, accept_empty=False, caller="KPI.name")
+
+
[docs]    def is_decision_expression(self):
+        """ returns True if the KPI is based on a decision expression or variable.
+
+        """
+        raise NotImplementedError   # pragma: no cover

+
+    def copy(self, new_model, var_map):
+        raise NotImplementedError   # pragma: no cover
+
+    def clone(self):
+        raise NotImplementedError  # pragma: no cover
+
+    @staticmethod
+    def new_kpi(model, kpi_arg, kpi_name):
+        # static factory method to build a new concrete instance of KPI
+        if isinstance(kpi_arg, KPI):
+            if not kpi_name:
+                return kpi_arg
+            else:
+                cloned = kpi_arg.clone()
+                cloned.name = kpi_name
+                return cloned
+        elif is_function(kpi_arg):
+            return FunctionalKPI(kpi_arg, model, kpi_name)
+        else:
+            # try a linear expr conversion
+            try:
+                expr = model._lfactory._to_expr(kpi_arg)
+                return DecisionKPI(expr, kpi_name)
+            except DOcplexException:
+                model.fatal("Cannot interpret this as a KPI: {0!r}. expecting expression, variable or function", kpi_arg)
+
+    def notify_removed(self):
+        pass

+
+
+
[docs]class DecisionKPI(KPI):
+    """ Specialized class of Key Performance Indicator, based on expressions.
+
+    This subclass is built from a decision variable or a linear expression.
+    The :func:`compute` method evaluate the value of the KPI in a solution. This solution can either be passed
+    to the `compute` method, or using th emodel's solution. In the latter case, the model must have been solved
+    with a solution.
+
+    """
+    def __init__(self, kpi_op, name=None):
+        expr = None
+        if is_number(kpi_op):
+            expr = self.get_model().linear_expr(arg=kpi_op)
+        elif isinstance(kpi_op, Operand):
+            expr = kpi_op
+            expr.notify_used(self)  # kpi is a subscriber
+            if hasattr(kpi_op, 'name'):
+                name = name or getattr(kpi_op, 'name')
+
+        else:
+            self.get_model().fatal('cannot interpret this as kpi: {0!r}, expecting number or operand', kpi_op)
+        super().__init__(name)
+        self._expr = expr
+
+    def notify_expr_modified(self, expr, event):
+        # do nothing
+        pass
+
+    def notify_removed(self):
+        self._expr.notify_unsubscribed(self)
+
+
[docs]    def get_model(self):
+        return self._expr.model

+
+
[docs]    def compute(self, s=None):
+        """ Redefinition of the abstract `compute(s=None)` method.
+
+        Returns:
+            float: The value of the decision expression in the solution.
+
+        Note:
+            Evaluating a KPI requires a solution object. This solution can either be passed explicitly
+            in the `s` argument, otherwise the model solution is used. In the latter case, th emodel must
+            have been solved with a solution, otherwise an exception is raised.
+
+        Raises:
+            Evaluating a KPI raises an exception if no `s` solution has been passed
+            and the underlying model has not been solved with a solution.
+
+        See Also:
+            :class:`docplex.mp.solution.SolveSolution`
+        """
+        es = self._ensure_solution(s, do_raise=True)
+        return self._expr._raw_solution_value(es)

+
+
[docs]    def is_decision_expression(self):
+        return True

+
+    def to_expr(self):
+        return self._expr
+
+    as_expression = to_expr
+
+    def to_linear_expr(self):
+        return self._expr.to_linear_expr()
+
+    def copy(self, new_model, var_map):
+        expr_copy = self._expr.copy(new_model, var_map)
+        return DecisionKPI(kpi_op=expr_copy, name=self.name)
+
+    def clone(self):
+        return DecisionKPI(self._expr, self.name)
+
+    def __repr__(self):
+        return "{0}(name={1},expr={2!s})".format(self.__class__.__name__, self.name, str_maxed(self._expr, maxlen=64))

+
+
+
[docs]class FunctionalKPI(KPI):
+    # Functional KPIs store a function that takes a model to compute a number
+    # Functional KPIs do not require a successful solve.
+
+    def __init__(self, fn, model, name):
+        KPI.__init__(self, name)
+        self._function = fn
+        self._model = model
+
+
[docs]    def get_model(self):
+        return self._model

+
+    def compute(self, s=None):
+        es = self._ensure_solution(s)
+        return self._function(self._model, es)
+
+
[docs]    def is_decision_expression(self):
+        return False

+
+    def copy(self, new_model, var_map):
+        return FunctionalKPI(fn=self._function, model=new_model, name=self.name)
+
+    def clone(self):
+        return FunctionalKPI(fn=self._function, model=self._model, name=self.name)
+
+    def to_expr(self):
+        docplex_fatal("This KPI cannot be used as an expression: {0!r}".format(self))

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/linear.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/linear.html new file mode 100644 index 0000000..25761e7 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/linear.html @@ -0,0 +1,1583 @@ + + + + + + + + + docplex.mp.linear — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.linear

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+# pylint: disable=too-many-lines
+from docplex.mp.constants import ComparisonType, UpdateEvent
+from docplex.mp.basic import Expr, ModelingObjectBase, _SubscriptionMixin
+from docplex.mp.operand import LinearOperand
+from docplex.mp.utils import is_int, is_number, iter_emptyset, is_quad_expr
+from docplex.mp.dvar import is_var
+# ----------------------------
+# kept for compatibility
+from docplex.mp.dvar import Var
+# ------------------
+from docplex.mp.sttck import StaticTypeChecker
+
+
+
[docs]class DOCplexQuadraticArithException(Exception):
+    # INTERNAL
+    pass

+
+
+# noinspection PyAbstractClass
+
[docs]class AbstractLinearExpr(LinearOperand, Expr):
+    __slots__ = ('_discrete_locked',)
+
+
[docs]    def get_coef(self, dvar):
+        """ Returns the coefficient of a variable in the expression.
+
+        Note:
+            If the variable is not present in the expression, the function returns 0.
+
+        :param dvar: The variable for which the coefficient is being queried.
+
+        :return: A floating-point number.
+        """
+        self.model._typecheck_var(dvar)
+        return self.unchecked_get_coef(dvar)

+
+    def __getitem__(self, dvar):
+        # direct access to a variable coef x[var]
+        return self.unchecked_get_coef(dvar)
+
+    def __iter__(self):
+        # INTERNAL: this is necessary to prevent expr from being an iterable.
+        # as it follows getitem protocol, it can mistakenly be interpreted as an iterable
+        # but this would make sum loop forever.
+        raise TypeError
+
+    def lock_discrete(self):
+        # intern al: used for any expression used in linear constraints inside equivalences
+        self._discrete_locked = True
+
+    def is_discrete_locked(self):
+        return getattr(self, '_discrete_locked', False)
+
+    def check_discrete_lock_frozen(self, item=None):
+        self.get_linear_factory().check_expr_discrete_lock(self, item)
+
+    def relaxed_copy(self, relaxed_model, var_map):
+        return self.copy(relaxed_model, var_map)
+
+    def set_coefficients(self, var_coef_seq):
+        for dv, k in var_coef_seq:
+            self.set_coefficient(dv, k)

+
+
+
[docs]class MonomialExpr(_SubscriptionMixin, AbstractLinearExpr):
+    # INTERNAL
+
+    def _raw_solution_value(self, s=None):
+        return self.coef * self._dvar._raw_solution_value(s)
+
+    # INTERNAL class
+    __slots__ = ('_dvar', '_coef', '_subscribers')
+
+    # noinspection PyMissingConstructor
+    def __init__(self, model, dvar, coeff, safe=False):
+        self._model = model  # faster than to call recursively init methods...
+        self._name = None
+        self._dvar = dvar
+        self._subscribers = []
+        if safe:
+            self._coef = coeff
+        else:
+            validfn = model._checker.get_number_validation_fn()
+            self._coef = validfn(coeff) if validfn else coeff
+
+
[docs]    def number_of_variables(self):
+        return 1

+
+    def __hash__(self):
+        # py3 requires this function
+        return id(self)
+
+    @property
+    def var(self):
+        return self._dvar
+
+    @property
+    def coef(self):
+        return self._coef
+
+    @property
+    def constant(self):
+        # for compatibility
+        return 0
+
+    def as_variable(self):
+        # INTERNAL
+        return self._dvar if 1 == self._coef else None
+
+    def clone(self):
+        return self.__class__(self.model, self._dvar, self._coef, safe=True)
+
+    def copy(self, target_model, var_mapping):
+        copy_var = var_mapping[self._dvar]
+        return MonomialExpr(target_model, dvar=copy_var, coeff=self._coef, safe=True)
+
+    def iter_terms(self):
+        yield self._dvar, self._coef
+
+    iter_sorted_terms = iter_terms
+
+    def unchecked_get_coef(self, dvar):
+        return self._coef if dvar is self._dvar else 0
+
+
[docs]    def contains_var(self, dvar):
+        return self._dvar is dvar

+
+    def is_normalized(self):
+        # INTERNAL
+        return self._coef != 0  # pragma: no cover
+
+    def is_discrete(self):
+        return self._dvar.is_discrete() and is_int(self._coef)
+
+    # arithmetics
+    def negate(self):
+        self._coef = - self._coef
+        self.notify_modified(event=UpdateEvent.LinExprCoef)
+        return self
+
+    def plus(self, e):
+        if isinstance(e, LinearOperand) or is_number(e):
+            return self.to_linear_expr().add(e)
+        else:
+            return e.plus(self)
+
+    def minus(self, e):
+        if isinstance(e, LinearOperand) or is_number(e):
+            expr = self.to_linear_expr()
+            expr.subtract(e)
+            return expr
+        else:
+            return e.rminus(self)
+
+    def times(self, e):
+        if is_number(e):
+            if 0 == e:
+                return self.get_linear_factory().new_zero_expr()
+            else:
+                # return a fresh instance
+                return MonomialExpr(self._model, self._dvar, self._coef * e, safe=True)
+        elif isinstance(e, LinearExpr):
+            return e.times(self)
+        elif is_var(e):
+            return self.model._qfactory.new_var_product(e, self)
+        elif isinstance(e, MonomialExpr):
+            return self.model._qfactory.new_monomial_product(self, e)
+        else:
+            expr = self.to_linear_expr()
+            return expr.multiply(e)
+
+    def square(self):
+        return self.model._qfactory.new_monomial_product(self, self)
+
+    def quotient(self, e):
+        # returns a new instance
+        self._model._typecheck_as_denominator(e, self)
+        inverse = 1.0 / float(e)
+        return MonomialExpr(self._model, self._dvar, self._coef * inverse, safe=True)
+
+    def __add__(self, e):
+        return self.plus(e)
+
+    def __radd__(self, e):
+        return self.__add__(e)
+
+    def __sub__(self, e):
+        return self.minus(e)
+
+    def __rsub__(self, e):
+        return self.get_linear_factory()._to_linear_operand(e, force_clone=True).minus(self)
+
+    def __neg__(self):
+        opposite = self.clone()
+        return opposite.negate()
+
+    def __mul__(self, e):
+        return self.times(e)
+
+    def __rmul__(self, e):
+        return self.times(e)
+
+    def __div__(self, e):
+        return self.quotient(e)
+
+    def __truediv__(self, e):
+        # for py3
+        # INTERNAL
+        return self.__div__(e)  # pragma: no cover
+
+    def __rtruediv__(self, e):
+        # for py3
+        self.model.cannot_be_used_as_denominator_error(self, e)  # pragma: no cover
+
+    def __rdiv__(self, e):
+        self.model.cannot_be_used_as_denominator_error(self, e)  # pragma: no cover
+
+    # changing a coef
+    def set_coefficient(self, dvar, coef):
+        m = self._model
+        m._typecheck_var(dvar)
+        m._typecheck_num(coef, 'Expr.set_coefficient()')
+        return self._set_coefficient(dvar, coef)
+
+    set_coef = set_coefficient
+
+    def _set_coefficient(self, dvar, coef):
+        self.check_discrete_lock_frozen(item=coef)
+        if dvar is self._dvar:
+            self._coef = coef
+            self.notify_modified(event=UpdateEvent.LinExprCoef)
+            if not coef:
+                self.notify_replaced(new_expr=self.lfactory.new_zero_expr())
+        elif coef:
+            # monomail is extended to a linear expr
+            new_self = self.to_linear_expr()
+            new_self._add_term(dvar, coef)
+            # beware self is modified here
+            self.notify_replaced(new_self)
+            # noinspection PyMethodFirstArgAssignment
+            self = new_self
+        return self
+
+    # -- arithmetic to self
+    def __iadd__(self, other):
+        return self._add_to_self(other)
+
+    def _add_to_self(self, other):
+        self.check_discrete_lock_frozen(item=other)
+        if isinstance(other, LinearOperand) or is_number(other):
+            added = self.to_linear_expr().add(other)
+        else:
+            added = other.plus(self)
+        self.notify_replaced(added)
+        return added
+
+    def add(self, other):
+        return self._add_to_self(other)
+
+    def __isub__(self, other):
+        return self._sub_to_self(other)
+
+    def _sub_to_self(self, other):
+        # INTERNAL
+        self.check_discrete_lock_frozen(item=other)
+        if isinstance(other, LinearOperand) or is_number(other):
+            expr = self.to_linear_expr()
+            expr.subtract(other)
+            subtracted = expr
+        else:
+            subtracted = other.rminus(self)
+        self.notify_replaced(subtracted)
+        return subtracted
+
+    def subtract(self, other):
+        return self._sub_to_self(other)
+
+    def __imul__(self, e):
+        return self.multiply(e)
+
+    def multiply(self, e):
+        self.check_discrete_lock_frozen(e)
+        if is_number(e):
+            if 0 == e:
+                product = self.get_linear_factory().new_zero_expr()
+            else:
+                self._coef *= e
+                self.notify_modified(event=UpdateEvent.LinExprCoef)
+                product = self
+        elif isinstance(e, LinearExpr):
+            product = e.times(self)
+        elif is_var(e):
+            product = self.model._qfactory.new_var_product(e, self)
+        elif isinstance(e, MonomialExpr):
+            product = self.model._qfactory.new_monomial_product(self, e)
+        elif is_quad_expr(e):
+            if e.has_quadratic_term():
+                StaticTypeChecker.mul_quad_lin_error(self._model, self, e)
+            else:
+                product = self.model._qfactory.new_monomial_product(self, e.linear_part)
+        else:
+            product = self.to_linear_expr().multiply(e)
+            self.notify_replaced(product)
+        return product
+
+    mul = multiply
+
+    def __idiv__(self, other):
+        return self.divide(other)  # pragma: no cover
+
+    def __itruediv__(self, other):  # pragma: no cover
+        # for py3
+        return self.divide(other)
+
+    def divide(self, other):
+        self._model._typecheck_as_denominator(other, self)
+        inverse = 1.0 / float(other)
+        self.check_discrete_lock_frozen(inverse)
+        self._coef *= inverse
+        self.notify_modified(event=UpdateEvent.LinExprCoef)
+        return self
+
+    def equals(self, other):
+        return isinstance(other, LinearOperand) and \
+               other.get_constant() == 0 and \
+               other.number_of_terms() == 1 and \
+               other.unchecked_get_coef(self._dvar) == self._coef
+
+    # conversion
+    def to_linear_expr(self):
+        e = LinearExpr(self._model, e=(self._dvar, self._coef), safe=True, transient=True)
+        return e
+
+    def to_stringio(self, oss, nb_digits, use_space, var_namer=lambda v: v.lp_name):
+        self_coef = self._coef
+        if self_coef != 1:
+            if self_coef < 0:
+                oss.write(u'-')
+                self_coef = - self_coef
+            if self_coef != 1:
+                self._num_to_stringio(oss, num=self_coef, ndigits=nb_digits)
+            if use_space:
+                oss.write(u' ')
+        oss.write(str(var_namer(self._dvar)))
+
+    def __repr__(self):
+        return "docplex.mp.MonomialExpr(%s)" % self.to_string()

+
+
+# from private.debug_deco import count_instances
+#
+# @count_instances
+
[docs]class LinearExpr(_SubscriptionMixin, AbstractLinearExpr):
+    """LinearExpr()
+
+    This class models linear expressions.
+    This class is not intended to be instantiated. Expressions are built
+    either using operators or using `Model.linear_expr()`.
+    """
+
+    @staticmethod
+    def _new_terms_dict(model, *args, **kwargs):
+        return model._lfactory.term_dict_type(*args, **kwargs)
+
+    # @staticmethod
+    # def _new_empty_terms_dict(model):
+    #     return model._lfactory.term_dict_type()
+
+    def to_linear_expr(self):
+        return self
+
+    def _get_terms_dict(self):
+        # INTERNAL
+        return self._terms
+
+    __slots__ = ('_constant', '_terms', '_transient', '_subscribers')
+
+    def __hash__(self):
+        # py3 requires this function
+        return id(self)
+
+    def __init__(self, model, e=None, constant=0, safe=False, transient=False):
+        ModelingObjectBase.__init__(self, model)
+        if not safe and constant:
+            model._typecheck_num(constant, 'LinearExpr()')
+        self._constant = constant
+        self._transient = transient
+        self._subscribers = []
+
+        if isinstance(e, dict):
+            if safe:
+                self._terms = e
+            else:
+                self_terms = model._lfactory.term_dict_type()
+                for (v, k) in e.items():
+                    model._typecheck_var(v)
+                    model._typecheck_num(k, 'LinearExpr')
+                    if k != 0:
+                        self_terms[v] = k
+                self._terms = self_terms
+            return
+        else:
+            self._terms = model._lfactory._new_term_dict()
+
+        if e is None:
+            pass
+
+        elif is_var(e):
+            self._terms[e] = 1
+
+        elif is_number(e):
+            self._constant += e
+
+        elif isinstance(e, MonomialExpr):
+            # TODO: simplify by self_terms[e.var] = e.coef
+            self._add_term(e.var, e.coef)
+
+        elif isinstance(e, LinearExpr):
+            # note that transient is not kept.
+            self._constant = e.get_constant()
+            self._terms = self._new_terms_dict(model, e._get_terms_dict())  # make a copy
+
+        elif isinstance(e, tuple):
+            v, k = e
+            self._terms[v] = k
+
+        else:
+            self.fatal("Cannot convert {0!r} to docplex.mp.LinearExpr, type is {1}", e, type(e))
+
+    def keep(self):
+        self._transient = False
+        return self
+
+    def is_kept(self):
+        # INTERNAL
+        return not self._transient
+
+    def is_transient(self):  # pragma: no cover
+        # INTERNAL
+        return self._transient
+
+    def clone_if_necessary(self):
+        #  INTERNAL
+        if self._transient and not self._model._keep_all_exprs and not self.is_in_use():
+            return self
+        else:
+            return self.clone()
+
+    # def set_name(self, name):
+    #     Expr.set_name(self, name)
+    #     # an expression with a name is not transient any more
+    #     if name:
+    #         self.keep()
+    #
+    # def _get_name(self):
+    #     return self._name
+    #
+    # name = property(_get_name, set_name)
+
+    # from private.debug_deco import count_calls
+    # @count_calls
+
[docs]    def clone(self):
+        """
+        Returns:
+            A copy of the expression on the same model.
+        """
+        cloned_terms = self._new_terms_dict(self._model, self._terms)  # faster than copy() on OrderedDict()
+        cloned = LinearExpr(model=self._model, e=cloned_terms, constant=self._constant, safe=True)
+        return cloned

+
+    def copy(self, target_model, var_mapping):
+        # INTERNAL
+        copied_terms = self._new_terms_dict(target_model)
+        for v, k in self.iter_sorted_terms():
+            copied_terms[var_mapping[v]] = k
+        copied_expr = LinearExpr(model=target_model, e=copied_terms, constant=self.constant, safe=True)
+        return copied_expr
+
+
[docs]    def negate(self):
+        """ Takes the negation of an expression.
+
+        Changes the expression by replacing each variable coefficient and the constant term
+        by its opposite.
+
+        Note:
+            This method does not create any new expression but modifies the `self` instance.
+
+        Returns:
+            The modified self.
+
+        """
+        self._constant = - self._constant
+        self_terms = self._terms
+        for v, k in self_terms.items():
+            self_terms[v] = -k
+        self.notify_modified(event=UpdateEvent.LinExprGlobal)
+        return self

+
+    def _clear(self):
+        """ Clears the expression.
+
+        All variables and coefficients are removed and the constant term is set to zero.
+        """
+        self._constant = 0
+        self._terms.clear()
+
+
[docs]    def equals_constant(self, scalar):
+        """ Checks if the expression equals a constant term.
+
+        Args:
+            scalar (float): A floating-point number.
+        Returns:
+            Boolean: True if the expression equals this constant term.
+        """
+        return self.is_constant() and (scalar == self._constant)

+
+    def is_zero(self):
+        return self.equals_constant(0)
+
+
[docs]    def is_constant(self):
+        """
+        Checks if the expression is a constant.
+
+        Returns:
+            Boolean: True if the expression consists of only a constant term.
+        """
+        return not self._terms

+
+    def as_variable(self):
+        # INTERNAL: returns True if expression is in fact a variable (1*x)
+        if 1 == len(self._terms) and not self._constant:
+            for v, k in self.iter_terms():
+                if k == 1:
+                    return v
+        return None
+
+    def is_normalized(self):
+        # INTERNAL
+        return all(k for _, k in self.iter_terms() )
+
+    def normalize(self):
+        doomed = [dv for dv, k in self.iter_terms() if not k]
+        lterms = self._terms
+        for d in doomed:
+            del lterms[d]
+
+
[docs]    def number_of_variables(self):
+        return len(self._terms)

+
+    def unchecked_get_coef(self, dvar):
+        # INTERNAL
+        return self._terms.get(dvar, 0)
+
+
[docs]    def add_term(self, dvar, coeff):
+        """
+        Adds a term (variable and coefficient) to the expression.
+
+        Args:
+            dvar (:class:`Var`): A decision variable.
+            coeff (float): A floating-point number.
+
+        Returns:
+            The modified expression itself.
+        """
+        if coeff:
+            self._model._typecheck_var(dvar)
+            self._model._typecheck_num(coeff)
+            self._add_term(dvar, coeff)
+            self.notify_modified(event=UpdateEvent.LinExprCoef)
+        return self

+
+    def _add_term(self, dvar, coef=1):
+        # INTERNAL
+        self_terms = self._terms
+        new_coef = self_terms.get(dvar, 0) + coef
+        if new_coef:
+            self_terms[dvar] = new_coef
+        else:
+            try:
+                del self_terms[dvar]
+            except KeyError:
+                pass
+
+    def set_coefficient(self, dvar, coeff):
+        self._model._typecheck_var(dvar)
+        self._model._typecheck_num(coeff)
+        self._set_coefficient(dvar, coeff)
+
+    set_coef = set_coefficient
+
+    def _set_coefficient_internal(self, dvar, coeff):
+        self_terms = self._terms
+        if coeff or dvar in self_terms:
+            self_terms[dvar] = coeff
+            return True
+        else:
+            return False
+
+    def _set_coefficient(self, dvar, coeff):
+        self.check_discrete_lock_frozen(coeff)
+        if self._set_coefficient_internal(dvar, coeff):
+            self.notify_modified(event=UpdateEvent.LinExprCoef)
+            if not coeff:
+                self.normalize()
+
+    def set_coefficients(self, var_coef_seq):
+        # TODO: typecheck
+        self._set_coefficients(var_coef_seq)
+
+    set_coefs = set_coefficients
+
+    def _set_coefficients(self, var_coef_seq):
+        self.check_discrete_lock_frozen()
+        nb_changes = 0
+        nb_nulls = 0
+        for dv, k in var_coef_seq:
+            if self._set_coefficient_internal(dv, k):
+                nb_changes += 1
+                if not k:
+                    nb_nulls += 1
+        if nb_changes:
+            self.notify_modified(event=UpdateEvent.LinExprCoef)
+            if nb_nulls:
+                self.normalize()
+
+
+
[docs]    def remove_term(self, dvar):
+        """ Removes a term associated with a variable from the expression.
+
+        Args:
+            dvar (:class:`Var`): A decision variable.
+
+        Returns:
+            The modified expression.
+
+        """
+        self.set_coefficient(dvar, 0)

+
+    @property
+    def constant(self):
+        """
+        This property is used to get or set the constant term of the expression.
+        """
+        return self._constant
+
+    @constant.setter
+    def constant(self, new_constant):
+        self._set_constant(new_constant)
+
+    def get_constant(self):
+        return self._constant
+
+    def _set_constant(self, new_constant):
+        if new_constant != self._constant:
+            self.check_discrete_lock_frozen(new_constant)
+            self._constant = new_constant
+            self.notify_modified(event=UpdateEvent.ExprConstant)
+
+
[docs]    def contains_var(self, dvar):
+        """ Checks whether a decision variable is part of an expression.
+
+        Args:
+            dvar (:class:`Var`): A decision variable.
+
+        Returns:
+            Boolean: True if `dvar` is mentioned in the expression with a nonzero coefficient.
+        """
+        return dvar in self._terms

+
+
[docs]    def equals(self, other):
+        """
+         This method is used to test equality between expressions.
+         Because of the overloading of operator `==` through the redefinition of
+         the `__eq__` method, you cannot use `==` to test for equality.
+         The `equals` method to test whether a given expression is equivalent to a variable.
+         Two linear expressions are equivalent if they have the same coefficient for all
+         variables.
+
+         Args:
+            other: a number or any expression.
+
+
+
+         Returns:
+             A boolean value, True if the passed expression is equivalent, else False.
+
+
+         Note:
+            A constant expression is considered equivalent to its constant number.
+
+                m.linear_expression(3).equals(3) returns True
+        """
+        if is_number(other):
+            return self.is_constant() and other == self.constant
+        else:
+            if not isinstance(other, LinearOperand):
+                return False
+            if self.constant != other.get_constant():
+                return False
+            if self.number_of_terms() != other.number_of_terms():
+                return False
+            for dv, k in self.iter_terms():
+                if k != other.unchecked_get_coef(dv):
+                    return False
+            return True

+
+    # noinspection PyPep8
+    def to_stringio(self, oss, nb_digits, use_space, var_namer=lambda v: v.lp_name):
+        # INTERNAL
+        # Writes unicode representation of self
+        c = 0
+        # noinspection PyPep8Naming
+        SP = u' '
+
+        for v, coeff in self.iter_sorted_terms():
+            if not coeff:
+                continue  # pragma: no cover
+
+            # 1 separator
+            if use_space and c > 0:
+                oss.write(SP)
+
+            # ---
+            # sign is printed if  non-first OR negative
+            # at the end of this block coeff is positive
+            if coeff < 0 or c > 0:
+                oss.write(u'-' if coeff < 0 else u'+')
+                if coeff < 0:
+                    coeff = -coeff
+                if use_space and c > 0:
+                    oss.write(SP)
+            # ---
+
+            if 1 != coeff:
+                self._num_to_stringio(oss, coeff, nb_digits)
+                if use_space:
+                    oss.write(SP)
+
+            varname = var_namer(v)
+            oss.write(str(varname))
+            c += 1
+
+        k = self.constant
+        if c == 0:
+            self._num_to_stringio(oss, k, nb_digits)
+        elif k != 0:
+            if k < 0:
+                sign = u'-'
+                k = -k
+            else:
+                sign = u'+'
+            if use_space:
+                oss.write(SP)
+            oss.write(sign)
+            if use_space:
+                oss.write(SP)
+            self._num_to_stringio(oss, k, nb_digits)
+
+    def _add_expr(self, other_expr):
+        # INTERNAL
+        self._constant += other_expr.get_constant()
+        # merge term dictionaries
+        for v, k in other_expr.iter_terms():
+            # use unchecked version
+            self._add_term(v, k)
+
+    def _add_expr_scaled(self, expr, factor):
+        # INTERNAL: used by quadratic
+        if factor:
+            self._constant += expr.get_constant() * factor
+            for v, k in expr.iter_terms():
+                # use unchecked version
+                self._add_term(v, k * factor)
+
+    # --- algebra methods always modify self.
+
[docs]    def add(self, e):
+        """ Adds an expression to self.
+
+        Note:
+            This method does not create an new expression but modifies the `self` instance.
+
+        Args:
+            e: The expression to be added. Can be a variable, an expression, or a number.
+
+        Returns:
+            The modified self.
+
+        See Also:
+            The method :func:`plus` to compute a sum without modifying the self instance.
+        """
+        event = UpdateEvent.LinExprGlobal
+        if is_var(e):
+            self._add_term(e, coef=1)
+        elif isinstance(e, LinearOperand):
+            self._add_expr(e)
+            if isinstance(e, ZeroExpr):
+                event = None
+        elif is_number(e):
+            validfn = self._model._checker.get_number_validation_fn()
+            valid_e = validfn(e) if validfn else e
+            self._constant += valid_e
+            event = UpdateEvent.ExprConstant
+        elif is_quad_expr(e):
+            raise DOCplexQuadraticArithException
+        else:
+            try:
+                self.add(e.to_linear_expr())
+            except AttributeError:
+                self._unsupported_binary_operation(self, "+", e)
+
+        self.notify_modified(event=event)
+        return self

+
+
[docs]    def iter_terms(self):
+        """ Iterates over the terms in the expression.
+
+        Returns:
+            An iterator over the (variable, coefficient) pairs in the expression.
+        """
+        return self._terms.items()

+
+    def number_of_terms(self):
+        return len(self._terms)
+
+    @property
+    def size(self):
+        return len(self._terms) + bool(self._constant)
+
+
[docs]    def subtract(self, e):
+        """ Subtracts an expression from this expression.
+        Note:
+            This method does not create a new expression but modifies the `self` instance.
+
+        Args:
+            e: The expression to be subtracted. Can be either a variable, an expression, or a number.
+
+        Returns:
+            The modified self.
+
+        See Also:
+            The method :func:`minus` to compute a difference without modifying the `self` instance.
+        """
+        event = UpdateEvent.LinExprCoef
+        if is_var(e):
+            self._add_term(e, -1)
+        elif is_number(e):
+            self._constant -= e
+            event = UpdateEvent.ExprConstant
+        elif isinstance(e, LinearExpr):
+            if e.is_constant() and 0 == e.get_constant():
+                return self
+            else:
+                # 1. decr constant
+                self.constant -= e.constant
+                # merge term dictionaries
+                for v, k in e.iter_terms():
+                    self._add_term(v, -k)
+        elif isinstance(e, MonomialExpr):
+            self._add_term(e.var, -e.coef)
+        elif isinstance(e, ZeroExpr):
+            event = None
+        elif is_quad_expr(e):
+            #
+            raise DOCplexQuadraticArithException
+        else:
+            try:
+                self.subtract(e.to_linear_expr())
+            except AttributeError:
+                self._unsupported_binary_operation(self, "-", e)
+        self.notify_modified(event)
+        return self

+
+    def _scale(self, factor):
+        # INTERNAL: used my multiply
+        # this method modifies self.
+        if 0 == factor:
+            self._clear()
+        elif factor != 1:
+            self._constant *= factor
+            self_terms = self._terms
+            for v, k in self_terms.items():
+                self_terms[v] = k * factor
+
+
[docs]    def multiply(self, e):
+        """ Multiplies this expression by an expression.
+
+        Note:
+            This method does not create a new expression but modifies the `self` instance.
+
+        Args:
+            e: The expression that is used to multiply `self`.
+
+        Returns:
+            The modified `self`.
+
+        See Also:
+            The method :func:`times` to compute a multiplication without modifying the `self` instance.
+        """
+        mul_res = self
+        event = UpdateEvent.LinExprGlobal
+        self_constant = self.get_constant()
+        if is_number(e):
+            self._scale(factor=e)
+
+        elif isinstance(e, LinearOperand):
+            if e.is_constant():
+                # simple scaling
+                self._scale(factor=e.get_constant())
+            elif self.is_constant():
+                # self is constant: import other terms , scaled.
+                # set constant to zero.
+                if self_constant:
+                    for lv, lk in e.iter_terms():
+                        self.set_coefficient(dvar=lv, coeff=lk * self_constant)
+                    self._constant *= e.get_constant()
+                else:
+                    self._scale(factor=0)
+
+            else:
+                # yields a quadratic
+                mul_res = self.model._qfactory.new_linexpr_product(self, e)
+                event = UpdateEvent.LinExprPromotedToQuad
+
+        # elif isinstance(e, ZeroExpr):
+        #     self._scale(factor=0)
+
+        elif is_quad_expr(e):
+            if not e.number_of_quadratic_terms:
+                return self.multiply(e.linear_part)
+            elif self.is_constant():
+                return e.multiply(self.get_constant())
+            else:
+                StaticTypeChecker.mul_quad_lin_error(self._model, self, e)
+
+        else:
+            self.fatal("Multiply expects variable, expr or number, {0!r} was passed (type is {1})", e, type(e))
+
+        self.notify_modified(event=event)
+
+        return mul_res

+
+    def square(self):
+        return self.model._qfactory.new_linexpr_product(self, self)
+
+
[docs]    def divide(self, e):
+        """ Divides this expression by an operand.
+
+        Args:
+            e: The operand by which the self expression is divided. Only nonzero numbers are permitted.
+
+        Note:
+            This method does not create a new expression but modifies the `self` instance.
+
+        Returns:
+            The modified `self`.
+        """
+        self.model._typecheck_as_denominator(e, numerator=self)
+        inverse = 1.0 / float(e)
+        return self.multiply(inverse)

+
+    # operator-based API
+    def opposite(self):
+        cloned = self.clone_if_necessary()
+        cloned.negate()
+        return cloned
+
+
[docs]    def plus(self, e):
+        """ Computes the sum of the expression and some operand.
+
+        Args:
+            e: the expression to add to self. Can be either a variable, an expression or a number.
+
+        Returns:
+            a new expression equal to the sum of the self expression and `e`
+
+        Note:
+            This method doe snot modify self.
+        """
+        cloned = self.clone_if_necessary()
+        try:
+            return cloned.add(e)
+        except DOCplexQuadraticArithException:
+            return e.plus(self)

+
+    def minus(self, e):
+        cloned = self.clone_if_necessary()
+        try:
+            return cloned.subtract(e)
+        except DOCplexQuadraticArithException:
+            return e.rminus(self)
+
+
[docs]    def times(self, e):
+        """ Computes the multiplication of this expression with an operand.
+
+        Note:
+            This method does not modify the `self` instance but returns a new expression instance.
+
+        Args:
+            e: The expression that is used to multiply `self`.
+
+        Returns:
+            A new instance of expression.
+        """
+        cloned = self.clone_if_necessary()
+        return cloned.multiply(e)

+
+
[docs]    def quotient(self, e):
+        """ Computes the division of this expression with an operand.
+
+        Note:
+            This method does not modify the `self` instance but returns a new expression instance.
+
+        Args:
+            e: The expression that is used to modify `self`. Only nonzero numbers are permitted.
+
+        Returns:
+            A new instance of expression.
+        """
+        cloned = self.clone_if_necessary()
+        cloned.divide(e)
+        return cloned

+
+    def __add__(self, e):
+        return self.plus(e)
+
+    def __radd__(self, e):
+        return self.plus(e)
+
+    def __iadd__(self, e):
+        try:
+            self.add(e)
+            return self
+        except DOCplexQuadraticArithException:
+            r = e + self
+            self.notify_replaced(new_expr=r)
+            return r
+
+    def __sub__(self, e):
+        return self.minus(e)
+
+    def __rsub__(self, e):
+        cloned = self.clone_if_necessary()
+        cloned.subtract(e)
+        cloned.negate()
+        return cloned
+
+    def __isub__(self, e):
+        try:
+            return self.subtract(e)
+        except DOCplexQuadraticArithException:
+            r = -e + self
+            return r
+
+    def __neg__(self):
+        return self.opposite()
+
+    def __mul__(self, e):
+        return self.times(e)
+
+    def __rmul__(self, e):
+        return self.times(e)
+
+    def __imul__(self, e):
+        return self.multiply(e)
+
+    def __div__(self, e):
+        return self.quotient(e)
+
+    def __idiv__(self, other):
+        return self.divide(other)  # pragma: no cover
+
+    def __itruediv__(self, other):
+        # this is for Python 3.z
+        return self.divide(other)  # pragma: no cover
+
+    def __truediv__(self, e):
+        return self.__div__(e)  # pragma: no cover
+
+    def __rtruediv__(self, e):
+        self.fatal("Expression {0!s} cannot be used as divider of {1!s}", self, e)  # pragma: no cover
+
+    @property
+    def solution_value(self):
+        """ This property returns the solution value of the variable.
+
+        Raises:
+            DOCplexException
+                if the model has not been solved.
+        """
+        return super().solution_value
+
+    def _raw_solution_value(self, s=None):
+        # INTERNAL: no checks
+        val = self._constant
+        sol = s or self._model.solution
+        for var, koef in self.iter_terms():
+            val += koef * sol._get_var_value(var)
+        return val
+
+
[docs]    def is_discrete(self):
+        """ Checks if the expression contains only discrete variables and coefficients.
+
+        Example:
+            If X is an integer variable, X, X+1, 2X+3 are discrete
+            but X+0.3, 1.5X, 2X + 0.7 are not.
+
+        Returns:
+            Boolean: True if the expression contains only discrete variables and coefficients.
+        """
+        self_cst = self._constant
+        if self_cst != int(self_cst):
+            # a float constant with integer value is OK
+            return False
+
+        for v, k in self.iter_terms():
+            if not v.is_discrete() or not is_int(k):
+                return False
+        return True

+
+    def __repr__(self):
+        return "docplex.mp.LinearExpr({0})".format(self.repr_str())
+
+    def _iter_sorted_terms(self):
+        # internal
+        self_terms = self._terms
+        for dv in sorted(self_terms.keys(), key=lambda v: v._index):
+            yield dv, self_terms[dv]
+
+    def iter_sorted_terms(self):
+        if self._model.keep_ordering:
+            return self.iter_terms()
+        else:
+            return self._iter_sorted_terms()

+
+
+LinearConstraintType = ComparisonType
+
+
+
[docs]class ZeroExpr(_SubscriptionMixin, AbstractLinearExpr):
+    def _raw_solution_value(self, s=None):
+        return 0
+
+    def is_zero(self):
+        return True
+
+    # INTERNAL
+    __slots__ = ('_subscribers',)
+
+    def __hash__(self):
+        return id(self)
+
+    def __init__(self, model):
+        ModelingObjectBase.__init__(self, model)
+        self._subscribers = []
+
+    def clone(self):
+        return self  # this is not cloned.
+
+    def copy(self, target_model, var_mapping):
+        return ZeroExpr(target_model)
+
+    def to_linear_expr(self):
+        return self  # this is a linear expr.
+
+
[docs]    def number_of_variables(self):
+        return 0

+
+    def number_of_terms(self):
+        return 0
+
+    def iter_terms(self):
+        return iter_emptyset()
+
+    def is_constant(self):
+        return True
+
+    def is_discrete(self):
+        return True
+
+    def unchecked_get_coef(self, dvar):
+        return 0
+
+
[docs]    def contains_var(self, dvar):
+        return False

+
+    @property
+    def constant(self):
+        # for compatibility
+        return 0
+
+    @constant.setter
+    def constant(self, newk):
+        if newk:
+            cexpr = self.get_linear_factory().constant_expr(newk, safe_number=False)
+            self.notify_replaced(cexpr)
+
+    def negate(self):
+        return self
+
+    # noinspection PyMethodMayBeStatic
+    def plus(self, e):
+        return e
+
+    def times(self, _):
+        return self
+
+    # noinspection PyMethodMayBeStatic
+    def minus(self, e):
+        return -e
+
+    def to_string(self, nb_digits=None, use_space=False):
+        return '0'
+
+    def to_stringio(self, oss, nb_digits, use_space, var_namer=lambda v: v.name):
+        oss.write(self.to_string())
+
+    # arithmetic
+    def __sub__(self, e):
+        return self.minus(e)
+
+    def __rsub__(self, e):
+        # e - 0 = e !
+        return e
+
+    def __neg__(self):
+        return self
+
+    def __add__(self, other):
+        return other
+
+    def __radd__(self, other):
+        return other
+
+    def __mul__(self, other):
+        return self
+
+    def __rmul__(self, other):
+        return self
+
+    def __div__(self, other):
+        return self._divide(other)
+
+    def __truediv__(self, e):
+        # for py3
+        # INTERNAL
+        return self.__div__(e)  # pragma: no cover
+
+    def _divide(self, other):
+        self.model._typecheck_as_denominator(numerator=self, denominator=other)
+        return self
+
+    def __repr__(self):
+        return "docplex.mp.ZeroExpr()"
+
+    def equals(self, other):
+        return (isinstance(other, LinearOperand) and
+                (0 == other.get_constant() and (0 == other.number_of_terms()))) or \
+               (is_number(other) and other == 0)
+
+    def square(self):
+        return self
+
+    # arithmetic to self
+    add = plus
+    subtract = minus
+    multiply = times
+
+    def __iadd__(self, other):
+        linear_other = self.get_linear_factory()._to_linear_operand(other, force_clone=False)
+        self.notify_replaced(linear_other)
+        return linear_other
+
+    def __isub__(self, other):
+        linear_other = self.get_linear_factory()._to_linear_operand(other, force_clone=True)
+        negated = linear_other.negate()
+        self.notify_replaced(negated)
+        return negated

+
+
+
[docs]class ConstantExpr(_SubscriptionMixin, AbstractLinearExpr):
+    __slots__ = ('_constant', '_subscribers')
+
+    def __init__(self, model, cst):
+        ModelingObjectBase.__init__(self, model=model, name=None)
+        # assume constant is a number (to be checked upfront)
+        self._constant = cst
+        self._subscribers = []
+
+    @property
+    def size(self):
+        return 1 if self._constant else 0
+
+    # INTERNAL
+    def _make_new_constant(self, new_value):
+        return ConstantExpr(self._model, new_value)
+
+    def _raw_solution_value(self, s=None):
+        return self._constant
+
+    def is_zero(self):
+        return 0 == self._constant
+
+    def clone(self):
+        return self.__class__(self._model, self._constant)
+
+    def copy(self, target_model, var_mapping):
+        return self.__class__(target_model, self._constant)
+
+    def to_linear_expr(self):
+        return self  # this is a linear expr.
+
+
[docs]    def number_of_variables(self):
+        return 0

+
+
[docs]    def iter_variables(self):
+        return iter_emptyset()

+
+    def iter_terms(self):
+        return iter_emptyset()
+
+    def is_constant(self):
+        return True
+
+    def is_discrete(self):
+        return is_int(self._constant)
+
+    def unchecked_get_coef(self, dvar):
+        return 0
+
+
[docs]    def contains_var(self, dvar):
+        return False

+
+    def set_coefficients(self, var_coef_seq):
+        pass
+
+    @property
+    def constant(self):
+        return self._constant
+
+    @constant.setter
+    def constant(self, new_constant):
+        self._set_constant(new_constant)
+
+    def get_constant(self):
+        return self._constant
+
+    def _set_constant(self, new_constant):
+        if new_constant != self._constant:
+            self.check_discrete_lock_frozen(new_constant)
+            self._constant = new_constant
+            self.notify_modified(event=UpdateEvent.ExprConstant)
+
+    def negate(self):
+        return self._make_new_constant(- self._constant)
+
+    def _apply_op(self, pyop, arg):
+        if is_number(arg):
+            return self._make_new_constant(pyop(self.constant, arg))
+        else:
+            return pyop(arg, self._constant)
+
+    # noinspection PyMethodMayBeStatic
+    def plus(self, e):
+        import operator
+        return self._apply_op(operator.add, e)
+
+    def times(self, e):
+        if is_number(e):
+            return self.__class__(self._model, e * self._constant)
+        else:
+            return e * self._constant
+
+    # noinspection PyMethodMayBeStatic
+    def minus(self, e):
+        return self + (-e)
+
+    def to_string(self, nb_digits=None, use_space=False):
+        return '{0}'.format(self._constant)
+
+    def to_stringio(self, oss, nb_digits, use_space, var_namer=lambda v: v.name):
+        self._num_to_stringio(oss, self._constant, nb_digits)
+
+    # arithmetic
+    def __sub__(self, e):
+        return self.minus(e)
+
+    def __rsub__(self, e):
+        # e - k = e !
+        return e - self._constant
+
+    def __neg__(self):
+        return self._make_new_constant(- self._constant)
+
+    def __add__(self, other):
+        return self.plus(other)
+
+    def __radd__(self, other):
+        return self.plus(other)
+
+    def __mul__(self, other):
+        return self.times(other)
+
+    def __rmul__(self, other):
+        return self.times(other)
+
+    def __div__(self, other):
+        return self._divide(other)
+
+    def __truediv__(self, e):
+        # for py3
+        # INTERNAL
+        return self.__div__(e)  # pragma: no cover
+
+    def _divide(self, other):
+        self.model._typecheck_as_denominator(numerator=self, denominator=other)
+        return self._make_new_constant(self._constant / other)
+
+    def __repr__(self):
+        return 'docplex.mp.linear.ConstantExpr({0})'.format(self._constant)
+
+    def equals_expr(self, other):
+        return isinstance(other, ConstantExpr) and self._constant == other.constant
+
+    def square(self):
+        return self._make_new_constant(self._constant ** 2)
+
+    # arithmetci to self
+
+    def _scale(self, factor):
+        return self._make_new_constant(self._constant * factor)
+
+    def equals(self, other):
+        if is_number(other):
+            return self._constant == other
+        else:
+            return isinstance(other, LinearOperand) \
+                   and other.is_constant() and \
+                   self._constant == other.get_constant()
+
+    # arithmetic to self
+    def __iadd__(self, other):
+        return self.add(other)
+
+    def add(self, other):
+        if is_number(other):
+            self._constant += other
+            self.notify_modified(UpdateEvent.ExprConstant)
+            return self
+        elif isinstance(other, LinearOperand) and other.is_constant():
+            self._constant += other.get_constant()
+            self.notify_modified(UpdateEvent.ExprConstant)
+            return self
+        else:
+            # replace self by other + self.
+            added = other.plus(self._constant)
+            self.notify_replaced(added)
+            return added
+
+    def subtract(self, other):
+        if is_number(other):
+            self._constant -= other
+            self.notify_modified(UpdateEvent.ExprConstant)
+            return self
+        elif isinstance(other, LinearOperand) and other.is_constant():
+            self._constant -= other.get_constant()
+            self.notify_modified(UpdateEvent.ExprConstant)
+            return self
+        else:
+            # replace self by (-other) + self.K
+            subtracted = other.negate().plus(self._constant)
+            self.notify_replaced(subtracted)
+            return subtracted
+
+    def __isub__(self, other):
+        return self.subtract(other)
+
+    def multiply(self, other):
+        if is_number(other):
+            self._constant *= other
+            self.notify_modified(UpdateEvent.ExprConstant)
+            return self
+        elif isinstance(other, LinearOperand) and other.is_constant():
+            self._constant *= other.get_constant()
+            self.notify_modified(UpdateEvent.ExprConstant)
+            return self
+        else:
+            # replace self by (-other) + self.K
+            multiplied = other * self._constant
+            self.notify_replaced(multiplied)
+            return multiplied
+
+    def __imul__(self, other):
+        return self.multiply(other)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/model.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/model.html new file mode 100644 index 0000000..aa1211e --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/model.html @@ -0,0 +1,7361 @@ + + + + + + + + + docplex.mp.model — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.model

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2018
+# --------------------------------------------------------------------------
+
+# pylint: disable=too-many-lines
+import os
+import sys
+import warnings
+from itertools import chain, product
+from io import StringIO
+
+from docplex.mp.aggregator import ModelAggregator
+from docplex.mp.constants import SOSType, CplexScope, ObjectiveSense, BasisStatus, EffortLevel,\
+    int_probtype_to_string, ComparisonType
+from docplex.mp.constr import AbstractConstraint, LinearConstraint, RangeConstraint, \
+    IndicatorConstraint, QuadraticConstraint, PwlConstraint, EquivalenceConstraint
+from docplex.mp.context import Context, OverridenOutputContext
+from docplex.mp.dvar import is_var
+
+from docplex.mp.engine_factory import EngineFactory
+from docplex.mp.environment import Environment
+from docplex.mp.error_handler import DefaultErrorHandler, \
+    docplex_add_trivial_infeasible_ct_here, handle_error
+from docplex.mp.format import parse_format
+from docplex.mp.lp_printer import LPModelPrinter
+from docplex.mp.mfactory import ModelFactory
+from docplex.mp.model_stats import ModelStatistics
+from docplex.mp.numutils import round_nearest_towards_infinity1, _NumPrinter, compute_tolerance
+
+from docplex.mp.pwl import PwlFunction
+from docplex.mp.tck import get_typechecker, warn_trivial_feasible, warn_trivial_infeasible, warn_trivial_none
+from docplex.mp.sttck import StaticTypeChecker
+from docplex.mp.utils import DOcplexException, MultiObjective,\
+    DOcplexLimitsExceeded, _var_match_function
+from docplex.mp.utils import is_indexable, is_iterable, is_int, is_string, \
+    make_output_path2, generate_constant, _AutomaticSymbolGenerator, _IndexScope, _to_list, \
+    is_number, str_maxed, normalize_basename, izip2_filled, ordered_sequence_to_list
+from docplex.mp.utils import apply_thread_limitations
+from docplex.mp.vartype import VarType, BinaryVarType, IntegerVarType, \
+    ContinuousVarType, SemiContinuousVarType, SemiIntegerVarType
+from docplex.util.environment import get_environment
+
+
+from docplex.mp.solve_env import CplexLocalSolveEnv
+
+
+# noinspection PyProtectedMember
+
[docs]class Model(object):
+    """ This is the main class to embed modeling objects.
+
+    The :class:`Model` class acts as a factory to create optimization objects,
+    decision variables, and constraints.
+    It provides various accessors and iterators to the modeling objects.
+    It also manages solving operations and solution management.
+
+    The Model class is a context manager and can be used with the Python `with` statement:
+
+    .. code-block:: python
+
+       with Model() as mdl:
+         # start modeling...
+
+    When the `with` block is finished, the :func:`end` method is called automatically, and all resources
+    allocated by the model are destroyed.
+    If the model is not created with the `with` keyword, then the :func:`end` method should be called to free all CPLEX resources.
+
+    When a model is created without a specified ``context``, a default
+    ``Context`` is created and initialized as described in :func:`docplex.mp.context.Context.read_settings`.
+
+    Example::
+
+        # Creates a model named 'my model' with default context
+        model = Model('my model')
+
+    In this example, we create a model to solve with just 2 threads::
+
+        context = Context.make_default_context()
+        context.cplex_parameters.threads = 2
+        model = Model(context=context)
+
+    Alternatively, this can be coded as::
+
+        model = Model()
+        model.context.cplex_parameters.threads = 2
+
+    Args:
+        name (optional): The name of the model.
+        context (optional): The solve context to be used. If no ``context`` is
+            passed, a default context is created.
+        log_output (optional): If ``True``, solver logs are output to
+            stdout. If this is a stream, solver logs are output to that
+            stream object.
+
+        checker (optional): If ``off``, then checking is disabled everywhere. Turning off checking
+            may improve performance but should be done only with extreme caution.
+            Possible values for the `checker` keyword argument are:
+
+                - `default` (or `std`, or `on`): detects modeling errors, but does not check
+                  numerical values for infinities or NaNs. This is the default value.
+                - `numeric`: checks that numerical arguments are valid numbers, neither NaN nor
+                  `math.infinity`. This option should be used when data are not trusted.
+                - `full`: performs all possible checks (This is the union of `std` and `numeric` checks).
+                - `off`: no typechecking is performed. This options must be used when the model has been
+                  thoroughly tested and numerical data are trusted.
+
+        cts_by_name (optional): a flag which control whether the constraint name dictionary is enabled.
+            Default is False.
+    """
+
+    _name_generator = _AutomaticSymbolGenerator(pattern="docplex_model", offset=1)
+
+    _default_effort_level = EffortLevel.Repair
+
+    @property
+    def binary_vartype(self):
+        """ This property returns an instance of :class:`docplex.mp.vartype.BinaryVarType`.
+
+        This type instance is used to build all binary decision variable collections of the model.
+        """
+        return self._binary_vartype
+
+    @property
+    def integer_vartype(self):
+        """ This property returns an instance of :class:`docplex.mp.vartype.IntegerVarType`.
+
+        This type instance is used to build all integer variable collections of the model.
+        """
+        return self._integer_vartype
+
+    @property
+    def continuous_vartype(self):
+        """ This property returns an instance of :class:`docplex.mp.vartype.ContinuousVarType`.
+
+        This type instance is used to build all continuous variable collections of the model.
+        """
+        return self._continuous_vartype
+
+    @property
+    def semicontinuous_vartype(self):
+        """ This property returns an instance of :class:`docplex.mp.vartype.SemiContinuousVarType`.
+
+        This type instance is used to build all semi-continuous variable collections of the model.
+        """
+        return self._semicontinuous_vartype
+
+    @property
+    def semiinteger_vartype(self):
+        """ This property returns an instance of :class:`docplex.mp.vartype.SemiIntegerType`.
+
+        This type instance is used to build all semi-integer variable collections of the model.
+        """
+        return self._semiinteger_vartype
+
+    def _vartypes(self):
+        return (self._binary_vartype, self._integer_vartype, self._continuous_vartype,
+                self._semicontinuous_vartype, self._semiinteger_vartype)
+
+    def iter_vartypes(self):
+        return iter(self._vartypes())
+
+    def _parse_vartype(self, arg):
+        if isinstance(arg, VarType):
+            return arg
+        else:
+            self._checker.typecheck_string(arg, accept_empty=False, accept_none=False)
+            argl = arg.lower()
+            for vt in iter(self.iter_vartypes()):
+                if argl == vt.short_name.lower() or argl == vt.cplex_typecode.lower():
+                    return vt
+            self.fatal("Cannot convert as a variable type: {0!r}", arg)
+
+    def _make_environment(self):
+        env = Environment.get_default_env()
+        # rtc-28869
+        env.numpy_hook = Model.init_numpy
+        return env
+
+    def _lazy_get_environment(self):
+        if self._environment is None:
+            self._environment = self._make_environment()  # pragma: no cover
+        return self._environment
+
+    _saved_numpy_options = None
+
+    _unknown_status = None
+
+
[docs]    @staticmethod
+    def init_numpy():
+        """ Static method to customize `numpy` for DOcplex.
+
+        This method makes `numpy` aware of DOcplex.
+        All `numpy` arrays with DOcplex objects will be printed by their string representations
+        as returned by `str(`) instead of `repr()` as with standard numpy behavior.
+
+        All customizations can be removed by calling the :func:`restore_numpy` method.
+
+        Note:
+            This method does nothing if `numpy` is not present.
+
+        See Also:
+            :func:`restore_numpy`
+        """
+        try:
+            # noinspection PyUnresolvedReferences
+            import numpy as np
+
+            Model._saved_numpy_options = np.get_printoptions()
+            np.set_printoptions(formatter={'numpystr': Model._numpy_print_str, 'object': Model._numpy_print_str})
+        except ImportError:  # pragma: no cover
+            pass  # pragma: no cover

+
+    @staticmethod
+    def _numpy_print_str(arg):
+        return str(arg) if ModelFactory._is_operand(arg) else repr(arg)
+
+
[docs]    @staticmethod
+    def restore_numpy():  # pragma: no cover
+        """ Static method to restore `numpy` to its default state.
+
+        This method is a companion method to :func:`init_numpy`. It restores `numpy` to its original state,
+        undoing all customizations that were done for DOcplex.
+
+        Note:
+            This method does nothing if numpy is not present.
+
+        See Also:
+            :func:`init_numpy`
+        """
+        try:
+            # noinspection PyUnresolvedReferences
+            import numpy as np
+
+            if Model._saved_numpy_options is not None:
+                np.set_printoptions(Model._saved_numpy_options)
+        except ImportError:  # pragma: no cover
+            pass  # pragma: no cover

+
+    @property
+    def environment(self):
+        # for a closed model with no CPLEX, numpy, etc return ClosedEnvironment
+        # return get_no_graphics_env()
+        # from docplex.environment import ClosedEnvironment
+        # return ClosedEnvironment
+        return self._lazy_get_environment()
+
+    # ---- type checking
+
+    def _typecheck_var(self, obj):
+        self._checker.typecheck_var(obj)
+
+    def _typecheck_num(self, arg, caller=None):
+        self._checker.typecheck_num(arg, caller, safe_number=False)
+
+    def _typecheck_as_denominator(self, denominator, numerator):
+        StaticTypeChecker.typecheck_as_denominator(self, denominator, numerator)
+
+    def _typecheck_optional_num_seq(self, nums, accept_none=True, expected_size=None, caller=None):
+        return StaticTypeChecker.typecheck_optional_num_seq(self, nums, accept_none, expected_size, caller)
+
+
+    # ---
+    def unsupported_relational_operator_error(self, left_arg, op, right_arg):
+        # INTERNAL
+        self.fatal("Unsupported relational operator:  {0!s} {1!s} {2!s}, only <=, ==, >= are allowed", left_arg, op,
+                   right_arg)
+
+    def cannot_be_used_as_denominator_error(self, denominator, numerator):
+        StaticTypeChecker.cannot_be_used_as_denominator_error(self, denominator, numerator)
+
+    def unsupported_power_error(self, e, power):
+        self.fatal("Cannot raise {0!s} to the power {1}. A variable's exponent must be 0, 1 or 2.", e, power)
+
+    def _parse_kwargs(self, kwargs):
+        # parse some arguments from kwargs
+        for arg_name, arg_val in kwargs.items():
+            if arg_name == "float_precision":
+                self.float_precision = arg_val
+            elif arg_name in frozenset({'keep_ordering', 'ordering'}):
+                self._keep_ordering = bool(arg_val)
+            elif arg_name == "round_solution":
+                self._round_solution = bool(arg_val)
+            elif arg_name in frozenset({"info_level", "output_level"}):
+                self.output_level = arg_val
+            elif arg_name in {"agent", "solver_agent"}:
+                self.context.solver.agent = arg_val
+            elif arg_name == "log_output":
+                self.context.solver.log_output = arg_val
+            elif arg_name == "max_str_len":
+                self._max_str_len = int(arg_val)
+            elif arg_name == "use_space_str":
+                self._use_space_str = bool(arg_val)
+            elif arg_name == "keep_all_exprs":
+                self._keep_all_exprs = bool(arg_val)
+            elif arg_name == 'checker':
+                self._checker_key = arg_val.lower() if is_string(arg_val) else 'default'
+            elif arg_name == 'full_obj':
+                self._print_full_obj = bool(arg_val)
+            elif arg_name == 'lp_line_size':
+                self._lp_line_length = int(arg_val)
+            elif arg_name == 'ignore_names':
+                self._ignore_names = bool(arg_val)
+            elif arg_name == 'clean_before_solve':
+                self.clean_before_solve = arg_val
+            elif arg_name == 'quality_metrics':
+                self._quality_metrics = bool(arg_val)
+            elif arg_name in frozenset({'url', 'key'}):
+                # these two are known, no need to rant
+                pass
+            elif arg_name in frozenset({"parameters", 'cplex_parameters'}):
+                # update parameters either from a params object or a dict
+                self.context.update_cplex_parameters(arg_val)
+            elif arg_name == 'cts_by_name':
+                # safe
+                pass
+            elif arg_name == "name_functional_vars":
+                self._name_functional_vars = bool(arg_val)
+            else:
+                self.warning("keyword argument: {0:s}={1!s} - is not recognized (ignored)", arg_name, arg_val)
+
+    def _get_kwargs(self):
+        kwargs_map = {'float_precision': self.float_precision,
+                      'keep_ordering': self.keep_ordering,
+                      "round_solution": self._round_solution,
+                      'output_level': self.output_level,
+                      'solver_agent': self.solver_agent,
+                      'log_output': self.log_output,
+                      'max_str_len': self._max_str_len,
+                      'use_space_str': self.str_use_space,
+                      'keep_all_exprs': self._keep_all_exprs,
+                      'checker': self._checker_key,
+                      'full_obj': self._print_full_obj,
+                      'lp_line_size': self._lp_line_length,
+                      'ignore_names': self._ignore_names,
+                      'clean_before_solve': self._clean_before_solve
+                      }
+        return kwargs_map
+
+
+
+    def _new_engine(self, solver_agent):
+        return self._make_new_engine_from_agent(solver_agent)
+
+    @classmethod
+    def _new_linear_factory(cls, mdl, engine):
+        return ModelFactory(mdl, engine)
+
+    @classmethod
+    def _new_quadratic_factory(cls, mdl, engine):
+        from docplex.mp.quadfact import QuadFactory
+        return QuadFactory(mdl, engine)
+
+    def __init__(self, name=None, context=None, **kwargs):
+        """Init a new Model.
+
+        Args:
+            name (optional): The name of the model
+            context (optional): The solve context to be used. If no ``context`` is
+                passed, a default context is created.
+            log_output (optional): if ``True``, solver logs are output to
+                stdout. If this is a stream, solver logs are output to that
+                stream object.
+        """
+        if name is None:
+            name = Model._name_generator.new_symbol()
+        self._name = name
+        self._provenance = None
+
+        self._error_handler = DefaultErrorHandler(output_level='warning')
+
+        # type instances
+        self._binary_vartype = BinaryVarType()
+        self._integer_vartype = IntegerVarType()
+        self._continuous_vartype = ContinuousVarType()
+        self._semicontinuous_vartype = SemiContinuousVarType()
+        self._semiinteger_vartype = SemiIntegerVarType()
+
+        #
+        self._container_map = None
+        self._all_containers = []
+        self._origin_map = {}
+        self._vars_by_name = {}
+        self._cts_by_name = None
+        self.__allpwlfuncs = []
+        self._benders_annotations = None
+        self._constraint_priority_dict = {}
+
+        self._lazy_constraints = []
+        self._user_cuts = []
+
+        # -- kpis --
+        self._allkpis = []
+
+        self._progress_listeners = []
+        self._qprogress_listeners = []
+        self._mipstarts = []
+
+        # by default, ignore_names is off
+        self._ignore_names = False
+
+        # clean engine before solve (mip starts)
+        self._clean_before_solve = False  # default is False: faster
+
+        # expression ordering
+        self._keep_ordering = False
+
+
+        # pwl aux var named
+        self._name_functional_vars = False
+
+        # -- float formats
+        self._float_precision = 3
+        self._float_meta_format = '{%d:.3f}'
+        self._num_printer = _NumPrinter(self._float_precision)
+
+        self._environment = self._make_environment()
+        self_env = self._environment
+
+        # init context
+        if context is None:
+            self.context = Context.make_default_context(_env=self_env)
+        else:
+            self.context = context
+            # a flag to indicate whether ot not parameters have been version-checked.
+        self._synced_params = False
+
+        self._engine_factory = EngineFactory(env=self_env)
+
+        # maximum length for expression in str strings
+        self._max_str_len = 1e+10
+        self._readable_str_len = 48
+
+        # use spaces in expressions
+        self._use_space_str = False
+
+        # internal
+        self._keep_all_exprs = True  # use False to get fast clone...with the risk of side effects...
+
+        # full objective lp
+        self._print_full_obj = False
+
+        # lp line size
+        self._lp_line_length = 80
+
+        # checker key
+        self._checker_key = 'default'
+
+        # quality_metrics
+        self._quality_metrics = False
+
+        # rond solution or not
+        self._round_solution = False
+        self._round_function = round_nearest_towards_infinity1
+
+        # update from kwargs, before the actual inits.
+        # pop cts_by name before parse kwargs
+        _enable_cts_by_name = kwargs.pop('cts_by_name', False)
+        # =======================================================
+        # parse without cts_by_name
+        self._parse_kwargs(kwargs)
+        self._cts_by_name = {} if _enable_cts_by_name else None
+        self._check_mip_for_mipstarts = True
+
+        self._checker = get_typechecker(arg=self._checker_key, logger=self.logger)
+
+        # -- scopes
+        self._var_scope = _IndexScope("var", cplex_scope=CplexScope.VAR_SCOPE)
+        self._linct_scope = _IndexScope("linear constraint",
+                                        cplex_scope=CplexScope.LINEAR_CT_SCOPE)
+        self._logical_scope = _IndexScope("logical constraint",
+                                          cplex_scope=CplexScope.IND_CT_SCOPE
+                                          )
+        self._quadct_scope = _IndexScope("quadratic constraint",
+                                         cplex_scope=CplexScope.QUAD_CT_SCOPE)
+        self._pwl_scope = _IndexScope("piecewise constraint",
+                                      cplex_scope=CplexScope.PWL_CT_SCOPE)
+
+        self._sos_scope = _IndexScope("SOS", cplex_scope=CplexScope.SOS_SCOPE)
+
+        self._scope_dict = {CplexScope.VAR_SCOPE: self._var_scope,
+                            CplexScope.LINEAR_CT_SCOPE: self._linct_scope,
+                            CplexScope.IND_CT_SCOPE: self._logical_scope,
+                            CplexScope.QUAD_CT_SCOPE: self._quadct_scope,
+                            CplexScope.PWL_CT_SCOPE: self._pwl_scope,
+                            CplexScope.SOS_SCOPE: self._sos_scope
+                            }
+
+        # init engine
+        engine = self._new_engine(self.solver_agent)
+        self.__engine = engine
+
+        # after engines
+        self._lfactory = self._new_linear_factory(self, engine)
+        self._qfactory = self._new_quadratic_factory(self, engine)
+
+        # after parse kwargs, after factories
+        self._aggregator = ModelAggregator(self._lfactory, self._qfactory)
+
+        self._quad_count = 0
+        self._solution = None
+        self._solve_details = None
+        self._last_solve_status = self._unknown_status
+
+        # all the following must be placed after an engine has been set.
+        self._objective_expr = None
+        self._multi_objective = MultiObjective.new_empty()
+
+        # engine log level
+        engineLogLevel = get_environment().get_parameter("oaas.engineLogLevel")
+        if engineLogLevel is not None and engineLogLevel in {"FINE", "FINER", "FINEST"}:
+            self.parameters.read.datacheck.set(2)
+
+        self.set_objective(sense=self.default_objective_sense,
+                           expr=self._new_default_objective_expr())
+
+        model_hook_fn = self.context.model_build_hook
+        if model_hook_fn:
+            try:
+                model_hook_fn(self)
+            except Exception as me:
+                print("* Error in model_build_hook: {0!s}".format(me))
+
+        self._ctstatus_counter = 0
+        self._cached_sos_weights = {}
+
+    def _get_cached_sos_weights(self, size):
+        sos_weight_cache = self._cached_sos_weights
+        if size not in sos_weight_cache:
+            sos_weight_cache[size] = [(i+1) for i in range(size)]
+        return sos_weight_cache[size]
+
+    def _new_ct_status_index(self):
+        # INTERNAL
+        new_ct_status_index = self._ctstatus_counter + 1
+        self._ctstatus_counter = new_ct_status_index
+        return new_ct_status_index
+
+
+    @property
+    def name(self):
+        """ This property is used to get or set the model name.
+        """
+        return self._name
+
+    def __repr__(self):
+        return self.to_string()
+
+    def to_string(self):
+        return "docplex.mp.Model['{0}']".format(self.name)
+
+    def __str__(self):
+        return self.to_string()
+
+    @property
+    def lfactory(self):
+        # INTERNAL
+        return self._lfactory
+
+    @name.setter
+    def name(self, name):
+        self._check_name(name)
+        self._name = name
+
+    def _check_name(self, new_name):
+        self._checker.typecheck_string(arg=new_name, accept_empty=False, accept_none=False)
+        if ' ' in new_name:
+            self.warning("Model name contains whitespaces: |{0:s}|", new_name)
+
+    @property
+    def provenance(self):
+        return self._provenance
+
+    def _get_obj_scope(self, cplex_scope, error='warn'):
+        # INTERNAL
+        ct_scope = self._scope_dict.get(cplex_scope)
+        if not ct_scope and error == 'raise':
+            raise ValueError("Unexpected scope code: {0}".format(cplex_scope))
+        return ct_scope
+
+    def _iter_scopes(self):
+        # INTERNAL
+        for _, scope in self._scope_dict.items():
+            yield scope
+
+    def _check_scope_indices(self):
+        for scope in self._iter_scopes():
+            scope.check_indices()
+
+    def _iter_constraint_scopes(self):
+        for cpxsc, scope in self._scope_dict.items():
+            if cpxsc.is_constraint_scope():
+                yield scope
+
+    def _sync_params(self, params):
+        # INTERNAL: execute only once
+        if self.has_cplex():
+            params.connect_model(self)
+            self_env = self._environment
+            self_cplex_parameters_version = self.context.cplex_parameters.cplex_version
+            self_engine = self.__engine
+            installed_cplex_version = self_env.cplex_version
+            # installed version is different from parameters: reset all defaults
+            if installed_cplex_version != self_cplex_parameters_version:  # pragma: no cover
+                # cplex is more recent than parameters. must update defaults.
+                self.info(
+                    "reset parameter defaults, from parameter version: {0} to installed version: {1}"  # pragma: no cover
+                    .format(self_cplex_parameters_version, installed_cplex_version))  # pragma: no cover
+                resets = self_engine._sync_parameter_defaults_from_cplex(params)  # pragma: no cover
+                if resets:
+                    for p, old, new in resets:
+                        if p.name != 'randomseed':  # usual practice to change randomseed at each version
+                            self.info('parameter changed, name: {0}, old default: {1}, new default: {2}',
+                                      p.name, old, new)
+
+    @property
+    def infinity(self):
+        """ This property returns the numerical value used as the upper bound for continuous decision variables.
+
+        Note:
+            CPLEX usually sets this limit to 1e+20.
+        """
+        return self.__engine.get_infinity()
+
+
[docs]    def get_cplex(self, do_raise=True):
+        """ Returns the instance of Cplex used by the model, if any.
+
+        In case no local installation of CPLEX can be found, this method either raises an exception,
+        if parameter `do_raise` is True, or else returns None.
+
+        :param do_raise: An optional flag: if True, raise an exception when no Cplex instance
+            is available, otherwise return None.
+
+        See Also:
+            the 'cplex' property calls :func:`get_cplex()` with do_raise=True.
+
+        :return: an instance of Cplex, or None.
+        """
+        return self._get_cplex(do_raise=do_raise)

+
+    def _get_cplex(self, do_raise=True, msgfn=None):
+        try:
+            cpx = self.__engine.get_cplex()
+            if cpx:
+                return cpx
+
+        except DOcplexException:
+            pass
+        if do_raise:
+            if msgfn:
+                raise_msg = msgfn()
+            else:
+                raise_msg = "CPLEX runtime not found - No instance of Cplex is available."
+            self.fatal(raise_msg)
+        else:
+            return None
+
+    @property
+    def cplex(self):
+        """ Returns the instance of Cplex used by the model, if any.
+
+        In case no local installation of CPLEX can be found, this method raises an exception.,
+
+        :return: a Cplex instance.
+
+        *New in version 2.15*
+        """
+        return self.get_cplex(do_raise=True)
+
+    def has_cplex(self):
+        return self.get_cplex(do_raise=False) is not None
+
+    def _read_cplex_file(self, name, path, extension, cpx_read_fn):
+        # INTERNAL
+        cpx = self._get_cplex(do_raise=True, msgfn=lambda: "CPLEX runtime not found, cannot read CPLEX {0} file: {1}".format(name, path))
+        StaticTypeChecker.check_file(self, name=name, path=path, expected_extensions=(extension,))
+        cpx_read_fn(cpx, path)
+
+    @property
+    def cplex_matrix_stats(self):
+        cpx = self._get_cplex(do_raise=True, msgfn=lambda: "Model.cplex_matrix_stats requires cplex")
+        return cpx.get_stats()
+
+
[docs]    def read_basis_file(self, bas_path):
+        """ Read a CPLEX basis status file.
+
+        This method requires the CPLEX runtime.
+
+        :param bas_path: the path of a basis file (extension is '.bas')
+
+        *New in version 2.10*
+        """
+        self._read_cplex_file(name='basis', path=bas_path,
+                              extension='.bas',
+                              cpx_read_fn=lambda cpx_, path_: cpx_.start.read_basis(path_))

+
+
+
[docs]    def read_priority_order_file(self, ord_path):
+        """ Read a CPLEX priority order file.
+
+        This method requires the CPLEX runtime.
+
+        :param ord_path: the path of a priority order file (extension is '.ord')
+
+        *New in version 2.10*
+        """
+        self._read_cplex_file(name='priority order', path=ord_path,
+                              extension='.ord',
+                              cpx_read_fn=lambda cpx_, path_: cpx_.order.read(path_))

+
+
[docs]    def export_priority_order_file(self, path=None, basename=None):
+        """ Exports a CPLEX priority order file.
+
+        This method requires the CPLEX runtime.
+
+        Args:
+            basename: Controls the basename with which the file is printed.
+                Accepts None, a plain string, or a string format.
+                If None, the model's name is used.
+                If passed a plain string, the string is used in place of the model's name.
+
+            path: A path to write the file, expects a string path or None.
+                Can be a directory, in which case the basename
+                that was computed with the basename argument, is appended to the directory to produce
+                the file.
+                If given a full path, the path is directly used to write the file, and
+                the basename argument is not used.
+                If passed None, the output directory will be ``tempfile.gettempdir()``.
+
+        Returns:
+            The full path of the written file, if successful,, else None.
+
+        *New in version 2.10*
+        """
+        return self._write_cplex_file(name='priority order', path=path, basename=basename,
+                              extension='.ord',
+                              cpx_write_fn=lambda cpx_, path_: cpx_.order.write(path_))

+
+    @property
+    def str_max_len(self):
+        return self._max_str_len
+
+    @property
+    def readable_str_len(self):
+        return self._readable_str_len
+
+    @str_max_len.setter
+    def str_max_len(self, max_str):
+        assert max_str >= 1
+        self._max_str_len = max_str
+
+    @property
+    def str_use_space(self):
+        """ This boolean property controls the use of space separators when displaying the str()
+            representation of expressions (especially in constraints).
+            With `str_use_space=False` a constraint is printed as : `2x+3y+5z <= 7`
+
+            With `str_use_space=True` the same constraint is printed as : `2 x + 3 y + 5 z <= 7`
+
+        The default is False, that is print a compact representation.
+
+        :return: True if space separator is used for string representations of expressions.
+        """
+        return self._use_space_str
+
+    @str_use_space.setter
+    def str_use_space(self, use_space):
+        self._use_space_str = bool(use_space)
+
+    @property
+    def str_space(self):
+        return ' ' if self._use_space_str else ''
+
+    @property
+    def keep_ordering(self):
+        return self._keep_ordering
+
+    @keep_ordering.setter
+    def keep_ordering(self, ordered):  # pragma: no cover
+        # INTERNAL
+        b_ordered = bool(ordered)
+        self._keep_ordering = b_ordered
+        self._lfactory.update_ordering(b_ordered)
+        self._qfactory.update_ordering(b_ordered)
+
+    @property
+    def ignore_names(self):
+        """ This property is used to ignore all names in the model.
+
+         This flag indicates whether names are used or not.
+         When set to True, all names are ignored. This could lead to performance 
+         improvements when building large models.
+         The default value of this flag is False. To change its value, add it as
+         keyword argument when creating the Model instance as in:
+
+            >>> m = Model(name="my_model", ignore_names=True)
+
+        Note:
+            Once a model instance has been created with `ignore_names=True`, there is no way to restore its names.
+            This flag only allows to enable or disable name generation while building the model.
+         """
+        return self._ignore_names
+
+    @property
+    def float_precision(self):
+        """ This property is used to get or set the float precision of the model.
+
+        The float precision is an integer number of digits, used
+        in printing the solution and objective.
+        This number of digits is used for variables and expressions which are not discrete.
+        Discrete variables and objectives are printed with no decimal digits.
+
+        """
+        return self._float_precision
+
+    @float_precision.setter
+    def float_precision(self, nb_digits):
+        used_digits = nb_digits
+        if nb_digits < 0:
+            self.warning("Negative float precision given: {0}, using 0 instead", nb_digits)
+            used_digits = 0
+        else:
+            max_digits = self.environment.max_nb_digits
+            bitness = self.environment.bitness
+            if nb_digits > max_digits:
+                self.warning("Given precision of {0:d} goes beyond {1:d}-bit capability, using maximum: {2:d}".
+                             format(nb_digits, bitness, max_digits))
+                used_digits = max_digits
+        self._float_precision = used_digits
+        # recompute float format
+        self._float_meta_format = '{%%d:.%df}' % nb_digits
+        self._num_printer.precision = nb_digits
+
+    @property
+    def quality_metrics(self):
+        """ This flag controls whether CPLEX quality metrics are stored into the solve details.
+         The default is not to store quality metrics.
+
+         *New in version 2.10*
+        """
+        return self._quality_metrics
+
+    @quality_metrics.setter
+    def quality_metrics(self, use_metrics):
+        self._quality_metrics = use_metrics
+
+    @property
+    def clean_before_solve(self):
+        return self._clean_before_solve
+
+    @clean_before_solve.setter
+    def clean_before_solve(self, must_clean):
+        self._clean_before_solve = bool(must_clean)
+
+    @property
+    def round_solution(self):
+        """
+        This flag controls whether integer and discrete variable values are rounded in solutions, or not.
+        If not rounded, it may happen that solution value for a binary variable returns 0.99999.
+        The default is not to round discrete values.
+
+        *New in version 2.15*
+        """
+        return self._round_solution
+
+    @round_solution.setter
+    def round_solution(self, do_round):
+        self._round_solution = bool(do_round)
+
+    def _round_element_value_if_necessary(self, elt, elt_value):
+        # INTERNAL
+        if self.round_solution and elt_value and elt.is_discrete() and elt_value != int(elt_value):
+            return self._round_function(elt_value)
+        else:
+            return elt_value
+
+    def has_cts_by_name_dict(self):
+        return self._cts_by_name is not None
+
+    def enable_cts_by_name_dict(self):
+        self._ensure_cts_name_dir()
+
+    def solved_stopped_by_limit(self):
+        sd = self.solve_details
+        return sd and sd.has_hit_limit()
+
+    @property
+    def time_limit(self):
+        """ This property is used to get/set the time limit for this model.
+        """
+        return self.time_limit_parameter.get()
+
+    @time_limit.setter
+    def time_limit(self, new_time_limit):
+        self.set_time_limit(new_time_limit)
+
+    @property
+    def time_limit_parameter(self):
+        # INTERNAL
+        return self.parameters.timelimit
+
+
[docs]    def get_time_limit(self):
+        """
+        Returns:
+            The time limit for the model.
+
+        """
+        return self.time_limit_parameter.get()

+
+
[docs]    def set_time_limit(self, time_limit):
+        """ Set a time limit for solve operations.
+
+        Args:
+            time_limit: The new time limit; must be a positive number.
+
+        """
+        self._checker.typecheck_num(time_limit)
+        if time_limit < 0:
+            self.fatal("Negative time limit: {0}", time_limit)
+        elif time_limit < 1:
+            self.warning("Time limit too small: {0} - using 1 instead", time_limit)
+            time_limit = 1
+        else:
+            pass
+
+        self.time_limit_parameter.set(time_limit)

+
+    @property
+    def lp_line_length(self):
+        """ This property lets you get or set the maximum line length of LP files generated by DOcplex.
+        The default is 80.
+
+         *New in version 2.11*
+
+        """
+        return self._lp_line_length
+
+    @lp_line_length.setter
+    def lp_line_length(self, new_length):
+        if 70 <= new_length <= 512:
+            self._lp_line_length = new_length
+        else:
+            lpz = min(128, max(new_length, 70))
+            print(" LP line size set to: {0}, should be in [70..512], {1} was passed".format(lpz, new_length))
+            self._lp_line_length = lpz
+
+    @property
+    def solver_agent(self):
+        return self.context.solver.agent
+
+    def _set_solver_agent(self, new_agent):
+        assert new_agent
+        self.context.solver.agent = new_agent
+
+    @property
+    def error_handler(self):
+        return self._error_handler
+
+    @property
+    def logger(self):
+        return self._error_handler
+
+    @property
+    def solution(self):
+        """ This property returns the current solution of the model or None if the model has not yet been solved
+        or if the last solve has failed.
+        """
+        return self._solution
+
+    def _get_solution(self):
+        # INTERNAL
+        return self._solution
+
+    def new_solution(self, var_value_dict=None, objective_value=None, name=None, **kwargs):
+        return self._lfactory.new_solution(var_value_dict=var_value_dict,
+                                           objective_value=objective_value, name=name, **kwargs)
+
+
+
[docs]    def import_solution(self, source_solution, match="auto", error="raise"):
+        """ Imports a solution from another model.
+
+        There must a a way to map variables from the solution model to the target model,
+        either by name, index or some other custom manner.
+        The simplest case is where the other model is a clone of the target model.
+        In that case, an index-based mapping is used.
+
+        :param source_solution: the imported solution, built on some othe rmodel,
+            different from target model.
+        :param match: described the mapping used for variables, accepts either a string for
+            predefined mappings: "index" for index mapping, "name" for name mapping, or "auto" for
+            automatic. Also accepts a function taking two arguments: the source variable, and the target model,
+            returning th eimage of the source variable in the target model.
+        :param error: A string describing how errors are handled. Accepts "raise", "warn", or "ignore"
+
+        :return: A solution object, instance of :class:`SolveSolution`, built on the target model,
+            from values and variables mapped from the source model to the target model.
+
+        *New in version 2.21*
+        """
+        target_model = self
+        find_matching_var = _var_match_function(source_model=source_solution.model,
+                                                target_model=target_model, match=match)
+        source_var_values = {}
+        source_keep_zeros = source_solution._keep_zeros
+        for dv, dvv in source_solution.iter_var_values():
+            target_var = find_matching_var(dv, target_model)
+            if target_var is None:
+                msg = "Cannot find matching variable in target model for {0!r}".format(dv)
+                handle_error(target_model, error, msg)
+            elif dvv or source_keep_zeros:
+                source_var_values[target_var] = dvv
+        source_obj = source_solution.objective_value
+        source_solved_by = source_solution.solved_by
+
+        newsol = target_model.new_solution(source_var_values, source_obj, keep_zeros=source_keep_zeros)
+        newsol._solved_by = source_solved_by
+        return newsol

+
+
[docs]    def populate_solution_pool(self, **kwargs):
+        """ Populates and return a solution pool.
+
+        returns either a solutiion pool object, or None if the model solve fails.
+
+        This method accepts the same keyword arguments as :meth:`Model.solve`.
+        See the documentation of :meth:`Model.solve` for more details.
+
+        :return: an instance of :class:`docplex.mp.solution.SolutionPool`, or None.
+
+        See Also:
+            :class:`docplex.mp.solution.SolutionPool`.
+
+        *New in version 2.16*
+        """
+        self_mname = 'Model.populate_solution_pool'
+        if not self.has_cplex():
+            self.fatal("{0} requires CPLEX, but a local CPLEX installation could not be found"
+                       .format(self_mname))
+        pb_type = self._get_cplex_problem_type()
+        if pb_type not in {'MILP'}:
+            self.fatal("{0} only for MILP problems, model '{1}' is a {2}",
+                       self_mname, self.name, pb_type)
+        elif self.has_multi_objective():
+            self.fatal("M{0}} is not available for multi-objective problems, model '{1}' has {2} objectives",
+                       self_mname, self.name, self.number_of_multi_objective_exprs)
+
+        context = self.prepare_actual_context(**kwargs)
+        parameters = apply_thread_limitations(context)
+        raw_params = self.context._get_raw_cplex_parameters()
+
+        self_engine = self.__engine
+        sol = None
+        if raw_params and parameters is not raw_params:
+            saved_params = {p: p.get() for p in raw_params}
+        else:
+            saved_params = {}
+
+        log_stream = context.solver.log_output_as_stream
+        with OverridenOutputContext(self, log_stream):
+
+            used_clean_before_solve = kwargs.get('clean_before_solve', self.clean_before_solve)
+            try:
+                used_parameters = parameters or raw_params
+                # assert used_parameters is not None
+                self._apply_parameters_to_engine(used_parameters)
+                sol, solnpool = self.__engine.populate(clean_before_solve=used_clean_before_solve)
+                assert (sol is not None) == bool(solnpool)
+
+            finally:
+                solve_details = self_engine.get_solve_details()
+                self._notify_solve_hit_limit(solve_details)
+                self._solve_details = solve_details
+                self._set_solution(sol)
+                if saved_params:
+                    for p, v in saved_params.items():
+                        self_engine.set_parameter(p, v)
+
+
+        return solnpool

+
+    populate = populate_solution_pool
+
+    def restore_solution(self, sol, restore_all=True):
+        try:
+            if self != sol.model:
+                self.fatal("Model.restore_solution(): Expecting solution attached to model {0}, but attached to {1}"
+                           .format(self.name, sol.model.name))
+            # check solution is linked to this model
+            sol.restore(self, restore_all=restore_all)
+        except AttributeError:
+            self.fatal("Model.restore_solution(): Expecting solution, {0!r} was passed", sol)
+
+    def fatal(self, msg, *args):
+        self._error_handler.fatal(msg, args)
+
+    def fatal_ce_limits(self, *args):
+        nb_vars = self.number_of_variables
+        nb_constraints = self.number_of_constraints
+
+        self._error_handler.fatal_limits_exceeded(nb_vars, nb_constraints)
+
+    def error(self, msg, *args):
+        self._error_handler.error(msg, args)
+
+    def warning(self, msg, *args):
+        self._error_handler.warning(msg, args)
+
+    def info(self, msg, *args):
+        self._error_handler.info(msg, args)
+
+    @property
+    def number_of_warnings(self):
+        return self._error_handler.number_of_warnings
+
+    @property
+    def number_of_errors(self):
+        return self._error_handler._number_of_errors
+
+
+    def trace(self, msg, *args):
+        self.logger.trace(msg, args)
+
+    @property
+    def output_level(self):
+        return self._error_handler.get_output_level()
+
+    @output_level.setter
+    def output_level(self, new_output_level):
+        self._error_handler.set_output_level(new_output_level)
+
+    def set_quiet(self):
+        self.logger.set_quiet()
+
+    def set_log_output(self, out=None):
+        self.context.solver.log_output = out
+        outs = self.context.solver.log_output_as_stream
+        self.__engine.set_streams(outs)
+
+    @property
+    def log_output(self):
+        return self.context.solver.log_output_as_stream
+
+    @log_output.setter
+    def log_output(self, out):
+        self.set_log_output(out)
+
+    def set_log_output_as_stream(self, outs):
+        self.__engine.set_streams(outs)
+
+    def is_logged(self):
+        return self.context.solver.log_output_as_stream is not None
+
+    def clear_engine_before_solve(self):
+        # INTERNAL
+        try:
+            self.__engine.clean_before_solve()
+        except AttributeError:
+            pass
+
+
[docs]    def clear(self):
+        """ Clears the model of all modeling objects.
+        """
+        self._clear_internal()

+
+    def _clear_internal(self, terminate=False):
+        self._container_map = None
+        self._all_containers = []
+        self._origin_map = {}
+        self._vars_by_name = {}
+        self._cts_by_name = None
+        self.__allpwlfuncs = []
+        self._benders_annotations = None
+        self._allkpis = []
+        self.clear_kpis()
+        self._last_solve_status = self._unknown_status
+        self._solution = None
+        self._mipstarts = []
+        self._clear_scopes()
+        self._lazy_constraints = []
+        self._user_cuts = []
+        self._quad_count = 0
+        if not terminate:
+            self.set_objective(sense=self.default_objective_sense,
+                               expr=self._new_default_objective_expr())
+            self._set_engine(self._make_new_engine_from_agent(self.solver_agent, self.context))
+        else:
+            self._terminate_engine()
+
+    def _clear_scopes(self):
+        for a_scope in self._iter_scopes():
+            a_scope.clear()
+
+    def set_checker(self, checker_key):
+        # internal
+        if checker_key != self._checker_key:
+            new_checker = get_typechecker(arg=checker_key, logger=self.logger)
+            self._checker_key = checker_key
+            self._checker = new_checker
+            self._aggregator._checker = new_checker
+            self._lfactory._checker = new_checker
+            self._qfactory._checker = new_checker
+
+    def _make_new_engine_from_agent(self, solver_agent, context=None):
+        ctx = context or self.context
+        new_engine = self._engine_factory.new_engine(solver_agent, self.environment, model=self, context=ctx)
+        new_engine.set_streams(self.context.solver.log_output_as_stream)
+        return new_engine
+
+    def _set_engine(self, e2):
+        # INTERNAL
+        old_engine = self.get_engine()
+        self.__engine = e2
+        self._lfactory.update_engine(e2)
+        self._qfactory.update_engine(e2)
+        try:
+            self._static_terminate_engine(old_engine)
+        finally:
+            pass
+
+    def _terminate_engine(self):
+        # INTERNAL
+        old_engine = self.__engine
+        self._static_terminate_engine(old_engine)
+        self.__engine = None
+
+    @classmethod
+    def _static_terminate_engine(cls, engine_to_terminate):
+        if engine_to_terminate is not None:
+            # dispose of old engine.
+            engine_to_terminate.end()
+            # from Ryan
+            del engine_to_terminate
+
+    def _parse_agent(self, new_agent):
+        if not new_agent:
+            new_agent = self.context.solver.agent
+        elif not is_string(new_agent):
+            self.fatal('unexpected value for agent: {0!r} was passed, expecting string or None', new_agent)
+        return new_agent
+
+    def _set_new_engine_from_agent(self, agent_arg):
+        new_agent = self._parse_agent(agent_arg)
+        new_engine = self._make_new_engine_from_agent(new_agent, self.context)
+        self._set_engine(new_engine)
+
+    @property
+    def solves_with(self):
+        return self.__engine.name
+
+    def get_engine(self):
+        # INTERNAL for testing
+        return self.__engine
+
+
[docs]    def print_information(self):
+        """ Prints general informational statistics on the model.
+
+        Prints the number of variables and their breakdown by type.
+        Prints the number of constraints and their breakdown by type.
+
+        """
+        print("Model: %s" % self.name)
+        self.get_statistics().print_information()
+
+        # --- annotations
+        self_anno = self._benders_annotations
+        if self_anno:
+            anno_stats = self.get_annotation_stats()
+            print(" - annotations: {0}".format(len(self_anno)))
+            print("   - {0}".format(', '.join('{0}: {1}'.format(cpx.descr, anno_stats[cpx]) for cpx in CplexScope if cpx in anno_stats)))
+
+
+        # --- parameters
+        self_params = self.context._get_raw_cplex_parameters()
+        if self_params and self_params.has_nondefaults():
+            print(" - parameters:")
+            self_params.print_information(indent_level=5)  # 3 for " - " + 2 = 5
+        else:
+            print(" - parameters: defaults")
+
+        # ------------------- objective
+        minmax = "minimize" if self.is_minimized() else "maximize"
+        obj_s = minmax
+        if self.has_multi_objective():
+            n_objs = self.number_of_multi_objective_exprs
+            obj_s = "{0} multiple[{1}]".format(minmax, n_objs)
+        elif not self.is_optimized():
+            obj_s = "none"
+        else:
+            try:
+                if self.objective_expr.is_quad_expr():
+                    obj_s = "{0} quadratic".format(minmax)
+            except AttributeError:
+                pass
+        print(" - objective: {0}".format(obj_s))
+
+        # ------------------- problem type
+        cpx_probtype = self._get_cplex_problem_type(fallback=None, do_raise=False)
+        if cpx_probtype:
+            print(" - problem type is: {0}".format(cpx_probtype))

+
+
+    def _get_cplex_problem_type(self, fallback="unknown", do_raise=False):
+        # INTERNAL
+        cpx = self.get_cplex(do_raise=do_raise)
+        return self._problem_type_from_cplex(cpx, fallback)
+
+    def _problem_type_from_cplex(self, cpx, fallback=None):
+        # INTERNAL: decode cplex type code.
+        if cpx:
+            cpx_probtype_code = cpx.get_problem_type()  # this is an int
+            return int_probtype_to_string(cpx_probtype_code)
+        else:
+            return fallback
+
+    @property
+    def problem_type(self):
+        """ Returns a string describing the type of problem.
+
+        This method requyires that CPLEX is installed and
+        available in PYTHONPATH. If the CPLEX runtime cannot be found, an exception is raised.
+
+        Possible values: LP, MILP, QP, MIQP, QCP, MIQCP,
+
+            *New in version 2.20*
+        """
+        cpx = self._get_cplex(do_raise=True, msgfn=lambda: "Model.problem_type requites CPLEX")
+        return self._problem_type_from_cplex(cpx, fallback=None)
+
+    def __notify_new_model_object(self, descr,
+                                  mobj, mindex, mobj_name,
+                                  name_dir, idx_scope,
+                                  is_name_safe=False):
+        """
+        Notifies the return af an object being create on the engine.
+        :param descr: A string describing the type of the object being created (e.g. Constraint, Variable).
+        :param mobj:  The newly created modeling object.
+        :param mindex: The index as returned by the engine.
+        :param name_dir: The directory of objects by name (e.g. name -> constraint directory).
+        :param idx_scope:  The index scope
+        """
+        mobj._set_index(mindex)
+
+        if name_dir is not None:
+            mobj_name = mobj_name or mobj.name
+            if mobj_name:
+                # in some cases, names are checked before register
+                if not is_name_safe:
+                    if mobj_name in name_dir:
+                        old_name_value = name_dir[mobj_name]
+                        # Duplicate constraint name: foo
+                        self.warning("Duplicate {0} name: {1} already used for {2!r}", descr, mobj_name, old_name_value)
+
+                name_dir[mobj_name] = mobj
+
+        # store in idx dir if any
+        if idx_scope:
+            idx_scope.notify_obj_index(mobj, mindex)
+
+    def _register_one_var(self, var, var_index, var_name):
+        self.__notify_new_model_object("variable", var, var_index, var_name, self._vars_by_name, self._var_scope)
+
+    # @profile
+    def _register_block_vars(self, allvars, indices, allnames):
+        if allnames:
+            varname_dict = self._vars_by_name
+            for var, var_index, var_name in zip(allvars, indices, allnames):
+                var._index = var_index
+                if var_name:
+                    if var_name in varname_dict:
+                        old_name_value = varname_dict[var_name]
+                        # Duplicate constraint name: foo
+                        self.warning("Duplicate variable name: {0} already used for {1!s}", var_name, old_name_value)
+                    varname_dict[var_name] = var
+        else:
+            for var, var_index in zip(allvars, indices):
+                var._index = var_index
+        self._var_scope.notify_obj_indices(objs=allvars, indices=indices)
+
+    def _register_one_constraint(self, ct, ct_index, is_ctname_safe=False):
+        """
+        INTERNAL
+        :param ct: The new constraint to register.
+        :param ct_index: The index as returned by the engine.
+        :param is_ctname_safe: True if ct name has been checked for duplicates already.
+        :return:
+        """
+        self.__notify_new_model_object(
+            "constraint", ct, ct_index, None,
+            self._cts_by_name, ct._get_index_scope(),
+            is_name_safe=is_ctname_safe)
+
+    def _ensure_cts_name_dir(self):
+        # INTERNAL: make sure the constraint name dir is present.
+        if self._cts_by_name is None:
+            self._cts_by_name = {ct.name: ct for ct in self.iter_constraints() if ct.has_user_name()}
+        return self._cts_by_name
+
+    def _register_block_cts(self, scope, cts, indices):
+        # INTERNAL: assert len(cts) == len(indices)
+        ct_name_map = self._cts_by_name
+        # --
+        if ct_name_map:
+            for ct, ct_index in zip(cts, indices):
+                ct._set_index(ct_index)
+                ct_name = ct.name
+                if ct_name:
+                    ct_name_map[ct_name] = ct
+        else:
+            for ct, ct_index in zip(cts, indices):
+                ct._index = ct_index
+
+        scope.notify_obj_indices(cts, indices)
+
+    def _register_implicit_equivalence_ct(self, eqct, eqctx):
+        self._register_one_constraint(eqct, eqctx, is_ctname_safe=True)
+
+    # iterators
+    def _ensure_var_to_container_map(self):
+        # lazy build of var -> container mapping
+        ctn_map = self._container_map
+        if ctn_map is None:
+            ctn_map = {}
+            doomed_ctns = set()
+            for ctn in self.iter_var_containers():
+                try:
+                    for dv in ctn:
+                        ctn_map[dv] = ctn
+                except RuntimeError: # occurs when the dict has been modified
+                    doomed_ctns.add(ctn)
+                    self.warning(f"Modified variable container has been removed, name='{ctn.name}', shape={ctn.shape}")
+            self._container_map = ctn_map
+            # remove those var containers
+            if doomed_ctns:
+                #print(f"-- removing {len(doomed_ctns)} modified containers")
+                clean_containers = [c for c in self.iter_var_containers() if c not in doomed_ctns]
+                self._all_containers = clean_containers
+
+        return ctn_map
+
+    def iter_var_containers(self):
+        # INTERNAL
+        return iter(self._all_containers)
+
+    def _get_number_of_var_containers(self):
+        # INTERNAL
+        return len(self._all_containers)
+
+    def get_var_container(self, dvar):
+        # INTERNAL
+        ctn_map = self._ensure_var_to_container_map()
+        return ctn_map.get(dvar)
+
+    def set_var_container(self, dvar, ctn):
+        pass
+
+    def _add_var_container(self, var_container):
+        # INTERNAL
+        if var_container is not None:
+            self._all_containers.append(var_container)
+            ctn_map = self._container_map
+            if ctn_map is not None:
+                # increment var container map, if any
+                assert isinstance(ctn_map, dict)
+                for dv in var_container:
+                    ctn_map[dv] = var_container
+    @staticmethod
+    def origin_key(obj):
+        # use id()here to allow case where index is not valid
+        return id(obj)
+
+    def get_obj_origin(self, obj):
+        # INTERNAL: retrieve origin of object
+        objkey = self.origin_key(obj)
+        return self._origin_map.get(objkey)
+
+    def set_obj_origin(self, obj, new_origin):
+        # INTERNAL: set origin of object
+        okey = self.origin_key(obj)
+        if new_origin is not None:
+            self._origin_map[okey] = new_origin
+        elif obj in self._origin_map:
+            del self._origin_map[okey]
+
+    def _is_binary_var(self, dvar):
+        return dvar.cplex_typecode == 'B'
+
+    def _is_integer_var(self, dvar):
+        return dvar.cplex_typecode == 'I'
+
+    def _is_continuous_var(self, dvar):
+        return dvar.cplex_typecode == 'C'
+
+    def _is_semicontinuous_var(self, dvar):
+        return dvar.cplex_typecode == 'S'
+
+    def _is_semiinteger_var(self, dvar):
+        return dvar.cplex_typecode == 'N'
+
+    @property
+    def number_of_generated_variables(self):
+        return sum(1 for v in self.iter_variables() if v.is_generated())
+
+    def _count_variables_w_code(self, cpxcode):
+        cnt = 0
+        for v in self.iter_variables():
+            if v.cplex_typecode == cpxcode:
+                cnt += 1
+        return cnt
+
+    def _iter_variables_w_code(self, cpxcode):
+        for v in self.iter_variables():
+            if v.cplex_typecode == cpxcode:
+                yield v
+
+    @property
+    def number_of_variables(self):
+        """ This property returns the total number of decision variables, all types combined.
+
+        """
+        return self._var_scope.size
+
+    @property
+    def number_of_binary_variables(self):
+        """ This property returns the total number of binary decision variables added to the model.
+        """
+        return self._count_variables_w_code('B')
+
+    @property
+    def number_of_integer_variables(self):
+        """ This property returns the total number of integer decision variables added to the model.
+        """
+        return self._count_variables_w_code('I')
+
+    @property
+    def number_of_continuous_variables(self):
+        """ This property returns the total number of continuous decision variables added to the model.
+        """
+        return self._count_variables_w_code('C')
+
+    @property
+    def number_of_semicontinuous_variables(self):
+        """ This property returns the total number of semi-continuous decision variables added to the model.
+        """
+        return self._count_variables_w_code('S')
+
+    @property
+    def number_of_semiinteger_variables(self):
+        """ This property returns the total number of semi-integer decision variables added to the model.
+        """
+        return self._count_variables_w_code('N')
+
+    @property
+    def number_of_user_variables(self):
+        return sum(1 for _ in self.generate_user_variables())
+
+    # def _has_discrete_var(self):
+    #     # INTERNAL
+    #     return any(v.is_discrete for v in self.iter_variables())
+
+    def _contains_discrete_artefacts(self):
+        if hasattr(self._lfactory, "_cached_justifier_discrete_var"):
+            return self._lfactory._cached_justifier_discrete_var is not None
+        elif self.number_of_sos or self._has_piecewise():
+            return True
+        for v in self.iter_variables():
+            if v.cplex_typecode in 'IBNS':
+                self._lfactory._cached_justifier_discrete_var = v
+                return True
+        return False
+
+    def _clear_cached_discrete_var(self):
+        lfactory = self._lfactory
+        if hasattr(lfactory, "_cached_justifier_discrete_var"):
+            lfactory._cached_justifier_discrete_var = None
+
+    def _has_piecewise(self):
+        return self._pwl_scope.size > 0
+
+    def _solved_as_mip(self):
+        # INTERNAL: is the model solved as mip (incl. engine status)
+        return self._contains_discrete_artefacts() or self.__engine.solved_as_mip()
+
+    def _solved_as_lp(self):
+        # INTERNAL: is the model solved as mip (incl. engine status)
+        if self.has_cplex():
+            return self.get_engine().solved_as_lp()
+        else:
+            return not self._contains_discrete_artefacts()
+
+    def is_quadratic(self):
+        # returns true if model is quadratic, that is
+        # either has atleast one quadratic constraint, or has a quadrtic objective.
+        return self._is_qc() or self._is_qp()
+
+    def _is_qc(self):
+        return self._quadct_scope.size > 0
+
+    def _is_qp(self):
+        if self.has_multi_objective():
+            return any(ex.is_quad_expr() for ex in self.iter_multi_objective_exprs())
+        else:
+            return self._objective_expr.is_quad_expr()
+
+    def _make_new_stats(self):
+        # INTERNAL
+        from collections import Counter
+
+        vartype_count = Counter(type(dv.vartype) for dv in self.iter_variables())
+        nbbvs = vartype_count[BinaryVarType]
+        nbivs = vartype_count[IntegerVarType]
+        nbcvs = vartype_count[ContinuousVarType]
+        nbscvs = vartype_count[SemiContinuousVarType]
+        nbsivs = vartype_count[SemiIntegerVarType]
+
+        linct_count = Counter(ct.cplex_code for ct in self.iter_binary_constraints())
+        nb_le_cts = linct_count['L']
+        nb_eq_cts = linct_count['E']
+        nb_ge_cts = linct_count['G']
+        nb_rng_cts= self.number_of_range_constraints
+        nb_ind_cts = self.number_of_indicator_constraints
+        nb_equiv_cts = self.number_of_equivalence_constraints
+        nb_quad_cts = self.number_of_quadratic_constraints
+        stats = ModelStatistics(nbbvs, nbivs, nbcvs, nbscvs, nbsivs,
+                                nb_le_cts, nb_ge_cts, nb_eq_cts, nb_rng_cts,
+                                nb_ind_cts, nb_equiv_cts, nb_quad_cts)
+        return stats
+
+    @property
+    def statistics(self):
+        """ Returns statistics on the model.
+
+        :returns: A new instance of :class:`docplex.mp.model_stats.ModelStatistics`.
+        """
+        return self._make_new_stats()
+
+    def get_statistics(self):
+        return self.statistics
+
+
[docs]    def iter_pwl_functions(self):
+        """ Iterates over all the piecewise linear functions in the model.
+
+        Returns the PWL functions in the order they were added to the model.
+
+        Returns:
+            An iterator object.
+        """
+        return iter(self.__allpwlfuncs)

+
+
[docs]    def iter_variables(self):
+        """ Iterates over all the variables in the model.
+
+        Returns the variables in the order they were added to the model,
+        regardless of their type.
+
+        Returns:
+            An iterator object.
+        """
+        return self._var_scope.iter_objects()

+
+
[docs]    def iter_binary_vars(self):
+        """ Iterates over all binary decision variables in the model.
+
+        Returns the variables in the order they were added to the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._iter_variables_w_code('B')

+
+
[docs]    def iter_integer_vars(self):
+        """ Iterates over all integer decision variables in the model.
+
+        Returns the variables in the order they were added to the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._iter_variables_w_code('I')

+
+
[docs]    def iter_continuous_vars(self):
+        """ Iterates over all continuous decision variables in the model.
+
+        Returns the variables in the order they were added to the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._iter_variables_w_code('C')

+
+
[docs]    def iter_semicontinuous_vars(self):
+        """ Iterates over all semi-continuous decision variables in the model.
+
+        Returns the variables in the order they were added to the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._iter_variables_w_code('S')

+
+
[docs]    def iter_semiinteger_vars(self):
+        """ Iterates over all semi-integer decision variables in the model.
+
+        Returns the variables in the order they were added to the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._iter_variables_w_code('N')

+
+
+
[docs]    def get_var_by_name(self, name):
+        """ Searches for a variable from a name.
+
+        Returns a variable if it finds one with exactly this name, or None.
+
+        Args:
+            name (str): The name of the variable being searched for.
+
+        :returns: A variable (instance of :class:`docplex.mp.dvar.Var`) or None.
+        """
+        return self._vars_by_name.get(name, None)

+
+    def _disambiguate_varname(self, candidate_name):
+        # INTERNAL
+        varname_map = self._vars_by_name
+        if varname_map is None:
+            return candidate_name
+        safe_name = candidate_name
+        p = 1
+        while safe_name in varname_map:
+            safe_name = f"{candidate_name}#{p}"
+            p += 1
+            if p >= 1001:
+                raise DOcplexException(f"disambiguation fails for name: {candidate_name}")
+        return safe_name
+
+    def generate_user_variables(self):
+        # internal
+        for dv in self.iter_variables():
+            if not dv.is_generated():
+                yield dv
+
+    def generate_user_linear_constraints(self):
+        # internal
+        for lct in self.iter_linear_constraints():
+            if not lct.is_generated():
+                yield lct
+
+
[docs]    def find_matching_vars(self, pattern, match_case=False):
+        """ Finds all variables whose name contain a given string
+
+        This method searches for all variables whose name
+        is not null and contains the passed ``pattern`` string. Anonymous variables
+        are not considered.
+
+        :param pattern: a non-empty string.
+        :param match_case: optional flag to match case (or not). Default is to not match case.
+
+        :return: A list of decision variables.
+        """
+        return self._find_matching_objs(self.generate_user_variables, pattern, match_case, caller='Model.find_matching_vars')

+
+
[docs]    def find_re_matching_vars(self, regexpr):
+        """ Finds all variables whose name match a regular expression.
+
+        This method searches for all variables with a name that
+        matches the given regular expression. Anonymous variables
+        are not counted as matching.
+
+        :param regexpr: a regular expression, as define din module ``re``
+
+        :return: A list of decision variables.
+
+        *New in version 2.9*
+        """
+        matches = []
+        for dv in self.generate_user_variables():
+            dvname = dv.name
+            if dvname and regexpr.match(dvname):
+                matches.append(dv)
+        return matches

+
+    def _find_matching_objs(self, obj_iter, pattern, match_case=False, caller=None):
+        # internal
+        self._checker.typecheck_string(pattern, accept_empty=False, accept_none=False, caller=caller)
+        key_pattern = pattern if match_case else pattern.lower()
+        matches = []
+        for obj in obj_iter():
+            obj_name = obj.name
+            if obj_name:
+                matched = obj_name if match_case else obj_name.lower()
+                if key_pattern in matched:
+                    matches.append(obj)
+        return matches
+
+
[docs]    def find_matching_linear_constraints(self, pattern, match_case=False):
+        """ Finds all linear constraints whose name contain a given string
+
+        This method searches for all linear constraints whose name
+        is not empty and contains the passed ``pattern`` string. Anonymous linear constraints
+        are not considered.
+
+        :param pattern: a non-empty string.
+        :param match_case: optional flag to match case (or not). Default is to not match case.
+
+        :return: A list of linear constraints.
+
+        *New in version 2.9*
+        """
+        return self._find_matching_objs(self.generate_user_linear_constraints, pattern, match_case,
+                                        caller='Model.find_matching_linear_constraints')

+
+
[docs]    def find_matching_quadratic_constraints(self, pattern, match_case=False):
+        """ Finds all quadratic constraints whose name contain a given string
+
+        This method searches for all quadratic constraints whose name
+        is not empty and contains the passed ``pattern`` string. Anonymous constraints
+        are not considered.
+
+        :param pattern: a non-empty string.
+        :param match_case: optional flag to match case (or not). Default is to not match case.
+
+        :return: A list of quadratic constraints.
+
+        *New in version 2.23*
+        """
+        return self._find_matching_objs(self.iter_quadratic_constraints, pattern, match_case,
+                                        caller='Model.find_matching_quadratic_constraints')

+
+
+    def get_var_by_index(self, idx):
+        # INTERNAL
+        return self._var_by_index(idx)
+
+    def _var_by_index(self, idx):
+        # INTERNAL
+        return self._var_scope.get_object_by_index(idx)
+
+    def _set_var_type(self, dvar, new_vartype_):
+        # INTERNAL
+        new_vartype = self._parse_vartype(new_vartype_)
+        if new_vartype != dvar.vartype:
+            self._change_var_types_internal((dvar,), (new_vartype,))
+        return dvar
+
+
[docs]    def change_var_types(self, dvars, vartype_args, discard_incompatible_solution=True):
+        """ Change  type for a collection of variables.
+        :param dvars: an iterable on decision variables.
+        :param vartype_args: either an iterable over variable types, or one single type.
+        :param discard_incompatible_solution: boolean (default is True).
+            If the model has a current solution, and if one of the changed variables
+            has a value in this solution, which is incompatible with the new type, the
+            the solution is discarded. For example, if a continuous variable with value 3.14
+            is changed to binary type, then the solution is discarded
+
+        """
+        candidate_vars = dvars.values() if isinstance(dvars, dict) else dvars
+        checked_vars = list(self._checker.typecheck_var_seq(candidate_vars, caller="Model.change_var_types"))
+
+        parsefn = self._parse_vartype
+        if is_iterable(vartype_args, accept_string=False):
+            new_vartypes = [parsefn(vt_arg) for vt_arg in vartype_args]
+        else:
+            new_vartype1 = parsefn(vartype_args)
+            new_vartypes = [new_vartype1] * len(checked_vars)
+
+        if checked_vars:
+            self._change_var_types_internal(checked_vars, new_vartypes, discard_incompatible_solution)

+
+    def _change_var_types_internal(self, dvars, new_vartypes, discard_incompatible_solution=False):
+        newbounds_dict = {}
+        sol = self._solution
+        nb_incompatible_sol_values = 0
+        try:
+            for dv, nvt in zip(dvars, new_vartypes):
+                nlb, nub = self._compute_changed_var_bounds(dv, nvt)
+                newbounds_dict[dv] = nlb, nub
+                dvv = sol._get_var_value(dv) if sol else 0
+                if sol and not nvt.accept_value(dvv):
+                    self.warning("Variable {0} has solution value {1} incompatible with new type {2}",
+                                 dv.name,dvv, nvt.short_name)
+                    nb_incompatible_sol_values += 1
+        except DOcplexException as vtex:
+            # something went wrong in bounds change
+            raise vtex
+
+        assert isinstance(dvars, (list, tuple))
+        # one batch call to engine
+        self.__engine.change_var_types(dvars, new_vartypes)
+        # update bounds, no error should occur here
+        for dv, nvt in zip(dvars, new_vartypes):
+            dv._set_vartype_internal(nvt)
+            nlb, nub = newbounds_dict[dv]
+            if nlb != dv.lb:
+                self._set_var_lb(dv, nlb)
+            if nub != dv.ub:
+                self._set_var_ub(dv, nub)
+        self._clear_cached_discrete_var()
+        if discard_incompatible_solution and nb_incompatible_sol_values:
+            self.warning("Removing current solution")
+            self._clear_solution()
+
+    def set_var_name(self, dvar, new_name):
+        # INTERNAL: use var.name to set variable names
+        if new_name != dvar.name:
+            self.__engine.rename_var(dvar, new_name)
+            dvar._set_name(new_name)
+
+    def set_linear_constraint_name(self, linct, new_name):
+        # INTERNAL: use lct.name to set a linear constraint's name
+        if new_name != linct.name:
+            self.__engine.rename_linear_constraint(linct, new_name)
+            linct._set_name(new_name)
+
+    #  ----   batch operations on variable bounds ----------------
+
[docs]    def change_var_lower_bounds(self, dvars, lbs, check_bounds=True):
+        """ Changes lower bounds for a collection of variables in one call.
+
+
+        :param dvars: an iterable over decision variables (a list, or a comprehension)
+        :param lbs: accepts either an iterable over numbers, a single number,
+            in which case the new bound is applied to all variables,
+            or None. If passed None, the lower bound of each variable is reset to
+            its type's default.
+        :param check_bounds: an optional flag to enable or disable checking of
+            new lower bounds (default is True: check)
+
+        The logic for checking new lower bounds is as follows: new bounds are checked if and only if
+        `check` is True and the model checker is not 'off'.
+
+        Example:
+            >>> ivars = m.integer_var_list(3, lb=7)
+            >>> m.change_var_lower_bounds(ivars, [1,2,3]) # sets lower bounds to 1,2,3 resp.
+
+            *New in 2.20*
+
+        """
+        checker = self._checker
+        var_list = checker.typecheck_var_seq(dvars, vtype=None, caller='Model.change_variable_lower_bounds')
+        if is_iterable(lbs):
+            lbs_ = (float(lb_) for lb_ in checker.typecheck_num_seq(lbs))
+        elif lbs is None:
+            lbs_ = (dv.vartype.default_lb for dv in dvars)
+        else:
+            checker.typecheck_num(lbs, caller='Model.change_variable_lower_bounds')
+            lbs_ = generate_constant(float(lbs), count_max=None)
+
+        def checked_lb(dvar, candidate_lb):
+            return dvar.vartype.resolve_lb(candidate_lb, self)
+
+        def to_float2(dvar, candidate_lb):
+            return candidate_lb
+
+        if check_bounds and checker.check_new_variable_bound():
+            # check bounds if not forced disable AND if checker allows it.
+            bound_transformer = checked_lb
+        else:
+            bound_transformer = to_float2
+
+        var_lb_dict = {dv: bound_transformer(dv, lb)  for dv, lb in zip(var_list, lbs_)}
+
+        engine = self.get_engine()
+        engine.change_var_lbs(var_lb_dict)
+        # now update vars
+        for dv, lb2 in var_lb_dict.items():
+            dv._lb = lb2

+
+
[docs]    def change_var_upper_bounds(self, dvars, ubs, check_bounds=True):
+        """ Changes upper bounds for a collection of variables in one call.
+
+        :param dvars: an iterable over decision variables (a list, or a comprehension)
+        :param ubs: accepts either an iterable over numbers, a single number,
+            in which case the new bound is applied to all variables,
+            or None. If passed None, the upper bound of each variable is reset to
+            its type's default.
+        :param check_bounds: an optional flag to enable or disable checking of
+            new upper bounds (default is True: check)
+
+        The logic for checking new upper bounds is as follows: new bounds are checked if and only if
+        `check` is True and the model checker is not 'off'.
+
+        Example:
+            >>> ivars = m.integer_var_list(3, lb=7)
+            >>> m.change_var_upper_bounds(ivars, [101,102,103]) # sets upper bounds to 1,01,102,103 resp.
+
+            *New in 2.20*
+
+        """
+        checker = self._checker
+        var_list = checker.typecheck_var_seq(dvars, vtype=None, caller='Model.change_variable_upper_bounds')
+        if is_iterable(ubs):
+            ubs_ = (float(ub_) for ub_ in checker.typecheck_num_seq(ubs))
+        elif ubs is None:
+            ubs_ = (dv.vartype.default_ub for dv in dvars)
+        else:
+            checker.typecheck_num(ubs, caller='Model.change_variable_upper_bounds')
+            ubs_ = generate_constant(float(ubs), count_max=None)
+
+        def checked_ub(dvar, candidate_ub):
+            return dvar.vartype.resolve_ub(candidate_ub, self)
+        def to_float2(dvar, candidate_ub):
+            return candidate_ub
+
+        if check_bounds and checker.check_new_variable_bound():
+            # check bounds if not forced disable AND if checker allows it.
+            bound_transformer = checked_ub
+        else:
+            bound_transformer = to_float2
+        var_ub_dict = {dv: bound_transformer(dv, ub)  for dv, ub in zip(var_list, ubs_)}
+
+        self.get_engine().change_var_ubs(var_ub_dict)
+        # now update vars
+        for dv, ub2 in var_ub_dict.items():
+            dv._ub = ub2

+
+    def set_var_lb(self, var, candidate_lb):
+        # INTERNAL: use var.lb to set lb
+        new_lb = var.vartype.resolve_lb(candidate_lb, self)
+        self._set_var_lb(var, new_lb)
+        return new_lb
+
+    def _set_var_lb(self, var, new_lb):
+        # INTERNAL
+        self.__engine.set_var_lb(var, new_lb)
+        var._internal_set_lb(new_lb)
+
+    def set_var_ub(self, var, candidate_ub):
+        # INTERNAL: use var.ub to set ub
+        new_ub = var.vartype.resolve_ub(candidate_ub, self)
+        self._set_var_ub(var, new_ub)
+        return new_ub
+
+    def _set_var_ub(self, var, new_ub):
+        # INTERNAL
+        self.__engine.set_var_ub(var, new_ub)
+        var._internal_set_ub(new_ub)
+
+    def _update_var_bounds_from_type(self, dvar, new_vartype, force_binary01=False):
+        # INTERNAL
+        old_lb, old_ub = dvar.lb, dvar.ub
+        if new_vartype == self.binary_vartype and force_binary01:
+            new_lb, new_ub = 0, 1
+        else:
+            new_lb = new_vartype.resolve_lb(old_lb, logger=self)
+            new_ub = new_vartype.resolve_ub(old_ub, logger=self)
+        if new_lb != old_lb:
+            self._set_var_lb(dvar, new_lb)
+        if new_ub != old_ub:
+            self._set_var_ub(dvar, new_ub)
+
+    def _compute_changed_var_bounds(self, dvar, new_vartype):
+        old_lb, old_ub = dvar.lb, dvar.ub
+        new_lb = new_vartype.resolve_lb(old_lb, logger=self)
+        new_ub = new_vartype.resolve_ub(old_ub, logger=self)
+
+        def is_possible(v_, eps_=1e-6):
+            return new_lb - eps_ <= v_ <= new_ub + eps_
+        if new_vartype == self.binary_vartype:
+            zero_in = is_possible(0)
+            one_in = is_possible(1)
+            if not (zero_in or one_in):
+                raise DOcplexException(f"Variable domain for \"{dvar.name}\" excludes both 0 and 1 - cannot be changed to binary")
+
+        # fail on empty domains
+        if new_ub <= new_lb - 1e-6:
+            raise DOcplexException(f"Variable {dvar.name} has empty updated domain: [{new_lb}, {new_ub}]")
+
+        return new_lb, new_ub
+
+
[docs]    def get_constraint_by_name(self, name):
+        """ Searches for a constraint from a name.
+
+        Returns the constraint if it finds a constraint with exactly this name, or None
+        if no constraint has this name.
+
+        This function will not raise an exception if the named constraint is not found.
+
+        Note:
+            The constraint name dicitonary in class Model is disabled by default. However,
+            calling `get_constraint_by_name` will compute one dicitonary on the fly,
+            but without warning for duplicate names. To enable the constraint
+            name dicitonary from the start (and get duplicate constraint messages),
+            add the `cts_by_name` keyword argument when creating the model, as in
+
+            >>> m = Model(name='my_model', cts_by_name=True)
+
+            This enables the constraint name dicitonary, and checks for duplicates when a named
+            constraint is added.
+
+        Args:
+            name (str): The name of the constraint being searched for.
+
+        Returns:
+            A constraint or None.
+        """
+        return self._ensure_cts_name_dir().get(name)

+
+
[docs]    def get_constraint_by_index(self, idx):
+        """ Searches for a linear constraint from an index.
+
+        Returns the linear constraint with `idx` as index, or None.
+        This function will not raise an exception if no constraint with this index is found.
+
+        Note: remember that linear constraints, logical constraints, and quadratic constraints
+        each have separate index spaces.
+
+        :param idx: a valid index (greater than 0).
+
+        :return: A linear constraint, or None.
+        """
+        return self._linct_scope.get_object_by_index(idx, self._checker)

+
+    def get_logical_constraint_by_index(self, idx):
+        return self._logical_scope.get_object_by_index(idx, self._checker)
+
+    def get_pwl_constraint_by_index(self, idx):
+        return self._pwl_scope.get_object_by_index(idx, self._checker)
+
+
[docs]    def get_quadratic_constraint_by_index(self, idx):
+        """ Searches for a quadratic constraint from an index.
+
+        Returns the quadratic constraint with `idx` as index, or None.
+        This function will not raise an exception if no constraint with this index is found.
+
+        Note: remember that linear constraints, logical constraints, and quadratic constraints
+        each have separate index spaces. Therefore, a model can contain both a linear constraint
+        and a quadratic constrait  having index 0
+
+        :param idx: a valid index (greater than 0).
+
+        :return: A quadratic constraint, or None.
+        """
+        return self._quadct_scope.get_object_by_index(idx, self._checker)

+
+    @property
+    def number_of_constraints(self):
+        """ This property returns the total number of constraints that were added to the model.
+
+        The number includes linear constraints, range constraints, and indicator constraints.
+        """
+        return sum(scope.size for scope in self._iter_constraint_scopes())
+
+    @property
+    def number_of_user_constraints(self):
+        """ This property returns the total number of constraints that were
+        explicitly added tothe model, not including generated constraints.
+
+        The number includes all types of constraints.
+        """
+        return sum(1 for ct in self.iter_constraints() if not ct.is_generated())
+
+
[docs]    def iter_constraints(self):
+        """ Iterates over all constraints (linear, ranges, indicators).
+
+        Returns:
+          An iterator object over all constraints in the model.
+        """
+        for sc in self._iter_constraint_scopes():
+            for obj in sc.iter_objects():
+                yield obj

+
+    def _count_constraints_with_type(self, scope, cttype):
+        return scope.count_filtered(pred=lambda ct: isinstance(ct, cttype))
+
+    @property
+    def number_of_range_constraints(self):
+        """ This property returns the total number of range constraints added to the model.
+
+        """
+        return self._count_constraints_with_type(self._linct_scope, RangeConstraint)
+
+    @property
+    def number_of_linear_constraints(self):
+        """ This property returns the total number of linear constraints added to the model.
+
+        This counts binary linear constraints (<=, >=, or ==) and
+        range constraints.
+
+        See Also:
+            :func:`number_of_range_constraints`
+
+        """
+        return self._linct_scope.size
+
+
[docs]    def iter_range_constraints(self):
+        """
+        Returns an iterator on the range constraints of the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._linct_scope.generate_objects_with_type(RangeConstraint)

+
+
[docs]    def iter_binary_constraints(self):
+        """
+        Returns an iterator on the binary constraints (expr1 <op> expr2) of the model.
+        This does not include range constraints.
+
+        Returns:
+            An iterator object.
+        """
+        return self._linct_scope.generate_objects_with_type(LinearConstraint)

+
+
[docs]    def iter_linear_constraints(self):
+        """
+        Returns an iterator on the linear constraints of the model.
+        This includes binary linear constraints and ranges but not indicators.
+
+        Returns:
+            An iterator object.
+        """
+        for c in self.iter_constraints():
+            if c.is_linear():
+                yield c

+
+
+    @property
+    def number_of_nonzeros(self):
+        return sum(lct.size for lct in self.iter_linear_constraints())
+
+
[docs]    def iter_indicator_constraints(self):
+        """ Returns an iterator on indicator constraints in the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._logical_scope.generate_objects_with_type(IndicatorConstraint)

+
+
[docs]    def iter_equivalence_constraints(self):
+        """ Returns an iterator on equivalence constraints in the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._logical_scope.generate_objects_with_type(EquivalenceConstraint)

+
+    @property
+    def number_of_indicator_constraints(self):
+        """ This property returns the number of indicator constraints in the model.
+        """
+        return self._count_constraints_with_type(self._logical_scope, IndicatorConstraint)
+
+    @property
+    def number_of_equivalence_constraints(self):
+        """ This property returns the number of equivalence constraints in the model.
+        """
+        return self._count_constraints_with_type(self._logical_scope, EquivalenceConstraint)
+
+
[docs]    def iter_quadratic_constraints(self):
+        """
+        Returns an iterator on the quadratic constraints of the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._quadct_scope.iter_objects()

+
+    @property
+    def number_of_quadratic_constraints(self):
+        """ This property returns the number of quadratic constraints in the model.
+        """
+        return self._quadct_scope.size
+
+    def has_quadratic_constraint(self):
+        return self._quadct_scope.size > 0
+
+    def iter_logical_constraints(self):
+        return self._logical_scope.iter_objects()
+
+
[docs]    def var(self, vartype, lb=None, ub=None, name=None):
+        """ Creates a decision variable and stores it in the model.
+
+        Args:
+            vartype: The type of the decision variable;
+                This field expects a concrete instance of the abstract class
+                :class:`docplex.mp.vartype.VarType`.
+
+            lb: The lower bound of the variable; either a number or None, to use the default.
+                 The default lower bound for all three variable types is 0.
+
+            ub: The upper bound of the variable domain; expects either a number or None to use the type's default.
+                The default upper bound for Binary is 1, otherwise positive infinity.
+
+            name: An optional string to name the variable.
+
+        :returns: The newly created decision variable.
+        :rtype: :class:`docplex.mp.dvar.Var`
+
+        Note:
+            The model holds local instances of BinaryVarType, IntegerVarType, ContinuousVarType which
+            are accessible by properties (resp. binary_vartype, integer_vartype, continuous_vartype).
+
+        See Also:
+            :attr:`infinity`,
+            :attr:`binary_vartype`,
+            :attr:`integer_vartype`,
+            :attr:`continuous_vartype`
+
+        """
+        self._checker.typecheck_vartype(vartype)
+        return self._var(vartype, lb, ub, name)

+
+    def _var(self, vartype, lb=None, ub=None, name=None):
+        # INTERNAL
+        if lb is not None:
+            self._checker.typecheck_num(lb, caller='Var.lb')
+        if ub is not None:
+            self._checker.typecheck_num(ub, caller='Var.ub')
+        return self._lfactory.new_var(vartype, lb, ub, name)
+
+
[docs]    def continuous_var(self, lb=None, ub=None, name=None):
+        """ Creates a new continuous decision variable and stores it in the model.
+
+        Args:
+            lb: The lower bound of the variable, or None. The default is 0.
+            ub: The upper bound of the variable, or None, to use the default. The default is model infinity.
+            name (string): An optional name for the variable.
+
+        :returns: A decision variable with type :class:`docplex.mp.vartype.ContinuousVarType`.
+        :rtype: :class:`docplex.mp.dvar.Var`
+        """
+        return self._var(self.continuous_vartype, lb, ub, name)

+
+
[docs]    def integer_var(self, lb=None, ub=None, name=None):
+        """ Creates a new integer variable and stores it in the model.
+
+        Args:
+            lb: The lower bound of the variable, or None. The default is 0.
+            ub: The upper bound of the variable, or None, to use the default. The default is model infinity.
+            name: An optional name for the variable.
+
+        :returns: An instance of the :class:`docplex.mp.dvar.Var` class with type `IntegerVarType`.
+        :rtype: :class:`docplex.mp.dvar.Var`
+        """
+        return self._var(self.integer_vartype, lb, ub, name)

+
+
[docs]    def binary_var(self, name=None):
+        """ Creates a new binary decision variable and stores it in the model.
+
+        Args:
+            name (string): An optional name for the variable.
+
+        :returns: A decision variable with type :class:`docplex.mp.vartype.BinaryVarType`.
+        :rtype: :class:`docplex.mp.dvar.Var`
+        """
+        return self._var(self.binary_vartype, name=name)

+
+
[docs]    def semicontinuous_var(self, lb, ub=None, name=None):
+        """ Creates a new semi-continuous decision variable and stores it in the model.
+
+        Args:
+            lb: The lower bound of the variable  (which must be strictly positive).
+            ub: The upper bound of the variable, or None, to use the default. The default is model infinity.
+            name (string): An optional name for the variable.
+
+        :returns: A decision variable with type :class:`docplex.mp.vartype.SemiContinuousVarType`.
+        :rtype: :class:`docplex.mp.dvar.Var`
+        """
+        self._checker.typecheck_num(lb)  # lb cannot be None
+        return self._var(self.semicontinuous_vartype, lb, ub, name)

+
+
[docs]    def semiinteger_var(self, lb, ub=None, name=None):
+        """ Creates a new semi-integer decision variable and stores it in the model.
+
+        Args:
+            lb: The lower bound of the variable (which must be strictly positive).
+            ub: The upper bound of the variable, or None, to use the default. The default is model infinity.
+            name (string): An optional name for the variable.
+
+        :returns: A decision variable with type :class:`docplex.mp.vartype.SemiIntegerVarType`.
+        :rtype: :class:`docplex.mp.dvar.Var`
+        """
+        self._checker.typecheck_num(lb)  # lb cannot be None
+        return self._var(self.semiinteger_vartype, lb, ub, name)

+
+    def var_list(self, keys, vartype, lb=None, ub=None, name=str, key_format=None):
+        self._checker.typecheck_vartype(vartype)
+        return self._var_list(keys, vartype, lb, ub, name, key_format)
+
+    def _var_list(self, keys, vartype, lb=None, ub=None, name=str, key_format=None):
+        return self._lfactory.var_list(keys, vartype, lb, ub, name, key_format)
+
+    def var_dict(self, keys, vartype, lb=None, ub=None, name=str, key_format=None):
+        self._checker.typecheck_vartype(vartype)
+        return self._var_dict(keys, vartype, lb, ub, name, key_format)
+
+    def _var_dict(self, keys, vartype, lb=None, ub=None, name=str, key_format=None):
+        return self._lfactory.new_var_dict(keys, vartype, lb, ub, name, key_format, ordered=self._keep_ordering)
+
+
[docs]    def binary_var_list(self, keys, lb=None, ub=None, name=str, key_format=None):
+        """ Creates a list of binary decision variables and stores them in the model.
+
+        Args:
+            keys: Either a sequence of objects or an integer.
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if keys is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+                        
+        Example:
+            If you want each key string to be surrounded by {}, use a special key_format: "_{%s}",
+            the %s denotes where the key string will be formatted and appended to `name`.
+
+        :returns: A list of :class:`docplex.mp.dvar.Var` objects with type :class:`doc.mp.vartype.BinaryVarType`.
+
+        Example:
+            `mdl.binary_var_list(3, "z")` returns a list of size 3
+            containing three binary decision variables with names `z_0`, `z_1`, `z_2`.
+
+        """
+        return self._var_list(keys, self.binary_vartype, name=name, lb=lb, ub=ub, key_format=key_format)

+
+
[docs]    def integer_var_list(self, keys, lb=None, ub=None, name=str, key_format=None):
+        """ Creates a list of integer decision variables with type `IntegerVarType`, stores them in the model,
+        and returns the list.
+
+        Args:
+            keys: Either a sequence of objects or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers with the same size as keys,
+                a function (which will be called on each key argument), or None.
+            ub: Upper bounds of the variables.  Accepts either a floating-point number,
+                a list of numbers with the same size as keys,
+                a function (which will  be called on each key argument), or None.
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                The default is "_%s". For example if name is "x" and each key object is represented by a string
+                like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+
+        Note:
+            Using None as the lower bound means the default lower bound (0) is used.
+            Using None as the upper bound means the default upper bound (the model's positive infinity)
+            is used.
+
+        :returns: A list of :class:`doc.mp.linear.Var` objects with type `IntegerVarType`.
+
+        Example:
+            >>> m.integer_var_list(3, name="ij")
+            returns a list of three integer variables from 0 to 1e+20, named ij_0, ij_1, ij_2.
+            The default behavior, when a string argument is passed as name,
+            is to concatenate the string , a "-" separator and a string representation
+            of the key; this allows to build arbitrary name strings from keys.
+
+            >>> m.integer_var_list(3, name=lambda i: "__name_{}__".format(i))
+            uses a functional name argument, producing names: "__name_0__",
+             "__name_1__", "_name__2__".
+
+            >>> m.integer_var_list(3, name="q", lb=1, ub=100)
+            returns a list of three integer variables from 1 to 100, named q_0, q_1, q_3
+
+            >>> m.integer_var_list([1,2,3], name="q", lb=lambda k: k, ub=lambda k: k*k+1)
+            returns a list of three integer variables q_1[1,1**1 +1], q2[2, 2*2+1], q3[3, 3*3+1]
+
+            The last example use the functional lb and ub, to compute bounds that
+            depend on the keys.
+        """
+        return self._var_list(keys, self.integer_vartype, lb, ub, name, key_format)

+
+
[docs]    def continuous_var_list(self, keys, lb=None, ub=None, name=str, key_format=None):
+        """
+        Creates a list of continuous decision variables with type :class:`docplex.mp.vartype.ContinuousVarType`,
+        stores them in the model, and returns the list.
+
+        Args:
+            keys: Either a sequence of objects or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same lower bound.
+                Otherwise either use an explicit list of numbers
+                or use a function if lower bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means using the default lower bound (0) is used.
+
+            ub: Upper bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same upper bound.
+                Otherwise either use an explicit list of numbers
+                or use a function if upper bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default upper bound (model infinity) is used.
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+                If passed a function, this function is called on each key object to generate a name.
+                The default behavior is to call :func:`str()` on each key object.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+        Note:
+            When `keys` is either an empty list or the integer 0, an empty list is returned.
+
+
+        :returns: A list of :class:`docplex.mp.dvar.Var` objects with type :class:`docplex.mp.vartype.ContinuousVarType`.
+
+        See Also:
+            :attr:`infinity`
+
+        """
+        return self._var_list(keys, self.continuous_vartype, lb, ub, name, key_format)

+
+
[docs]    def semicontinuous_var_list(self, keys, lb, ub=None, name=str, key_format=None):
+        """
+        Creates a list of semi-continuous decision variables with type :class:`docplex.mp.vartype.SemiContinuousVarType`,
+        stores them in the model, and returns the list.
+
+        Args:
+            keys: Either a sequence of objects or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, or a function.
+                Use a number if all variables share the same lower bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if lower bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                Note that the lower bound of a semi-continuous variable must be strictly positive.
+
+            ub: Upper bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same upper bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if upper bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default upper bound (model infinity) is used.
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+                If passed a function, this function is called on each key object to generate a name.
+                The default behavior is to call :func:`str()` on each key object.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+        Note:
+            When `keys` is either an empty list or the integer 0, an empty list is returned.
+
+
+        :returns: A list of :class:`docplex.mp.dvar.Var` objects with type :class:`docplex.mp.vartype.SemiContinuousVarType`.
+
+        See Also:
+            :attr:`infinity`
+
+        """
+        return self._var_list(keys, self.semicontinuous_vartype, lb, ub, name, key_format)

+
+
[docs]    def semiinteger_var_list(self, keys, lb, ub=None, name=str, key_format=None):
+        """
+        Creates a list of semi-integer decision variables with type :class:`docplex.mp.vartype.SemiIntegerVarType`,
+        stores them in the model, and returns the list.
+
+        Args:
+            keys: Either a sequence of objects or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, or a function.
+                Use a number if all variables share the same lower bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if lower bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                Note that the lower bound of a semi-integer variable must be strictly positive.
+
+            ub: Upper bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same upper bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if upper bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default upper bound (model infinity) is used.
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+                If passed a function, this function is called on each key object to generate a name.
+                The default behavior is to call :func:`str()` on each key object.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+        Note:
+            When `keys` is either an empty list or the integer 0, an empty list is returned.
+
+
+        :returns: A list of :class:`docplex.mp.dvar.Var` objects with type :class:`docplex.mp.vartype.SemiIntegerVarType`.
+
+        See Also:
+            :attr:`infinity`
+
+        """
+        return self._var_list(keys, self.semiinteger_vartype, lb, ub, name, key_format)

+
+
[docs]    def continuous_var_dict(self, keys, lb=None, ub=None, name=None, key_format=None):
+        """ Creates a dictionary of continuous decision variables, indexed by key objects.
+
+        Creates a dictionary that allows retrieval of variables from business
+        model objects. Keys can be either a Python collection, an iterator, or a generator.
+
+        A key can be any Python object, with the exception of None.
+        Keys are used in the naming of variables.
+
+        Note:
+            If `keys` is empty, this method returns an empty dictionary.
+            The returned dictionary should not be modified.
+
+        Args:
+            keys: Either a sequence of objects, an iterator, or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, or a function.
+                Use a number if all variables share the same lower bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if lower bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default lower bound (0) is used.
+
+            ub: Upper bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same upper bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if upper bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default upper bound (model infinity) is used.
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+                If passed a function, this function is called on each key object to generate a name.
+                The default behavior is to call :func:`str` on each key object.
+
+            key_format: A format string or None. This format string describes how `keys` contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+
+        :returns: A dictionary of :class:`docplex.mp.dvar.Var` objects (with type `ContinuousVarType`) indexed by
+                  the objects in `keys`.
+
+        See Also:
+            :class:`docplex.mp.dvar.Var`,
+            :attr:`infinity`
+        """
+        return self._var_dict(keys, self.continuous_vartype, lb=lb, ub=ub, name=name, key_format=key_format)

+
+
[docs]    def integer_var_dict(self, keys, lb=None, ub=None, name=None, key_format=None):
+        """  Creates a dictionary of integer decision variables, indexed by key objects.
+
+        Creates a dictionary that allows retrieval of variables from business
+        model objects. Keys can be either a Python collection, an iterator, or a generator.
+
+        A key can be any Python object, with the exception of None.
+        Keys are used in the naming of variables.
+
+        Note:
+            If `keys` is empty, this method returns an empty dictionary.
+            The returned dictionary should not be modified.
+
+        Args:
+            keys: Either a sequence of objects, an iterator, or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, or a function.
+                Use a number if all variables share the same lower bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if lower bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default lower bound (0) is used.
+
+            ub: Upper bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same upper bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if upper bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default upper bound (model infinity) is used.
+
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+                If passed a function, this function is called on each key object to generate a name.
+                The default behavior is to call :func:`str` on each key object.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+
+        :returns:  A dictionary of :class:`docplex.mp.dvar.Var` objects (with type `IntegerVarType`) indexed by the
+                   objects in `keys`.
+
+        See Also:
+            :attr:`infinity`
+        """
+        return self._var_dict(keys, self.integer_vartype, lb=lb, ub=ub, name=name, key_format=key_format)

+
+
[docs]    def binary_var_dict(self, keys, lb=None, ub=None, name=None, key_format=None):
+        """ Creates a dictionary of binary decision variables, indexed by key objects.
+
+        Creates a dictionary that allows retrieval of variables from business
+        model objects. Keys can be either a Python collection, an iterator, or a generator.
+
+        A key can be any Python object, with the exception of None.
+        Keys are used in the naming of variables.
+
+        Note:
+            If `keys` is empty, this method returns an empty dictionary.
+            The returned dictionary should not be modified.
+
+        Args:
+            keys: Either a sequence of objects, an iterator, or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            name (string): Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+
+        :returns: A dictionary of :class:`docplex.mp.dvar.Var` objects with type
+                  :class:`docplex.mp.vartype.BinaryVarType` indexed by the objects in `keys`.
+        """
+        return self._var_dict(keys, self.binary_vartype, lb=lb, ub=ub, name=name, key_format=key_format)

+
+
[docs]    def semiinteger_var_dict(self, keys, lb, ub=None, name=str, key_format=None):
+        """  Creates a dictionary of semi-integer decision variables, indexed by key objects.
+
+        Creates a dictionary that allows retrieval of variables from business
+        model objects. Keys can be either a Python collection, an iterator, or a generator.
+
+        A key can be any Python object, with the exception of None.
+        Keys are used in the naming of variables.
+
+        Note:
+            If `keys` is empty, this method returns an empty dictionary.
+            The returned dictionary should not be modified.
+
+        Args:
+            keys: Either a sequence of objects, an iterator, or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, or a function.
+                Use a number if all variables share the same lower bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if lower bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+
+            ub: Upper bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same upper bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if upper bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default upper bound (model infinity) is used.
+
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+                If passed a function, this function is called on each key object to generate a name.
+                The default behavior is to call :func:`str` on each key object.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+
+        :returns:  A dictionary of :class:`docplex.mp.dvar.Var` objects (with type `SemiIntegerVarType`) indexed by the
+                   objects in `keys`.
+
+        See Also:
+            :attr:`infinity`
+        """
+        return self._var_dict(keys, self.semiinteger_vartype, lb, ub, name, key_format)

+
+
[docs]    def semiinteger_var_matrix(self, keys1, keys2, lb, ub=None, name=None, key_format=None):
+        """ Creates a dictionary of semiinteger decision variables, indexed by pairs of key objects.
+
+        Creates a dictionary that allows the retrieval of variables from  a tuple
+        of two keys, the first one from `keys1`, the second one from `keys2`.
+        In short, variables are indexed by the Cartesian product of the two key sets.
+
+        A key can be any Python object, with the exception of None.
+
+        Arguments `lb`, `ub`, `name`, and `key_format` are interpreted as in :func:`semiinteger_var_dict`.
+
+        *New in version 2.9*
+        """
+        return self._var_multidict(self.semiinteger_vartype, [keys1, keys2], lb, ub, name, key_format)

+
+
[docs]    def semicontinuous_var_dict(self, keys, lb, ub=None, name=str, key_format=None):
+        """  Creates a dictionary of semi-continuous decision variables, indexed by key objects.
+
+        Creates a dictionary that allows retrieval of variables from business
+        model objects. Keys can be either a Python collection, an iterator, or a generator.
+
+        A key can be any Python object, with the exception of None.
+        Keys are used in the naming of variables.
+
+        Note:
+            If `keys` is empty, this method returns an empty dictionary.
+            The returned dictionary should not be modified.
+
+        Args:
+            keys: Either a sequence of objects, an iterator, or a positive integer. If passed an integer,
+                it is interpreted as the number of variables to create.
+
+            lb: Lower bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, or a function.
+                Use a number if all variables share the same lower bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if lower bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+
+            ub: Upper bounds of the variables. Accepts either a floating-point number,
+                a list of numbers, a function, or None.
+                Use a number if all variables share the same upper bound.
+                Otherwise either use an explicit list of numbers or
+                use a function if upper bounds vary depending on the key, in which case,
+                the function will be called on each `key` in `keys`.
+                None means the default upper bound (model infinity) is used.
+
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if `keys` is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+                If passed a function, this function is called on each key object to generate a name.
+                The default behavior is to call :func:`str` on each key object.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+
+        :returns:  A dictionary of :class:`docplex.mp.dvar.Var` objects (with type `SemiIntegerVarType`) indexed by the
+                   objects in `keys`.
+
+        See Also:
+            :attr:`infinity`
+        """
+        return self._var_dict(keys, self.semicontinuous_vartype, lb, ub, name, key_format)

+
+
[docs]    def semicontinuous_var_matrix(self, keys1, keys2, lb, ub=None, name=None, key_format=None):
+        """ Creates a dictionary of semicontinuous decision variables, indexed by pairs of key objects.
+
+        Creates a dictionary that allows the retrieval of variables from  a tuple
+        of two keys, the first one from `keys1`, the second one from `keys2`.
+        In short, variables are indexed by the Cartesian product of the two key sets.
+
+        A key can be any Python object, with the exception of None.
+
+        Arguments `lb`, `ub`, `name`, and `key_format` are interpreted as in :func:`semiinteger_var_dict`.
+
+        *New in version 2.9*
+        """
+        return self._var_multidict(self.semicontinuous_vartype, [keys1, keys2], lb, ub, name, key_format)

+
+
[docs]    def var_hypercube(self, vartype_spec, seq_of_keys, lb=None, ub=None, name=None, key_format=None):
+        """ 
+        Creates a dictionary of  decision variables, indexed by tuples
+        of arbitrary size.
+
+        Arguments are analogous to methods of the type xxx_var_matrix,
+        except a type argument has to be passed.
+
+        Args:
+            vartype_spec: type specificsation: accepts either an instance of class
+                `docplex.mp.VarType`, or a string that can be translated into a vartype.
+                Possible strings are:
+
+                    - cplex type codes, e.g. B,I,C,N,S or type short names
+                      (e.g.: binary, integer, continuous, semicontinuous, semiinteger)
+
+            seq_of_keys: a sequence of sequence of keys. Typically of length >= 4,
+                as other dimensions are handled by the 'list', 'matrix' and 'cube'
+                series of methods.
+                Variables are indexed by tuples formed by the cartesian product of elements
+                form the sequences; all sequences of keys must be non-empty.
+
+        All other arguments have the same meaning as for all the "xx_var_matrix" family of methods.
+
+        Example:
+            >>> hc = Model().var_hypercube(vartype_spec='B', seq_of_keys=[[1,2], [3], ['a','b'], [1,2,3,4]]
+            >>> len(hc)
+            16
+            returns a dict of 2x2x4 = 16 variables indexed by tuples formed by the cartesian product
+            of the four lists, for example (1,3,'a',4)is a valid key for the hypercube.
+
+        *New in 2.19*
+
+        See Also:
+            :class:`docplex.mp.vartype.VarType`
+
+        """
+        vartype = self._parse_vartype(vartype_spec)
+        self._checker.typecheck_vartype(vartype)
+        self._checker.typecheck_iterable(seq_of_keys)
+        lkeys = list(seq_of_keys)
+        arity = len(lkeys)
+        if arity == 0:
+            self.fatal("Variable hypercube with zero dimension")
+
+        return self._var_multidict(vartype, lkeys, lb, ub, name, key_format)

+
+    def _var_multidict(self, vartype, keys, lb=None, ub=None, name=None, key_format=None):
+        assert isinstance(vartype, VarType)
+        return self._lfactory.new_var_multidict(keys, vartype, lb, ub, name, key_format, ordered=self._keep_ordering)
+
+    def var_matrix(self, vartype, keys1, keys2, lb=None, ub=None, name=None, key_format=None):
+        return self._var_multidict(vartype, keys=[keys1, keys2],
+                                  lb=lb, ub=ub, name=name, key_format=key_format)
+
+
[docs]    def binary_var_matrix(self, keys1, keys2, name=None, key_format=None):
+        """ Creates a dictionary of binary decision variables, indexed by pairs of key objects.
+
+        Creates a dictionary that allows the retrieval of variables from  a tuple
+        of two keys, the first one from `keys1`, the second one from `keys2`.
+        In short, variables are indexed by the Cartesian product of the two key sets.
+
+        A key can be any Python object, with the exception of None.
+        Keys are used in the naming of variables.
+
+        Note:
+            If either of `keys1` or `keys2` is empty, this method returns an empty dictionary.
+
+        Args:
+            keys1: Either a sequence of objects, an iterator, or a positive integer. If passed an integer N,
+                    it is interpreted as a range from 0 to N-1.
+
+            keys2: Same as `keys1`.
+
+            name: Used to name variables. Accepts either a string or
+                a function. If given a string, the variable name is formed by appending the string
+                to the string representation of the key object (if keys is a sequence) or the
+                index of the variable within the range, if an integer argument is passed.
+
+            key_format: A format string or None. This format string describes how keys contribute to variable names.
+                        The default is "_%s". For example if name is "x" and each key object is represented by a string
+                        like "k1", "k2", ... then variables will be named "x_k1", "x_k2",...
+
+        :returns: A dictionary of :class:`docplex.mp.dvar.Var` objects with type
+                  :class:`docplex.mp.vartype.BinaryVarType` indexed by
+                  all couples `(k1, k2)` with `k1` in `keys1` and `k2` in `keys2`.
+        """
+        return self._var_multidict(self.binary_vartype, [keys1, keys2], 0, 1, name=name, key_format=key_format)

+
+
[docs]    def integer_var_matrix(self, keys1, keys2, lb=None, ub=None, name=None, key_format=None):
+        """ Creates a dictionary of integer decision variables, indexed by pairs of key objects.
+
+        Creates a dictionary that allows the retrieval of variables from  a tuple
+        of two keys, the first one from `keys1`, the second one from `keys2`.
+        In short, variables are indexed by the Cartesian product of the two key sets.
+
+        A key can be any Python object, with the exception of None.
+
+        Arguments `lb`, `ub`, `name`, and `key_format` are interpreted as in :func:`integer_var_dict`.
+        """
+        return self._var_multidict(self.integer_vartype, [keys1, keys2], lb, ub, name, key_format)

+
+
[docs]    def continuous_var_matrix(self, keys1, keys2, lb=None, ub=None, name=None, key_format=None):
+        """ Creates a dictionary of continuous decision variables, indexed by pairs of key objects.
+
+        Creates a dictionary that allows retrieval of variables from a tuple
+        of two keys, the first one from `keys1`, the second one from `keys2`.
+        In short, variables are indexed by the Cartesian product of the two key sets.
+
+        A key can be any Python object, with the exception of None.
+
+        Arguments `lb`, `ub`, `name`, and `key_format` are interpreted the same as in :func:`integer_var_dict`.
+
+        """
+        return self._var_multidict(self.continuous_vartype, [keys1, keys2], lb, ub, name, key_format)

+
+
[docs]    def continuous_var_cube(self, keys1, keys2, keys3, lb=None, ub=None, name=None, key_format=None):
+        """ Creates a dictionary of continuous decision variables, indexed by triplets of key objects.
+
+        Same as :func:`continuous_var_matrix`, except that variables are indexed by triplets of
+        the form `(k1, k2, k3)` with `k1` in `keys1`, `k2` in `keys2`, `k3` in `keys3`.
+        """
+        return self._var_multidict(self.continuous_vartype, [keys1, keys2, keys3], lb, ub, name, key_format)

+
+
[docs]    def integer_var_cube(self, keys1, keys2, keys3, lb=None, ub=None, name=str):
+        """ Creates a dictionary of integer decision variables, indexed by triplets.
+
+        Same as :func:`integer_var_matrix`, except that variables are indexed by triplets of
+        the form `(k1, k2, k3)` with `k1` in `keys1`, `k2` in `keys2`, `k3` in `keys3`.
+
+        See Also:
+            :func:`integer_var_matrix`
+        """
+        return self._var_multidict(self.integer_vartype, [keys1, keys2, keys3], lb, ub, name)

+
+
[docs]    def binary_var_cube(self, keys1, keys2, keys3, name=None, key_format=None):
+        """Creates a dictionary of binary decision variables, indexed by triplets.
+
+        Same as :func:`binary_var_matrix`, except that variables are indexed by triplets of
+        the form `(k1, k2, k3)` with `k1` in `keys1`, `k2` in `keys2`, `k3` in `keys3`.
+
+        :returns: A dictionary of :class:`docplex.mp.dvar.Var` objects (with type :class:`docplex.mp.vartype.BinaryVarType`) indexed by
+            triplets.
+
+        """
+        return self._var_multidict(self.binary_vartype, [keys1, keys2, keys3], name=name, key_format=key_format)

+
+
[docs]    def linear_expr(self, arg=None, constant=0, name=None):
+        ''' Returns a new empty linear expression.
+
+        Args:
+            arg: an optional argument to convert to a linear expression. Detailt is None,
+                in which case, an empty expression is returned.
+
+        :returns: An instance of :class:`docplex.mp.linear.LinearExpr`.
+        '''
+        self._checker.typecheck_num(arg=constant, caller='Model.linear_expr()')
+        if name:
+            warnings.warn("Naming expressions is deprecated -- ignored")
+        return self._lfactory.linear_expr(arg=arg, constant=constant)

+
+
[docs]    def quad_expr(self, name=None):
+        ''' Returns a new empty quadratic expression.
+
+        :returns: An empty instance of :class:`docplex.mp.quad.QuadExpr`.
+        '''
+        if name:
+            if self.is_docplex_debug():
+                raise RuntimeError
+            warnings.warn("Naming expressions is deprecated, use a variable if necessary")
+        return self._qfactory.new_quad()

+
+
[docs]    def abs(self, e):
+        """ Builds an expression equal to the absolute value of its argument.
+
+        Args:
+            e: Accepts any object that can be transformed into an expression:
+                decision variables, expressions, or numbers.
+
+        Returns:
+            An expression that can be used in arithmetic operators and constraints.
+
+        Note:
+            Building the expression generates auxiliary decision variables, including binary decision variables,
+            and this may change the nature of the problem from a LP to a MIP.
+
+        """
+        self._checker.typecheck_operand(e, caller="Model.abs", accept_numbers=True)
+        return self._lfactory.new_abs_expr(e)

+
+
[docs]    def min(self, *args):
+        """ Builds an expression equal to the minimum value of its arguments.
+
+        This method accepts a variable number of arguments.
+
+        If no arguments are provided, returns positive infinity (see :attr:`infinity`).
+
+        Args:
+            args: A variable list of arguments, each of which is either an expression, a variable,
+                or a container.
+
+        If passed a container or an iterator, this container or iterator must be the unique argument.
+
+        If passed one dictionary, returns the minimum of the dictionary values.
+
+
+        Returns:
+            An expression that can be used in arithmetic operators and constraints.
+
+        Example:
+            `model.min()` -> returns `model.infinity`.
+
+            `model.min(e)` -> returns `e`.
+
+            `model.min(e1, e2, e3)` -> returns a new expression equal to the minimum of the values of `e1`, `e2`, `e3`.
+
+            `model.min([x1,x2,x3])` where `x1`, `x2` .. are variables or expressions -> returns the minimum of these expressions.
+
+            `model.min([])` -> returns `model.infinity`.
+
+        Note:
+            Building the expression generates auxiliary variables, including binary decision variables,
+            and this may change the nature of the problem from a LP to a MIP.
+        """
+        min_args = args
+        nb_args = len(args)
+        if 0 == nb_args:
+            pass
+        elif 1 == nb_args:
+            unique_arg = args[0]
+            if is_iterable(unique_arg):
+                if isinstance(unique_arg, dict):
+                    min_args = unique_arg.values()
+                else:
+                    min_args = _to_list(unique_arg)
+                for a in min_args:
+                    self._checker.typecheck_operand(a, caller="Model.min()")
+            else:
+                self._checker.typecheck_operand(unique_arg, caller="Model.min()")
+
+        else:
+            for arg in args:
+                self._checker.typecheck_operand(arg, caller="Model.min")
+
+        return self._lfactory.new_min_expr(*min_args)

+
+
[docs]    def max(self, *args):
+        """ Builds an expression equal to the maximum value of its arguments.
+
+        This method accepts a variable number of arguments.
+
+        Args:
+            args: A variable list of arguments, each of which is either an expression, a variable,
+                or a container.
+
+        If passed a container or an iterator, this container or iterator must be the unique argument.
+
+        If passed one dictionary, returns the maximum of the dictionary values.
+
+        If no arguments are provided, returns negative infinity (see :attr:`infinity`).
+
+
+        Example:
+            `model.max()` -> returns `-model.infinity`.
+
+            `model.max(e)` -> returns `e`.
+
+            `model.max(e1, e2, e3)` -> returns a new expression equal to the maximum of the values of `e1`, `e2`, `e3`.
+
+            `model.max([x1,x2,x3])` where `x1`, `x2` .. are variables or expressions -> returns the maximum of these expressions.
+
+            `model.max([])` -> returns `-model.infinity`.
+
+
+        Note:
+            Building the expression generates auxiliary variables, including binary decision variables,
+            and this may change the nature of the problem from a LP to a MIP.
+        """
+        max_args = args
+        nb_args = len(args)
+        if 0 == nb_args:
+            pass
+        elif 1 == nb_args:
+            unique_arg = args[0]
+            if is_iterable(unique_arg):
+                if isinstance(unique_arg, dict):
+                    max_args = unique_arg.values()
+                else:
+                    max_args = _to_list(unique_arg)
+                for a in max_args:
+                    self._checker.typecheck_operand(a, caller="Model.max")
+            else:
+                self._checker.typecheck_operand(unique_arg, caller="Model.max")
+        else:
+            for arg in args:
+                self._checker.typecheck_operand(arg, caller="Model.max")
+
+        return self._lfactory.new_max_expr(*max_args)

+
+
+
[docs]    def logical_and(self, *args):
+        """ Builds an expression equal to the logical AND value of its arguments.
+
+        This method takes a variable number of arguments, and accepts
+        binary variables, other logical expressions, or discrete constraints.
+
+        Args:
+            args: A variable list of logical operands.
+
+        Note:
+            If passed an empty number of arguments, this method an expression equal to 1.
+
+        Returns:
+            An expression, equal to 1 if and only if all of its
+            arguments are equal to 1, else equal to 0.
+
+        See Also:
+            :func:`logical_or`
+            :func:`logical_not`
+
+        Example::
+
+            # return logical XOR or two binary variables.
+            def logxor(m, b1, b2):
+                return m.logical_and(m.logical_or(b1, b2), m.logical_not(m.logical_and(b1, b2)))
+
+        """
+        bvars = self._checker.typecheck_logical_op_seq(args, caller='Model.logical_and')
+        return self._lfactory.new_logical_and_expr(bvars)

+
+
[docs]    def logical_or(self, *args):
+        """ Builds an expression equal to the logical OR value of its arguments.
+
+        This method takes a variable number of arguments, and accepts
+            binary variables, other logical expressions, or discrete constraints.
+
+        Args:
+            args: A variable list of logical operands.
+
+        Note:
+            If passed an empty number of arguments, this method a zero expression.
+
+        Returns:
+            An expression, equal to 1 if and only if at least one of its
+             arguments is equal to 1, else equal to 0.
+
+        See Also:
+            :func:`logical_and`
+            :func:`logical_not`
+
+        *New in version 2.11*
+
+        """
+        bvars = self._checker.typecheck_logical_op_seq(args, caller='Model.logical_or')
+        return self._lfactory.new_logical_or_expr(bvars)

+
+
[docs]    def logical_not(self, arg):
+        """ Builds an expression equal to the logical negation of its argument.
+
+        This method accepts either a binary variable, or another logical expression.
+
+        Args:
+            arg: A binary variable, or a logical expression,
+                e.g. an expression built by logical_and, logical_or, logical_not
+
+        Returns:
+            An expression, equal to 1 if its argument is 0, else 0.
+
+        See Also:
+            :func:`logical_and`
+            :func:`logical_or`
+
+        """
+        StaticTypeChecker.typecheck_logical_op(self, arg, 'Model.logical_not')
+        return self._lfactory.new_logical_not_expr(arg)

+
+
[docs]    def scal_prod(self, terms, coefs):
+        """
+        Creates a linear expression equal to the scalar product of a sequence of decision variables
+        and a sequence of coefficients.
+
+        This method accepts different types of input for both arguments. `terms` can be any
+        iterable returning expressions or variables, and `coefs` is usually
+        an iterable returning numbers.
+        `cal_prod` also accept one number as `coefs`, in which case
+        the scalar product reduces to a sum times this coefficient.
+
+        :param terms: An iterable returning variables or expressions.
+        :param coefs: An iterable returning numbers, or a number.
+
+        Note:
+            - both iterables are iterated at the same time, so the order in which terms and numbers
+              are returned must be consistent: using unordered collections (e.g. sets) could lead to unexpected results.
+
+           - Iteration stops as soon as one iterable stops. If both iterables are empty, the method returns 0.
+
+        :return: A linear expression or 0.
+        """
+        self._checker.check_ordered_sequence(arg=terms, caller='Model.scal_prod() requires a list of expressions/variables')
+        return self._aggregator.scal_prod(terms, coefs)

+
+
[docs]    def dot(self, terms, coefs):
+        """ Synonym for :func:`scal_prod`.
+
+        """
+        return self.scal_prod(terms, coefs)

+
+
[docs]    def dotf(self, var_dict, coef_fn, assume_alldifferent=True):
+        """ Creates a scalar product from a dictionary of variables and a function.
+
+        This method is a functional variant of `dot`. I takes as asrgument a dictionary of variables,
+        as returned by xxx_var_dict or xx_var_var_matrix (where xxx is a type), and a function.
+
+        :param var_dict: a dictionary of variables, as returned by all the xxx_var_dict methods (e.g. integer_var_dict),
+            but also multi-dimensional dictionaries, such as xxx_var_matrix (or var_cube).
+        :param coef_fn: A function that takes one dictionary key and returns anumber. One-dimension dictionaries (such
+            as integer_var_dict) have plain object as keys, but multi-dimensional dictionaries have tuples keys.
+            For example, a binary_var_matrix returns a dictionary, the keys of which are 2-tuples.
+        :param assume_alldifferent: an optional flag whichi ndicates whether variables values in the dictionary
+            can be assumed to be all different. This is true when the dicitonary has been built by Docplex's
+            Model.xxx_var-dict(), and thi sis the default behavior.
+            For a custom-built dictionary, set the flag to False. A wrong flag value may yield incorrect results.
+
+        :return: an expression, built as a scalar product of all variables in the dictionay, multiplied by the result of the function.
+
+        Examples:
+
+                >>> m1 = m.binary_var_matrix(keys1=range(1,3), keys2=range(1,3), name='b')
+                >>> s = m.dotf(m1, lambda keys: keys[0] + keys[1])
+
+                returns 2 b_1_1 + 3 b_1_2 +3 b_2_1 + 4 b_2_2
+
+        """
+        StaticTypeChecker.typecheck_callable\
+            (self, coef_fn,
+             "Functional scalar product requires a function taking variable keys as argument. A non-callable was passed: {0!r}".format(
+                 coef_fn))
+        return self._aggregator._scal_prod_f(var_dict, coef_fn, assume_alldifferent)

+
+    scal_prod_f = dotf
+
+
+
[docs]    def scal_prod_vars_all_different(self, terms, coefs):
+        """ Fastly creates a scalar product from a dictionary of variables and a list of coefficients or a coefficient.
+        :param terms: An iterable returning variables or expressions.
+        :param coefs: An iterable returning numbers, or a number.
+        """
+        self._checker.check_ordered_sequence(arg=terms,
+                                             caller='Model.scal_prod() requires a list of expressions/variables')
+        var_seq = self._checker.typecheck_var_seq_all_different(terms)
+        return self._aggregator._scal_prod_vars_all_different(var_seq, coefs)

+
+
[docs]    def sum(self, args):
+        """ Creates an expression summing over an iterable over expressions or variables.
+        This method expects an iterable over any type of expression: quadrayic expression,
+        linear expression, variables, constants.
+
+        Note:
+           The returned expression is quadratic as soon as the result is quadratic, otherwise it returns
+           a linear expression, or 0 if the iterable is empty.
+        
+        :param args: An iterable over expressions (quadratic or linear), variables, or constants.
+
+        :return: A Docplex expression.
+        """
+        return self._aggregator.sum(args)

+
+
[docs]    def sums(self, *args):
+        """ Same as `Model.sum()` but accepts a variable number of arguments.
+
+        :param args: A variable number of expressions (quadratic or linear), variables, or constants.
+        :return: A Docplex expression.
+
+        Example:
+            Assuming x is a variable.
+            >>> m.sums(x**2, x, 1)
+            is identical to
+            >> m.sum([x**2, x, 1])
+
+            Both return a quadratic expression "x^2+x+1"
+
+        *New in version 2.22*
+        """
+        return self.sum(args)

+
+
[docs]    def sumsq(self, args):
+        """ Creates a quadratic expression summing squares of expressions.
+
+        Each element of the list is squared and added to the result. Quadratic expressions
+        are not accepted, as they cannot be squared.
+
+        Note:
+           This method returns 0 if the argument is an empty list or iterator.
+
+        :param args: An iterable returning linear expressions, variables or numbers.
+
+        :return: A quadratic expression (possibly constant).
+        """
+        return self._aggregator.sumsq(args)

+
+    sum_squares = sumsq
+
+
[docs]    def sum_vars(self, dvars):
+        """ Creates a linear expression that sums variables.
+
+        This method is faster than `Model.sum()` but accepts only variables.
+
+        :param dvars: an iterable returning variables.
+
+        :return: a linear expression equal to the sum of the variables.
+
+        *New in version 2.10*
+        """
+        return self._aggregator._sum_vars(dvars)

+
+
+
[docs]    def sum_vars_all_different(self, terms):
+        """
+        Creates a linear expression equal to sum of a list of decision variables.
+        The variable sequence is a list or an iterator of variables.
+
+        This method is faster than the standard generic summation method due to the fact that it takes only
+        variables and does not take expressions as arguments.
+
+        :param terms: A list or an iterator on variables only, with no duplicates.
+
+        :return: a linear expression equal to the sum of the variables.
+
+        Note:
+           If the variable iteration contains duplicates, this function returns an incorrect result.
+
+        """
+        if isinstance(terms, dict):
+            return self.sum_vars_all_different(terms.values())
+        else:
+            var_seq = self._checker.typecheck_var_seq_all_different(terms)
+            return self._aggregator._sum_vars_all_different(var_seq)

+
+
[docs]    def le_constraint(self, lhs, rhs, name=None):
+        """ Creates a "less than or equal to" linear constraint.
+
+        Note:
+            This method returns a constraint object, that is not added to the model.
+            To add it to the model, use the :func:`add_constraint` method.
+
+        Args:
+            lhs: An object that can be converted to a linear expression, typically a variable,
+                    a member of an expression.
+            rhs: An object that can be converted to a linear expression, typically a variable,
+                    a member of an expression.
+            name (string): An optional string to name the constraint.
+
+        :returns: An instance of :class:`docplex.mp.linear.LinearConstraint`.
+        """
+        return self._lfactory.new_le_constraint(lhs, rhs, name)

+
+
[docs]    def ge_constraint(self, lhs, rhs, name=None):
+        """ Creates a "greater than or equal to" linear constraint.
+
+        Note:
+            This method returns a constraint object that is not added to the model.
+            To add it to the model, use the :func:`add_constraint` method.
+
+        Args:
+            lhs: An object that can be converted to a linear expression, typically a variable,
+                    a member of an expression.
+            rhs: An object that can be converted to a linear expression, typically a variable,
+                    a number of an expression.
+            name (string): An optional string to name the constraint.
+
+        :returns: An instance of :class:`docplex.mp.linear.LinearConstraint`.
+        """
+        return self._lfactory.new_ge_constraint(lhs, rhs, name)

+
+
[docs]    def eq_constraint(self, lhs, rhs, name=None):
+        """ Creates an equality constraint.
+
+        Note:
+            This method returns a constraint object that is not added to the model.
+            To add it to the model, use the :func:`add_constraint` method.
+
+        :param lhs: An object that can be converted to a linear expression, typically a variable,
+                    a member of an expression.
+        :param rhs: An object that can be converted to a linear expression, typically a variable,
+                    a member of an expression.
+        :param name: An optional string to name the constraint.
+
+        :returns: An instance of :class:`docplex.mp.linear.LinearConstraint`.
+        """
+        return self._lfactory.new_eq_constraint(lhs, rhs, name)

+
+
[docs]    def linear_constraint(self, lhs, rhs, ctsense, name=None):
+        """ Creates a linear constraint.
+
+        Note:
+            This method returns a constraint object that is not added to the model.
+            To add it to the model, use the :func:`add_constraint` method.
+
+        Args:
+            lhs: An object that can be converted to a linear expression, typically a variable,
+                    a member of an expression.
+            rhs: An object that can be converted to a linear expression, typically a variable,
+                    a number of an expression.
+            ctsense: A constraint sense; accepts either a
+                    value of type `ComparisonType` or a string (e.g 'le', 'eq', 'ge').
+
+            name (string): An optional string to name the constraint.
+
+        :returns: An instance of :class:`docplex.mp.linear.LinearConstraint`.
+        """
+        return self._lfactory.new_binary_constraint(lhs, ctsense, rhs, name)

+
+
+    def not_equal_constraint(self, lhs, rhs, name=None):
+        return self._lfactory.new_neq_constraint(lhs, rhs, name)
+
+    def _create_engine_constraint(self, ct):
+        # INTERNAL
+        eng = self.__engine
+        if isinstance(ct, LinearConstraint):
+            return eng.create_linear_constraint(ct)
+        elif isinstance(ct, RangeConstraint):
+            return eng.create_range_constraint(ct)
+        elif isinstance(ct, IndicatorConstraint):
+            # here check whether linear ct is trivial. if yes do not send to CPLEX
+            indicator = ct
+            linct = indicator.linear_constraint
+            if linct.is_trivial():
+                is_feasible = linct._is_trivially_feasible()
+                if is_feasible:
+                    self.warning("Indicator constraint {0!s} has a trivially feasible constraint (no effect)",
+                                 indicator)
+                    return -2
+                else:
+                    self.warning(
+                        "indicator constraint {0!s} has a trivially infeasible constraint; variable invalidated",
+                        indicator)
+                    indicator.invalidate()
+                    return -4
+            return eng.create_logical_constraint(ct, is_equivalence=False)
+        elif isinstance(ct, EquivalenceConstraint):
+            return eng.create_logical_constraint(ct, is_equivalence=True)
+
+        elif isinstance(ct, QuadraticConstraint):
+            return eng.create_quadratic_constraint(ct)
+        elif isinstance(ct, PwlConstraint):
+            return eng.create_pwl_constraint(ct)
+        else:
+            self.fatal("Expecting binary constraint, indicator or range, got: {0!s}", ct)  # pragma: no cover
+
+    def _notify_trivial_constraint(self, ct, ctname, is_feasible):
+        self_trivial_warn_level = self._checker.check_trivial_constraints()
+        if is_feasible and self_trivial_warn_level > warn_trivial_feasible:
+            return
+        elif self_trivial_warn_level > warn_trivial_infeasible:
+            return
+        # ---
+        # hereafter we are sure to warn
+        if ct is None:
+            arg = None
+        # elif ctname:
+        #     arg = ctname
+        # elif ct.has_name():
+        #     arg = ct.name
+        else:
+            arg = str_maxed(ct, maxlen=24)
+        # ---
+        ct_typename = ct.short_typename if ct is not None else "constraint"
+        ct_rank = self.number_of_constraints + 1
+        # BEWARE: do not use if arg here
+        # because if arg is a constraint, boolean conversion won't work.
+        trivial_msg = "Adding trivially {3}feasible {2}: '{0!s}', pos: {1}"
+        if arg is not None:
+            if is_feasible:
+                self.info(trivial_msg, arg, ct_rank, ct_typename, '')
+            else:
+                self.error(trivial_msg, arg, ct_rank, ct_typename, 'in')
+                docplex_add_trivial_infeasible_ct_here()
+        else:
+            if is_feasible:
+                self.info(trivial_msg, '', ct_rank, ct_typename, '')
+            else:
+                self.error(trivial_msg, '', ct_rank, ct_typename, 'in')
+                docplex_add_trivial_infeasible_ct_here()
+
+    def _register_ct_name(self, ct, ctname, arg_checker):
+        checker = arg_checker or self._checker
+        if ctname:
+            ct_name_map = self._cts_by_name
+            if ct_name_map is not None:
+                checker.check_duplicate_name(ctname, ct_name_map, "constraint")
+                ct_name_map[ctname] = ct
+            ct._set_name(ctname)
+
+    def _prepare_constraint(self, ct, ctname, check_for_trivial_ct, arg_checker=None):
+        # INTERNAL
+        checker = arg_checker or self._checker
+        if ct is True:
+            # sum([]) == 0
+            self._notify_trivial_constraint(ct=None, ctname=ctname, is_feasible=True)
+            return False
+
+        elif ct is False:
+            # happens with sum([]) and constant e.g. sum([]) == 2
+            self._notify_trivial_constraint(ct=None, ctname=ctname, is_feasible=False)
+            msg = "Adding a trivially infeasible constraint"
+            if ctname:
+                msg += ' with name: {0}'.format(ctname)
+            # analogous to 0 == 1, model is sure to fail
+            self.fatal(msg)
+
+        else:
+            checker.typecheck_ct_to_add(ct, self, 'add_constraint')
+            # -- watch for trivial cts e.g. linexpr(0) <= linexpr(1)
+            if check_for_trivial_ct and ct.is_trivial():
+                if ct._is_trivially_feasible():
+                    self._notify_trivial_constraint(ct, ctname, is_feasible=True)
+                elif ct._is_trivially_infeasible():
+                    self._notify_trivial_constraint(ct, ctname, is_feasible=False)
+
+        # check for already posted cts.
+        if not self._check_new_ct_index(ct):
+            return False
+        # --- name management ---
+        self._register_ct_name(ct, ctname, checker)
+        # ---
+        return True
+
+    def _check_new_ct_index(self, ct):
+        ok = True
+        if ct._index >= 0:
+            self.warning("constraint has already been posted: {0!s}, index is: {1}", ct, ct.index)  # pragma: no cover
+            ok = False
+        return ok
+
+    def _check_trivial_constraints(self):
+        check_trivial = self._checker.check_trivial_constraints()
+        return check_trivial  < warn_trivial_none
+
+    def _add_constraint_internal(self, ct, ctname=None):
+        used_ct_name = None if self._ignore_names else ctname
+        if not isinstance(ct, AbstractConstraint) and hasattr(ct, 'as_logical_operand'):
+            ct1 = self._lfactory.logical_expr_to_constraint(ct, ctname)
+            return self._post_constraint(ct1)
+
+        check_trivial = self._check_trivial_constraints()
+        if self._prepare_constraint(ct, used_ct_name, check_for_trivial_ct=check_trivial):
+            self._post_constraint(ct)
+            return ct
+        elif ct is True or ct is False:
+            return None
+        else:
+            return ct
+
+    def _post_constraint(self, ct):
+        ct_engine_index = self._create_engine_constraint(ct)
+        self._register_one_constraint(ct, ct_engine_index, is_ctname_safe=True)
+        return ct
+
+    def _remove_constraint_internal(self, ct):
+        self._remove_constraints_internal(cts_to_remove=(ct,))
+
+    def _resolve_ct(self, ct_arg, silent=False, check_index=True, caller=None):
+        verbose = not silent
+        if caller:
+            s_caller = caller + ": "
+        else:
+            s_caller = ""
+
+        ct = None
+        if isinstance(ct_arg, AbstractConstraint):
+            ct = ct_arg
+        elif is_string(ct_arg):
+            ct = self.get_constraint_by_name(ct_arg)
+            if ct is None and verbose:
+                self.error("{0}no constraint with name: \"{1}\" - ignored", s_caller, ct_arg)
+
+        elif is_int(ct_arg):
+            if ct_arg >= 0:
+                ct_index = ct_arg
+                ct = self.get_constraint_by_index(ct_index)
+                if ct is None and verbose:
+                    self.error("{0}no constraint with index: \"{1}\" - ignored", s_caller, ct_arg)
+            else:
+                self.error("{0}not a valid index: \"{1}\" - ignored", s_caller, ct_arg)
+        else:
+            if verbose:
+                self.error("{0}unexpected argument {1!s}, expecting string or constraint", s_caller, ct_arg)
+        if ct is not None and ct.has_valid_index() or not check_index:
+            return ct
+        else:
+            return None
+
+
[docs]    def remove_constraint(self, ct_arg):
+        """ Removes a constraint from the model.
+
+        Args:
+            ct_arg: The constraint to remove. Accepts either a constraint object or a string.
+                If passed a string, looks for a constraint with that name.
+
+        """
+        ct = self._resolve_ct(ct_arg, silent=False, caller="remove_constraint")
+        if ct is not None:
+            self._checker.typecheck_in_model(self, ct, caller="constraint")
+            self._remove_constraints_internal(cts_to_remove=(ct,))

+
+
[docs]    def clear_constraints(self):
+        """
+        This method removes all constraints from the model.
+        """
+        self.__engine.remove_constraints(cts=None)  # special case to denote all
+        # clear containers
+        self._cts_by_name = None
+        # clear constraint index scopes.
+        for ctscope in self._iter_constraint_scopes():
+            ctscope.clear()

+
+
[docs]    def remove_constraints(self, cts=None, error='warn'):
+        """
+        This method removes a batch of constraints from the model.
+
+        :param cts: an iterable of constraints (linear, range, quadratic, indicators)
+        """
+        if cts is not None:
+            # resolve constraints
+            if not is_iterable(cts):
+                self.fatal("Model.remove_constraints expects an iterable with constraints or strings")
+            lcts = []
+
+            for cta in cts:
+                ct = self._resolve_ct(cta, silent=True, caller='Model.remove_constraints')
+                if ct is not None:
+                    lcts.append(ct)
+                elif error == 'raise':
+                    self.fatal("Model.remove_constraints: cannot resolve this as a constraint: {0}", repr(cta))
+                elif error == 'warn':
+                    self.warning("Model.remove_constraints: cannot resolve this as a constraint: {0}", repr(cta))
+
+            self._remove_constraints_internal(lcts)

+
+    def _remove_constraints_internal(self, cts_to_remove):
+        if cts_to_remove:
+            assert all(ct_.has_valid_index() for ct_ in cts_to_remove)
+            self.__engine.remove_constraints(cts_to_remove)
+            # INTERNAL
+            self_cts_by_name = self._cts_by_name
+
+            if self_cts_by_name:
+                for d in cts_to_remove:
+                    dname = d.name
+                    if dname:
+                        try:
+                            del self_cts_by_name[dname]
+                        except KeyError:
+                            pass
+
+            actual_touched_scopes = set()
+            #removed_ids = set()
+            from collections import defaultdict
+            idxs_by_scope = defaultdict(set)
+            for d in cts_to_remove:
+                #removed_ids.add(id(d))
+                idxs_by_scope[d.cplex_scope].add(d.index)
+                actual_touched_scopes.add(d._get_index_scope())
+
+            for sc, delset in idxs_by_scope.items():
+                scope = self._get_obj_scope(sc)
+                scope.notify_delete_set(delset)
+
+            for d in cts_to_remove:
+                d.notify_deleted()
+
+        if self.is_docplex_debug():
+            for sc in self._iter_constraint_scopes():
+                sc.check_indices()
+
+
[docs]    def remove(self, removed):
+        """
+        This method removes a constraint or a collection of constraints from the model.
+
+        :param removed: accapts either a constraint or an iterable on constraints (linear, range, quadratic, indicators)
+        """
+        if is_iterable(removed):
+            self.remove_constraints(removed)
+        else:
+            self.remove_constraint(removed)

+
+
[docs]    def add_range(self, lb, expr, ub, rng_name=None):
+        """ Adds a new range constraint to the model.
+
+        A range constraint states that a linear
+        expression has to stay within an interval `[lb..ub]`.
+        Both `lb` and `ub` have to be float numbers with `lb` smaller than `ub`.
+
+        The method creates a new range constraint and adds it to the model.
+
+        Args:
+            lb (float): A floating-point number.
+            expr: A linear expression, e.g. X+Y+Z.
+            ub (float): A floating-point number, which should be greater than `lb`.
+            rng_name (string): An optional name for the range constraint.
+
+        :returns: The newly created range constraint.
+        :rtype: :class:`docplex.mp.constr.RangeConstraint`
+
+        Raises:
+            An exception if `lb` is greater than `ub`.
+
+        """
+        rng = self.range_constraint(lb, expr, ub)
+        ctname = None if self._ignore_names else rng_name
+        ct = self._add_constraint_internal(rng, ctname)
+        return ct

+
+
[docs]    def indicator_constraint(self, binary_var, linear_ct, active_value=1, name=None):
+        """ Creates and returns a new indicator constraint.
+
+        The indicator constraint is not added to the model.
+
+        Args:
+            binary_var: The binary variable used to control the satisfaction of the linear constraint.
+            linear_ct: A linear constraint (EQ, LE, GE).
+            active_value: 0 or 1. The value used to trigger the satisfaction of the constraint. The default is 1.
+            name (string): An optional name for the indicator constraint.
+
+        :return:
+            The newly created indicator constraint.
+        """
+        self._checker.typecheck_binary_var(binary_var)
+        self._checker.typecheck_linear_constraint(linear_ct)
+        self._checker.typecheck_zero_or_one(active_value)
+        self._checker.typecheck_in_model(self, binary_var, caller="binary variable")
+        self._checker.typecheck_in_model(self, linear_ct, caller="linear_constraint")
+        return self._lfactory.new_indicator_constraint(binary_var, linear_ct, active_value, name)

+
+
+
[docs]    def add_indicator(self, binary_var, linear_ct, active_value=1, name=None):
+        """ Adds a new indicator constraint to the model.
+
+        An indicator constraint links (one-way) the value of a binary variable to
+        the satisfaction of a linear constraint.
+        If the binary variable equals the active value, then the constraint is satisfied, but
+        otherwise the constraint may or may not be satisfied.
+
+        Args:
+             binary_var: The binary variable used to control the satisfaction of the linear constraint.
+             linear_ct: A linear constraint (EQ, LE, GE).
+             active_value: 0 or 1. The value used to trigger the satisfaction of the constraint. The default is 1.
+             name (string): An optional name for the indicator constraint.
+
+        Returns:
+            The newly created indicator constraint.
+        """
+        self._checker.typecheck_string(name, accept_none=True)
+        iname = None if self._ignore_names else name
+        indicator = self.indicator_constraint(binary_var, linear_ct, active_value)
+        return self._add_indicator(indicator, iname)

+
+    _indicator_trivial_feasible_idx = -2
+    _indicator_trivial_infeasible_idx = -4
+
+    def _add_indicator(self, indicator, ind_name, check_trivials=False):
+        # INTERNAL
+        linear_ct = indicator.linear_constraint
+        if check_trivials and self._checker.check_trivial_constraints() and linear_ct.is_trivial():
+            is_feasible = linear_ct._is_trivially_feasible()
+            if is_feasible:
+                self.warning("Indicator constraint {0!s} has a trivial feasible linear constraint (has no effect)",
+                             indicator)
+                return self._indicator_trivial_feasible_idx
+            else:
+                self.warning("indicator constraint {0!s} has a trivial infeasible linear constraint - invalidated",
+                             indicator)
+                indicator.invalidate()
+                return self._indicator_trivial_infeasible_idx
+        else:
+            return self._add_constraint_internal(indicator, ind_name)
+
+
[docs]    def add_equivalence(self, binary_var, linear_ct, true_value=1, name=None):
+        """ Adds a new equivalence constraint to the model.
+
+        An equivalence constraints links two-way the value of a binary variable to
+        the satisfaction of a discrete linear constraint.
+        If the binary variable equals the true value, then the constraint is satisfied,
+        conversely if the constraint is satisfied, the binary variable is equal to the true value.
+
+        Args:
+             binary_var: The binary variable used to control the satisfaction of the linear constraint.
+             linear_ct: A linear constraint (EQ, LE, GE).
+             true_value: 0 or 1. The value used to trigger the satisfaction of the constraint. The default is 1.
+             name (string): An optional name for the equivalence constraint.
+
+        Returns:
+            The newly created equivalence constraint.
+        """
+        equiv = self.equivalence_constraint(binary_var, linear_ct, true_value, name=None)
+        eq_name = None if self.ignore_names else name
+        eqct = self._add_constraint_internal(equiv, eq_name)
+        return eqct

+
+
[docs]    def equivalence_constraint(self, binary_var, linear_ct, true_value=1, name=None):
+        """ Creates and returns a new equivalence constraint.
+
+        The newly created equivalence constraint is not added to the model.
+
+        Args:
+             binary_var: The binary variable used to control the satisfaction of the linear constraint.
+             linear_ct: A linear constraint (EQ, LE, GE).
+             true_value: 0 or 1. The value used to mark the satisfaction of the constraint. The default is 1.
+             name (string): An optional name for the equivalence constraint.
+
+        Returns:
+            The newly created equivalence constraint.
+        """
+        checker = self._checker
+        checker.typecheck_binary_var(binary_var)
+        checker.typecheck_linear_constraint(linear_ct)
+        checker.typecheck_zero_or_one(true_value)
+        checker.typecheck_in_model(self, binary_var, caller="binary variable")
+        checker.typecheck_in_model(self, linear_ct, caller="linear_constraint")
+        checker.typecheck_string(name, accept_empty=True, accept_none=True)
+        StaticTypeChecker.typecheck_discrete_constraint(self, linear_ct,
+                                                        msg='Model.add_equivalence() requires a discrete constraint')
+        used_name = None if self.ignore_names else name
+        equiv = self._lfactory.new_equivalence_constraint(binary_var, linear_ct, true_value, used_name)
+        return equiv

+
+
[docs]    def add_equivalences(self, binary_vars, cts, true_values=1, names=None):
+        """ Adds a batch of equivalence constraints to the model.
+
+        This method adds a batch of equivalence constraints to the model.
+
+        :param binary_vars: a sequence of binary variables.
+        :param cts: a sequence of discrete linear constraints
+        :param true_values: the true values to use. Accepts either 1, 0 or a sequence of {0, 1} values.
+        :param names: an optional sequence of names
+
+        All sequences must have the same length.
+
+        :return: a list of equivalence constraints.
+        """
+        return self._add_batch_logical_cts(binary_vars, cts, names, true_values, is_equivalence=True,
+                                           caller='Model.add_equivalences')

+
+
[docs]    def add_indicators(self, binary_vars, cts, true_values=1, names=None):
+        """ Adds a batch of indicator constraints to the model.
+
+        This method adds a batch of indicator constraints to the model.
+
+        :param binary_vars: a sequence of binary variables.
+        :param cts: a sequence of discrete linear constraints
+        :param true_values: the true values to use. Accepts either 1, 0 or a sequence of {0, 1} values.
+        :param names: an optional sequence of names
+
+        All sequences must have the same length.
+
+        :return: a list of indicator constraints.
+        """
+        return self._add_batch_logical_cts(binary_vars, cts, names, true_values, is_equivalence=False,
+                                           caller='Model.add_indicators')

+
+    def _add_batch_logical_cts(self, binary_vars, cts, names, true_values, is_equivalence, caller=''):
+        # internal
+        checker = self._checker
+        bvars = checker.typecheck_var_seq(binary_vars, vtype='B', caller=caller)
+        ctseq = checker.typecheck_constraint_seq(cts, check_linear=True)
+        try:
+            n_vars = len(bvars)
+            n_cts = len(cts)
+        except TypeError:
+            # if passed iterators, no len()
+            bvars = list(bvars)
+            ctseq = list(ctseq)
+            n_vars = len(bvars)
+            n_cts = len(ctseq)
+
+        if n_vars != n_cts:
+            self.fatal('Model.add_equivalences(): binary_vars and linear cts must have same size.')
+
+        if true_values == 0 or true_values == 1:
+            actual_true_values = generate_constant(true_values, n_vars)
+
+        elif is_iterable(true_values):
+            actual_true_values = list(true_values)
+            if len(actual_true_values) != n_vars:
+                self.fatal('Model.add_equivalences(): true_values has wrong size. expecting: {0}, got: {1}'
+                           .format(n_vars, len(actual_true_values)))
+            for a in actual_true_values:
+                checker.typecheck_zero_or_one(a)
+        else:
+            self.fatal('Model.add_equivalence(): true_values expects 0|1 or sequence of {{0, 1}}, got: {0!r}'.format(true_values))
+
+        if names is not None and not self._ignore_names:
+            c_names = checker.typecheck_string_seq(names, accept_none=True, accept_empty=True, caller=caller)
+            used_names = [n or '' for n in c_names]
+            #     checker.typecheck_string(n, accept_empty=False, accept_none=True)
+            #     used_names.append(n or '')
+        else:
+            used_names = generate_constant(None, n_vars)
+
+        if is_equivalence:
+            # check discrete
+            lcts = list(ctseq)
+            caller = "Model.add_equivalences" if is_equivalence else "Model.add_indicators"
+            caller += " requires an iterable of discrete constraints"
+            for ct in lcts:
+                StaticTypeChecker.typecheck_discrete_constraint(self, ct, caller)
+            eqcts = self._lfactory.new_batch_equivalence_constraints(bvars, lcts, actual_true_values, used_names)
+            self.add_equivalence_constraints_(eqcts)
+            return eqcts
+        else:
+            indcts = self._lfactory.new_batch_indicator_constraints(bvars, ctseq, actual_true_values, used_names)
+            self.add_indicator_constraints_(indcts)
+            return indcts
+
+
[docs]    def add_indicator_constraints(self, indcts):
+        """ Adds a batch of indicator constraints to the model
+
+        :param indcts: an iterable returning indicator constraints.
+
+        See Also:
+            :func:`indicator_constraint`
+        """
+        ind_cts_list_ = list(indcts)
+        self._checker.typecheck_logical_constraint_seq(ind_cts_list_, true_if_equivalence=False)
+        ind_indices = self.__engine.create_batch_logical_constraints(ind_cts_list_, is_equivalence=False)
+        self._register_block_cts(self._logical_scope, ind_cts_list_, ind_indices)
+        return ind_cts_list_

+
+    add_indicator_constraints_ = add_indicator_constraints
+
+
[docs]    def add_equivalence_constraints(self, eqcts):
+        """ Adds a batch of equivalence constraints to the model
+
+        :param eqcts: an iterable returning equivalence constraints.
+
+        See Also:
+            :func:`equivalence_constraint`
+        """
+        eqcts_list_ = list(eqcts)  # the list is traversed twice
+        self._checker.typecheck_logical_constraint_seq(eqcts_list_, true_if_equivalence=True)
+        eq_indices = self.__engine.create_batch_logical_constraints(eqcts_list_, is_equivalence=True)
+        self._register_block_cts(self._logical_scope, eqcts_list_, eq_indices)
+        return eqcts_list_

+
+    add_equivalence_constraints_ = add_equivalence_constraints
+
+
[docs]    def if_then(self, if_ct, then_ct, negate=False):
+        """ Creates and returns an if-then constraint.
+
+        An if-then constraint links two constraints ct1, ct2 such that when ct1 is satisfied then ct2 is also satisfied.
+
+        :param if_ct: a linear constraint, the satisfaction of which governs the satisfaction of the `then_ct`
+        :param then_ct: a linear constraint, which becomes satisfied as soon as `if_ct` is satisfied
+            (or when it is not, depending on the `negate` flag).
+        :param negate: an optional boolean flag (default is False). If True, `then_ct` is satisfied when `if_ct` is *not* satisfied.
+
+        :return:
+            an instance of IfThenConstraint, that is not added to the model.
+            Use Model.add_constraint() or Model.add() to add it to the model.
+
+        Note:
+            This constraint relies on the status of the `if_ct` constraint, so this constraint must be discrete,
+            otherwise an exception will be raised.
+        """
+        checker = self._checker
+        checker.typecheck_linear_constraint(if_ct)
+        checker.typecheck_linear_constraint(then_ct)
+        StaticTypeChecker.typecheck_discrete_constraint(logger=self, ct=if_ct, msg='Model.if_then()')
+        return self._lfactory.new_if_then_constraint(if_ct, then_ct, bool(negate))

+
+
[docs]    def add_if_then(self, if_ct, then_ct, negate=False):
+        """ Creates a new if-then constraint and adds it to the model
+
+        :param if_ct: a linear constraint, the satisfaction of which governs the satisfaction of the `then_ct`
+        :param then_ct: a linear constraint, which becomes satisfied as soon as `if_ct` is satisfied
+            (or when it is not, depending on the `negate` flag).
+        :param negate: an optional boolean flag (default is False). If True, `then_ct` is satisfied when `if_ct` is *not* satisfied.
+
+        :return:
+            an instance of IfThenConstraint.
+
+        Note:
+            This constraint relies on the status of the `if_ct` constraint, so this constraint must be discrete,
+            otherwise an exception will be raised. On the opposite, the `then_ct` constraint may be non-discrete.
+
+            Also note that this construct relies on the status variable of the `if_ct`, so one extra binary variable is generated.
+
+            *New in 2.16*: when `if_ct` is of the form `bvar == 1` or `bvar ==0`, where `bvar` is a binary variable,
+             , no extra variable is generated, and a plain indicator constraint is generated.
+
+            An alternative syntax is to use the `>>` operator on linear constraints:
+
+                >>> m.add(c1 >> c2)
+
+            is exactly equivalent to:
+
+                >>> m.add_if_then(c1, c2)
+
+
+        """
+        ifthen_ct = self.if_then(if_ct, then_ct, negate=negate)
+        return self._post_constraint(ifthen_ct)

+
+
[docs]    def range_constraint(self, lb, expr, ub, rng_name=None):
+        """ Creates a new range constraint but does not add it to the model.
+
+        A range constraint states that a linear
+        expression has to stay within an interval `[lb..ub]`.
+        Both `lb` and `ub` have to be floating-point numbers with `lb` smaller than `ub`.
+
+        The method creates a new range constraint but does not add it to the model.
+
+        Args:
+            lb: A floating-point number.
+            expr: A linear expression, e.g. X+Y+Z.
+            ub: A floating-point number, which should be greater than `lb`.
+            rng_name: An optional name for the range constraint.
+
+        Returns:
+            The newly created range constraint.
+        Raises:
+             An exception if `lb` is greater than `ub`.
+
+        """
+        self._checker.typecheck_num(lb, 'Model.range_constraint')
+        self._checker.typecheck_num(ub, 'Model.range_constraint')
+        self._checker.typecheck_string(rng_name, accept_empty=False, accept_none=True)
+        rng = self._lfactory.new_range_constraint(lb, expr, ub, rng_name)
+        return rng

+
+
[docs]    def add_constraint(self, ct, ctname=None):
+        """ Adds a new linear constraint to the model.
+
+        Args:
+            ct: A linear constraint of the form <expr1> <op> <expr2>, where both expr1 and expr2 are
+                 linear expressions built from variables in the model, and <op> is a relational operator
+                 among <= (less than or equal), == (equal), and >= (greater than or equal).
+            ctname (string): An optional string used to name the constraint.
+
+        Returns:
+            The newly added constraint.
+
+        See Also:
+            :func:`add_constraint_`
+        """
+        ct = self._add_constraint_internal(ct, ctname)
+        return ct

+
+
[docs]    def add_constraint_(self, ct, ctname=None):
+        """ Adds a new linear constraint to the model.
+
+        Args:
+            ct: A linear constraint of the form <expr1> <op> <expr2>, where both expr1 and expr2 are
+                 linear expressions built from variables in the model, and <op> is a relational operator
+                 among <= (less than or equal), == (equal), and >= (greater than or equal).
+            ctname (string): An optional string used to name the constraint.
+
+        Note:
+            This method does the same as `docplex.mp.model.Model.add_constraint()` except that it has no return value.
+
+        See Also:
+            :func:`add_constraint`
+        """
+        self._add_constraint_internal(ct, ctname)

+
+    def add(self, ct, name=None):
+        if is_iterable(ct):
+            return self.add_constraints(ct, name)
+        else:
+            return self.add_constraint(ct, name)
+
+    def add_(self, ct, name=None):
+        if is_iterable(ct):
+            self.add_constraints_(ct, name)
+        else:
+            self.add_constraint_(ct, name)
+
+
[docs]    def add_constraints(self, cts, names=None):
+        """ Adds a batch of linear constraints to the model in one operation.
+
+        Each constraint from the `cts` iterable is added to the model.
+        If present, the `names` iterable is used to set names to the constraints.
+
+        Example:
+                # list
+                >>> m.add_constraints([x >= 1, y<= 3], ["c1", "c2"])
+                # comprehension
+                >>> m.add_constraints((xs[i] >= i for i in range(N)))
+
+        Args:
+            cts: An iterable of linear constraints; can be a list, a set or a comprehensions.
+                Any Python object, which can be iterated on and yield consttraint objects.
+            names: An optional iterable on strings. ANy Python object which can be iterated on
+                and yield strings. The default value is None, meaning no names are set.
+
+        Returns:
+            A list of the newly added constraints.
+
+        Note:
+            This method handles only linear constraints (including range constraints). To add
+        multiple quadratic constraints, see :func:`add_quadratic_constraints`
+
+        See Also:
+            :func:`add_constraints_`
+
+        """
+        self._checker.typecheck_iterable(cts)
+        if names is not None and not self.ignore_names:
+            if not is_iterable(names) or (is_string(names) and not names):
+                self.fatal("Model.add_constraints() expects a sequence of strings or a non-empty string")
+            return self._lfactory._new_constraint_block2(cts, names)
+        else:
+            return self._lfactory._new_constraint_block1(cts)

+
+
+    def vector_compare(self, lhss, rhss, sense):
+        l_lhs = ordered_sequence_to_list(lhss, caller='Model.vector.compare')
+        l_rhs = ordered_sequence_to_list(rhss, caller='Model.vector.compare')
+        if len(l_lhs) != len(l_rhs):
+            self.fatal('Model.vector_compare() requires two lists with same length, left size: {0}, right size: {1}'.
+                       format(len(l_lhs), len(l_rhs)))
+        ctsense = ComparisonType.parse(sense)
+        return self._aggregator._vector_compare(l_lhs, l_rhs, ctsense)
+
+    def vector_compare_le(self, lhss, rhss):
+        return self.vector_compare(lhss, rhss, 'le')
+
+    def vector_compare_ge(self, lhss, rhss):
+        return self.vector_compare(lhss, rhss, 'ge')
+
+    def vector_compare_eq(self, lhss, rhss):
+        return self.vector_compare(lhss, rhss, 'eq')
+
+    def _new_xconstraint(self, lhs, rhs, comparaison_type):
+        isquad = False
+        if self._quad_count:
+            try:
+                isquad = rhs.is_quad_expr()
+            except AttributeError:
+                pass
+        if isquad:
+            return self._qfactory._new_qconstraint(lhs, comparaison_type, rhs)
+        else:
+            return self._lfactory._new_binary_constraint(lhs, comparaison_type, rhs)
+
+
[docs]    def add_constraints_(self, cts, names=None):
+        """ Adds a batch of linear constraints to the model in one operation.
+
+        Same as `docplex.model.Model.add_constraints()` except that is does not return anything.
+        """
+        self._checker.typecheck_iterable(cts)
+        if names is not None and not self.ignore_names:
+            self._lfactory._new_constraint_block2(cts, names)
+        else:
+            self._lfactory._new_constraint_block1(cts)

+
+
+    def add_ranges(self, lbs, exprs, ubs, names=None):
+        checker = self._checker
+        lbsl = checker.typecheck_num_seq(lbs, caller="Model.add_ranges.lbs")
+        ubsl = checker.typecheck_num_seq(ubs, caller="Model.add_ranges.ubs")
+        checker.typecheck_iterable(exprs)
+        range_names = names if names and not self.ignore_names else None
+        return self._lfactory.new_range_block(lbsl, exprs, ubsl, range_names)
+
+    def _post_quadratic_constraint(self, qct):
+        qcx = self.__engine.create_quadratic_constraint(qct)
+        self._register_one_constraint(qct, qcx, is_ctname_safe=True)
+        return qct
+
+
[docs]    def add_quadratic_constraints(self, qcs):
+        """ Adds a batch of quadratic contraints in one call.
+
+        :param qcs: an iterable on a quadratic constraints.
+
+        Note:
+            The `Model.add_constraints` method handles only linear constraints.
+
+        New in version 2.16*
+        """
+        lqcs = self._checker.typecheck_quadratic_constraint_seq(qcs)
+        for qc in lqcs:
+            self._post_quadratic_constraint(qc)

+
+    # ----------------------------------------------------
+    # objective
+    # ----------------------------------------------------
+
+
[docs]    def minimize(self, expr):
+        """ Sets an expression as the expression to be minimized.
+
+        The argument is converted to a linear expression. Accepted types are variables (instances of
+        :class:`docplex.mp.dvar.Var` class), linear expressions (instances of
+        :class:`docplex.mp.linear.LinearExpr`), or numbers.
+
+        :param expr: A linear expression or a variable.
+        """
+        self.set_objective(ObjectiveSense.Minimize, expr)

+
+
[docs]    def maximize(self, expr):
+        """
+        Sets an expression as the expression to be maximized.
+
+        The argument is converted to a linear expression. Accepted types are variables (instances of
+        :class:`docplex.mp.dvar.Var` class), linear expressions (instances of
+        :class:`docplex.mp.linear.LinearExpr`), or numbers.
+
+        :param expr: A linear expression or a variable.
+        """
+        self.set_objective(ObjectiveSense.Maximize, expr)

+
+    def _make_lex_priorities(self, nb_objectives):
+        # INTERNAL
+        return list(range(nb_objectives-1, -1, -1))
+
+    def _compile_multiobj_expr_list(self, exprs, caller, accept_empty=False):
+        # INTERNAL
+        # converts an exprs argument to a (possibly empty) list of expressions.
+        # no side-effect is performed here, the caller has to take action.
+        caller_string = "{0} ".format(caller) if caller is not None else ""
+        if not exprs:
+            if accept_empty:
+                self.warning("{0}requires a non-empty list of linear expressions, got: {1!r}",
+                             caller_string, exprs)
+                return []
+            else:
+                self.fatal("{0}requires a non-empty list of linear expressions, got: {1!r}",
+                             caller_string, exprs)
+        if is_indexable(exprs):
+            try:
+                exprs = [self._lfactory._to_linear_operand(x) for x in exprs]
+                return exprs
+
+            except (TypeError, DOcplexException):
+                pass
+        self.fatal(
+            "{0}requires an indexable sequence of linear expressions, {1!r} was passed",
+            caller_string, exprs)
+
+
+    @classmethod
+    def supports_multi_objective(cls):
+        return cls()._supports_multi_objective()
+
+    def _supports_multi_objective(self):
+        # INTERNAL
+        ok, _ = self.__engine.supports_multi_objective()
+        return ok
+
+    def _check_multi_objective_support(self):
+        # INTERNAL
+        ok, why = self.__engine.supports_multi_objective()
+        if not ok:
+            assert why
+            self.fatal(msg=why)
+
+
[docs]    def minimize_static_lex(self, exprs, abstols=None, reltols=None, objnames=None):
+        """ Sets a list of expressions to be minimized in a lexicographic solve.
+        exprs must be an ordered sequence of objective functions, that are minimized.
+
+        The argument is converted to a list of linear expressions. Accepted types for the list elements are variables
+        (instances of :class:`docplex.mp.dvar.Var` class), linear expressions (instances of
+        :class:`docplex.mp.linear.LinearExpr`), or numbers.
+
+        Warning:
+           This method requires CPLEX 12.9 or higher
+
+        Args:
+            exprs: a list of linear expressions or variables
+            abstols: if defined, a list of absolute tolerances having the same size as the `exprs` argument.
+            reltols: if defined, a list of relative tolerances having the same size as the `exprs` argument.
+            objnames:  if defined, a list of names for objectives having the same size as the `exprs` argument.
+
+
+        *New in version 2.9*
+        """
+        self._set_lex_multi_objective(ObjectiveSense.Minimize, exprs, abstols=abstols, reltols=reltols, names=objnames,
+                                     caller='Model.minimize_static_lex()')

+
+
+
[docs]    def maximize_static_lex(self, exprs, abstols=None, reltols=None, objnames=None):
+        """ Sets a list of expressions to be maximized in a lexicographic solve.
+        exprs defines an ordered sequence of objective functions that are maximized.
+
+        The argument is converted to a list of linear expressions. Accepted types for the list elements are variables
+        (instances of :class:`docplex.mp.dvar.Var` class), linear expressions (instances of
+        :class:`docplex.mp.linear.LinearExpr`), or numbers.
+
+        Warning:
+            This method requires CPLEX 12.9 or higher
+
+        Args:
+            exprs: a list of linear expressions or variables
+            abstols: if defined, a list of absolute tolerances having the same size as the `exprs` argument.
+            reltols: if defined, a list of relative tolerances having the same size as the `exprs` argument.
+            objnames:  if defined, a list of names for objectives having the same size as the `exprs` argument.
+
+
+        *New in version 2.9*
+        """
+        self._set_lex_multi_objective(ObjectiveSense.Maximize, exprs, abstols=abstols, reltols=reltols, names=objnames,
+                                     caller='Model.maximize_static_lex()')

+
+
+
[docs]    def is_minimized(self):
+        """ Checks whether the model is a minimization model.
+
+        Note:
+            This returns True even if the expression to minimize is a constant.
+            To check whether the model has a non-constant objective, use :func:`is_optimized`.
+
+        Returns:
+           Boolean: True if the model is a minimization model.
+        """
+        return self._objective_sense is ObjectiveSense.Minimize

+
+
[docs]    def is_maximized(self):
+        """ Checks whether the model is a maximization model.
+
+        Note:
+           This returns True even if the expression to maximize is a constant.
+           To check whether the model has a non-constant objective, use :func:`is_optimized`.
+
+        Returns:
+            Boolean: True if the model is a maximization model.
+        """
+        return self._objective_sense is ObjectiveSense.Maximize

+
+
[docs]    def objective_coef(self, dvar):
+        """ Returns the objective coefficient of a variable.
+
+        The objective coefficient is the coefficient of the given variable in
+        the model's objective expression. If the variable is not explicitly
+        mentioned in the objective, it returns 0.
+
+        :param dvar: The decision variable for which to compute the objective coefficient.
+
+        Returns:
+            float: The objective coefficient of the variable.
+        """
+        self._checker.typecheck_var(dvar)
+        return self._objective_coef(dvar)

+
+    def _objective_coef(self, dvar):
+        return self._objective_expr.unchecked_get_coef(dvar)
+
+
[docs]    def remove_objective(self):
+        """ Clears the current objective.
+
+        This is equivalent to setting "minimize 0".
+        Any subsequent solve will look only for a feasible solution.
+        You can detect this state by calling :func:`has_objective` on the model.
+
+        """
+        self.set_objective(self.default_objective_sense, self._new_default_objective_expr())

+
+
[docs]    def is_optimized(self):
+        """ Checks whether the model has a non-constant objective expression.
+
+        A model with a constant objective will only search for a feasible solution when solved.
+        This happens either if no objective has been assigned to the model,
+        or if the objective has been removed with :func:`remove_objective`.
+
+        Returns:
+            Boolean: True, if the model has a non-constant objective expression.
+
+        """
+        return self.has_multi_objective() or not self._objective_expr.is_constant()

+
+
[docs]    def set_multi_objective(self, sense, exprs, priorities=None, weights=None,
+                            abstols=None, reltols=None,
+                            names=None):
+        """ Sets a list of objectives.
+
+        Warning:
+            This method requires CPLEX 12.9 or higher
+
+        Args:
+            sense: Either an instance of :class:`docplex.mp.basic.ObjectiveSense` (Minimize or Maximize),
+                or a string: "min" or "max".
+            exprs: Is converted to a list of expressions. Accepted types for this list items are variables,
+                linear expressions or numbers.
+            priorities: a list of priorities having the same size as the `exprs` argument. Priorities
+                define how objectives are grouped together into sub-problems, and in which order these sub-problems
+                are solved (in decreasing order of priorities). If not defined, allexpressions are assumed to share the same priority,
+                and are combined with `weights`.
+            weights: if defined, a list of weights having the same size as the `exprs` argument. Weights define
+                how objectives with same priority are blended together to define the associated sub-problem's
+                objective that is optimized. If not defined, weights are assumed to be all equal to 1.
+            abstols: if defined, a list of absolute tolerances having the same size as the `exprs` argument.
+            reltols: if defined, a list of relative tolerances having the same size as the `exprs` argument.
+            names:  if defined, a list of names for objectives having the same size as the `exprs` argument.
+
+        Note:
+            When using a number for an objective, the search will not optimize but only look for a feasible solution.
+
+        *New in version 2.9.*
+        """
+        self.set_objective_sense(sense)
+        self._set_multi_objective_exprs(exprs, priorities=priorities, weights=weights,
+                                        abstols=abstols, reltols=reltols, names=names,
+                                        caller='Model.set_multi_objective()')

+
+
[docs]    def set_lex_multi_objective(self, sense, exprs, abstols=None, reltols=None, names=None):
+        """ Sets a list of objectives to be solved in a lexicographic fashion.
+
+        Objective expressions are listed in decreasing priority.
+
+        Warning:
+            This method requires CPLEX 12.9 or higher
+
+        Args:
+            sense: Either an instance of :class:`docplex.mp.basic.ObjectiveSense` (Minimize or Maximize),
+                or a string: "min" or "max".
+            exprs: Is converted to a list of expressions. Accepted types for this list items are variables,
+                linear expressions or numbers.
+
+            abstols: if defined, a list of absolute tolerances having the same size as the `exprs` argument.
+            reltols: if defined, a list of relative tolerances having the same size as the `exprs` argument.
+            names:  if defined, a list of names for objectives having the same size as the `exprs` argument.
+
+        Note:
+            When using a number for an objective, the search will not optimize but only look for a feasible solution.
+
+        *New in version 2.9.*
+        """
+        self._set_lex_multi_objective(sense, exprs, abstols=abstols, reltols=reltols, names=names, caller='Model.set_lex_multi_objective')

+
+    def _set_lex_multi_objective(self, sense, exprs, abstols, reltols, names, caller):
+        # INTERNAL
+        self.set_objective_sense(sense)
+        lex_exprs = self._compile_multiobj_expr_list(exprs, caller=caller, accept_empty=False)
+        lex_priorities = self._make_lex_priorities(len(exprs))
+        self._set_multi_objective_internal(lex_exprs, priorities=lex_priorities,
+                                           weights=None,
+                                           abstols=abstols, reltols=reltols, names=names,
+                                           caller=caller)
+
+
[docs]    def set_multi_objective_exprs(self, exprs, priorities=None, weights=None,
+                                  abstols=None, reltols=None, names=None):
+        """ Defines a list of blended objectives.
+
+        Objectives with the same priority are combined using weights. Then, objectives are optimized in a
+        lexicographic fashion by decreasing priority.
+
+        Args:
+            exprs: Is converted to a list of linear expressions. Accepted types for this list items are variables,
+                linear expressions or numbers.
+            priorities: if defined, a list of priorities having the same size as the `exprs` argument. Priorities
+                define how objectives are grouped together into sub-problems, and in which order these sub-problems
+                are solved (in decreasing order of priorities).
+            weights: if defined, a list of weights having the same size as the `exprs` argument. Weights define
+                how objectives with same priority are blended together to define the associated sub-problem
+                objective that is optimized.
+            abstols: if defined, a list of absolute tolerances having the same size as the `exprs` argument.
+            reltols:if defined, a list of relative tolerances having the same size as the `exprs` argument.
+            names: if defined, a list of names for objectives having the same size as the `exprs` argument.
+
+        Note:
+            When using a number for an objective, the search will not optimize but only look for a feasible solution.
+
+        *New in version 2.9.*
+        """
+        self._set_multi_objective_exprs(exprs, priorities, weights, abstols, reltols, names, caller='Model.set_multi_objective()')

+
+    def _set_multi_objective_exprs(self, exprs, priorities=None, weights=None,
+                                  abstols=None, reltols=None, names=None, caller=None):
+        exprs_ = self._compile_multiobj_expr_list(exprs, accept_empty=False, caller=caller)
+        if priorities:
+            # check an array of len(exprs)
+            priorities_ =  priorities
+        else:
+            priorities_ = [1] * len(exprs_)
+
+        self._set_multi_objective_internal(exprs_, priorities=priorities_, weights=weights,
+                                           abstols=abstols, reltols=reltols, names=names, clear_objective=True,
+                                           caller=caller)
+
+    def _set_multi_objective_internal(self, exprs, priorities, weights,
+                                      abstols, reltols,
+                                      names, clear_objective=True, caller=None):
+        # INTERNAL: assumes exprs is a valid list of linear expressions
+        if 1 == len(exprs):
+            expr0 = exprs[0]
+            self.warning('Multi-objective has been converted to single objective: {0}', str_maxed(expr0, maxlen=16))
+            self.set_objective_expr(expr0)
+        else:
+            for x in exprs:
+                x.notify_used(self)
+            if self.has_objective() and clear_objective:
+                self._clear_objective_expr()
+
+            def refine_caller(caller_, qualifier):
+                if not caller_:
+                    return caller_
+                elif caller_[-1] == ')':
+                    return '%s.%s' % (caller_[:-2], qualifier)
+                else:
+                    return '%s.%s' % (caller_, qualifier)
+
+            abstols_ = self._typecheck_optional_num_seq(abstols, accept_none=True, caller=refine_caller(caller, 'abstols'))
+            reltols_ = self._typecheck_optional_num_seq(reltols, accept_none=True, caller=refine_caller(caller, 'reltols'))
+            self._set_engine_multi_objective_exprs(exprs, priorities, weights, abstols_, reltols_, names)
+            self._multi_objective.update(exprs, priorities, weights, abstols, reltols, names)
+
+    def _clear_multi_objective(self):
+        # INTERNAL
+        zero_exprs = [self._new_default_objective_expr()]
+        self._set_engine_multi_objective_exprs(zero_exprs, priorities=[0], weights=[1],
+                                               abstols=[0], reltols=[0], names=[None])
+        self._multi_objective.clear()
+
+    def _nth_multi_objective(self, multiobj_index):
+        return self._multi_objective[multiobj_index]
+
+    def _check_has_multi_objective(self, caller):
+        if not self.has_multi_objective():
+            self.fatal("{0} requires model with multi-objective models", caller)
+
+
[docs]    def set_multi_objective_abstols(self, abstols):
+        """ Changes absolute tolerances for multiple objectives.
+
+        Args:
+            abstols: new absolute tolerances. Can be either a number (applies to all objectives),
+                or a sequence of numbers.
+                A sequence must have the same length as the number of objectives.
+        *New in version 2.16*
+        """
+        self._check_has_multi_objective(caller='Model.set_multi_objective_abstols')
+        nb_objectives = self.number_of_multi_objective_exprs
+        abstols_ = self._typecheck_optional_num_seq(abstols, accept_none=False, expected_size=nb_objectives)
+        self.get_engine().set_multi_objective_tolerances(abstols_, reltols=None)
+        # update tolerances in multi obj
+        self._multi_objective.update(new_abstols=abstols_, new_reltols=None)

+
+
[docs]    def set_multi_objective_reltols(self, reltols):
+        """ Changes relative tolerances for multiple objectives.
+
+        Args:
+            reltols: new relative tolerances. Can be either a number (applies to all objectives),
+                or a sequence of numbers.
+                A sequence must have the same length as the number of objectives.
+
+        *New in version 2.16*
+        """
+        self._check_has_multi_objective(caller='Model.set_multi_objective_reltols')
+        nb_objectives = self.number_of_multi_objective_exprs
+        reltols_ = self._typecheck_optional_num_seq(reltols, accept_none=False, expected_size=nb_objectives)
+        self.get_engine().set_multi_objective_tolerances(abstols=None, reltols=reltols_)
+        # update tolerances in multi obj
+        self._multi_objective.update(new_abstols=None, new_reltols=reltols_)

+
+    def _set_engine_multi_objective_exprs(self, exprs, priorities, weights, abstols, reltols, names):
+        # INTERNAL
+        old_multi_objective_exprs = self._multi_objective.exprs
+        eng = self.__engine
+        if eng:
+            nb_exprs = len(exprs)
+            eng.set_multi_objective_exprs(new_multiobjexprs=exprs,
+                                          old_multiobjexprs=old_multi_objective_exprs,
+                                          priorities=priorities, weights=weights,
+                                          abstols=MultiObjective.as_optional_sequence(abstols, nb_exprs),
+                                          reltols=MultiObjective.as_optional_sequence(reltols, nb_exprs),
+                                          objnames=names)
+        if old_multi_objective_exprs is not None:
+            for expr in old_multi_objective_exprs:
+                expr.notify_unsubscribed(subscriber=self)
+
+
[docs]    def clear_multi_objective(self):
+        """ Clears everything related to multi-objective, if any.
+
+        If the model had previously defined
+        multi-objectives, resets the model with an objective of zero.
+        If the model had not defined multi-objectives, this method does nothing.
+
+        *New in version 2.10*
+        """
+        self._clear_multi_objective()

+
+    def has_objective(self):
+        # INTERNAL
+        return not self._objective_expr.is_zero()
+
+
[docs]    def has_multi_objective(self):
+        """ Returns True if the model has multi objectives defined
+
+        *New in version 2.10*
+        """
+        return not self._multi_objective.empty()

+
+    @property
+    def number_of_multi_objective_exprs(self):
+        return self._multi_objective.number_of_objectives
+
+    def iter_multi_objective_tuples(self):
+        return self._multi_objective.itertuples()
+
+    def iter_multi_objective_exprs(self):
+        return self._multi_objective.iter_exprs()
+
+
[docs]    def set_objective(self, sense, expr):
+        """ Sets a new objective.
+
+        Args:
+            sense: Either an instance of :class:`docplex.mp.basic.ObjectiveSense` (Minimize or Maximize),
+                or a string: "min" or "max".
+            expr: Is converted to an expression. Accepted types are variables,
+                linear expressions, quadratic expressions or numbers.
+
+        Note:
+            When using a number, the search will not optimize but only look for a feasible solution.
+
+        """
+        self.set_objective_sense(sense)
+        self.set_objective_expr(expr)

+
+    def set_objective_sense(self, sense):
+        actual_sense = self._resolve_sense(sense)
+        self._objective_sense = actual_sense
+        eng = self.__engine
+        if eng:
+            # when ending the model, the engine is None here
+            eng.set_objective_sense(actual_sense)
+
+    @property
+    def objective_sense(self):
+        """ This property is used to get or set the direction of the optimization as an instance of
+        :class:`docplex.mp.basic.ObjectiveSense`, either Minimize or Maximize.
+
+        This property also accepts strings as arguments: 'min' for minimize and 'max' for maximize.
+
+        """
+        return self._objective_sense
+
+    @objective_sense.setter
+    def objective_sense(self, new_sense):
+        self.set_objective_sense(new_sense)
+
+    def set_objective_expr(self, new_objexpr, clear_multiobj=True):
+        # INTERNAL
+        if self.has_multi_objective() and clear_multiobj:
+            # Need also to set all attributes to default values so that the model won't be treated as multi-objective
+            self._clear_multi_objective()
+
+        if new_objexpr is None:
+            expr = self._new_default_objective_expr()
+        else:
+            expr = self._lfactory._to_expr(new_objexpr)
+            #expr.keep()
+            expr.notify_used(self)
+
+        eng = self.__engine
+        current_objective_expr = self._objective_expr
+        if eng:
+            # when ending the model, the engine is None here
+            eng.set_objective_expr(expr, current_objective_expr)
+
+        if current_objective_expr is not None:
+            current_objective_expr.notify_unsubscribed(subscriber=self)
+        self._objective_expr = expr
+
+    def _clear_objective_expr(self):
+        # INTERNAL
+        current_objective_expr = self._objective_expr
+        if not current_objective_expr.is_zero():
+            eng = self.__engine
+            current_objective_expr = self._objective_expr
+            zero_expr = self._new_default_objective_expr()
+            if eng:
+                # when ending the model, the engine is None here
+                eng.set_objective_expr(new_objexpr=zero_expr, old_objexpr=current_objective_expr)
+            if current_objective_expr is not None:
+                current_objective_expr.notify_unsubscribed(subscriber=self)
+            self._objective_expr = zero_expr
+
+
[docs]    def get_objective_expr(self):
+        """ This method returns the expression used as the model objective.
+
+        Note:
+            The default objective is a constant zero expression.
+
+        Returns:
+            an expression.
+        """
+        return self._objective_expr

+
+    @property
+    def objective_expr(self):
+        """ This property is used to get or set the expression used as the model objective.
+        """
+        return self._objective_expr
+
+    @objective_expr.setter
+    def objective_expr(self, new_expr):
+        self.set_objective_expr(new_expr)
+
+
+    def notify_expr_modified(self, expr, event):
+        # INTERNAL
+        objexpr = self._objective_expr
+        if event and expr is objexpr or expr is objexpr.linear_part:
+            # old and new are the same
+            self.__engine.update_objective(expr=expr, event=event)
+
+    def notify_expr_replaced(self, old_expr, new_expr):
+        if old_expr is self._objective_expr:
+            self.__engine.set_objective_expr(new_objexpr=new_expr, old_objexpr=old_expr)
+            if not is_var(new_expr):
+                new_expr.grab_subscribers(old_expr)
+
+    def _new_default_objective_expr(self):
+        # INTERNAL
+        return self._lfactory.linear_expr(arg=None, constant=0, safe=True)
+
+    @property
+    def default_objective_sense(self):
+        return ObjectiveSense.Minimize
+
+    def _can_solve(self):
+        return self.has_cplex()
+
+
+    def _make_end_infodict(self):  # pragma: no cover
+        return self.solution.as_name_dict() if self.solution is not None else dict()
+
+    def prepare_actual_context(self, **kwargs):
+        # prepares the actual context that will be used for a solve
+
+        # use the provided context if any, or the self.context otherwise
+        if not kwargs:
+            return self.context
+
+        arg_context = kwargs.get('context') or self.context
+        if not isinstance(arg_context, Context):
+            self.fatal('Expecting instance of docplex.mp.Context, {0!r} was passed', arg_context)
+        cloned = False
+        context = arg_context
+
+        # update the context with provided kwargs
+        for argname, argval in kwargs.items():
+            if argname == 'clean_before_solve':
+                pass
+            elif argname != "context" and argval is not None:
+                if not cloned:
+                    context = context.override()
+                    cloned = True
+                context.update_key_value(argname, argval)
+
+        return context
+
+
[docs]    def build_multiobj_paramsets(self, timelimits = None, mipgaps = None):
+        """ Creates a sequence containing pre-filled `ParameterSet` objects to be used with multi objective optimization
+            only.
+
+        Args:
+            lex_timelimits (optional): a sequence of time limits
+            lex_mipgaps (optional): a sequence of mip gaps
+        """
+        return self.__engine._build_multiobj_paramsets(self, timelimits, mipgaps)

+
+
[docs]    def create_parameter_sets(self):
+        """ Creates a sequence containing empty `ParameterSet` objects to be used with multi objective optimization
+            only.
+        """
+        return self.__engine._create_parameter_sets(self)

+
+
[docs]    def solve(self, **kwargs):
+        """ Starts a solve operation on the model.
+
+        Args:
+            context (optional): An instance of context to be used in instead of
+                the context this model was built with.
+            cplex_parameters (optional): A set of CPLEX parameters to use
+                instead of the parameters defined as
+                ``context.cplex_parameters``.
+                Accepts either a RootParameterGroup object (obtained by cloning the model's
+                parameters), or a dict of path-like names and values.
+            checker (optional): a string which controls which type of checking is performed.
+                Possible values are:
+                - 'std' (the default) performs type checks on arguments to methods; checks that numerical
+                arguments are numbers, but will not check for NaN or infinity.
+                - 'numeric' checks that numerical arguments are valid numbers, neither NaN nor
+                math.infinity
+                - 'full' performs all possible checks, the union of 'std' and 'numeric' checks.
+                - 'off' performs no checking at all. Disabling all checks might improve performance, but only when
+                it is safe to do so.
+            log_output (optional): if ``True``, solver logs are output to
+                stdout. If this is a stream, solver logs are output to that
+                stream object. Overwrites the ``context.solver.log_output``
+                parameter.
+            clean_before_solve (optional): a boolean (default is False).
+                Solve normally picks up where the previous solve left, but if this flag is set to ``True``,
+                a fresh solve is started, forgetting all about previous solves..
+            parameter_sets (optional) an iterable of parameterset to be used with multi objective optimization.
+                See :func:`create_parameter_sets`
+
+        Returns:
+            A :class:`docplex.mp.solution.SolveSolution` object if the solve operation managed to create
+            a feasible solution, else None.
+            The reason why solve returned None includes not only errors, but also proper cases of infeasibilties
+            or unboundedness. When solve returns None, use Model.solve_details to check the status
+            of the latest solve operation: Model.solve_details always returns
+            a :class:`docplex.mp.sdetails.SolveDetails` object, whether or not
+            a solution has been found.
+            This object contains detailed information about the latest solve operation, such as status, elapsed time,
+            and for MILP problems, number of nodes processed and final gap.
+
+        See Also:
+            :func:`solve_details`
+            :class:`docplex.mp.sdetails.SolveDetails`
+        """
+        if not self.is_optimized():
+            self.info("No objective to optimize - searching for a feasible solution")
+
+        parameter_sets = kwargs.pop('parameter_sets', None)
+        context = self.prepare_actual_context(**kwargs)
+
+        # log stuff
+        a_stream = context.solver.log_output_as_stream
+        with OverridenOutputContext(self, a_stream):
+            if self.environment.has_cplex:
+                # take arg clean flag or this model's
+                used_clean_before_solve = kwargs.get('clean_before_solve', self.clean_before_solve)
+                return self._solve_local(context, used_clean_before_solve, parameter_sets)# lex_timelimits, lex_mipgaps)
+            else:
+                return self.fatal("Cannot solve model: no CPLEX runtime found.")

+
+    def _connect_progress_listeners(self):
+        self.__engine.connect_progress_listeners(self, self._progress_listeners, self._qprogress_listeners)
+
+    def _disconnect_progress_listeners(self):
+        map (lambda xl: xl._disconnect(), chain(self._progress_listeners, self._qprogress_listeners))
+
+    def _notify_solve_hit_limit(self, solve_details):
+        # INTERNAL
+        if solve_details and solve_details.has_hit_limit():
+            self.info("solve: {0}".format(solve_details.status))
+
+    def _solve_local(self, context, clean_before_solve=None, parameter_sets = None):# lex_timelimits=None, lex_mipgaps=None):
+        """ Starts a solve operation on the local machine.
+
+        Note: If CPLEX is not available, an error is raised.
+
+        Args:
+            context: a (possibly new) context whose parameters override those of the modle
+                during this solve.
+
+        Returns:
+            A Solution object if the solve operation succeeded, None otherwise.
+
+        """
+        local_solve_env = CplexLocalSolveEnv(self)
+        params_to_use = local_solve_env.before_solve(context)
+        self_engine = self.__engine
+        new_solution = None
+        try:
+            used_parameters = params_to_use or self.context._get_raw_cplex_parameters()
+            # assert used_parameters is not None
+            self._apply_parameters_to_engine(used_parameters)
+
+            new_solution = self_engine.solve(self,
+                                             parameters=used_parameters,
+                                             clean_before_solve=clean_before_solve,
+                                             parameter_sets = parameter_sets)
+
+            # store solve status as returned by the engine.
+            engine_status = self_engine.get_solve_status()
+            self._last_solve_status = engine_status
+
+        except DOcplexException as docpx_e:  # pragma: no cover
+            new_solution = None
+            raise docpx_e
+
+        except Exception as e:
+            new_solution = None
+            print("----------------- Python exception: {}".format(str(e)))
+            raise e
+
+        finally:
+            self._set_solution(new_solution)
+            local_solve_env.after_solve(context, new_solution, self_engine)
+        return new_solution
+
+
[docs]    def get_solve_status(self):
+        """ Returns the solve status of the last successful solve.
+
+        If the model has been solved successfully, returns the status stored in the
+        model solution. Otherwise returns None.
+
+        :returns: The solve status of the last successful solve, a enumerated value of type
+            `docplex.utils.JobSolveStatus`
+
+        Note: The status returned by Cplex is stored as `status` in the solve_details of the model.
+
+        >>> m.solve_details.status
+
+        See Also:
+            :func:`docplex.mp.SolveDetails.status` to get the Cplex status as a string (eg. "optimal")
+            :func:`docplex.mp.SolveDetails.status_code` to get the Cplex status as an integer code..
+        """
+        warnings.warn("Model.get_solve_status() is deprecated with cloud solve, use Model.solve_details instead", DeprecationWarning)
+        return self._last_solve_status

+
+    @property
+    def solve_status(self):
+        """ Returns the solve status of the last successful solve.
+
+        If the model has been solved successfully, returns the status stored in the
+        model solution. Otherwise returns None`.
+
+        :returns: The solve status of the last successful solve, a string, or None.
+        """
+        warnings.warn("Model.solve_status is deprecated with cloud solve, use Model.solve_details instead", DeprecationWarning)
+        return self._last_solve_status
+
+    @property
+    def job_solve_status(self):
+        # INTERNAL WML
+        return self._last_solve_status
+
+    def notify_start_solve(self):
+        # INTERNAL
+        pass
+
+    def notify_solve_failed(self):
+        pass
+
+    @property
+    def solve_details(self):
+        """
+        This property returns detailed information about the latest solve,
+        an instance of :class:`docplex.mp.solution.SolveDetails`.
+
+        When the latest solve did return a Solution instance, this property
+        returns the solve details corresponding to the solution; when no
+        solution has been found (in other terms, the latest solve operation
+        returned None), it still returns a SolveDetails object, containing a
+        CPLEX code identifying the reason why no solution could be found
+        (for example, infeasibility or unboundedness).
+
+        See Also:
+            :class:`docplex.mp.sdetails.SolveDetails`
+
+        """
+        from copy import copy as shallow_copy
+
+        return shallow_copy(self._solve_details)
+
+    def get_solve_details(self):
+        return self.solve_details
+
+    def notify_solve_relaxed(self, relaxed_solution, solve_details):
+        # INTERNAL: used by relaxer
+        self._solve_details = solve_details
+        self._set_solution(relaxed_solution)
+        if relaxed_solution is not None:
+            self.notify_start_solve()
+        else:
+            self.notify_solve_failed()
+
+    def _resolve_sense(self, sense_arg):
+        return ObjectiveSense.parse(sense_arg, self.logger)  # raise if invalid
+
+
[docs]    def solve_with_goals(self, goals,
+                         senses='min',
+                         abstols=None,
+                         reltols=None,
+                         goal_names=None,
+                         write_pass_files=False,
+                         solution_callbackfn=None,
+                         **kwargs):
+        """ Performs a solve from an ordered collection of goals.
+
+        :param goals: An ordered collection of linear expressions.
+
+        :param senses: Accepts ither an ordered sequence of senses, one sense, or
+           None. The default is None, in which case the solve uses a Minimize
+           sense. Each sense can be either a sense object, that is either
+           `ObjectiveSense.Minimize` or `Maximize`, or a string "min" or "max".
+
+        :param abstols: if defined, accepts either a number or a list of numbers having the same size as the `exprs` argument,
+            interpreted as absolute tolerances. If passed asingle number, this tolerance number will be used for all
+            passes.
+
+        :param reltols: if defined, accepts either a number or a list of numbers having the same size as the `exprs` argument,
+            interpreted as absolute tolerances. If passed asingle number, this tolerance number will be used for all
+            passes.
+
+        Note:
+            tolerances are used at each step to constraint the previous
+            objective value to be be 'no worse' than the value found in the
+            last pass. For example, if relative tolerance is 2% and pass #1 has
+            found an objective of 100, then pass #2 will constraint the first
+            goal to be no greater than 102 if minimizing, or
+            no less than 98, if maximizing.
+
+            If one pass fails, return the previous pass' solution. If the solve fails at the first
+            goal, then return None.
+
+        Return:
+            If successful, returns a tuple with all pass solutions, reversed else None.
+            The current solution of the model is the first solution in the tuple.
+        """
+        if not goals:
+            self.error("solve_with_goals requires a non-empty list of goals, got: {0!r}".format(goals))
+            return None
+        if not is_indexable(goals):
+            self.fatal("solve_with_goals requires an indexable sequence of goals, got: {0!s}", goals)
+
+        is_verbose = kwargs.pop('verbose', False)
+
+        nb_goals =len(goals)
+        actual_goal_names = ["goal%d" % (gi + 1) for gi in range(nb_goals)]
+        if isinstance(goal_names, list):
+            for i in range(nb_goals):
+                try:
+                    gn = goal_names[i]
+                    if gn:
+                        actual_goal_names[i] = gn
+                except (KeyError, TypeError, ValueError):
+                    pass
+
+        actual_goals = [(gn, self._lfactory._to_expr(g))  for gn, g in zip(actual_goal_names, goals)]
+        # --- senses ---
+        abstols_ = []
+        reltols_ = []
+
+        # compile tolerances to abstols, reltols
+        if abstols is not None:
+            abstols_ = self._typecheck_optional_num_seq(abstols, expected_size=nb_goals, caller='Model.solve_with_goals')
+        if reltols is not None:
+            reltols_ = self._typecheck_optional_num_seq(reltols, expected_size=nb_goals, caller='Model.solve_with_goals')
+
+        if not abstols_:
+            abstols_ = [1e-6] * nb_goals
+        if not reltols_:
+            reltols_ = [1e-4] * nb_goals
+
+        old_objective_expr = self._objective_expr
+        old_objective_sense = self._objective_sense
+
+        pass_count = 0
+        m = self
+        results = []
+
+        if not is_iterable(senses, accept_string=False):
+            senses = generate_constant(ObjectiveSense.parse(senses), count_max=nb_goals)
+
+        def lex_info(msg):
+            if is_verbose:
+                print("-- lex_goals: {0}".format(msg))
+
+        # keep extra constraints, in order to remove them at the end.
+        extra_cts = []
+        cplex_param_key = Context.cplex_parameters_key
+        ctx_params = kwargs.get(cplex_param_key)
+        iter_pass_params = generate_constant(None, nb_goals)
+        baseline_params = None  # parameters to restore at each iteration, default is to do nothing
+        if ctx_params and is_iterable(ctx_params):
+            # must pop out the list as normal solve won't have it.
+            pass_params = list(kwargs.pop(cplex_param_key))
+            if len(pass_params) != nb_goals:
+                self.fatal("List of parameters should have same length as goals, expecting: {0} but a list of size {1} was passed",
+                           nb_goals, pass_params)
+            else:
+                iter_pass_params = iter(pass_params)
+                baseline_params = m.context.parameters  # need to clear/reset parameters at each pass
+
+        # --- main loop ---
+        prev_step = (None, None, None)
+        all_solutions = []
+        solve_kwargs = kwargs.copy()
+        current_sol = None
+        try:
+            for (goal_name, goal_expr), next_sense, abstol, reltol in zip(actual_goals, senses, abstols_, reltols_):
+                if goal_expr.is_constant() and pass_count > 1:
+                    self.warning("Constant expression in lexicographic solve: {0!s}, skipped", goal_expr)
+                    continue
+                pass_count += 1
+
+                if pass_count > 1:
+                    prev_goal, prev_obj, prev_sense = prev_step
+                    tolerance = compute_tolerance(prev_obj, abstol, reltol)
+                    if prev_sense.is_minimize():
+                        pass_ct = m._post_constraint(prev_goal <= prev_obj + tolerance)
+                    else:
+                        pass_ct = m._post_constraint(prev_goal >= prev_obj - tolerance)
+                    pass_ct.name = "lex_{0}_ct".format(pass_count)
+                    lex_info("pass #{0} generated constraint with rhs: {1}, tolerance={2:.3g}"
+                             .format(pass_count, str(pass_ct.rhs), tolerance))
+                    extra_cts.append(pass_ct)
+
+
+                sense = self._resolve_sense(next_sense)
+
+                lex_info("starting pass %d, %s: %s" % (pass_count, sense.verb, str_maxed(goal_expr, 64)))
+                m.set_objective(sense, goal_expr)
+
+                if write_pass_files:  # pragma: no cover
+                    pass_basename = f"lex_{self.name}_{goal_name}_pass{pass_count}"
+                    dump_path = self.export_as_lp(path='.', basename=pass_basename)
+                    lex_info("saved pass file: {0}".format(dump_path))
+
+                # --- update pass parameters, if any
+                pass_param = next(iter_pass_params)
+                if pass_param:
+                    # print('applying custom parameters')
+                    # pass_param.print_information()
+                    m.context.update_cplex_parameters(pass_param)
+                    m.context.cplex_parameters.print_information()
+                # --- TODO: why is this here?
+                # if current_sol and pass_count > 1:
+                #     solve_kwargs['lex_mipstart'] = current_sol
+
+                current_sol = m.solve(**solve_kwargs)
+                # restore params if need be
+                if baseline_params:
+                    m.context.cplex_parameters = baseline_params
+
+                if current_sol is not None:
+                    current_sol.set_name("lex_{0}_{1}_{2}".format(self.name, goal_name, pass_count))
+                    current_obj = current_sol.objective_value
+                    results.append(current_obj)
+                    prev_step = (goal_expr, current_obj, sense)
+                    all_solutions.append(current_sol)
+                    lex_info("objective value for pass #{0} is: {1}".format(pass_count, current_sol.objective_value))
+                    if write_pass_files:
+                        pass_basename = f"lex_{self.name}_{goal_name}_pass{pass_count}"
+                        if self.problem_type == 'LP':
+                            bas_path = self.export_basis(path='.', basename=pass_basename)
+                            lex_info("saved pass basis file: {0}".format(bas_path))
+                        else:
+                            write_level = kwargs.get('write_level', 'auto')
+                            mst_path = current_sol.export_as_mst(path='.', basename=pass_basename, write_level=write_level)
+                            lex_info("saved pass MST file: {0}".format(mst_path))
+                    if solution_callbackfn:
+                        solution_callbackfn(current_sol)
+
+
+                else:  # pragma: no cover
+                    sd = m.solve_details
+                    status = sd.status
+                    self.error("lexicographic: pass {0} fails, status={1} ({2}), stopping",
+                               pass_count, status, sd.status_code)
+                    break
+        finally:
+            # print("-> start restoring model at end of lexicographic")
+            while extra_cts:
+                # using LIFO logic to avoid holes in indices.
+                ct_to_remove = extra_cts.pop()
+                # print("* removing constraint: name: {0}, idx: {1}".format(ct_to_remove.name, ct_to_remove.index))
+                self._remove_constraint_internal(ct_to_remove)
+            # restore objective whatsove
+            self.set_objective(old_objective_sense, old_objective_expr)
+            # print("<- end restoring model at end of lexicographic")
+
+        # return a solution or None
+        return tuple(reversed(all_solutions))

+
+
+    def _has_solution(self):
+        # INTERNAL
+        return self._solution is not None
+
+    def _set_solution(self, new_solution):
+        """
+        INTERNAL: Sets this solution as the model's current solution.
+        Copies values to variables (for now, let's think more about this)
+        :param new_solution:
+        :return:
+        """
+        self._solution = new_solution
+
+    def _clear_solution(self):
+        self._set_solution(None)
+        # what to do with details....
+
+    def _check_has_solution(self):
+        # see if we can refine messages here...
+        if self._solution is None:
+            if self._solve_details is None:
+                self.fatal("Model<{0}> has not been solved yet", self.name)
+            else:
+                self.fatal("Model<{0}> did not solve successfully", self.name)
+
+    def _check_solved_as_mip(self, caller, do_raise):
+        if self._check_mip_for_mipstarts:
+            if not self._solved_as_mip():
+                msg = "{0}  is only available for MIP problems".format(caller)
+                if do_raise:
+                    self.fatal(msg)
+                else:
+                    self.error(msg)
+                return False
+        # either a MIP or we don't care...
+        return True
+
+
[docs]    def add_mip_start(self, mip_start_sol, effort_level=None, write_level=None, complete_vars=False, eps_zero=1e-6):
+        """  Adds a (possibly partial) solution to use as a starting point for a MIP.
+
+        This is valid only for models with binary or integer decision variables.
+        The given solution must contain the value for at least one binary or integer variable.
+
+        This feature is also known as 'warm start'.
+
+        The solution passed in input is copied into a new instance of :class:`docplex.mp.SolveSolution`.
+        Depending on the "write_level" argument, some filtering operations can be performed: by default (no
+        explicit write level) only discrete variables are copied. When an explicit level is passed,
+        the level controls whether zero values are passed ore not: for example "WiteLevel.NonZeroDiscreteVars" specifies
+        only copying non zero values for discrete variables.
+
+        Args:
+            mip_start_sol (:class:`docplex.mp.solution.SolveSolution`): The solution object to use as a starting point.
+            write_level: an optional enumerated value from class :class:`docplex.mp.constants.WriteLevel`, controlling
+                which variables are copied to the MIP start solution. By default, only discrete variables are copied.
+            complete_vars: optinal flag. If False (default), only variables mentioned in the solution are copied. If True,
+                all variables in the model are copied to the MIP start.
+            effort_level: an optional enumerated value of class :class:`docplex.mp.constants.EffortLevel`, or None.
+
+        Returns:
+            an instance of :class:`doplex.mp.SolveSolution`, different from the one passed in input if the conversion succeeds,
+            else None (typically for LP models).
+
+        Examples:
+            The default values correspond to copying only variables explicitly mentioned in the passed solution,
+            copying only discrete variables, including zeros.
+            To exclude zeros, use
+
+            >>> mdl.add_mip_start(sol, write_level=WriteLevel.NonZeroDiscreteVars)
+
+            To include all variables in the model, wincluding continuous ones, use:
+
+            >>> mdl.add_mip_start(sol, write_level=WriteLevel.AllVars, complete_vars=True)
+
+        See Also:
+            :class:`docplex.mp.constants.EffortLevel`
+            :class:`docplex.mp.constants.WriteLevel`
+            :class:`docplex.mp.solution.SolveSolution`
+
+        """
+        assert eps_zero >= 0
+        assert eps_zero < 1
+        mip_start_ = None
+        if self._check_solved_as_mip(caller="Model.add_mip_start", do_raise=False):
+            try:
+                mip_start_ = mip_start_sol.as_mip_start(write_level=write_level,
+                                                        complete_vars=bool(complete_vars),
+                                                        eps_zero=eps_zero)
+                mip_start_.check_as_mip_start()
+                effort = EffortLevel.parse(effort_level)
+                self._mipstarts.append((mip_start_, effort))
+            except AttributeError:
+                self.fatal("add_mip_starts expects solution, {0!r} was passed", mip_start_sol)
+        return mip_start_

+
+    @property
+    def mip_starts(self):
+        """ This property returns the list of MIP start solutions (a list of instances of :class:`docplex.mp.solution.SolveSolution`)
+        attached to the model if MIP starts have been defined, possibly an empty list.
+        """
+        warnings.warn("Model.mip_starts is deprecated. Use Model.iter_mip_starts instead"
+                      , DeprecationWarning, stacklevel=2)
+        return [s for (s, _) in self.iter_mip_starts()]
+
+    @property
+    def number_of_mip_starts(self):
+        """ This property returns the number of MIP start associated with the model.
+
+        *New in version 2.10*
+         """
+        return len(self._mipstarts)
+
+
[docs]    def iter_mip_starts(self):
+        """ This property returns an iterator on the MIP starts associated with
+         the model.
+
+         It returns tuples of size 2:
+            - first element is a solution (an instance of :class:`docplex.mp.solution.SolveSolution`)
+            - second is an enumerated value of type :class:`docplex.mp.constants.EffortLevel`
+
+        *New in version 2.10*
+
+        """
+        return iter(self._mipstarts)

+
+
[docs]    def clear_mip_starts(self):
+        """  Clears all MIP starts associated with the model.
+
+        Note: this clears only MIP starts provided by the user via the `Model.add_mip_start` method.
+        This does not remove interbal solutions found by previous solves. To run a fresh solve,
+        \and forget all about previous solves, use the `clean_before_solve=True` keyword argument for
+        :func:`solv()`
+
+        See Also:
+            :func:`add_mip_start`
+            :func:`solve`
+
+        """
+        self._mipstarts = []

+
+
[docs]    def read_mip_starts(self, mst_path):
+        """ Read MIP starts from a file.
+
+        Reads the file and returns a list of (solution, effort_level) tuples.
+
+        :param mst_path: the path to mip start file (in CPLEX MST file format)
+
+        :return: a list of tuples of size 2; the first element is an instance of `SolveSolution`
+            and the second element is an enumerated value of type `EffortLevel`
+
+        See Also:
+            :class:`docplex.mp.constants.EffortLevel`
+            :class:`docplex.mp.solution.SolveSolution`
+
+        * New in version 2.10*
+
+        """
+        self._check_solved_as_mip(caller="Model.read_mip_starts", do_raise=True)
+
+        from docplex.mp.sol_xml_reader import read_mst_file
+
+        self.info("Reading mip starts from file: {0}".format(mst_path))
+        mip_starts = read_mst_file(mst_path, self, caller='Model.read_mip_starts')
+        if mip_starts is not None:
+            if not mip_starts:
+                self.warning("Found no MIP starts in file: {0}", mst_path)
+            else:
+                self.info("Read {0} MIP starts in file: {1}".format(len(mip_starts), mst_path))
+            self._mipstarts = mip_starts
+            return mip_starts
+        else:
+            # do not overwrite current mip starts (IMHO)
+            return None

+
+
[docs]    def set_lp_start_basis(self, dvar_stats, lct_stats):
+        """ Provides an initial basis for a LP problem.
+
+        :param dvar_stats: an ordered sequence (list) of basis status objects, one for
+            each decision variable in the model.
+        :param lct_stats: an ordered sequence (list) of basis status objects, one for each linear constraint
+            in the model
+
+        Note:
+            Basis status are values of the enumerated type :class:`docplex.mp.constants.BasisStatus`.
+
+        See Also:
+             :class:`docplex.mp.constants.BasisStatus`.
+
+        * New in version 2.10*
+
+        """
+        l_dvar_stats = StaticTypeChecker.typecheck_initial_lp_stats\
+            (logger=self, stats=dvar_stats, stat_type='variable', caller='Model.set_lp_start_basis')
+        l_lct_stats = StaticTypeChecker.typecheck_initial_lp_stats\
+            (logger=self, stats=lct_stats, stat_type='constraint', caller='Model.set_lp_start_basis')
+        self.__engine.set_lp_start(l_dvar_stats, l_lct_stats)

+
+    @property
+    def objective_value(self):
+        """ This property returns the value of the objective expression in the solution of the last solve.
+        In case of a multi-objective, only the value of the first objective is returned
+
+        Raises an exception if the model has not been solved successfully.
+
+        """
+        self._check_has_solution()
+        return self._objective_value()
+
+    def _objective_value(self):
+        return self.solution.objective_value
+
+    @property
+    def multi_objective_values(self):
+        """ This property returns the list of values of the objective expressions in the solution of the last solve.
+
+        Raises an exception if the model has not been solved successfully.
+
+        *New in version 2.9*
+        """
+        self._check_has_solution()
+        return self._multi_objective_values()
+
+    def _multi_objective_values(self):
+        # INTERNAL
+        return self.solution.multi_objective_values
+
+    @property
+    def blended_objective_values(self):
+        """ This property returns the list of values of the blended objective expressions based on the decreasing
+        order of priorities in the solution of the last solve.
+
+        Raises an exception if the model has not been solved successfully.
+
+        *New in version 2.9.*
+        """
+        self._check_has_solution()
+        blended_obj_values = self.solution.get_blended_objective_value_by_priority()
+        return blended_obj_values
+
+    def _reported_objective_value(self, failure_obj=0):
+        return self.solution.objective_value if self.solution else failure_obj
+
+    def _resolve_path(self, path_arg, basename_arg, extension):
+        # INTERNAL
+        if is_string(path_arg):
+            if os.path.isdir(path_arg):
+                if path_arg == ".":
+                    path_arg = os.getcwd()
+                return self._make_output_path(extension, basename_arg, path_arg)
+            else:
+                # add extension if not present (but not twice!)
+                return path_arg if path_arg.endswith(extension) else path_arg + extension
+        else:
+            assert path_arg is None
+            return self._make_output_path(extension, basename_arg, path_arg)
+
+    def _make_output_path(self, extension, basename, path=None):
+        return make_output_path2(self.name, extension, basename, path)
+
+    def _get_printer(self, format_spec, do_raise=False, silent=False):
+        # INTERNAL
+        printer_kwargs = {'full_obj': self._print_full_obj}
+        format_ = parse_format(format_spec)
+        printer = None
+        if format_.name == 'LP':
+            printer = LPModelPrinter(**printer_kwargs)
+        else:
+            if do_raise:
+                self.fatal("Unsupported output format: {0!s}", format_spec)
+            elif not silent:
+                self.error("Unsupported output format: {0!s}", format_spec)
+        return printer
+
+    def dump_as_lp(self, path=None, basename=None):
+        return self._export_from_cplex(path, basename, format_spec="lp")
+
+
[docs]    def export_as_lp(self, path=None, basename=None, hide_user_names=False):
+        """ Exports a model in LP format.
+
+        Args:
+            basename: Controls the basename with which the model is printed.
+                Accepts None, a plain string, or a string format.
+                if None, uses the model's name;
+                if passed a plain string, the string is used in place of the model's name;
+                if passed a string format (either with %s or {0}, it is used to format the
+                model name to produce the basename of the written file.
+
+            path: A path to write file, expects a string path or None.
+                can be either a directory, in which case the basename
+                that was computed with the basename argument, is appended to the directory to produce
+                the file.
+                If given a full path, the path is directly used to write the file, and
+                the basename argument is not used.
+                If passed None, the output directory will be ``tempfile.gettempdir()``.
+
+            hide_user_names: A Boolean indicating whether or not to keep user names for
+                variables and constraints. If True, all names are replaced by `x1`, `x2`, ... for variables,
+                and `c1`, `c2`, ... for constraints.
+
+        Returns:
+            The full path of the generated file, or None if an error occured.
+
+        Examples:
+            Assuming the model's name is `mymodel`:
+            
+            >>> m.export_as_lp()
+            
+            will write ``mymodel.lp`` in ``gettempdir()``.
+            
+            >>> m.export_as_lp(basename="foo")
+            
+            will write ``foo.lp`` in ``gettempdir()``.
+            
+            >>> m.export_as_lp(basename="foo", path="e:/home/docplex")
+
+            will write file ``e:/home/docplex/foo.lp``.
+            
+            >>> m.export_as_lp("e/home/docplex/bar.lp")
+            
+            will write file ``e:/home/docplex/bar.lp``.
+            
+            >>> m.export_as_lp(basename="docplex_%s", path="e/home/") 
+            
+            will write file ``e:/home/docplex/docplex_mymodel.lp``.
+        """
+        return self.export(path, basename, hide_user_names=hide_user_names, format_spec='lp')

+
+
[docs]    def export_as_sav(self, path=None, basename=None):
+        """ Exports a model in CPLEX SAV format.
+
+        Exporting to SAV format requires that CPLEX is installed and
+        available in PYTHONPATH. If the CPLEX runtime cannot be found, an exception is raised.
+
+        Args:
+            basename: Controls the basename with which the model is printed.
+                Accepts None, a plain string, or a string format.
+                If None, the model's name is used.
+                If passed a plain string, the string is used in place of the model's name.
+                If passed a string format (either with %s or {0}), it is used to format the
+                model name to produce the basename of the written file.
+
+            path: A path to write the file, expects a string path or None.
+                Can be a directory, in which case the basename
+                that was computed with the basename argument, is appended to the directory to produce
+                the file.
+                If given a full path, the path is directly used to write the file, and
+                the basename argument is not used.
+                If passed None, the output directory will be ``tempfile.gettempdir()``.
+
+        Returns:
+            The full path of the generated file, or None if an error occured.
+
+        Examples:
+            See the documentation of  :func:`export_as_lp` for examples of pathname generation.
+            The logic is identical for both methods.
+
+        """
+        return self._export_from_cplex(path, basename, format_spec="sav")

+
+    dump_as_sav = export_as_sav
+
+
[docs]    def export_as_mps(self, path=None, basename=None):
+        """ Exports a model in MPS format.
+
+        Exporting to MPS format requires that CPLEX is installed and
+        available in PYTHONPATH. If the CPLEX runtime cannot be found, an exception is raised.
+
+        Args:
+            basename: Controls the basename with which the model is printed.
+                Accepts None, a plain string, or a string format.
+                If None, the model's name is used.
+                If passed a plain string, the string is used in place of the model's name.
+                If passed a string format (either with %s or {0}), it is used to format the
+                model name to produce the basename of the written file.
+
+            path: A path to write the file, expects a string path or None.
+                Can be a directory, in which case the basename
+                that was computed with the basename argument, is appended to the directory to produce
+                the file.
+                If given a full path, the path is directly used to write the file, and
+                the basename argument is not used.
+                If passed None, the output directory will be ``tempfile.gettempdir()``.
+
+        Returns:
+            The full path of the generated file, or None if an error occured.
+
+        Examples:
+            See the documentation of  :func:`export_as_lp` for examples of pathname generation.
+            The logic is identical for both methods.
+
+        """
+        return self._export_from_cplex(path, basename, format_spec="mps")

+
+
[docs]    def export_as_savgz(self, path=None, basename=None):
+        """ Exports a model in compressed SAV format.
+
+        Exporting to SAV compressed format requires that CPLEX is installed and
+        available in PYTHONPATH. If the CPLEX runtime cannot be found, an exception is raised.
+
+        Arguments 'path' and 'basename' have similar usage as for :func:`export_as_lp`.
+
+        Returns:
+            The full path of the generated file, or None if an error occured.
+
+        Examples:
+            See the documentation of  :func:`export_as_lp` for examples of pathname generation.
+            The logic is identical for both methods.
+
+        *New In 2.19*
+
+        """
+        return self._export_from_cplex(path, basename, format_spec="sav.gz")

+
+
+    def _export_from_cplex(self, path=None, basename=None, hide_user_names=False,
+                           format_spec="lp"):
+        return self._export(path, basename,
+                            use_engine=True,
+                            hide_user_names=hide_user_names,
+                            format_spec=format_spec)
+
+    def export(self, path=None, basename=None,
+               hide_user_names=False, format_spec="lp"):
+        # INTERNAL
+        return self._export(path, basename,
+                            use_engine=False,
+                            hide_user_names=hide_user_names,
+                            format_spec=format_spec)
+
+    def _export(self, path=None, basename=None,
+                use_engine=False, hide_user_names=False,
+                format_spec="lp"):
+        # INTERNAL
+        # path is either a nonempty path string or None
+        self._checker.typecheck_string(path, accept_none=True, accept_empty=False)
+        self._checker.typecheck_string(basename, accept_none=True, accept_empty=False)
+        # INTERNAL
+        _format = parse_format(format_spec)
+        if not _format:
+            self.fatal("Not a supported exchange format: {0!s}", format_spec)
+        extension = _format.extension
+
+        # combination of path/directory and basename resolution are done in resolve_path
+        path = self._resolve_path(path, basename, extension)
+        ret = self._export_to_path(path, hide_user_names, use_engine, _format)
+        if ret:
+            self.trace("model file: {0} overwritten", path)
+        return ret
+
+    def _export_to_path(self, path, hide_user_names=False, use_engine=False, format_spec="lp"):
+        # INTERNAL
+        format_ = parse_format(format_spec)
+        try:
+            if use_engine:
+                # rely on engine for the dump
+                if self.has_cplex():
+                    self.__engine.export(path, format_)
+                else:  # pragma: no cover
+                    self.fatal(
+                        "Exporting to {0} requires CPLEX, but a local CPLEX installation could not be found, file: {1} could not be written",
+                        format_.name, path)
+                    return None
+            else:
+                # a path is not a stream but anyway it will work
+                self._export_to_stream(stream=path, hide_user_names=hide_user_names, format_spec=format_)
+            return path
+
+        except IOError:
+            self.error("Cannot open file: \"{0}\", model: {1} not exported".format(path, self.name))
+            raise
+
+    def _export_to_stream(self, stream, hide_user_names=False, format_spec="lp"):
+        format_ = parse_format(format_spec)
+        printer = self._get_printer(format_, do_raise=False, silent=True)
+        if printer:
+            printer.set_mangle_names(hide_user_names)
+            printer.printModel(self, stream)
+        else:
+            self.__engine.export(stream, format_spec)
+
+
[docs]    def export_to_stream(self, stream, hide_user_names=False, format_spec="lp"):
+        """ Export the model to an output stream in LP format.
+
+        A stream can be one of:
+            - a string, interpreted as a system path,
+            - None, interpreted as `stdout`, or
+            - a Python file-type object (e.g. a StringIO() instance).
+                
+        Args:
+            stream: An object defining where the output will be sent.
+            
+            hide_user_names: An optional Boolean indicating whether or not to keep user names for
+                variables and constraints. If True, all names are replaced by `x1`, `x2`, ... for variables,
+                and `c1`, `c2`, ,... for constraints. Default is to keep user names.
+
+        """
+        self._export_to_stream(stream, hide_user_names, format_spec)

+
+
[docs]    def export_as_lp_string(self, hide_user_names=False):
+        """ Exports the model to a string in LP format.
+
+        The output string contains the model in LP format.
+
+        Args:
+            hide_user_names: An optional Boolean indicating whether or not to keep user names for
+                variables and constraints. If True, all names are replaced by `x1`, `x2`, ... for variables,
+                and `c1`, `c2`, ... for constraints. Default is to keep user names.
+
+        Returns:
+            A string, containing the model exported in LP format.
+        """
+        return self.export_to_string(hide_user_names, "lp")

+
+    @property
+    def lp_string(self):
+        """ This property returns a string encoding the model in LP format.
+
+            *New in version 2.16*
+        """
+        return self.export_as_lp_string()
+
+
[docs]    def export_as_mps_string(self):
+        """ Exports the model to a string in MPS format.
+
+        Returns:
+            A string, containing the model exported in MPS format.
+
+        *New in version 2.13*
+        """
+        return self._export_as_cplex_string("mps")

+
+
[docs]    def export_as_sav_string(self):
+        """ Exports the model to a string of bytes in SAV format.
+
+        Returns:
+            A string of bytes..
+
+        *New in version 2.13*
+        """
+        return self._export_as_cplex_string("sav")

+
+    def _export_as_cplex_string(self, format_spec):
+        # INTERNAL
+        _format = parse_format(format_spec)
+        if not self.has_cplex():
+            self.fatal("Exporting to {0} requires CPLEX, but a local CPLEX installation could not be found",
+                       _format.name)
+
+        from io import BytesIO
+        bs = BytesIO()
+        self.__engine.export(bs, _format)
+        raw_res = bs.getvalue()
+        if _format.is_binary:
+            # for b, by in enumerate(raw_res):
+            #     nl = (b % 21 == 20)
+            #     print(f" {by}", end='\n' if nl else '')
+            # print()
+            return raw_res
+        else:
+            return raw_res.decode(self.parameters.read.fileencoding.get())
+
+    def export_to_string(self, hide_user_names=False, format_spec="lp"):
+        # INTERNAL
+        oss = StringIO()
+        self._export_to_stream(oss, hide_user_names, format_spec)
+        return oss.getvalue()
+
+    def export_parameters_as_prm(self, path=None, basename=None):
+        # path is either a nonempty path string or None
+        self._checker.typecheck_string(path, accept_none=True, accept_empty=False)
+        self._checker.typecheck_string(basename, accept_none=True, accept_empty=False)
+
+        # combination of path/directory and basename resolution are done in resolve_path
+        prm_path = self._resolve_path(path, basename, extension='.prm')
+        self.parameters.export_prm_to_path(path=prm_path)
+        return prm_path
+
+    def export_parameters_as_ops(self, path=None, basename=None):
+        # path is either a nonempty path string or None
+        self._checker.typecheck_string(path, accept_none=True, accept_empty=False)
+        self._checker.typecheck_string(basename, accept_none=True, accept_empty=False)
+
+        # combination of path/directory and basename resolution are done in resolve_path
+        ops_path = self._resolve_path(path, basename, extension='.ops')
+        self.parameters.export_as_ops_file(filename=ops_path)
+        return ops_path
+
+    def export_annotations(self, path=None, basename=None):
+        from docplex.mp.anno import ModelAnnotationPrinter
+
+        self._checker.typecheck_string(path, accept_none=True, accept_empty=False)
+        self._checker.typecheck_string(basename, accept_none=True, accept_empty=False)
+
+        # combination of path/directory and basename resolution are done in resolve_path
+        anno_path = self._resolve_path(path, basename, extension='.ann')
+        ap = ModelAnnotationPrinter()
+        ap.print_to_stream(self, anno_path)
+
+        return anno_path
+
+    def _check_problem_type(self, feature, requires_solution=True, accept_qxp=True):
+        if self._solve_details is None:
+            self.fatal('{0} are not available, model is not solved yet'.format(feature))
+        elif requires_solution and self._solution is None:
+            self.fatal('{0} require a solution, but model is not solved with a solution'.format(feature))
+        elif self._solved_as_lp():
+            pass
+        elif not accept_qxp and self.is_quadratic():
+            self.fatal('{0} are not available for QP/QCP problems'.format(feature))
+        elif self._solved_as_mip():
+            self.fatal('{0} are not available for integer problems'.format(feature))
+
+    def _dual_value1(self, linear_ct):
+        # PRIVATE
+        self._check_problem_type(feature='dual values')
+        self._checker.typecheck_ct_added_to_model(self, linear_ct)
+        dvs = self._dual_values([linear_ct])
+        return dvs[0]
+
+
[docs]    def dual_values(self, cts):
+        """ Returns the dual values of a sequence of linear constraints.
+
+        Note: the model must a pure LP: no integer or binary variable, no piecewise, no SOS.
+        The model must also be solved successfully before calling this method.
+
+        :param cts: a sequence of linear constraints.
+
+        :return: a sequence of float numbers
+        """
+        self._check_problem_type(feature='dual values')
+        checked_lcts = self._checker.typecheck_constraint_seq(cts, check_linear=True)
+        return self._dual_values(checked_lcts)

+
+    def _dual_values(self, cts):
+        # PRIVATE
+        checked_lcts = self._checker.typecheck_cts_added_to_model(mdl=self, cts=cts)
+        sol = self.solution
+        sol.ensure_dual_values(self, self.get_engine())
+        return sol.get_dual_values(checked_lcts)
+
+    def _slack_value1(self, ct):
+        # private
+        self._checker.typecheck_ct_added_to_model(mdl=self, ct=ct)
+        self._check_has_solution()
+        return self._slack_values([ct])[0]
+
+
[docs]    def slack_values(self, cts):
+        """ Return the slack values for a sequence of constraints.
+
+        Slack values are available for linear, quadratic and indicator constraints.
+        The model must be solved successfully before calling this method.
+
+        :param cts: a sequence of constraints.
+        :return: a list of float values, in the same order as the constraints.
+        """
+        self._check_has_solution()
+        ckr = self._checker
+        cts1 = ckr.typecheck_constraint_seq(cts)
+        cts2 = ckr.typecheck_cts_added_to_model(self, cts1)
+        return self._slack_values(cts2)

+
+    def _slack_values(self, cts):
+        checked_cts = self._checker.typecheck_constraint_seq(cts)
+        # ---
+        sol = self.solution
+        sol.ensure_slack_values(self, self.get_engine())
+        return sol.get_slacks(checked_cts)
+
+    def _reduced_cost1(self, dvar):
+        # PRIVATE
+        self._check_problem_type(feature='reduced costs')
+        #self._checker.typecheck_var(dvar)
+        rcs = self._reduced_costs([dvar])
+        return rcs[0]
+
+
[docs]    def get_cuts(self):
+        """ Returns the number of cuts under the form of a dict(type -> number).
+
+        Note: The model must also be solved successfully before calling this method.
+
+        :return: the number of cuts under the form of a dict(type -> number).
+        """
+        sol = self.solution
+        assert sol is not None
+        return sol.get_cuts()

+
+
[docs]    def get_num_cuts(self, cut_type):
+        """ Returns the number of cuts for a specific type.
+
+        Note: The model must also be solved successfully before calling this method.
+
+        :param cut_type: a cut type.
+        :return: the number of cuts associated to this type of cut.
+        """
+        sol = self.solution
+        assert sol is not None
+        return sol.get_num_cuts(cut_type)

+
+
[docs]    def reduced_costs(self, dvars):
+        """ Returns the reduced costs for a variable iterable.
+
+         Note: the model must a pure LP: no integer or binary variable, no piecewise, no SOS.
+         The model must also be solved successfully before calling this method.
+
+        :param dvars: a sequence of variables.
+        :return: a list of float numbers, in the same order as the variable sequence.
+        """
+        self._check_problem_type(feature='reduced costs')
+        checked_vars = self._checker.typecheck_var_seq(dvars, caller='Model.reduced_costs')
+        return self._reduced_costs(checked_vars)

+
+    def _reduced_costs(self, dvars):
+        sol = self.solution
+        assert sol is not None
+        sol.ensure_reduced_costs(model=self, engine= self.get_engine())
+        return sol.get_reduced_costs(dvars)
+
+
[docs]    def quadratic_dual_slacks(self, *args):
+        """ Returns quadratic dual slacks as a dict of dicts.
+
+        Can be called in two forms: either with no arguments, in which case it returns
+        quadratic dual slacks for all quadratic constraints in the model, or with
+        a list of quadratic constraints. In this case it returns only quadratic dual slacks for those constraints
+
+        :param args: accepts either no arguments,or a list of quadratic constraints.
+
+        :return: a Python dictionary, whose keys are quadratic constraints, and
+            values are dictionaries from variables to quadratic dual slacks.
+
+        *New in version 2.15*
+        """
+        nb_args = len(args)
+        if 0 == nb_args:
+            qcts = self.iter_quadratic_constraints()
+        elif 1 == nb_args:
+            qcts = args[0]
+        else:
+            qcts = None
+            self.fatal("Model.quadratic_dual_slacks expects either an iteratble on quadratic constraints, or no args.")
+
+        self._check_problem_type('quadratic_dual_slacks', requires_solution=True, accept_qxp=True)
+        cpx = self._get_cplex(do_raise=True, msgfn=lambda: "Quadratic dual slacks require CPLEX library")
+        checked_qcts = self._checker.typecheck_quadratic_constraint_seq(qcts)
+        if checked_qcts:
+            qixs = [qc.index for qc in checked_qcts]
+            cpx_qdss = cpx.solution.get_quadratic_dualslack(qixs)
+            qds_as_dict = {checked_qcts[q]: {self._var_by_index(idx): qds for idx, qds in zip(cpx_sp.ind, cpx_sp.val)} \
+                        for q, cpx_sp in enumerate(cpx_qdss) }
+            return qds_as_dict
+        else:
+            return {}

+
+    def _var_basis_status1(self, dvar):
+        # internal
+        return self.var_basis_statuses([dvar])[0]
+
+
[docs]    def var_basis_statuses(self, dvars):
+        """
+        Returns basis status for a batch of variables.
+
+        :param dvars: an iterable returning variables.
+        :return: a list of basis status, of type :class:`docplex.mp.constants.BasisStatus`.
+            The order of the list is the order in which variables were returned by the iterable.
+
+        *New in version 2.10*
+        """
+        self._check_problem_type(feature='basis status', requires_solution=False, accept_qxp=False)
+        checked_vars = self._checker.typecheck_var_seq(dvars)
+        return self._var_basis_status(checked_vars)

+
+    def _var_basis_status(self, dvars):
+        return self._generic_get_basis_status(dvars, pos=0,
+                                               sol_getter=lambda s_, dvs_: s_.get_var_basis_statuses(dvs_))
+
+
[docs]    def linear_constraint_basis_statuses(self, lcts):
+        """
+        Returns basis status for a batch of linear constraints.
+
+        :param lcts: an iterable returning linear constraints.
+        :return: a list of basis status, of type :class:`docplex.mp.constants.BasisStatus`.
+            The order of the list is the order in which constraints were returned by the iterable.
+
+        *New in version 2.10*
+        """
+        self._check_problem_type(feature='basis status', requires_solution=False, accept_qxp=False)
+        checked_lincts = self._checker.typecheck_constraint_seq(lcts, check_linear=True, accept_range=True)
+        return self._linearct_basis_status(checked_lincts)

+
+    def _linearct_basis_status(self, lcts):
+        return self._generic_get_basis_status\
+            (lcts, pos=1, sol_getter=lambda s_, cts_: s_.get_linearct_basis_statuses(cts_))
+
+    def _generic_get_basis_status(self, objs, pos, sol_getter):
+        assert pos in {0, 1}
+        sol = self.solution
+        if sol:
+            sol.ensure_basis_statuses(model=self, engine= self.get_engine())
+            return sol_getter(sol, objs) #sol.get_linearct_basis_statuses(lcts)
+        else:
+            basis_tuple = self.__engine.get_basis(self)
+            basis = basis_tuple[pos]
+            if not len(basis):
+                self.error("No basis is available")
+                return [BasisStatus.NotABasisStatus] * len(objs)
+            else:
+                return [ BasisStatus.parse(basis.get(obj, -1)) for obj in objs]
+
+
[docs]    def has_basis(self):
+        """ returns True if the model contains basis information.
+
+        *New in version 2.9*
+        """
+        sol = self.solution
+        if sol:
+            sol.ensure_basis_statuses(model=self, engine= self.get_engine())
+            return sol._has_basis()
+        else:
+            var_basis, linct_basis = self.__engine.get_basis(self)
+            return len(var_basis) > 0

+
+    def _write_cplex_file(self, name, path, basename, extension, cpx_write_fn, check_fn=lambda m_: 0):
+        check_fn(self)
+        export_basename = normalize_basename(self.name, force_lowercase=True)
+        export_path = make_output_path2(actual_name=export_basename,
+                                        extension=extension,
+                                        path=path,
+                                        basename_fmt=basename)
+        if export_path:
+            msg = "CPLEX runtime is required for {0} export - file {1} not written".format(name, export_path)
+            cpx = self._get_cplex(do_raise=True, msgfn=lambda: msg)
+            try:
+                cpx_write_fn(cpx, export_path)
+            except Exception as ex:
+                print(f"An error occured: '{str(ex)}' -- write aborted")
+                return None
+            return export_path
+
+    def _check_basis(self):
+        if not self.has_basis():
+            self.fatal("No basis data is available for model '{0}'- cannot write basis file",
+                    self.name)
+
+    def export_basis(self, path=None, basename=None):
+        return self._write_cplex_file(name='basis', path=path, basename=basename,
+                                      extension='.bas',
+                                      cpx_write_fn=lambda cpx_, path_: cpx_.solution.basis.write(path_),
+                                      check_fn=lambda m_: m_._check_basis())
+
+
+    DEFAULT_VAR_VALUE_QUOTED_SOLUTION_FMT = '  \"{varname}\"={value:.{prec}f}'
+    DEFAULT_VAR_VALUE_UNQUOTED_SOLUTION_FMT = '  {varname}={value:.{prec}f}'
+    DEFAULT_OBJECTIVE_FMT = "{0}: {1:.{prec}f}"
+
+    @classmethod
+    def supports_logical_constraints(cls):
+        return cls()._supports_logical_constraints()
+
+    def _supports_logical_constraints(self):
+        # INTERNAL
+        ok, _ = self.__engine.supports_logical_constraints()
+        return ok
+    
+    _is_cplex_ce = None
+    
+    @classmethod
+    def is_cplex_ce(cls):
+        if cls._is_cplex_ce is None:
+            m = Model()
+            if not m.has_cplex():
+                cls._is_cplex_ce = False
+            else:
+                try:
+                    for i in range(1001):
+                        v = m.integer_var()
+                        m.add_constraint(v <= i)
+                    m.solve()
+                    cls._is_cplex_ce = False
+                except DOcplexLimitsExceeded as e:
+                    cls._is_cplex_ce = True
+        return cls._is_cplex_ce
+
+    def _check_logical_constraint_support(self):
+        ok, why = self.__engine.supports_logical_constraints()
+        if not ok:
+            assert why
+            self.fatal(msg=why)
+
+    @classmethod
+    def is_docplex_debug(cls):
+        return not not os.environ.get("DOCPLEX_DEBUG")
+
+    def _has_username_with_spaces(self):
+        for v in self.iter_variables():
+            if v.has_user_name() and ' ' in v.name:
+                return True
+        return False
+
+
[docs]    def print_solution(self, print_zeros=False,
+                       solution_header_fmt=None,
+                       var_value_fmt=None,
+                       **kwargs):
+        """  Prints the values of the model variables after a solve.
+
+        Only valid after a successful solve. If the model has not been solved successfully, an
+        exception is raised.
+
+        Args:
+            print_zeros (Boolean): If False, only non-zero values are printed. Default is False.
+            solution_header_fmt: a solution header string in format syntax, or None.
+                This format will be passed to  :func:`docplex.mp.solution.SolveSolution.display`.
+            var_value_fmt : A format string to format the variable name and value. Again, the default uses the automatically computed precision.
+
+        See also:
+            :func:`docplex.mp.solution.SolveSolution.display`
+        """
+        self._check_has_solution()
+        if var_value_fmt is None:
+            if self._has_username_with_spaces():
+                var_value_fmt = self.DEFAULT_VAR_VALUE_QUOTED_SOLUTION_FMT
+            else:
+                var_value_fmt = self.DEFAULT_VAR_VALUE_UNQUOTED_SOLUTION_FMT
+        if not self.has_objective():
+            var_value_fmt = var_value_fmt[2:]
+        # scope of variables.
+        iter_vars = self.iter_variables() if print_zeros else None
+        # if some username has a whitespace, use quoted format
+        self.solution.display(print_zeros=print_zeros,
+                              header_fmt=solution_header_fmt,
+                              value_fmt=var_value_fmt,
+                              iter_vars=iter_vars, **kwargs)

+
+
[docs]    def report(self):
+        """  Prints the value of the objective and the KPIs.
+        Only valid after a successful solve, otherwise states that the model is not solved.
+        """
+        if self._has_solution():
+            if self.has_multi_objective():
+                mobj_values = self._multi_objective_values()
+                prec = self._float_precision
+                s_mobjs = ", ".join("{0:.{prec}f}".format(mo, prec=prec) for mo in mobj_values)
+                print("* model {0} solved with objectives = [{1}]".format(self.name, s_mobjs))
+            else:
+                used_prec = self._float_precision
+                print("* model {0} solved with objective = {1:.{prec}f}".format(self.name,
+                                                                                self._objective_value(), prec=used_prec))
+            self.report_kpis()
+        else:
+            status = self.solve_details.status
+            self.info("Model {0} has not been solved successfully, status is: {1}.".format(self.name, status))

+
+
[docs]    def report_kpis(self, solution=None, selected_kpis=None, kpi_format='*  KPI: {1:<{0}} = '):
+        """  Prints the values of the KPIs.
+
+        KPIs require a solution to be evaluated. This solution can be passed explicitly as a parameter,
+        or the model is assumed to be solved with a valid solution.
+
+        :param solution: an instance of `SolveSolution`. If not passed, the model solution is
+            queried. If the model has no solution, an exception is raised.
+        :param selected_kpis: an optional iterable returning the KPIs to print.
+            The default behavior is to print all kpis.
+        :param kpi_format: an optional format to print the KPi name and its value.
+
+        See Also:
+            :class:`docplex.mp.solution.SolveSolution`
+            :func:`new_solution`
+        """
+        kpi_num_format = kpi_format + self._float_meta_format % (2,)
+        kpi_str_format = kpi_format + '{2!s}'
+        printed_kpis = list(selected_kpis if is_iterable(selected_kpis) else self.iter_kpis())
+        try:
+            max_kpi_name_len = max(len(k.name) for k in printed_kpis) # max() raises ValueError on empty
+        except ValueError:
+            max_kpi_name_len = 0
+        for kpi in printed_kpis:
+            kpi_value = kpi.compute(solution)
+            if is_number(kpi_value):
+                k_format = kpi_num_format
+            else:
+                k_format = kpi_str_format
+
+            if type(k_format) != type(kpi.name):
+                # infamous mix of str and unicode. Should happen only
+                # in py2. Let's convert things
+                if isinstance(k_format, str):
+                    k_format = k_format.decode('utf-8')
+                else:
+                    k_format = k_format.encode('utf-8')
+
+
+            output = k_format.format(max_kpi_name_len, kpi.name, kpi_value)
+            try:
+                print(output)
+            except UnicodeEncodeError:
+                encoding = sys.stdout.encoding if sys.stdout.encoding else 'ascii'
+                print(output.encode(encoding,
+                                    errors='backslashreplace'))

+
+
[docs]    def kpis_as_dict(self, solution=None, kpi_filter=None, objective_key=None, use_names=True):
+        """ Returns KPI values in a solution as a dictionary.
+
+        Each KPI has a value in the solution. This method returns a dictionary of KPI values,
+        indexed by KPI objects.
+
+        :param solution: an instance of solution, as returned by solve(). If not passed, will
+            use the model's solution. If no solution is present, an exception is raised.
+        :param kpi_filter: an optional predicate to filter some kpis.
+            If provided, accepts a function taking one KPI as argument and
+            returning a boolean. By default, all KPIs are returned.
+        :param objective_key: an optional string key for th eobjective value. If present, the
+            value of the objective is added to the dictionary, with this key. By default, this parameter
+            is None and the objective is *not* appended to the dictionary.
+        :param use_names: a flag which determines whether keys in the resulting dict
+            are KPI objects or kpi names. Default is to use KPI names.
+
+        :return:
+            A dictionary mapping KPIs, or KPI names to values.
+
+        See Also:
+            :class:`docplex.mp.solution.SolveSolution`
+        """
+        if kpi_filter is None:
+            kpi_filter = lambda _: True
+
+        if use_names:
+            kpi_dict = {kpi.name: kpi.compute(solution) for kpi in self.iter_kpis() if kpi_filter(kpi)}
+        else:
+            kpi_dict = {kpi: kpi.compute(solution) for kpi in self.iter_kpis() if kpi_filter(kpi)}
+        if objective_key:
+            kpi_dict[objective_key] = solution.objective_value
+        return kpi_dict

+
+    def _report_lexicographic_goals(self, goal_name_values, kpi_header_format):  # pragma: no cover
+        kpi_format = kpi_header_format + self._float_meta_format % (1,) # be safe even integer KPIs might yield floats
+        printed_kpis = goal_name_values if is_iterable(goal_name_values) else self.iter_kpis()
+        for goal_name, goal_expr in printed_kpis:
+            goal_value = goal_expr.solution_value
+            print(kpi_format.format(goal_name, goal_value))
+
+
[docs]    def iter_kpis(self):
+        """ Returns an iterator over all KPIs in the model.
+
+        Returns:
+           An iterator object.
+        """
+        return iter(self._allkpis)

+
+
[docs]    def kpi_by_name(self, name, try_match=True, match_case=False, do_raise=True):
+        """ Fetches a KPI from a string.
+
+        This method fetches a KPI from a string, using either exact naming or trying
+        to match a substring of the KPI name.
+
+        Args:
+            name (string): The string to be matched.
+            try_match (Boolean): If True, returns KPI whose name is not equal to the
+                argument, but contains it. Default is True.
+            match_case: If True, looks for a case-exact match, else ignores case. Default is False.
+            do_raise: If True, raise an exception when no KPI is found.
+
+        Example:
+            If the KPI name is "Total CO2 Cost" then fetching with argument `co2` and `match_case` to False
+            will succeed. If `match_case` is True, then no KPI will be returned.
+
+        Returns:
+            The KPI expression if found. If the search fails, either raises an exception or returns a dummy
+            constant expression with 0.
+        """
+        matching_kpi = self._matching_kpi(name, try_match, match_case)
+        if matching_kpi:
+            return matching_kpi
+        # no match was found
+        if do_raise:
+            self.fatal("Model has no KPI with name matching: '{0:s}'", name)
+        else:
+            return self._lfactory.new_zero_expr()

+
+    def _matching_kpi(self, name, try_match=True, match_case=False):
+        # internal
+        for kpi in iter(reversed(self._allkpis)):
+            kpi_name = kpi.name
+            ok = False
+            if kpi_name == name:
+                ok = True
+            elif try_match:
+                if match_case:
+                    ok = kpi_name.find(name) >= 0
+                else:
+                    ok = kpi_name.lower().find(name.lower()) >= 0
+            if ok:
+                return kpi
+        return None
+
+
[docs]    def kpi_value_by_name(self, name, solution=None, try_match=True, match_case=False):
+        """ Returns a KPI value from a KPI name.
+
+        This method fetches a KPI value from a string, using either exact naming or trying
+        to match a substring of the KPI name.
+
+        Args:
+            name (str): The string to be matched.
+            solution: an optional solution. If not present, assume the model is solved
+                and use the model solution.
+            try_match (Bool): If True, returns KPI whose name is not equal to the
+                argument, but contains it. Default is True.
+            match_case: If True, looks for a case-exact match, else ignores case. Default is False.
+
+        Example:
+            If the KPI name is "Total CO2 Cost" then fetching with argument `co2` and `match_case` to False
+            will succeed. If `match_case` is True, then no KPI will be returned.
+
+        Note:
+            KPIs require a solution to be evaluated. This solution can be passed explicitly as a parameter,
+            or the model is assumed to be solved with a valid solution.
+
+        Returns:
+            float: The KPI value.
+
+        See Also:
+            :class:`docplex.mp.solution.SolveSolution`
+            :func:`new_solution`
+        """
+        kpi = self.kpi_by_name(name, try_match, match_case=match_case, do_raise=True)
+        return kpi.compute(solution)

+
+
[docs]    def add_kpi(self, kpi_arg, publish_name=None):
+        """ Adds a Key Performance Indicator to the model.
+
+        Key Performance Indicators (KPIs) are objects that can be evaluated after a solve().
+        Typical use is with decision expressions, the evaluation of which return the expression's solution value.
+
+        KPI values are displayed with the method :func:`report_kpis`.
+
+        Args:
+            kpi_arg:  Accepted arguments are either an expression,
+                        a lambda function with two arguments (model + solution)
+                        or an instance of a subclass of abstract class KPI.
+
+            publish_name (string, optional): The published name of the KPI.
+
+        Note:
+            - If no publish_name is provided, DOcplex will try to access a
+              'name' attribute of the argument; if none exists, it will use the
+              string representation of the argument , as returned by `str()`.
+            - expression KPIs are seperate from the model. In other terms,
+              adding KPIs does not change the model (and matrix) being solved.
+
+        Examples:
+            `model.add_kpi(x+y+z, "Total Profit")` adds the expression `(x+y+z)` as a KPI with the name "Total Profit".
+
+            `model.add_kpi(x+y+z)` adds the expression `(x+y+z)` as a KPI with
+            the name "x+y+z", assuming variables x,y,z have names 'x', 'y', 'z' (resp.)
+
+        Returns:
+            The newly added KPI instance.
+
+        See Also:
+            :class:`docplex.mp.kpi.KPI`,
+            :class:`docplex.mp.kpi.DecisionKPI`
+        """
+        self._checker.typecheck_string(publish_name, accept_empty=False, accept_none=True, caller="Model.add_kpi(): ")
+        new_kpi = self._lfactory.new_kpi(kpi_arg, publish_name)
+        new_kpi_name = new_kpi.name
+        if new_kpi_name in set(kp.name for kp  in self._allkpis):
+            self.fatal("Duplicate KPI name: \"{0!s}\" ", new_kpi_name)
+        self._allkpis.append(new_kpi)
+        return new_kpi

+
+
[docs]    def remove_kpi(self, kpi_arg):
+        """ Removes a Key Performance Indicator from the model.
+
+        Args:
+            kpi_arg:  A KPI instance that was previously added to the model. Accepts either a KPI object or a string.
+                If passed a string, looks for a KPI with that name.
+
+        See Also:
+            :func:`add_kpi`
+            :class:`docplex.mp.kpi.KPI`,
+            :class:`docplex.mp.kpi.DecisionKPI`
+        """
+        if is_string(kpi_arg):
+            kpi = self.kpi_by_name(kpi_arg)
+            if kpi:
+                self._allkpis.remove(kpi)
+                kpi.notify_removed()
+        else:
+            for k, kp in enumerate(self._allkpis):
+                if kp is kpi_arg:
+                    kx = k
+                    break
+            else:
+                kx = -1
+            if kx >= 0:
+                removed_kpi = self._allkpis.pop(kx)
+                removed_kpi.notify_removed()
+
+            else:
+                self.warning('Model.remove_kpi(): cannot interpret this either as a string or as a KPI: {0!r} - ignored', kpi_arg)

+
+
[docs]    def clear_kpis(self):
+        ''' Clears all KPIs defined in the model.
+
+        
+        '''
+        self._allkpis = []

+
+    @property
+    def number_of_kpis(self):
+        return len(self._allkpis)
+
+
+
[docs]    def add_progress_listener(self, listener):
+        """ Adds a progress listener to the model.
+
+        A progress listener is a subclass of :class:~docplex.mp.ProgressListener:
+
+        :param listener:
+        """
+        self._checker.typecheck_progress_listener(listener)
+        self._add_progress_listener(listener)

+
+    def _add_progress_listener(self, listener):
+        # INTERNAL
+        self._progress_listeners.append(listener)
+
+    def _add_qprogress_listener(self, qlistener):
+        self._qprogress_listeners.append(qlistener)
+
+
[docs]    def remove_progress_listener(self, listener):
+        """ Remove a progress listener from the model.
+
+        :param listener:
+        """
+        try:
+            self._progress_listeners.remove(listener)
+        except ValueError:
+            # ignore errors
+            if self.is_docplex_debug():
+                raise
+            else:
+                pass

+
+
[docs]    def iter_progress_listeners(self):
+        """ Returns an iterator on the progress listeners attached to the model.
+
+        :return: an iterator.
+
+        """
+        return iter(self._progress_listeners)

+
+    @property
+    def number_of_progress_listeners(self):
+        """ Returns the number of progress listeners attached to the model.
+
+        :return: an integer
+        """
+        return len(self._progress_listeners)
+
+
[docs]    def clear_progress_listeners(self):
+        """ Remove all progress listeners from the model."""
+        self._progress_listeners = []

+
+    def _clear_qprogress_listeners(self):
+        self._qprogress_listeners = []
+
+    def _fire_start_solve_listeners(self):
+        for l in self._progress_listeners:
+            l.notify_start()
+
+    def _fire_end_solve_listeners(self, has_solution, objective_value):
+        for l in self._progress_listeners:
+            l.notify_end(has_solution, objective_value)
+
+    def prettyprint(self, out=None):
+        from docplex.mp.ppretty import ModelPrettyPrinter
+        ppr = ModelPrettyPrinter()
+        ppr.printModel(self, out=out)
+
+    pprint = prettyprint
+
+    def pprint_as_string(self):
+        from docplex.mp.ppretty import ModelPrettyPrinter
+        with StringIO() as oss:
+            ppr = ModelPrettyPrinter()
+            ppr.printModel(self, out=oss)
+            return oss.getvalue()
+
+
[docs]    def clone(self, new_name=None, **clone_kwargs):
+        """ Makes a deep copy of the model, possibly with a new name.
+        Decision variables, constraints, and objective are copied.
+
+        Args:
+            new_name (string): The new name to use. If None is provided, returns a "Copy of xxx" where xxx is the original model name.
+
+        :returns: A new model.
+
+        :rtype: :class:`docplex.mp.model.Model`
+        """
+        return self.copy(new_name=new_name, **clone_kwargs)

+
+    def copy(self, new_name=None, removed_cts=None, **new_kwargs):
+        # INTERNAL
+        actual_copy_name = new_name or "Copy of %s" % self.name
+        # copy kwargs
+        copy_kwargs = self._get_kwargs().copy()
+        copy_kwargs.update(**new_kwargs)
+
+        copy_context = self.context.copy()
+        # pass copy of initial context
+        # plus override kwargs (e.g. log_output)
+        copy_model = Model(name=actual_copy_name, context=copy_context, **copy_kwargs)
+
+        # clone variable containers
+        ctn_map = {}
+        for ctn in self.iter_var_containers():
+            copied_ctn = ctn.copy(copy_model)
+            ctn_map[ctn] = copied_ctn
+            copy_model._add_var_container(copied_ctn)
+
+        # clone variables
+        def make_memo():
+            memo = {}
+            generated_vars = []
+
+            # clone PWL functions and add them to var_mapping
+            for pwl_func in self.iter_pwl_functions():
+                copied_pwl_func = pwl_func.copy(copy_model, memo)
+                memo[pwl_func] = copied_pwl_func
+            # copy 'primary' variables
+            for v in self.iter_variables():
+                if v.is_generated():
+                    generated_vars.append(v)
+                else:
+                    copied_var = copy_model._var(v.vartype, v.lb, v.ub, v.name)
+                    var_ctn = v.container
+                    if var_ctn:
+                        copied_ctn = ctn_map.get(var_ctn)
+                        assert copied_ctn is not None
+                        copied_var.container = copied_ctn
+                    memo[v] = copied_var
+
+            for gv in generated_vars:
+                gvoo = gv.origin
+                try:
+                    gvo, gvx = gvoo
+                except TypeError:
+                    gvo = gvoo
+                    gvx = 0
+                assert gvo is not None
+                gvk = id(gvo)
+                cloned_origin = memo.get(gvk)
+                if cloned_origin is None:
+                    cloned_origin = gvo.copy(copy_model, memo)
+                    cloned_origin.resolve()
+                    memo[gvk] = cloned_origin
+                cloned_gv = cloned_origin.get_artefact(gvx)
+                assert cloned_gv
+
+                memo[gv] = cloned_gv
+            return memo
+
+        memo = make_memo()
+
+
+
+        # copy constraints
+        setof_removed_cts = set(removed_cts) if removed_cts else {}
+        linear_cts = []
+        for ct in self.iter_constraints():
+            if not ct.is_generated() and ct not in setof_removed_cts:
+                if isinstance(ct, PwlConstraint):
+                    continue
+                if ct.is_linear():
+                    linear_cts.append(ct.copy(copy_model, memo))
+                elif ct.is_logical:
+                    if linear_cts:
+                        # add stored linear cts
+                        copy_model.add_constraints(linear_cts)
+                        linear_cts = []
+                    copy_model.add(ct.copy(copy_model, memo))
+
+        if linear_cts:
+            copy_model.add_constraints(linear_cts)
+
+        # clone objective
+        copy_model.set_objective_sense(self.objective_sense)
+        if self.has_multi_objective():
+            multi_objective = self._multi_objective
+            exprs = multi_objective.exprs
+            nb_exprs = len(exprs)
+            copied_exprs = [expr.copy(copy_model, memo) for expr in exprs]
+            copy_model.set_multi_objective(self.objective_sense,
+                                           exprs=copied_exprs,
+                                           priorities=multi_objective.priorities,
+                                           weights=multi_objective.weights,
+                                           abstols=MultiObjective.as_optional_sequence(multi_objective.abstols,
+                                                                                       nb_exprs),
+                                           reltols=MultiObjective.as_optional_sequence(multi_objective.reltols,
+                                                                                       nb_exprs),
+                                           names=multi_objective.names)
+
+        else:
+            copy_model.set_objective(self.objective_sense, self.objective_expr.copy(copy_model, memo))
+
+        # clone kpis
+        for kpi in self.iter_kpis():
+            copy_model.add_kpi(kpi.copy(copy_model, memo))
+
+        # clone sos
+        for sos in self.iter_sos():
+            if not sos.is_generated():
+                copy_model._create_engine_sos(sos.copy(copy_model, memo))
+
+        # parameters
+        for p in self.parameters.iter_params():
+            if p.is_nondefault():
+                # copy value to new parames
+                newp = copy_model.get_parameter_from_id (p.cpx_id)
+                if newp:
+                    newp.set(p.value)
+
+        return copy_model
+
+
[docs]    def end(self):
+        """ Terminates a model instance.
+
+        Since this method destroys the objects associated with the model, you must not use the model
+        after you call this member function.
+        This method must be called when you don't need a CPLEX engine anymore to free resources,
+        unless the docplex.Model was created with the `with` keyword.
+
+        """
+        self._clear_internal(terminate=True)

+
+    @property
+    def parameters(self):
+        """ This property returns the root parameter group of the model.
+
+        The root parameter group models the parameter hierarchy.
+        It is the way to access any CPLEX parameter and get or set its value.
+
+        Examples:
+
+            .. code-block:: python
+
+               model.parameters.mip.tolerances.mipgap
+
+            Returns the parameter itself, an instance of the `Parameter` class.
+
+            To get the value of the parameter, use the `get()` method, as in:
+
+            .. code-block:: python
+
+               model.parameters.mip.tolerances.mipgap.get()
+               >>> 0.0001
+
+            To change the value of the parameter, use a standard Python assignment:
+
+            .. code-block:: python
+
+               model.parameters.mip.tolerances.mipgap = 0.05
+               model.parameters.mip.tolerances.mipgap.get()
+              >>> 0.05
+
+            Assignment is equivalent to the `set()` method:
+
+            .. code-block:: python
+
+               model.parameters.mip.tolerances.mipgap.set(0.02)
+               model.parameters.mip.tolerances.mipgap.get()
+               >>> 0.02
+
+        Returns:
+            The root parameter group, an instance of the `ParameterGroup` class.
+
+        """
+        context_params = self.context.cplex_parameters
+        if not self._synced_params:
+            self._sync_params(context_params)
+            self._synced_params = True
+        return context_params
+
+
[docs]    def get_parameter_from_id(self, parameter_cpx_id):
+        """ Finds a parameter from a CPLEX id code.
+
+        Args:
+            parameter_cpx_id: A CPLEX parameter id (positive integer, for example, 2009 is mipgap).
+
+        :returns: An instance of :class:`docplex.mp.params.parameters.Parameter` if found, else None.
+        """
+        assert parameter_cpx_id >= 0
+        for p in self.parameters.generate_params():
+            if p.cpx_id == parameter_cpx_id:
+                return p
+        return None

+
+    def get_engine_parameter_value(self, param):
+        return self.__engine.get_parameter(param)
+
+    def apply_parameters(self):
+        self._apply_parameters_to_engine(self.parameters)
+
+    def apply_one_parameter(self, param):
+        # internal
+        self.__engine.set_parameter(param, param.value)
+
+    def _apply_parameters_to_engine(self, parameters_to_use):
+        # internal
+        if parameters_to_use is not None:
+            self_engine = self.__engine
+            for param in parameters_to_use:
+                self_engine.set_parameter(param, param.value)
+
+    def _get_cplex_engine(self, caller):
+        # INTERNAL
+        self_engine = self.get_engine()
+        if self_engine.name != 'cplex_local':
+            self.fatal("{1} is only for Cplex, engine is '{0}'", self_engine.name, str(caller))
+        else:
+            return self_engine
+
+    def set_hidden_parameter(self, parameter_id, param_value):
+        self_engine = self._get_cplex_engine(caller="Model.set_hidden_parameter")
+        self_engine.set_parameter_from_id(parameter_id, param_value)
+
+    def get_hidden_parameter(self, parameter_id):
+        self_engine = self._get_cplex_engine(caller="Model.get_hidden_parameter")
+        return self_engine.get_parameter_from_id(parameter_id)
+
+
+    # with protocol
+    def __enter__(self):
+        return self
+
+    def __exit__(self, atype, avalue, atraceback):
+        # terminate the model upon exiting a 'with' block.
+        self.end()
+
+    def __iadd__(self, e):
+        # implements the "+=" dialect a la PulP
+        self.add(e)
+        return self
+
+    def _resync(self):
+        # INTERNAL
+        self._lfactory.resync_whole_model()
+
+    def resync_engine(self):
+        # INTERNAL: resync after pickle
+        self.__engine.resync()
+
+    def sync_cplex_engine(self):
+        if self.has_cplex():
+            eng = self.get_engine()
+            eng.sync_cplex()
+        else:
+            self.warning('Model has no cplex, sync operation ignored.')
+
+
[docs]    def add_sos1(self, dvars, name=None):
+        ''' Adds  an SOS of type 1 to the model.
+
+        Args:
+            dvars: The variables in the special ordered set.
+                This method only accepts ordered sequences of variables or iterators.
+                Unordered iterables (e.g. dictionaries or sets) are not accepted.
+
+            name: An optional name.
+
+        Returns:
+            The newly added SOS.
+        '''
+        return self.add_sos(dvars, sos_arg=SOSType.SOS1, name=name)

+
+
[docs]    def add_sos2(self, dvars, name=None):
+        ''' Adds  an SOS of type 2 to the model.
+
+        Args:
+           dvars: The variables in the specially ordered set.
+                This method only accepts ordered sequences of variables or iterators.
+                Unordered iterables (e.g. dictionaries or sets) are not accepted.
+           name: An optional name.
+
+        Returns:
+            The newly added SOS.
+        '''
+        return self.add_sos(dvars, sos_arg=SOSType.SOS2, name=name)

+
+
[docs]    def add_sos(self, dvars, sos_arg, weights=None, name=None):
+        ''' Adds  an SOS to the model.
+
+        Args:
+           sos_arg: The SOS type. Valid values are numerical (1 and 2) or enumerated (`SOSType.SOS1` and
+              `SOSType.SOS2`).
+           dvars: The variables in the special ordered set.
+                This method only accepts ordered sequences of variables or iterators,
+                e.g. lists, numpy arrays, pandas Series.
+                Unordered iterables (e.g. dictionaries or sets) are not accepted.
+           weights: optional weights. Accepts None (no weights) or a list of numbers, with the same size as
+                number of variables.
+           name: An optional name.
+
+        Returns:
+            The newly added SOS.
+        '''
+        sos_type = SOSType.parse(sos_arg)
+        msgfn = lambda: f"Model.add_sos{sos_type.value} expects an ordered sequence (or iterator) of variables"
+        self._checker.check_ordered_sequence(arg=dvars, caller=msgfn)
+        var_seq = self._checker.typecheck_var_seq(dvars, caller="Model.add_sos")
+
+        var_list = list(var_seq)  # we need len here.
+        nb_vars = len(var_list)
+        if nb_vars <= sos_type.size:
+            if nb_vars < sos_type.size:
+                self.fatal("A {0:s} variable set must contain at least {1:d} variables, got: {2:d}",
+                           sos_type.name, sos_type.size, nb_vars)
+            else:
+                self.warning("{0:s} variable is trivial, contains {1} variable(s): all variables set to 1",
+                              sos_type.name, sos_type.size)
+
+        if weights is None:
+            lweights = weights
+        else:
+            checked_weights = StaticTypeChecker.typecheck_optional_num_seq(self, weights, accept_none=True, expected_size=nb_vars,
+                                                                caller='Model.add_sos')
+            lweights = [float(w) for w in checked_weights]
+        return self._add_sos(dvars, sos_type, weights=lweights, name=name)

+
+    def _add_sos(self, dvars, sos_type, weights=None, name=None):
+        # INTERNAL
+        new_sos = self._lfactory.new_sos(dvars, sos_type=sos_type, weights=weights, name=name)
+        sos_index = self.__engine.create_sos(new_sos)
+        self._register_sos(new_sos, sos_index)
+        new_sos._set_index(sos_index)
+        return new_sos
+
+    def _create_engine_sos(self, new_sos):
+        # internal
+        sos_index = self.__engine.create_sos(new_sos)
+        self._register_sos(new_sos, sos_index)
+        new_sos._set_index(sos_index)
+
+    def _register_sos(self, new_sos, sos_index):
+        self._sos_scope.notify_obj_index(new_sos, sos_index)
+
+    def _get_sos_by_index(self, sos_idx):
+        return self._sos_scope.get_object_by_index(sos_idx)
+
+
[docs]    def iter_sos(self):
+        ''' Iterates over all SOS sets in the model.
+
+        Returns:
+            An iterator object.
+        '''
+        return self._sos_scope.iter_objects()

+
+    @property
+    def number_of_sos(self):
+        ''' This property returns the total number of SOS sets in the model.
+
+        '''
+        return self._sos_scope.size
+
+
[docs]    def clear_sos(self):
+        ''' Clears all SOS sets in the model.
+        '''
+        self._sos_scope.clear()
+        self.__engine.clear_all_sos()

+
+    def _generate_sos(self, sos_type):
+        # INTERNAL
+        for sos_set in self.iter_sos():
+            if sos_set.sos_type == sos_type:
+                yield sos_set
+
+
[docs]    def iter_sos1(self):
+        ''' Iterates over all SOS1 sets in the model.
+
+        Returns:
+            An iterator object.
+        '''
+        return self._generate_sos(SOSType.SOS1)

+
+
[docs]    def iter_sos2(self):
+        ''' Iterates over all SOS2 sets in the model.
+
+        Returns:
+            An iterator object.
+        '''
+        return self._generate_sos(SOSType.SOS2)

+
+    @property
+    def number_of_sos1(self):
+        ''' This property returns the total number of SOS1 sets in the model.
+
+        '''
+        return sum(1 for _ in self.iter_sos1())
+
+    @property
+    def number_of_sos2(self):
+        ''' This property returns the total number of SOS2 sets in the model.
+
+        '''
+        return sum(1 for _ in self.iter_sos2())
+
+
[docs]    def piecewise(self, preslope, breaksxy, postslope, name=None):
+        """  Adds a piecewise linear function (PWL) to the model, using breakpoints to specify the function.
+
+        Args:
+            preslope: Before the first segment of the PWL function there is a half-line; its slope is specified by
+                        this argument.
+            breaksxy: A list `(x[i], y[i])` of coordinate pairs defining segments of the PWL function.
+            postslope: After the last segment of the the PWL function there is a half-line; its slope is specified by
+                        this argument.
+            name: An optional name.
+
+        Example::
+
+            # Creates a piecewise linear function whose value if '0' if the `x_value` is `0`, with a slope
+            # of -1 for negative values and +1 for positive value
+            model = Model('my model')
+            model.piecewise(-1, [(0, 0)], 1)
+
+            # Note that a PWL function may be discontinuous. Here is an example of a step function:
+            model.piecewise(0, [(0, 0), (0, 1)], 0)
+
+        Returns:
+            The newly added piecewise linear function.
+        """
+
+        if breaksxy is None:
+            self._checker.fatal("argument 'breaksxy' must be defined")
+
+        StaticTypeChecker.typecheck_num_nan_inf(self, preslope, caller='Model.piecewise.preslope')
+        StaticTypeChecker.typecheck_num_nan_inf(self, postslope, caller='Model.piecewise.postslope')
+        PwlFunction.check_list_pair_breaksxy(self._checker, breaksxy)
+        return self._piecewise(PwlFunction._PwlAsBreaks(preslope, breaksxy, postslope), name)

+
+
[docs]    def piecewise_as_slopes(self, slopebreaksx, lastslope, anchor=(0, 0), name=None):
+        """  Adds a piecewise linear function (PWL) to the model, using a list of slopes and x-coordinates.
+
+        Args:
+            slopebreaksx: A list of tuple pairs `(slope[i], breakx[i])` of slopes and x-coordinates defining the slope of
+                        the piecewise function between the previous breakpoint (or minus infinity if there is none)
+                        and the breakpoint with x-coordinate `breakx[i]`.
+                        For representing a discontinuity, two consecutive pairs with the same value for `breakx[i]`
+                        are used. The value of `slope[i]` in the second pair is the discontinuity gap.
+            lastslope: The slope after the last specified breakpoint.
+            anchor: The coordinates of the 'anchor point'. The purpose of the anchor point is to ground the piecewise
+                        linear function specified by the list of slopes and breakpoints.
+            name: An optional name.
+        Example::
+
+            # Creates a piecewise linear function whose value if '0' if the `x_value` is `0`, with a slope
+            # of -1 for negative values and +1 for positive value
+            model = Model('my model')
+            model.piecewise_as_slopes([(-1, 0)], 1, (0, 0))
+
+            # Here is the definition of a step function to illustrate the case of a discontinuous PWL function:
+            model.piecewise_as_slopes([(0, 0), (0, 1)], 0, (0, 0))
+
+        Returns:
+            The newly added piecewise linear function.
+        """
+        StaticTypeChecker.typecheck_num_nan_inf(self, lastslope, caller="Model.piecewise_as_slopes.lastslope")
+        StaticTypeChecker.check_number_pair(self, anchor, caller="Model.piecewise_as_slopes.anchor")
+        PwlFunction.check_list_pair_slope_breakx(self, slopebreaksx, anchor)
+        return self._piecewise(PwlFunction._PwlAsSlopes(slopebreaksx, lastslope, anchor), name)

+
+    def add_piecewise_constraint(self, y, pwlf, x, name=None):
+        checker = self._checker
+        checker.typecheck_continuous_var(x)
+        checker.typecheck_continuous_var(y)
+        checker.typecheck_pwl_function(pwlf)
+        if x is y:
+            self.fatal('Piecewise-linear constraint requires two different variables, only one wa passed: {0}', x)
+
+        pwl_expr = self._add_pwl_expr(pwlf, arg=x, yvar=y, resolve=False) # will be resolved later
+        pwl_ct = self._lfactory.new_pwl_constraint(pwl_expr, name)
+        return self._add_pwl_constraint_internal(pwl_ct)
+
+    def _piecewise(self, pwl_def, name=None):
+        pwl_func = self._lfactory.new_piecewise(pwl_def, name)
+        self.__allpwlfuncs.append(pwl_func)
+        return pwl_func
+
+    def _add_pwl_expr(self, pwl_func, arg, yvar=None, resolve=True):
+        pwl_expr = self._lfactory.new_pwl_expr(pwl_func, arg, y_var=yvar, resolve=resolve)
+        return pwl_expr
+
+    def _add_pwl_constraint_internal(self, pwlct):
+        ct_engine_index = self.__engine.create_pwl_constraint(pwlct)
+        self._register_one_pwl_constraint(pwlct, ct_engine_index)
+        return pwlct
+
+    def _register_one_pwl_constraint(self, new_pwl_ct, ct_index):
+        self.__notify_new_model_object(
+            "pwl", new_pwl_ct, ct_index, mobj_name=None, name_dir=None, idx_scope=self._pwl_scope, is_name_safe=True)
+
+
[docs]    def iter_pwl_constraints(self):
+        """ Iterates over all PWL constraints in the model.
+
+        Returns:
+            An iterator object.
+        """
+        return self._pwl_scope.iter_objects()

+
+    @property
+    def number_of_pwl_constraints(self):
+        """ This property returns the total number of PWL constraints in the model.
+        """
+        return self._pwl_scope.size
+
+    def _ensure_benders_annotations(self):
+        if self._benders_annotations is None:
+            self._benders_annotations = {}
+        return self._benders_annotations
+
+    def set_benders_annotation(self, obj, group):
+        if group is None:
+            self_benders = self._benders_annotations
+            if self_benders is not None and obj in self_benders:
+                del self_benders[obj]
+        else:
+            self._checker.typecheck_int(group, accept_negative=False, caller='Model.set_benders_annotation')
+            self._ensure_benders_annotations()[obj] = group
+
+    def remove_benders_annotation(self, obj):
+        self_benders = self._benders_annotations
+        if self_benders:
+            del self_benders[obj]
+
+    def get_benders_annotation(self, obj):
+        self_benders = self._benders_annotations
+        return self_benders.get(obj) if self_benders is not None else None
+
+    def iter_benders_annotations(self):
+        self_benders = self._benders_annotations
+        return self_benders.items() if self_benders is not None else iter([])
+
+    def clear_benders_annotations(self):
+        self._benders_annotations = None
+
+    def get_annotations_by_scope(self):
+        # INTERNAL
+        from collections import defaultdict
+        annotated_by_scope = defaultdict(list)
+        for obj, group in self.iter_benders_annotations():
+            annotated_by_scope[obj.cplex_scope].append((obj, group))
+        return annotated_by_scope
+
+    def has_benders_annotations(self):
+        self_benders = self._benders_annotations
+        return bool(self_benders)
+
+    def get_annotation_stats(self):
+        from collections import Counter
+        annotated_by_scope = Counter()
+        for obj, group in self.iter_benders_annotations():
+            annotated_by_scope[obj.cplex_scope] += 1
+        return annotated_by_scope
+
+    def register_callback(self, cb_type):
+        # Registers a callback with the model.
+        #
+        # Assumes the type has a `model` setter property. Use a subclass of `ModelCallbackMixin` mixin class
+        # as a parent class to ensure this.
+        #
+        # :param cb_type: a callback type; the type must be a subtype of some cplex callback type
+        #
+        # :return: an instance of the callback
+        #
+        cplex_cb = self.__engine.register_callback(cb_type)
+        if cplex_cb:
+            cplex_cb._model = self
+        return cplex_cb
+
+    def _resolve_pwls(self):
+        # INTERNAL
+        self._objective_expr.resolve()
+        no_pwl_scopes = [self._linct_scope, self._logical_scope, self._quadct_scope]
+        for sc in no_pwl_scopes:
+            for x in sc.iter_objects():
+                x.resolve()
+        # this call updates the dict so we must iterate on something else.
+        #pwls = [pw for pw in self._pwl_scope.iter_objects()]
+        pwls = list(self._pwl_scope.iter_objects())
+        # BEWARE: need this temp list as resolve will modify the dict, so canno titerate on it.
+        for pw in pwls:
+            pw.resolve()
+
+    def get_constraint_priority(self, ct):
+        # INTERNAL
+        return self._constraint_priority_dict.get(ct)  # return None if not found
+
+    def set_constraint_priority(self, ct, prio):
+        # INTERNAL
+        self._constraint_priority_dict[ct] = prio
+
+    def _extend_constraint_section(self, collector, extra_cts, ctnames, caller):
+        # INTERNAL
+        checker = self._checker
+        new_cts = checker.typecheck_constraint_seq(extra_cts, check_linear=True, accept_range=False)
+
+        if ctnames is not None:
+            checker.typecheck_iterable(ctnames)
+            for ct, ctn in izip2_filled(new_cts, ctnames):
+                checker.typecheck_string(ctn, accept_none=True)
+                if ctn:
+                    self._register_ct_name(ct, ctn, checker)
+
+        # extend
+        lncts = list(new_cts)
+        for nc in lncts:
+            checker.typecheck_ct_not_added(nc, do_raise=False, caller=caller)
+
+        collector.extend(new_cts)
+        return new_cts
+
+
[docs]    def add_lazy_constraints(self, lazy_cts, names=None):
+        """Adds lazy constraints to the problem.
+
+        This method expects an iterable returning linear constraints (ranges are not accepted).
+
+        :param lazy_cts: an iterable returning linear constraints (not ranges)
+        :param names: an optional iterable returning strings, used to set names for lazy constraints.
+
+        *New in version 2.10*
+        """
+        new_lazy_cts = self._extend_constraint_section(self._lazy_constraints, lazy_cts, names, caller='Model.add_lazy_constraints')
+        for nc in new_lazy_cts:
+            nc.notify_used_as_lazy_constraint()
+        self.__engine.add_lazy_constraints(new_lazy_cts)

+
+
[docs]    def add_lazy_constraint(self, lazy_ct, name=None):
+        """Adds one lazy constraint to the problem.
+
+        This method expects a linear constraint.
+
+        :param lazy_ct: a linear constraints (ranges are not accepted)
+        :param name: an optional string, used to set the name of the lazy constraint.
+
+        *New in version 2.10*
+
+        """
+        self.add_lazy_constraints((lazy_ct,), names=(name,))

+
+
[docs]    def clear_lazy_constraints(self):
+        """
+        Clears all lazy constraints from the model.
+
+        *New in version 2.10*
+        """
+        old_lazy_cts = self._lazy_constraints
+        for lz in old_lazy_cts:
+            lz.notify_unused_as_lazy_constraint()
+        self._lazy_constraints = []
+        self.__engine.clear_lazy_constraints()

+
+
[docs]    def iter_lazy_constraints(self):
+        """ Returns an iterator on the model's lazy constraints
+
+        :return: an iterator on lazy constraints.
+
+        *New in version 2.10*
+        """
+        return iter(self._lazy_constraints)

+
+    @property
+    def number_of_lazy_constraints(self):
+        """Returns the number of lazy constraints present in the model
+        """
+        return len(self._lazy_constraints)
+
+    def _is_lazy_constraint(self, lineart_ct):
+        # INTERNAL
+        return any(lc is lineart_ct for lc in self.iter_lazy_constraints())
+
+
[docs]    def add_user_cut_constraints(self, cut_cts, names=None):
+        """Adds user cut constraints to the problem.
+
+        This method expects an iterable returning linear constraints (ranges are not accepted).
+
+        :param cut_cts: an iterable returning linear constraints (not ranges)
+        :param names: an optional iterable returning strings, used to set names for user cut constraints.
+
+        *New in version 2.10*
+        """
+        new_user_cuts = self._extend_constraint_section(self._user_cuts, cut_cts, names, caller='Model.add_user_cut_constraints')
+        for nc in new_user_cuts:
+            nc.notify_used_as_user_cut()
+        self.__engine.add_user_cuts(new_user_cuts)

+
+
[docs]    def add_user_cut_constraint(self, cut_ct, name=None):
+        """Adds one user cut constraint to the problem.
+
+        This method expects a linear constraint.
+
+        :param cut_ct: a linear constraints (ranges are not accepted)
+        :param name: an optional string, used to set the name for the cut constraint.
+
+        *New in version 2.10*
+        """
+        self.add_user_cut_constraints((cut_ct,), names=(name,))

+
+
[docs]    def clear_user_cut_constraints(self):
+        """
+        Clears all user cut constraints from the model.
+
+        *New in version 2.10*
+        """
+        old_user_cuts = self._user_cuts
+        for uc in old_user_cuts:
+            uc.notify_unused_as_user_cut()
+
+        self._user_cuts = []
+        self.__engine.clear_user_cuts()

+
+
[docs]    def iter_user_cut_constraints(self):
+        """ Returns an iterator on the model's user cut constraints
+
+        :return: an iterator on user cut constraints.
+
+        *New in version 2.10*
+        """
+        return iter(self._user_cuts)

+
+    @property
+    def number_of_user_cut_constraints(self):
+        """Returns the number of user cut constraints present in the model
+
+        *New in version 2.10*
+
+        """
+        return len(self._user_cuts)
+
+    def _is_user_cut_constraint(self, lineart_ct):
+        # INTERNAL
+        return any(lc is lineart_ct for lc in self.iter_user_cut_constraints())

+
+
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/model_reader.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/model_reader.html new file mode 100644 index 0000000..b07bb17 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/model_reader.html @@ -0,0 +1,940 @@ + + + + + + + + + docplex.mp.model_reader — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.model_reader

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+import os
+import time
+
+# docplex
+from docplex.mp.model import Model
+from docplex.mp.utils import DOcplexException, MockIterable
+from docplex.mp.environment import Environment
+
+from docplex.mp.params.cplex_params import get_params_from_cplex_version
+from docplex.mp.constants import ComparisonType
+from docplex.mp.constr import LinearConstraint
+
+from docplex.mp.cplex_adapter import CplexAdapter
+from docplex.mp.cplex_engine import CplexEngine
+
+from docplex.mp.quad import VarPair
+
+import os
+import xml.etree.ElementTree as ET
+import tempfile
+
+
+
+
[docs]class ModelReaderError(DOcplexException):
+    pass

+
+
+class _CplexReaderFileContext(object):
+    def __init__(self, filename, read_method=None):
+        self._cplex = None
+        self._filename = filename
+        self._read_method = read_method or ["read"]
+
+    def __enter__(self):
+        self.cpx_adapter = CplexAdapter()
+        cpx = self.cpx_adapter.cpx
+        # no output from CPLEX
+        cpx.set_results_stream(None)
+        cpx.set_log_stream(None)
+        cpx.set_warning_stream(None)
+        cpx.set_error_stream(None)
+        self_read_fn = cpx
+        for m in self._read_method:
+            self_read_fn = self_read_fn.__getattribute__(m)
+
+        try:
+            self_read_fn(self._filename)
+            self._cplex = cpx
+            return self.cpx_adapter
+
+        except self.cpx_adapter.CplexError as cpx_e:  # pragma: no cover
+            # delete cplex instance
+            del cpx
+            raise ModelReaderError("*CPLEX error {0!s} reading file {1} - exiting".format(cpx_e, self._filename))
+
+    # noinspection PyUnusedLocal
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        cpx = self._cplex
+        if cpx is not None:
+            del cpx
+            self._cplex = None
+
+
+# def compute_full_dotf(mdl, coefs, constant=0):
+#     def coef_fn(dvx):
+#         return coefs[dvx]
+#
+#     lfactory = mdl._lfactory
+#     terms_dict = lfactory._new_term_dict()
+#     for dv in mdl.iter_variables():
+#         coef = coef_fn(dv.index)
+#         if coef:
+#             terms_dict[dv] = coef
+#     linear_expr = lfactory.linear_expr(terms_dict, constant=constant, safe=True)
+#     return linear_expr
+
+
+def compute_full_dot(mdl, coefs, constant=0):
+    # compute a scalar product, with possible zeros as coefs
+    lfactory = mdl._lfactory
+    terms_dict = lfactory._new_term_dict()
+    for dv, k in zip(mdl.iter_variables(), coefs):
+        if k:
+            terms_dict[dv] = k
+    linear_expr = lfactory.linear_expr(terms_dict, constant=constant, safe=True)
+    return linear_expr
+
+
+# noinspection PyArgumentList
+
[docs]class ModelReader(object):
+    """ This class is used to read models from CPLEX files (e.g.  SAV, LP, MPS)
+    This class requires CPLEX runtime, otherwise an exception is raised.
+
+    Example:
+        Use class method ``read`` to read a model file.
+
+        >>> m = ModelReader.read('mymodel.lp', ignore_names=True)
+
+        reads a model while ignoring all names.
+
+        Global function ``read_model`` is a synonym for ``ModelReader.read``,
+        and is the preferred way to read model files.
+
+    """
+
+    @staticmethod
+    def _build_linear_expr_from_sparse_pair(lfactory, var_map, cpx_sparsepair):
+        terms = {var_map[ix]: k for ix, k in zip(cpx_sparsepair.ind, cpx_sparsepair.val)}
+        expr = lfactory.linear_expr(arg=terms, safe=True)
+        return expr
+
+    _sense2comp_dict = {'L': ComparisonType.LE, 'E': ComparisonType.EQ, 'G': ComparisonType.GE}
+
+    # noinspection PyDefaultArgument
+    @classmethod
+    def parse_sense(cls, cpx_sense, sense_dict=_sense2comp_dict):
+        return sense_dict.get(cpx_sense)
+
+
[docs]    @classmethod
+    def read_ops_file(cls, filename, version=None):
+        """ Reads an OPL .ops setting file and builds a CPLEX parameter group.
+
+        Reads a .ops file and returns a DOcplex parameter group instance.
+        All CPO and OPL settings are ignored. This parameter object can be used in a solve().
+        .ops file have dedicated User Interface in OPL IDE and Cloud Pak for Data Experiments, which ease
+        the selection of engine settings.
+
+        Args:
+            filename: a path string
+            version: optional CPLEX version.
+
+        Returns:
+            A `RootParameterGroup object`, if the read operation succeeds, else None.
+        """
+        # We parse the XML file to get the list of cplex params names in OPL naming convention and their value.
+        # We rely on the old 12.x CPLEX naming convention CPX_PARAM_ instead of standard CPXPARAM_ as in OPL runtime to rebuild the names.
+        # We build a temporary .prm and import it in docplex with existing method.
+        # We can't do a cleaner way as not all CPLEX C methods related to settings are available in python.
+        # Adding them would only work in a next future version and not previous ones...
+
+        tree = ET.parse(filename)
+        root = tree.getroot()
+        # Find the CPLEX section
+        # < settings version = "2" >
+        # < category name = "cplex" >
+        # < setting  name = "advind"  value = "2" / >
+
+        cplex_node = None
+        if root.tag == "settings":
+            for child in root:
+                if child.tag == "category" and child.attrib.get("name", "") == "cplex":
+                    cplex_node = child
+                    break
+        values = {}
+        if cplex_node is not None:
+            for child in cplex_node:
+                if child.tag == "setting":
+                    if "name" in child.attrib and "value" in child.attrib:
+                        # Some settings have different names from OPL to CPLEX
+                        def get_name(name):
+                            if name == "rootalg":
+                                name = "STARTALG"
+                            elif name == "nodealg":
+                                name = "SUBALG"
+                            return "CPX_PARAM_" + name.upper()
+
+                        values[get_name(child.attrib["name"].lower())] = child.attrib["value"]
+                    else:
+                        raise Exception("Bad XML .ops file: bad attributes {0}".format(child.attrib))
+                else:
+                    raise Exception("Bad XML .ops file: unknown tag {0}".format(child.tag))
+        else:
+            return None
+
+        # clean up param input
+        def boolean_to_int(b):
+            if b == "true":
+                return 1
+            elif b == "false":
+                return 0
+            else:
+                return b
+
+        values = {k: boolean_to_int(v) for k, v in values.items()}
+
+        with tempfile.NamedTemporaryFile(suffix=".prm", delete=False) as prm_file:
+            if version is not None:
+                prm_file.write("CPLEX Parameter File Version {}\n".format(version).encode('utf-8'))
+            for k, v in values.items():
+                prm_file.write("{0} {1}\n".format(k, v).encode('utf-8'))
+
+        prms = ModelReader.read_prm(prm_file.name)
+        os.remove(prm_file.name)
+        return prms

+
[docs]    @classmethod
+    def read_prm(cls, filename):
+        """ Reads a CPLEX PRM file.
+
+        Reads a CPLEX parameters file and returns a DOcplex parameter group
+        instance. This parameter object can be used in a solve().
+
+        Args:
+            filename: a path string
+
+        Returns:
+            A `RootParameterGroup object`, if the read operation succeeds, else None.
+        """
+        with _CplexReaderFileContext(filename, read_method=["parameters", "read_file"]) as adapter:
+            cpx = adapter.cpx
+            if cpx:
+                # raw parameters
+                params = get_params_from_cplex_version(cpx.get_version())
+                for param in params:
+                    try:
+                        cpx_value = cpx._env.parameters._get(param.cpx_id)
+                        if cpx_value != param.default_value:
+                            param.set(cpx_value)
+
+                    except adapter.CplexError:  # pragma: no cover
+                        pass
+                return params
+            else:  # pragma: no cover
+                return None

+
+    @staticmethod
+    def _safe_call_get_names(cpx_adapter, get_names_fn, fallback_names=None):
+        # cplex crashes when calling get_names on some files (e.g. SAV)
+        # in this case filter out error 1219
+        # and return a fallback list with None or ""
+        try:
+            names = get_names_fn()
+            return names
+        # except TypeError:
+        #     print("** type error ignored in call to {0}".format(get_names_fn.__name__))
+        #     return fallback_names or []
+
+        except cpx_adapter.CplexSolverError as cpxse:  # pragma: no cover
+            errcode = cpxse.args[2]
+            # when all indicators have no names, cplex raises this error
+            # CPLEX Error  1219: No names exist.
+            if errcode == 1219:
+                return fallback_names or []
+            else:
+                # this is something else
+                raise
+
+    @classmethod
+    def _read_cplex(cls, filename, datacheck=None, silent=True):
+        cpx_adapter = CplexAdapter()
+        cpx = cpx_adapter.cpx
+        # no warnings
+        if silent:
+            cpx.set_results_stream(None)
+            cpx.set_log_stream(None)
+            cpx.set_warning_stream(None)
+            cpx.set_error_stream(None)  # remove messages about names
+        try:
+            if datacheck is not None:
+                assert datacheck in {0,1,2}
+                cpx.parameters.read.datacheck.set(datacheck)
+            t0 = time.time()
+            cpx.read(filename)
+            t1 = time.time() - t0
+            if Model.is_docplex_debug() and t1 >= 0.1:
+                print(f"-- cplex read time={t1:.1f}s")
+            return cpx_adapter
+        except cpx_adapter.CplexError as cpx_e:
+            raise ModelReaderError("*CPLEX error {0!s} reading file {1} - exiting".format(cpx_e, filename))
+
+    @classmethod
+    def _make_expr_from_varmap_coefs_dict(cls, lfactory, varmap, var_indices, coefs, offset=0):
+        terms_dict = {varmap.get(dvx): k for dvx, k in zip(var_indices, coefs)}
+        return lfactory.linear_expr(arg=terms_dict, constant=offset, safe=True)
+
+    @classmethod
+    def _make_expr_from_var_coef_seq_dict(cls, lfactory, varmap, var_coefs, constant=0):
+        terms_dict = {varmap.get(dvx): k for dvx, k in var_coefs}
+        return lfactory.linear_expr(arg=terms_dict, constant=constant, safe=True)
+
+    @classmethod
+    def _make_expr_from_varmap_coefs_nodict(cls, lfactory, varmap, var_indices, coefs, offset=0):
+        terms_dict = lfactory._new_term_dict()
+        for dvx, k in zip(var_indices, coefs):
+            dv = varmap.get(dvx)
+            if dv is not None:
+                terms_dict[dv] = k
+        return lfactory.linear_expr(arg=terms_dict, constant=offset, safe=True)
+
+    @classmethod
+    def _make_expr_from_var_coef_seq_nodict(cls, lfactory, varmap, var_coefs, constant=0):
+        terms_dict = lfactory._new_term_dict()
+        for dvx, k in var_coefs:
+            dv = varmap.get(dvx)
+            if dv is not None:
+                terms_dict[dv] = k
+        return lfactory.linear_expr(arg=terms_dict, constant=constant, safe=True)
+
+    @classmethod
+    def _make_expr_from_varmap_coefs(cls, lfactory, varmap, var_indices, coefs, offset=0):
+        if Environment.env_is_python36:
+            terms_dict = {varmap.get(dvx): k for dvx, k in zip(var_indices, coefs)}
+        else:
+            terms_dict = lfactory._new_term_dict()
+            for dvx, k in zip(var_indices, coefs):
+                dv = varmap.get(dvx)
+                if dv is not None:
+                    terms_dict[dv] = k
+        return lfactory.linear_expr(arg=terms_dict, constant=offset, safe=True)
+
+
[docs]    @classmethod
+    def read(cls, filename, model_name=None, verbose=False, model_class=None, **kwargs):
+        """ Reads a model from a CPLEX export file.
+
+        Accepts all formats exported by CPLEX: LP, SAV, MPS.
+
+        If an error occurs while reading the file, the message of the exception
+        is printed and the function returns None.
+
+        Args:
+            filename: The file to read.
+            model_name: An optional name for the newly created model. If None,
+                the model name will be the path basename.
+            verbose: An optional flag to print informative messages, default is False.
+            model_class: An optional class type; must be a subclass of Model.
+                The returned model is built using this model_class and the keyword arguments kwargs, if any.
+                By default, the model class is :class:`docplex.mp.model.Model`.
+            kwargs: A dict of keyword-based arguments that are used when creating the modelpassed to the
+                model constructor.
+
+        Example:
+            `m = read_model("c:/temp/foo.mps", model_name="docplex_foo", ignore_names=True)`
+
+            reads a ,odel from file "c:/temp/foo.mps", sets its name to "docplex_foo", and discard all names.
+
+        Returns:
+            An instance of Model, or None if an exception is raised.
+
+        See Also:
+            :class:`docplex.mp.model.Model`
+
+        """
+        if not os.path.exists(filename):
+            raise IOError("* file not found: {0}".format(filename))
+
+        # extract basename
+        if model_name:
+            name_to_use = model_name
+        else:
+            basename = os.path.basename(filename)
+            if '.' not in filename:  # pragma: no cover
+                raise RuntimeError('ModelReader.read_model(): path has no extension: {}'.format(filename))
+            dotpos = basename.find(".")
+            if dotpos > 0:
+                name_to_use = basename[:dotpos]
+            else:  # pragma: no cover
+                name_to_use = basename
+
+        model_class = model_class or Model
+
+        if 0 == os.stat(filename).st_size:
+            print("* file is empty: {0} - exiting".format(filename))
+            return model_class(name=name_to_use, **kwargs)
+
+        data_check = kwargs.pop('datacheck', None)
+        if verbose:
+            print("-> CPLEX starts reading file: {0}".format(filename))
+        cpx_adapter = cls._read_cplex(filename, datacheck=data_check)
+        cpx = cpx_adapter.cpx
+        if verbose:
+            print("<- CPLEX finished reading file: {0}".format(filename))
+
+        if not cpx:  # pragma: no cover
+            return None
+
+        final_output_level = kwargs.get("output_level", "info")
+        debug_read = kwargs.get("debug", False)
+        final_agent = kwargs.get('agent', 'cplex')
+        use_new = kwargs.pop('use_new', True)
+
+
+        try:
+            # force no tck
+            if 'checker' in kwargs:
+                final_checker = kwargs['checker']
+            else:
+                final_checker = 'default'
+            # build the model with no checker, then restore final_checker in the end.
+            kwargs['checker'] = 'off'
+            kwargs['agent'] = 'zero'
+
+            ignore_names = kwargs.get('ignore_names', False)
+            # -------------
+            if Environment.env_is_python36:
+                make_terms_fn = cls._make_expr_from_varmap_coefs_dict
+                make_terms_seq_fn = cls._make_expr_from_var_coef_seq_dict
+            else:
+                make_terms_fn = cls._make_expr_from_varmap_coefs_nodict
+                make_terms_seq_fn = cls._make_expr_from_var_coef_seq_nodict
+
+            mdl = model_class(name=name_to_use, **kwargs)
+            if data_check is not None:
+                mdl.parameters.read.datacheck = data_check
+            mdl._provenance = filename
+            lfactory = mdl._lfactory
+            qfactory = mdl._qfactory
+            mdl.set_quiet()  # output level set to ERROR
+            vartype_cont = mdl.continuous_vartype
+            vartype_map = {'B': mdl.binary_vartype,
+                           'I': mdl.integer_vartype,
+                           'C': mdl.continuous_vartype,
+                           'S': mdl.semicontinuous_vartype}
+
+            def cpx_type_to_docplex_type(cpxt):
+                return vartype_map.get(cpxt, vartype_cont)
+
+            # 1 upload variables
+            cpx_nb_vars = cpx.variables.get_num()
+
+            if verbose:
+                print("-- uploading {0} variables...".format(cpx_nb_vars))
+
+            cpx_env_e = cpx._env._e
+            cpx_lp = cpx._lp
+            has_non_default_lb = cpx_adapter.has_non_default_lb
+            has_non_default_ub = cpx_adapter.has_non_default_ub
+            has_name = cpx_adapter.has_name
+
+            cpx_var_names = []
+            if not ignore_names:
+                if not has_name or has_name(cpx_env_e, cpx_lp, 0, cpx_nb_vars - 1):
+                    cpx_var_names = cls._safe_call_get_names(cpx_adapter, cpx.variables.get_names)
+
+            # check whether all varianbles have same type, it's worth it.
+            unique_type = None
+            docplex_vartypes = None
+            if cpx._is_MIP():
+                cpx_types = cpx.variables.get_types()
+                first_cpxtype = cpx_types[0]
+                if all(cpxt == first_cpxtype for cpxt in cpx_types):
+                    unique_type = cpx_type_to_docplex_type(first_cpxtype)
+                else:
+                    # docplex_vartypes = [cpx_type_to_docplex_type(cpxt) for cpxt in cpx_types]
+                    def kth_vartype(k):
+                        return cpx_type_to_docplex_type(cpx_types[k])
+                    docplex_vartypes = MockIterable(size=cpx_nb_vars, fn_k=kth_vartype)
+            else:
+                unique_type = vartype_cont
+
+            if use_new and has_non_default_lb and not has_non_default_lb(cpx_env_e, cpx_lp, 0, cpx_nb_vars - 1):
+                cpx_var_lbs = []
+            else:
+                # either we have no fast predicate or we dont use it.
+                cpx_var_lbs = cpx.variables.get_lower_bounds()
+                # we have no predicate, so we might try to avoid building a large list??
+                if not has_non_default_lb and not any(cpx_var_lbs):  # all equal 0
+                    cpx_var_lbs = []
+
+            if use_new and has_non_default_ub and not has_non_default_ub(cpx_env_e, cpx_lp, 0, cpx_nb_vars - 1):
+                cpx_var_ubs = []
+            else:
+                cpx_var_ubs = cpx.variables.get_upper_bounds()
+
+                if not has_non_default_ub and all(cpxu >= 1e+20 for cpxu in cpx_var_ubs):
+                    cpx_var_ubs = []
+
+            # if no names, None is fine.
+            model_varnames = cpx_var_names or None
+
+            model_lbs = cpx_var_lbs
+            model_ubs = cpx_var_ubs
+
+            # vars
+            if unique_type:
+                model_vars = lfactory.new_var_list(var_container=None,
+                                                   key_seq=range(cpx_nb_vars),
+                                                   vartype=unique_type,
+                                                   lb=model_lbs,
+                                                   ub=model_ubs,
+                                                   name=model_varnames,
+                                                   _safe_bounds=True,
+                                                   _safe_names=True
+                                                   )
+            else:
+                assert docplex_vartypes
+                model_vars = lfactory.new_multitype_var_list(cpx_nb_vars,
+                                                             docplex_vartypes,
+                                                             model_lbs,
+                                                             model_ubs,
+                                                             model_varnames)
+
+            # inverse map from indices to docplex vars
+            cpx_var_index_to_docplex = {v: model_vars[v] for v in range(cpx_nb_vars)}
+
+            # 2. upload linear constraints and ranges (mixed in cplex)
+            cpx_linearcts = cpx.linear_constraints
+            nb_linear_cts = cpx_linearcts.get_num()
+
+            all_rhs = cpx_linearcts.get_rhs()
+            all_senses = cpx_adapter.getsense(cpx_env_e, cpx_lp, 0, nb_linear_cts - 1)
+            if 'R' in all_senses:
+                all_range_values = cpx_linearcts.get_range_values()
+            else:
+                # do not query ranges if no R in senses...
+                all_range_values = []
+            cpx_ctnames = [] if ignore_names else cls._safe_call_get_names(cpx_adapter,
+                                                                           cpx_linearcts.get_names)
+
+            def make_constant_expr(k):
+                return lfactory.constant_expr(k, safe_number=True)
+
+            if verbose:
+                print("-- uploading {0} linear constraints...".format(nb_linear_cts))
+
+            def upload_rows(row_iter):
+                cts_ = []
+                for c, (indices, coefs) in enumerate(row_iter):
+                    sense = all_senses[c]
+                    rhs = all_rhs[c]
+
+                    ctname = cpx_ctnames[c] if cpx_ctnames else None
+
+                    expr = make_terms_fn(lfactory, cpx_var_index_to_docplex, indices, coefs)
+
+                    if sense == 'R':
+                        # no use of querying range vars if no R constraints
+                        range_val = all_range_values[c]
+                        # rangeval can be negative !!! issue 52
+                        if range_val >= 0:
+                            range_lb = rhs
+                            range_ub = rhs + range_val
+                        else:
+                            range_ub = rhs
+                            range_lb = rhs + range_val
+
+                        rgct = lfactory.new_range_constraint(lb=range_lb, ub=range_ub, expr=expr, name=ctname,
+                                                             check_feasible=False)
+                        cts_.append(rgct)
+                    else:
+                        op = cls.parse_sense(sense)
+                        rhs_expr = make_constant_expr(rhs)
+
+                        ct = LinearConstraint(mdl, expr, op, rhs_expr, ctname)
+                        cts_.append(ct)
+
+                return cts_
+            if nb_linear_cts:
+                fast_get_rows_tuple = cpx_adapter.fast_get_row_tuples
+                if fast_get_rows_tuple:
+                    with fast_get_rows_tuple(cpx_env_e, cpx_lp) as rowgen:
+                        deferred_cts = upload_rows(rowgen)
+                else:
+                    all_rows = cpx_adapter.fast_get_rows(cpx)
+                    deferred_cts = upload_rows(all_rows)
+                # add constraint as a block
+                lfactory._post_constraint_block(posted_cts=deferred_cts)
+
+            # 3. upload Quadratic constraints
+            cpx_quadraticcts = cpx.quadratic_constraints
+            nb_quadratic_cts = cpx_quadraticcts.get_num()
+            if nb_quadratic_cts:
+                all_rhs = cpx_quadraticcts.get_rhs()
+                all_linear_nb_non_zeros = cpx_quadraticcts.get_linear_num_nonzeros()
+                all_linear_components = cpx_quadraticcts.get_linear_components()
+                all_quadratic_nb_non_zeros = cpx_quadraticcts.get_quad_num_nonzeros()
+                all_quadratic_components = cpx_quadraticcts.get_quadratic_components()
+                all_senses = cpx_quadraticcts.get_senses()
+                cpx_ctnames = [] if ignore_names else cls._safe_call_get_names(cpx_adapter,
+                                                                               cpx_quadraticcts.get_names)
+
+                for c in range(nb_quadratic_cts):
+                    rhs = all_rhs[c]
+                    linear_nb_non_zeros = all_linear_nb_non_zeros[c]
+                    linear_component = all_linear_components[c]
+                    quadratic_nb_non_zeros = all_quadratic_nb_non_zeros[c]
+                    quadratic_component = all_quadratic_components[c]
+                    sense = all_senses[c]
+                    ctname = cpx_ctnames[c] if cpx_ctnames else None
+
+                    if linear_nb_non_zeros > 0:
+                        indices, coefs = linear_component.unpack()
+                        # linexpr = mdl._aggregator._scal_prod((cpx_var_index_to_docplex[idx] for idx in indices), coefs)
+                        linexpr = make_terms_fn(lfactory, cpx_var_index_to_docplex, indices, coefs)
+                    else:
+                        linexpr = None
+
+                    if quadratic_nb_non_zeros > 0:
+                        qfactory = mdl._qfactory
+                        ind1, ind2, coefs = quadratic_component.unpack()
+                        quads = qfactory.term_dict_type()
+                        for idx1, idx2, coef in zip(ind1, ind2, coefs):
+                            quads[VarPair(cpx_var_index_to_docplex[idx1], cpx_var_index_to_docplex[idx2])] = coef
+
+                    else:  # pragma: no cover
+                        # should not happen, but who knows
+                        quads = None
+
+                    quad_expr = mdl._aggregator._quad_factory.new_quad(quads=quads, linexpr=linexpr, safe=True)
+                    op = ComparisonType.cplex_ctsense_to_python_op(sense)
+                    ct = op(quad_expr, rhs)
+                    mdl.add_constraint(ct, ctname)
+
+            # 4. upload indicators
+            cpx_indicators = cpx.indicator_constraints
+            nb_indicators = cpx_indicators.get_num()
+            if nb_indicators:
+                all_ind_names = [] if ignore_names else cls._safe_call_get_names(cpx_adapter,
+                                                                                 cpx_indicators.get_names)
+
+                all_ind_bvars = cpx_indicators.get_indicator_variables()
+                all_ind_rhs = cpx_indicators.get_rhs()
+                all_ind_linearcts = cpx_indicators.get_linear_components()
+                all_ind_senses = cpx_indicators.get_senses()
+                all_ind_complemented = cpx_indicators.get_complemented()
+                all_ind_types = cpx_indicators.get_types()
+                ind_equiv_type = 3
+
+                for i in range(nb_indicators):
+                    ind_bvar = all_ind_bvars[i]
+                    ind_name = all_ind_names[i] if all_ind_names else None
+                    ind_rhs = all_ind_rhs[i]
+                    ind_linear = all_ind_linearcts[i]  # SparsePair(ind, val)
+                    ind_sense = cls.parse_sense(all_ind_senses[i])
+                    ind_complemented = all_ind_complemented[i]
+                    ind_type = all_ind_types[i]
+                    # 1 . check the bvar is ok
+                    ind_bvar = cpx_var_index_to_docplex[ind_bvar]
+                    # each var appears once
+                    ind_linexpr = cls._build_linear_expr_from_sparse_pair(lfactory, cpx_var_index_to_docplex,
+                                                                          ind_linear)
+                    ind_lct = lfactory._new_binary_constraint(ind_linexpr, ind_sense, ind_rhs)
+                    if ind_type == ind_equiv_type:
+                        logct = lfactory.new_equivalence_constraint(
+                            ind_bvar, ind_lct, true_value=1 - ind_complemented, name=ind_name)
+                    else:
+                        logct = lfactory.new_indicator_constraint(
+                            ind_bvar, ind_lct, true_value=1 - ind_complemented, name=ind_name)
+                    mdl.add(logct)
+
+            # 5. upload Piecewise linear constraints
+            try:
+                cpx_pwl = cpx.pwl_constraints
+                cpx_pwl_defs = cpx_pwl.get_definitions()
+                pwl_fallback_names = [""] * cpx_pwl.get_num()
+                cpx_pwl_names = pwl_fallback_names if ignore_names else cls._safe_call_get_names(cpx_adapter,
+                                                                                                 cpx_pwl.get_names,
+                                                                                                 pwl_fallback_names)
+                for (vary_idx, varx_idx, preslope, postslope, breakx, breaky), pwl_name in zip(cpx_pwl_defs,
+                                                                                                cpx_pwl_names):
+                    varx = cpx_var_index_to_docplex.get(varx_idx, None)
+                    vary = cpx_var_index_to_docplex.get(vary_idx, None)
+                    breakxy = [(brkx, brky) for brkx, brky in zip(breakx, breaky)]
+                    pwl_func = mdl.piecewise(preslope, breakxy, postslope, name=pwl_name)
+                    pwl_expr = mdl._lfactory.new_pwl_expr(pwl_func, varx, 0, resolve=False)
+                    pwl_expr._f_var = vary
+                    pwl_expr._ensure_resolved()
+
+            except AttributeError:  # pragma: no cover
+                pass  # Do not check for PWLs if Cplex version does not support them
+
+            # 6. upload objective
+
+            # noinspection PyPep8
+            try:
+                cpx_multiobj = cpx.multiobj
+            except AttributeError:  # pragma: no cover
+                # pre-12.9 version
+                cpx_multiobj = None
+
+            if cpx_multiobj is None or cpx_multiobj.get_num() <= 1:
+                cpx_obj = cpx.objective
+                cpx_sense = cpx_obj.get_sense()
+                fast_getobj = cpx_adapter.fast_getobj
+                if fast_getobj:
+                    with fast_getobj(cpx_env_e, cpx_lp, 0, cpx_nb_vars-1) as var_coefs_tuple:
+                        obj_expr = make_terms_seq_fn(lfactory, cpx_var_index_to_docplex, var_coefs_tuple)
+                else:
+                    cpx_all_lin_obj_coeffs = cpx_obj.get_linear()
+                    obj_expr = compute_full_dot(mdl, cpx_all_lin_obj_coeffs)
+
+                if cpx_obj.get_num_quadratic_variables() > 0:
+                    cpx_all_quad_cols_coeffs = cpx_obj.get_quadratic()
+                    quads = qfactory.term_dict_type()
+                    for v, col_coefs in zip(cpx_var_index_to_docplex, cpx_all_quad_cols_coeffs):
+                        var1 = cpx_var_index_to_docplex[v]
+                        indices, coefs = col_coefs.unpack()
+                        for idx, coef in zip(indices, coefs):
+                            vp = VarPair(var1, cpx_var_index_to_docplex[idx])
+                            quads[vp] = quads.get(vp, 0) + coef / 2
+
+                    obj_expr += qfactory.new_quad(quads=quads, linexpr=None)
+
+                obj_expr += cpx.objective.get_offset()
+                is_maximize = cpx_sense == cpx_adapter.cplex_module._internal._subinterfaces.ObjSense.maximize
+
+                if is_maximize:
+                    mdl.maximize(obj_expr)
+                else:
+                    mdl.minimize(obj_expr)
+            else:
+                # we have multiple objective
+
+                nb_multiobjs = cpx_multiobj.get_num()
+                exprs = [0] * nb_multiobjs
+                priorities = [1] * nb_multiobjs
+                weights = [1] * nb_multiobjs
+                abstols = [0] * nb_multiobjs
+                reltols = [0] * nb_multiobjs
+                if ignore_names:
+                    names = ["Goal_{0}".format(g) for g in range(1, nb_multiobjs + 1)]
+                else:
+                    names = cpx_multiobj.get_names()
+
+                fast_multiobj = cpx_adapter.fast_multiobj_getobj is not None
+                if fast_multiobj:
+                    def get_kth_multiobj(k):
+                        weight = cpx_adapter.fast_multiobj_getweight(cpx_env_e, cpx_lp, k)
+                        offset = cpx_adapter.fast_multiobj_getoffset(cpx_env_e, cpx_lp, k)
+                        priority = cpx_adapter.fast_multiobj_getprio(cpx_env_e, cpx_lp, k)
+                        abstol = cpx_adapter.fast_multiobj_getabstol(cpx_env_e, cpx_lp, k)
+                        reltol = cpx_adapter.fast_multiobj_getreltol(cpx_env_e, cpx_lp, k)
+                        with cpx_adapter.fast_multiobj_getobj(cpx_env_e, cpx_lp, k, 0, cpx_nb_vars-1) as objk_tuples:
+                            obj_expr = make_terms_seq_fn(lfactory, cpx_var_index_to_docplex, objk_tuples, constant=offset)
+                        return obj_expr, weight, priority, abstol, reltol
+                else:
+                    def get_kth_multiobj(k):
+                        (obj_coeffs, obj_offset, weight, prio, abstol, reltol) = cpx_multiobj.get_definition(k)
+                        obj_expr = compute_full_dot(mdl, obj_coeffs, obj_offset)
+                        return obj_expr, weight, prio, abstol, reltol
+
+                for m in range(nb_multiobjs):
+                    (obj_expr, weight, prio, abstol, reltol) = get_kth_multiobj(m)
+                    exprs[m] = obj_expr
+                    priorities[m] = prio
+                    weights[m] = weight
+                    abstols[m] = abstol
+                    reltols[m] = reltol
+                sense = cpx_multiobj.get_sense()
+                mdl.set_multi_objective(sense, exprs, priorities, weights, abstols, reltols, names)
+
+            # upload sos
+            cpx_sos = cpx.SOS
+            cpx_sos_num = cpx_sos.get_num()
+            if cpx_sos_num > 0:
+                cpx_sos_types = cpx_sos.get_types()
+                cpx_sos_indices = cpx_sos.get_sets()
+                cpx_sos_names = cpx_sos.get_names()
+                if not cpx_sos_names:
+                    cpx_sos_names = [None] * cpx_sos_num
+                for sostype, sos_sparse, sos_name in zip(cpx_sos_types, cpx_sos_indices, cpx_sos_names):
+                    sos_var_indices = sos_sparse.ind
+                    sos_weights = sos_sparse.val
+                    isostype = int(sostype)
+                    sos_vars = [cpx_var_index_to_docplex[var_ix] for var_ix in sos_var_indices]
+                    mdl.add_sos(dvars=sos_vars, sos_arg=isostype, name=sos_name, weights=sos_weights)
+
+            # upload lazy constraints
+            cpx_linear_advanced = cpx.linear_constraints.advanced
+            cpx_lazyct_num = cpx_linear_advanced.get_num_lazy_constraints()
+            if cpx_lazyct_num:
+                print("WARNING: found {0} lazy constraints that cannot be uploaded to DOcplex".format(cpx_lazyct_num))
+
+            mdl.output_level = final_output_level
+            if final_checker:
+                # need to restore checker
+                mdl.set_checker(final_checker)
+
+        except cpx_adapter.CplexError as cpx_e:  # pragma: no cover
+            print("* CPLEX error: {0!s} reading file {1}".format(cpx_e, filename))
+            mdl = None
+            if debug_read:
+                raise
+
+        except ModelReaderError as mre:  # pragma: no cover
+            print("! Model reader error: {0!s} while reading file {1}".format(mre, filename))
+            mdl = None
+            if debug_read:
+                raise
+
+        except DOcplexException as doe:  # pragma: no cover
+            print("! Internal DOcplex error: {0!s} while reading file {1}".format(doe, filename))
+            mdl = None
+            if debug_read:
+                raise
+
+        # except Exception as any_e:  # pragma: no cover
+        #     print("Internal exception raised: {0} msg={1!s} while reading file '{2}'".format(type(any_e), any_e, filename))
+        #     mdl = None
+        #     if debug_read:
+        #         raise
+
+        finally:
+            # clean up CPLEX instance...
+            # cpx.end()
+            pass
+        if mdl:
+            # reset engine, if necessary
+            if final_agent == 'zero':
+                pass  # nothing to do
+            if final_agent == 'cplex':
+                mdl._set_engine(CplexEngine(mdl, _cplex=cpx_adapter))
+                # mdl._check_scope_indices()
+            else:
+                # set a new non-cplex agent
+                mdl._set_new_engine_from_agent(final_agent)
+            mdl._set_solver_agent(final_agent)
+
+        return mdl

+
+
[docs]    @classmethod
+    def read_model(cls, filename, model_name=None, verbose=False, model_class=None, **kwargs):
+        """ This method is a synonym of `read` for compatibility.
+
+        """
+        import warnings
+        warnings.warn("ModelReader.read_model is deprecated, use class method ModelReader.read()", DeprecationWarning)
+        return cls.read(filename, model_name, verbose, model_class, **kwargs)

+
+
+
[docs]def read_model(filename, model_name=None, verbose=False, **kwargs):
+    """ Reads a model from a CPLEX export file.
+
+    Accepts all formats exported by CPLEX: LP, SAV, SAV.gz, MPS.
+
+    If an error occurs while reading the file, the message of the exception
+    is printed and the function returns None.
+
+    Args:
+        filename: The model file to read.
+        model_name: An optional name for the newly created model. If None,
+            the model name will be the path basename.
+        verbose: An optional flag to print informative messages, default is False.
+        kwargs: A dict of keyword-based arguments that are passed to the model contructor.
+
+    Note:
+        This function requires CPLEX runtime, otherwise an exceotion is raised.
+
+    Example:
+        `m = read_model("c:/temp/foo.mps", model_name="docplex_foo", solver_agent="local", output_level=100)`
+
+    Returns:
+        An instance of Model, or None if an exception is raised.
+
+
+
+    See Also:
+        :class:`docplex.mp.model.Model`
+
+    """
+    return ModelReader.read(filename, model_name=model_name, verbose=verbose, **kwargs)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/model_stats.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/model_stats.html new file mode 100644 index 0000000..e6db257 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/model_stats.html @@ -0,0 +1,332 @@ + + + + + + + + + docplex.mp.model_stats — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.model_stats

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from io import StringIO
+
+
+
[docs]class ModelStatistics(object):
+    """ModelStatistics()
+
+    This class gathers statistics from the model.
+
+    Instances of this class are returned by the method :func:`docplex.mp.model.Model.get_statistics`.
+
+    The class contains counters on the various types of variables and constraints
+    in the model.
+
+    """
+
+    def __init__(self, nb_bvs, nb_ivs, nb_cvs,
+                 nb_scvs, nb_sivs,
+                 nb_le_cts, nb_ge_cts, nb_eq_cts,
+                 nb_rng_cts,
+                 nb_ind_cts, nb_equiv_cts, nb_quad_cts):
+        self._number_of_binary_variables = nb_bvs
+        self._number_of_integer_variables = nb_ivs
+        self._number_of_continuous_variables = nb_cvs
+        self._number_of_semicontinuous_variables = nb_scvs
+        self._number_of_semiinteger_variables = nb_sivs
+        self._number_of_le_constraints = nb_le_cts
+        self._number_of_ge_constraints = nb_ge_cts
+        self._number_of_eq_constraints = nb_eq_cts
+        self._number_of_range_constraints = nb_rng_cts
+        self._number_of_indicator_constraints = nb_ind_cts
+        self._number_of_equivalence_constraints = nb_equiv_cts
+        self._number_of_quadratic_constraints = nb_quad_cts
+
+    def as_tuple(self):
+        return (self._number_of_binary_variables,
+                self._number_of_integer_variables,
+                self._number_of_continuous_variables,
+                self._number_of_semicontinuous_variables,
+                self._number_of_semiinteger_variables,
+                self._number_of_le_constraints,
+                self._number_of_ge_constraints,
+                self._number_of_eq_constraints,
+                self._number_of_range_constraints,
+                self._number_of_indicator_constraints,
+                self._number_of_equivalence_constraints,
+                self._number_of_quadratic_constraints)
+
+    def equal_stats(self, other):
+        return isinstance(other, ModelStatistics) and (self.as_tuple() == other.as_tuple())
+
+    def __eq__(self, other):
+        return self.equal_stats(other)
+
+    @property
+    def number_of_variables(self):
+        """ This property returns the total number of variables in the model.
+
+        """
+        return self._number_of_binary_variables \
+               + self._number_of_integer_variables \
+               + self._number_of_continuous_variables \
+               + self._number_of_semicontinuous_variables
+
+    @property
+    def number_of_binary_variables(self):
+        """ This property returns the number of binary decision variables in the model.
+
+        """
+        return self._number_of_binary_variables
+
+    @property
+    def number_of_integer_variables(self):
+        """ This property returns the number of integer decision variables in the model.
+
+        """
+        return self._number_of_integer_variables
+
+    @property
+    def number_of_continuous_variables(self):
+        """ This property returns the number of continuous decision variables in the model.
+
+        """
+        return self._number_of_continuous_variables
+
+    @property
+    def number_of_semicontinuous_variables(self):
+        """ This property returns the number of semicontinuous decision variables in the model.
+
+        """
+        return self._number_of_semicontinuous_variables
+
+    @property
+    def number_of_semiinteger_variables(self):
+        """ This property returns the number of semi-integer decision variables in the model.
+
+        """
+        return self._number_of_semiinteger_variables
+
+    @property
+    def number_of_linear_constraints(self):
+        """ This property returns the total number of linear constraints in the model.
+
+        This number comprises all relational constraints: <=, ==, and >=
+        and also range constraints.
+
+        """
+        return self._number_of_eq_constraints + \
+               self._number_of_le_constraints + \
+               self._number_of_ge_constraints + \
+               self._number_of_range_constraints
+
+    @property
+    def number_of_le_constraints(self):
+        """ This property returns the number of <= constraints
+
+        """
+        return self._number_of_le_constraints
+
+    @property
+    def number_of_eq_constraints(self):
+        """ This property returns the number of == constraints
+
+        """
+        return self._number_of_eq_constraints
+
+    @property
+    def number_of_ge_constraints(self):
+        """ This property returns the number of >= constraints
+
+        """
+        return self._number_of_ge_constraints
+
+    @property
+    def number_of_range_constraints(self):
+        """ This property returns the number of range constraints.
+
+        Range constraints are of the form L <= expression <= U.
+
+        See Also:
+            :class:`docplex.mp.constr.RangeConstraint`
+
+        """
+        return self._number_of_range_constraints
+
+    @property
+    def number_of_indicator_constraints(self):
+        """ This property returns the number of indicator constraints.
+
+        See Also:
+            :class:`docplex.mp.constr.IndicatorConstraint`
+
+        """
+        return self._number_of_indicator_constraints
+
+    @property
+    def number_of_equivalence_constraints(self):
+        """ This property returns the number of equivalence constraints.
+
+        See Also:
+            :class:`docplex.mp.constr.EquivalenceConstraint`
+
+        """
+        return self._number_of_equivalence_constraints
+
+    @property
+    def number_of_quadratic_constraints(self):
+        """ This property returns the number of quadratic constraints.
+
+        See Also:
+            :class:`docplex.mp.constr.QuadraticConstraint`
+
+        """
+        return self._number_of_quadratic_constraints
+
+    @property
+    def number_of_constraints(self):
+        return self.number_of_linear_constraints + \
+               self.number_of_quadratic_constraints + \
+               self.number_of_indicator_constraints + \
+               self._number_of_equivalence_constraints
+
+
[docs]    def print_information(self):
+        """ Prints model statistics in readable format.
+
+        """
+        print(' - number of variables: {0}'.format(self.number_of_variables))
+        var_fmt = '   - binary={0}, integer={1}, continuous={2}'
+        if self._number_of_semicontinuous_variables:
+            var_fmt += ', semi-continuous={3}'
+        print(var_fmt.format(self.number_of_binary_variables,
+                             self.number_of_integer_variables,
+                             self.number_of_continuous_variables,
+                             self._number_of_semicontinuous_variables
+                             ))
+
+        print(' - number of constraints: {0}'.format(self.number_of_constraints))
+        ct_fmt = '   - linear={0}'
+        if self._number_of_indicator_constraints:
+            ct_fmt += ', indicator={1}'
+        if self._number_of_equivalence_constraints:
+            ct_fmt += ', equiv={2}'
+        if self._number_of_quadratic_constraints:
+            ct_fmt += ', quadratic={3}'
+        print(ct_fmt.format(self.number_of_linear_constraints,
+                            self.number_of_indicator_constraints,
+                            self.number_of_equivalence_constraints,
+                            self.number_of_quadratic_constraints))

+
+    def to_string(self):
+        oss = StringIO()
+        oss.write(" - number of variables: %d\n" % self.number_of_variables)
+        var_fmt = '   - binary={0}, integer={1}, continuous={2}'
+        if self._number_of_semicontinuous_variables:
+            var_fmt += ', semi-continuous={3}'
+        oss.write(var_fmt.format(self.number_of_binary_variables,
+                                 self.number_of_integer_variables,
+                                 self.number_of_continuous_variables,
+                                 self._number_of_semicontinuous_variables
+                                 ))
+        oss.write('\n')
+        nb_constraints = self.number_of_constraints
+        oss.write(' - number of constraints: {0}\n'.format(nb_constraints))
+        if nb_constraints:
+            ct_fmt = '   - linear={0}'
+            if self._number_of_indicator_constraints:
+                ct_fmt += ', indicator={1}'
+            if self._number_of_equivalence_constraints:
+                ct_fmt += ', equiv={2}'
+            if self._number_of_quadratic_constraints:
+                ct_fmt += ', quadratic={3}'
+            oss.write(ct_fmt.format(self.number_of_linear_constraints,
+                                    self.number_of_indicator_constraints,
+                                    self.number_of_equivalence_constraints,
+                                    self.number_of_quadratic_constraints))
+        return oss.getvalue()
+
+    def __str__(self):
+        return self.to_string()
+
+    def __repr__(self):  # pragma: no cover
+        return "docplex.mp.Model.ModelStatistics()"

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/params/parameters.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/params/parameters.html new file mode 100644 index 0000000..74b5a23 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/params/parameters.html @@ -0,0 +1,1073 @@ + + + + + + + + + docplex.mp.params.parameters — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.params.parameters

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from io import StringIO
+
+from docplex.mp.utils import is_int, is_string
+from docplex.mp.error_handler import docplex_fatal, DOcplexException
+
+
+
[docs]class ParameterGroup(object):
+    """ A group of parameters.
+
+    Note:
+        This class is not meant to be instantiated by users. Models come
+        with a full hierarchy of parameters with groups as nodes.
+
+    """
+
+    def __init__(self, name, parent_group=None):
+        self._name = name
+        self._parent = parent_group
+        self._params = []
+        self._subgroups = []
+        if parent_group:
+            parent_group._add_subgroup(self)
+
+    def to_string(self, include_root=True):
+        return "group<%s>" % self.qualified_name(include_root=include_root)
+
+    def __str__(self):
+        return self.to_string()
+
+    def __repr__(self):
+        return "docplex.mp.params.ParameterGroup({0})".format(self.qualified_name())
+
+
[docs]    def clone(self):
+        """
+        Returns:
+           A deep copy of the parameter group.
+        """
+        from copy import deepcopy
+        return deepcopy(self)

+
+    def copy(self):
+        return self.clone()
+
+    @property
+    def name(self):
+        """ This property returns the name of the group.
+
+        Note:
+            Parameter group names are always lowercase.
+        """
+        return self._name
+
+
[docs]    def iter_params(self):
+        """ Iterates over the group's own parameters.
+
+        Returns:
+            A iterator over directparameters belonging to the group, not including
+            sub-groups.
+        """
+        return iter(self._params)

+
+    @property
+    def number_of_params(self):
+        """  This property returns the number of parameters in the group, not including subgroups.
+        """
+        return len(self._params)
+
+
[docs]    def total_number_of_params(self):
+        """
+        Includes all parameters of subgroups recursively.
+
+        Returns:
+           integer: The total number of parameters inside the group.
+        """
+        subparams = sum(g.total_number_of_params() for g in self._subgroups)
+        return subparams + self.number_of_params

+
+    def total_number_of_groups(self):
+        subgroups = sum(g.total_number_of_groups() for g in self._subgroups)
+        return subgroups + 1
+
+    @property
+    def number_of_subgroups(self):
+        """ This property returns the number of subgroups of the group, non-recursively.
+
+        """
+        return len(self._subgroups)
+
+    def has_subgroups(self):
+        return len(self._subgroups) > 0
+
+    def iter_subgroups(self):
+        return iter(self._subgroups)
+
+    @property
+    def parent_group(self):
+        """ This property returns the parent group (an instance of :class:`ParameterGroup`), or None for the root group.
+        """
+        return self._parent
+
+    def _add_param(self, param):
+        # internal
+        self._params.append(param)
+
+    def _add_subgroup(self, subgroup):
+        # internal
+        self._subgroups.append(subgroup)
+
+
[docs]    def is_root(self):
+        """ Checks whether the group is the root group, in other words, has no parent group.
+
+        Returns:
+            Boolean: True if the group is the root group.
+        """
+        return self._parent is None

+
+    def root_group(self):
+        group = self
+        while not group.is_root():
+            group = group.parent_group
+        return group
+
+
[docs]    def qualified_name(self, sep=".", include_root=True):
+        """ Computes a string with all the parents of the parameters.
+
+        Example:
+            `parameter mip.mip_cuts.Cover` returns "mip.mip_cuts.Covers".
+
+        Args:
+            sep (string): The separator string. Default is ".".
+            include_root (flag): True if the root name is included.
+
+        Returns:
+            string: A string representation of the parameter hierarchy.
+        """
+        self_parent = self._parent
+        if not self_parent:
+            return self.name
+        if not include_root and self_parent.is_root():
+            return self.name
+        else:
+            return "".join([self._parent.qualified_name(sep=sep, include_root=include_root), sep, self.name])

+
+    def prettyprint(self, indent=0):
+        tab = indent * 4 * " "
+        print("{0}{1!s}={{".format(tab, self.qualified_name(include_root=False)))
+        for p in self.iter_params():
+            print("{0}    {1!s}".format(tab, p))
+        for sg in self.iter_subgroups():
+            assert isinstance(sg, ParameterGroup)
+            sg.prettyprint(indent + 1)
+        print("{0}}}".format(tab))
+
+    def _update_self_dict(self, extra_dict, do_check=True):
+        self_dict = self.__dict__
+        if do_check:
+            # new entries should not already be present in self.dict
+            for k in extra_dict:
+                if k in self_dict:
+                    # should not happen
+                    print("!! update_self_dict: name collision with: %s" % k)  # pragma: no cover
+        self_dict.update(extra_dict)
+
+    def _restore_dict_recursive(self):
+        # internal use for  deepcopy
+        param_dict = {p._name: p for p in self.iter_params()}
+        subgroup_dict = {sg._name: sg for sg in self.iter_subgroups()}
+        # update the __dict__ itself
+        self._update_self_dict(param_dict, do_check=False)
+        self._update_self_dict(subgroup_dict, do_check=False)
+        # recurse
+        for sg in self.iter_subgroups():
+            sg._restore_dict_recursive()
+
+    @staticmethod
+    def make(name, param_dict_fn, subgroup_fn, parent=None):
+        # INTERNAL
+        # factory method to create one group from:
+        # 1. a lambda function taking a group as argument and returning a dict of name: param instances
+        # 2. a dict of subgroup name: subgroup_make functions
+        # 3. a possibly-None parent group. If None, we are at root.
+        group = ParameterGroup(name, parent) if parent else RootParameterGroup(name, cplex_version=None)
+        group._initialize(param_dict_fn, subgroup_fn)
+        return group
+
+    def _initialize(self, param_dict_fn, subgroup_fn):
+        param_dict = param_dict_fn(self)
+        self._update_self_dict(param_dict)
+        if subgroup_fn:
+            subgroup_fn_dict = subgroup_fn()
+            subgroup_dict = {group_name: group_fn(self)
+                             for group_name, group_fn in subgroup_fn_dict.items()}
+            self._update_self_dict(subgroup_dict)
+
+    def number_of_nondefaults(self):
+        return sum(1 for _ in self.generate_nondefault_params())
+
+    def has_nondefaults(self):
+        for _ in self.generate_nondefault_params():
+            return True
+        else:
+            return False
+
+
[docs]    def reset(self, recursive=False):
+        """ Resets all parameters in the group.
+
+        Args:
+            recursive (Boolean): If True, also resets the subgroups.
+        """
+        for p in self.iter_params():
+            p.reset()
+        if recursive:
+            for g in self.iter_subgroups():
+                g.reset(recursive=True)

+
+    def reset_all(self):
+        self.reset(recursive=True)
+
+
[docs]    def generate_params(self):
+        """  A generator function that traverses all parameters.
+
+        The generator yields all parameters from the group
+        and also from its subgroups, recursively.
+        When called from the root parameter group, it returns all parameters.
+
+        Returns:
+            A generator object.
+
+        """
+        return self._generate_and_filter_params(predicate=None)

+
+    def _generate_and_filter_params(self, predicate):
+        """ A filtering generator function that traverses a group's parameters.
+
+        This generator function traverses the group and its subgroup tree,
+        yielding only  parameters that are accepted by th epredicate.
+
+        Args:
+           predicate: A function that takes one parameter as asrgument.
+           The return value of this function will be interpreted as a boolean using
+           Python conversion rules.
+
+        Returns:
+            A generator object.
+        """
+        for p in self.iter_params():
+            if predicate is None or predicate(p):
+                yield p
+        # now recurse
+        for sg in self.iter_subgroups():
+            for nd in sg._generate_and_filter_params(predicate):
+                yield nd
+
+
[docs]    def generate_nondefault_params(self):
+        """ A generator function that returns all non-default parameters.
+
+        This generator function traverses the group and its subgroup tree,
+        yielding those parameters with a non-default value, one at a time.
+        A parameter is non-default when its value differs from the default.
+
+        Returns:
+            A generator object.
+        """
+        return self._generate_and_filter_params(predicate=lambda p: p.is_nondefault())

+
+    def generate_all_subgroups(self):
+        # INTERNAL
+        for sg in self.iter_subgroups():
+            yield sg
+            for ssg in sg.generate_all_subgroups():
+                yield ssg
+
+    def __setattr__(self, attr_name, value):
+        if attr_name.startswith("_"):
+            self.__dict__[attr_name] = value
+        elif hasattr(self, attr_name):
+            attr = getattr(self, attr_name)
+            if isinstance(attr, Parameter):
+                # attribute is set inside param, not necessarily in engine...
+                attr.set(value)
+            else:
+                docplex_fatal("No parameter with name {0} in {1}", attr_name, self.qualified_name())
+        else:
+            docplex_fatal("No parameter with name {0} in {1}", attr_name, self.qualified_name())
+
+    @property
+    def cplex_version(self):
+        return self.root_group().cplex_version

+
+
+
[docs]class Parameter(object):
+    """ Base class for all parameters.
+
+    This class is not meant to be instantiated but subclassed.
+
+    """
+    __slots__ = ('_parent', '_name', '_cpx_name', '_id', '_description', '_default_value',
+                 '_current_value', '_synchronous')
+
+    # This global flag controls checking new values.
+    # If set to False, assigned values are not checked for min/max ranges
+    skip_range_check = False
+
+    # noinspection PyProtectedMember
+    def __init__(self, group, short_name, cpx_name, param_key, description, default_value):
+        assert isinstance(group, ParameterGroup)
+        self._parent = group
+        self._name = short_name
+        self._cpx_name = cpx_name
+        self._id = param_key
+        self._description = description
+        self._default_value = default_value
+        # current = default at start...
+        self._current_value = default_value
+        self._synchronous = False
+        # link to parent group
+        group._add_param(self)
+
+    def ctor_name(self):
+        return self.__class__.__name__
+
+    def is_synchronous(self):
+        return self._synchronous
+
+    @property
+    def short_name(self):
+        return self._name
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def qualified_name(self):
+        """ Returns a hierarchical name string for the parameter.
+
+        The qualified name reflects the location of the parameter in the parameter hierarchy.
+        The qualified name of a parameter is guaranteed to be unique.
+
+        Examples:
+            `parameters.mip.tolerances.mipgap -> mip.tolerances.mipgap`
+
+        Returns:
+            A unique name that reflects the parameter location in the hierarchy.
+        :rtype:
+            string
+        """
+        return self.get_qualified_name(sep='.', include_root=True)
+
+    def get_qualified_name(self, sep='.', include_root=True):
+        parent_qname = self._parent.qualified_name(sep=sep, include_root=include_root)
+        if parent_qname:
+            return "%s.%s" % (parent_qname, self.name)
+        else:
+            return self.name
+
+    @property
+    def cpx_name(self):
+        """ Returns the CPLEX name of the parameter. This string is the CPLEX reference name which is used
+        in CPLEX Reference Manual.
+
+        Examples:
+            `parameters.mip.tolerances.mipgap` has the name `CPX_PARAM_EPGAP` in CPLEX
+
+        :rtype:
+            string
+        """
+        return self._cpx_name
+
+    @property
+    def cpx_id(self):
+        """ Returns the CPLEX integer code of the parameter.  See the CPLEX Reference Manual for more
+        information.
+
+        Returns:
+            An integer code.
+        """
+        return self._id
+
+    @property
+    def description(self):
+        """ Returns a string describing the parameter.
+
+        :rtype:
+           string
+        """
+        return self._description
+
+    @property
+    def default_value(self):
+        """ Returns the default value of the parameter. This value can be numeric or a string,
+        depending on the parameter type.
+
+        Examples:
+            `parameters.workdir` has default value "."
+            `parameters.optimalitytarget` has default value 0
+            `parameters.mip.tolerances.mipgap` has default value of 0.0001
+
+        Returns:
+           The default value.
+        """
+        return self._default_value
+
+    def reset_default_value(self, new_default):
+        # INTERNAL: use with caution
+        self._default_value = new_default  # pragma: no cover
+        self._current_value = new_default  # pragma: no cover
+
+    @property
+    def value(self):
+        return self._current_value
+
+
[docs]    def accept_value(self, new_value):
+        """ Checks if `new_value` is an accepted value for the parameter.
+
+        Args:
+            new_value: The candidate value.
+
+        Returns:
+            Boolean: True if acceptable, else False.
+
+        """
+        raise NotImplementedError()  # pragma: no cover

+
+    def transform_value(self, raw_value):
+        # INTERNAL
+        return raw_value
+
+    def _check_value(self, raw_value):
+        if raw_value == self.default_value:
+            return raw_value
+        elif not self.accept_value(raw_value):
+            docplex_fatal("Value {0!r} of type {2} is invalid for parameter '{1}'",
+                          raw_value, self.get_qualified_name(include_root=False), type(raw_value))
+        else:
+            return self.transform_value(raw_value)
+
+    def __call__(self, *args):
+        if not args:
+            return self._current_value
+        elif len(args) == 1:
+            self.set(args[0])
+        else:
+            docplex_fatal('Call parameter accepts either 0 or 1 argument')
+
+
[docs]    def set(self, new_value):
+        """ Changes the value of the parameter to `new_value`.
+
+        This method checks that the new value has the proper type and is valid.
+        Numeric parameters often specify a valid range with a minimum and a maximum value.
+
+        If the value is valid, the current value of the parameter is changed, otherwise
+        an exception is raised.
+
+        Args:
+            new_value: The new value for the parameter.
+
+        Raises:
+            An exception if the value is not valid.
+        """
+        accepted_value = self._check_value(new_value)
+        if accepted_value is not None:
+            self._current_value = accepted_value
+            if self._synchronous:
+                #  print(" syncing {0!s} to {1}".format(self, accepted_value))
+                self.root_group().apply(self)
+
+        return accepted_value

+
+
[docs]    def get(self):
+        """ Returns the current value of the parameter.
+        """
+        return self._current_value

+
+
[docs]    def reset(self):
+        """ Resets the parameter value to its default.
+        """
+        self._current_value = self.default_value

+
+
[docs]    def is_nondefault(self):
+        """ Checks if the current value of the parameter does not equal its default.
+
+        Returns:
+           Boolean: True if the current value of the parameter differs from its default.
+
+        """
+        return self.get() != self._default_value

+
+
[docs]    def is_default(self):
+        """  Checks if the current value of the parameter equals its default.
+
+        Returns:
+            Boolean: True if the current value of the parameter equals its default.
+        """
+        return self.get() == self.default_value

+
+    @classmethod
+    def _is_in_range(cls, arg, range_min, range_max):
+        if not cls.skip_range_check:
+            if range_min is not None and arg < range_min:
+                return False
+            if range_max is not None and arg > range_max:
+                return False
+        return True
+
+
[docs]    def to_string(self):
+        """ Converts the parameter to a string.
+
+        This method is used in the `__str__` method to convert a parameter to a string.
+
+        :rtype:
+            string
+        """
+        return "{0}:{1:s}({2!s})".format(self._name, self.type_name, self._current_value)

+
+    def __str__(self):
+        return self.to_string()
+
+    def is_numeric(self):
+        # INTERNAL
+        return False  # pragma: no cover
+
+    @property
+    def type_name(self):
+        # INTERNAL
+        raise NotImplementedError  # pragma: no cover
+
+    def root_group(self):
+        return self._parent.root_group()
+
+    def _repr_classname(self):
+        return "docplex.mp.params.{0}".format(self.__class__.__name__)
+
+    def __repr__(self):
+        return "{0}({1},{2!s})".format(self._repr_classname(), self.qualified_name, self._current_value)

+
+
+_BOOLEAN_STATES = {'1': True, 'yes': True, 'true': True, 'on': True,
+                   '0': False, 'no': False, 'false': False, 'off': False}
+
+
+
[docs]class BoolParameter(Parameter):
+    __slots__ = ()
+
+    def __init__(self, group, short_name, cpx_name, param_key, description, default_value):
+        Parameter.__init__(self, group, short_name, cpx_name, param_key, description, default_value)
+
+    def transform_value(self, new_value):
+        svalue = str(new_value).lower()
+        if new_value in {True, False}:
+            return new_value
+        elif new_value in {0, 1}:
+            return True if new_value else False
+        elif svalue in _BOOLEAN_STATES:
+            return _BOOLEAN_STATES[svalue]
+        else:
+            return None
+
+
[docs]    def accept_value(self, value):
+        return value in {0, 1} or str(value).lower() in _BOOLEAN_STATES or value in {True, False}

+
+    @property
+    def type_name(self):
+        return "bool"

+
+
+
[docs]class StrParameter(Parameter):
+    __slots__ = ()
+
+    def __init__(self, group, short_name, cpx_name, param_key, description, default_value):
+        Parameter.__init__(self, group, short_name, cpx_name, param_key, description, default_value)
+        assert isinstance(default_value, str)
+
+
[docs]    def accept_value(self, new_value):
+        return isinstance(new_value, str)

+
+    @property
+    def type_name(self):
+        return "string"
+
+
[docs]    def to_string(self):
+        """ Converts the parameter to a string.
+
+        This method is used in the `__str__` method to convert a parameter to a string.
+
+        :rtype:
+            string
+        """
+        safe_value = self._current_value or ''
+        return "{0}:{1:s}('{2!s}')".format(self._name, self.type_name, safe_value)

+
+
[docs]class IntParameter(Parameter):
+    __slots__ = ('_min_value', '_max_value')
+
+
[docs]    def accept_value(self, new_value):
+        return is_int(new_value) and self._is_in_range(new_value, self._min_value, self._max_value)

+
+    def is_numeric(self):
+        return True  # pragma: no cover
+
+    def _get_min_value(self):
+        return self._min_value  # pragma: no cover
+
+    def _get_max_value(self):
+        return self._max_value  # pragma: no cover
+
+    def __init__(self, group, short_name, cpx_name, param_key, description, default_value, min_value=None,
+                 max_value=None, sync=False):
+        Parameter.__init__(self, group, short_name, cpx_name, param_key, description, default_value)
+        self._min_value = int(min_value)
+        self._max_value = int(max_value)
+        self._synchronous = sync
+
+    @property
+    def min_value(self):
+        return self._min_value
+
+    @property
+    def max_value(self):
+        return self._max_value
+
+    @property
+    def type_name(self):
+        return "int"
+
+    def __repr__(self):
+        return "{0}({1},{2!s})".format(self._repr_classname(), self.qualified_name, self._current_value)
+
+    def transform_value(self, new_value):
+        return int(new_value)

+
+
+
[docs]class PositiveIntParameter(IntParameter):
+    __slots__ = ()
+
+    def __init__(self, group, short_name, cpx_name, param_key, description, default_value, max_value=None):
+        IntParameter.__init__(self, group, short_name, cpx_name, param_key, description, default_value, min_value=0,
+                              max_value=max_value)
+
+    @property
+    def type_name(self):
+        return "positive int"

+
+
+
[docs]class NumParameter(Parameter):
+    """ A numeric parameter can take any floating-point value in the range of `[min,max]` values.
+    """
+    __slots__ = ('_min_value', '_max_value')
+
+    def __init__(self, group, short_name, cpx_name, param_key, description, default_value, min_value=None,
+                 max_value=None):
+        Parameter.__init__(self, group, short_name, cpx_name, param_key, description, default_value)
+        self._min_value = min_value
+        self._max_value = max_value
+
+    def is_numeric(self):
+        return True  # pragma: no cover
+
+    def _get_min_value(self):
+        return self._min_value  # pragma: no cover
+
+    def _get_max_value(self):
+        return self._max_value  # pragma: no cover
+
+    @property
+    def min_value(self):
+        return self._min_value
+
+    @property
+    def max_value(self):
+        return self._max_value
+
+
[docs]    def accept_value(self, new_value):
+        fvalue = float(new_value)
+        return self._is_in_range(fvalue, self._min_value, self._max_value)

+
+    def transform_value(self, new_value):
+        return float(new_value)
+
+    @property
+    def type_name(self):
+        return "number"

+
+
+# a dictionary of formats for each type.
+_param_prm_formats = {NumParameter: "%.14f",
+                      IntParameter: "%d",
+                      PositiveIntParameter: "%d",
+                      BoolParameter: "%d",
+                      StrParameter: "\"%s\""  # need quotes
+                      }
+
+
+
[docs]class RootParameterGroup(ParameterGroup):
+    """ The root parameter group (there should be only one instance at the root of the tree).
+    """
+
+    def __init__(self, name, cplex_version):
+        ParameterGroup.__init__(self, name)
+        self._cplex_version = cplex_version
+        self._models = []
+
+    def __deepcopy__(self, memodict={}):
+        """
+        Returns:
+           A deep copy of the parameter group.
+        """
+        import copy
+        saved_models = self._models
+        self._models = []
+        new_root = RootParameterGroup(self.name, self._cplex_version)
+        memodict[id(self)] = new_root
+        for p in self.iter_params():
+            new_root._add_param(copy.copy(p))
+        for sg in self.iter_subgroups():
+            new_root._add_subgroup(copy.deepcopy(sg, memodict))
+        # add parameter and subgroup names to the inner __dict__ of the root
+        new_root._restore_dict_recursive()
+        # ---
+        for m in saved_models:
+            new_root.connect_model(m)
+        return new_root
+
+    def connect_model(self, m):
+        self._models.append(m)
+
+    def apply(self, param):
+        # apply one parameter to connected models
+        for m in self._models:
+            m.apply_one_parameter(param)
+
+    @property
+    def cplex_version(self):
+        return self._cplex_version
+
+
[docs]    def is_root(self):
+        return True

+
+
[docs]    def export_prm(self, out, overload_params=None):
+        """
+        Exports parameters to an output stream in PRM format.
+
+        This method writes non-default parameters in CPLEX PRM syntax.
+        In addition to non-default parameters, some parameters can be forced to
+        be printed with a specific value by passing a dictionary with
+        Parameter objects as keys and values as arguments.
+        These values are used in the print operation, but will not be kept,
+        and the values of parameters will not be changed.
+        Passing `None` as `overload_params` will disable this functionality, and
+        only non-default parameters are printed.
+
+        Args:
+            out: The output stream, typically a filename.
+
+            overload_params: A dictionary of overloaded values for
+                certain parameters. This dictionary is of the form {param: value}
+                the printed PRM file will use overloaded values
+                for those parameters present in the dictionary.
+
+        """
+        cplex_version_string = self._cplex_version
+        out.write("# -- This content is generated by DOcplex\n")
+        out.write("CPLEX Parameter File Version %s\n" % cplex_version_string)
+
+        param_generator = self.generate_params()
+        for param in param_generator:
+            if overload_params and param in overload_params:
+                param_value = overload_params[param]
+            else:
+                param_value = param.get()
+
+            if param_value != param.default_value:
+                out.write("{0:<33}".format(param.cpx_name))
+                out.write(_param_prm_formats[type(param)] % param_value)
+                out.write("\n")
+
+        out.write("# --- end of generated prm data ---\n")

+
+    def print_information(self, indent_level=0, print_all=False):
+        indent = ' ' * indent_level
+        param_generator = self.generate_params()
+        for param in param_generator:
+            if param.is_nondefault() or print_all:
+                param_value = param.get()
+                print("{0}{1} = {2!s}"
+                      .format(indent,
+                              param.qualified_name,
+                              _param_prm_formats[type(param)] % param_value))
+
+    def export_prm_to_path(self, path, overload_params=None):
+        with open(path, mode='w') as out:
+            self.export_prm(out, overload_params=overload_params)
+
+
[docs]    def print_info_to_stream(self, output, overload_params=None, print_defaults=False, indent_level=0):
+        """ Writes parameters to an output stream.
+
+        This method writes non-default parameters in a human readable syntax.
+        In addition to non-default parameters, some parameters can be forced to
+        be printed with a specific value by passing a dictionary with
+        Parameter objects as keys and values as arguments.
+        These values are used in the print operation but not be kept,
+        and the values of parameters will not be changed.
+        Passing `None` as `overload_params` will disable this functionality, and
+        only non-default parameters are printed.
+
+        Args:
+            output: The output stream.
+            overload_params: A dictionary of overloaded values for
+                certain parameters. This dictionary is of the form {param: value}.
+        """
+        indent = " " * indent_level
+        param_generator = self.generate_params()
+        for param in param_generator:
+            if overload_params and param in overload_params:
+                param_value = overload_params[param]
+            elif print_defaults or param.is_nondefault():
+                param_value = param.get()
+            else:
+                param_value = None
+            if param_value is not None:
+                output.write("{0}{1} = {2!s}\n"
+                             .format(indent,
+                                     param.qualified_name,
+                                     _param_prm_formats[type(param)] % param_value))

+
+
[docs]    def export_prm_to_string(self, overload_params=None):
+        """  Exports non-default parameters in PRM format to a string.
+
+        The logic of overload is the same as in :func:`export_prm`.
+        A parameter is written if either it is a key on `overload_params`,
+        or it has a non-default value.
+        This allows merging non-default parameters with temporary parameter values.
+
+
+        Args:
+            overload_params: A dictionary of overloaded values, possibly None.
+
+        Note:
+            This method has no side effects on the parameters.
+
+        Returns:
+            string: A string in CPLEX PRM format.
+        """
+        oss = StringIO()
+        self.export_prm(oss, overload_params)
+        return oss.getvalue()

+
+    def export_as_ops_file(self, filename):
+        with open(filename, mode='w') as out:
+            out.write(self.export_as_ops_file_to_string())
+
+    def export_as_ops_file_to_string(self):
+        from xml.etree.ElementTree import Element
+        from xml.etree import ElementTree
+        from xml.dom import minidom
+
+        def prettify(elem):
+            """Return a pretty-printed XML string for the Element.
+            """
+            rough_string = ElementTree.tostring(element=elem, encoding='utf-8')
+            reparsed = minidom.parseString(rough_string)
+            return reparsed.toprettyxml(indent="  ", )
+
+        settings = Element("settings")
+        settings.attrib = {"version": "2"}
+        category = Element("category")
+        category.attrib = {"name": "cplex"}
+        settings.append(category)
+
+        for p in self.generate_nondefault_params():
+            name = p.cpx_name.replace("CPX_PARAM_", "").lower()
+            if name == "startalg":
+                name = "rootalg"
+            elif name == "subalg":
+                name = "nodealg"
+            value = str(p.get())
+            if isinstance(p, BoolParameter):
+                if p.get() == 0:
+                    value = "false"
+                else:
+                    value = "true"
+
+            child = Element("setting")
+            child.attrib = {"name": name, "value": value}
+            category.append(child)
+
+        return prettify(settings)
+
+
[docs]    def print_info_to_string(self, overload_params=None, print_defaults=False):
+        """  Writes parameters in readable format to a string.
+
+        The logic of overload is the same as in :func:`export_prm`.
+        A parameter is written if either it is a key on `overload_params`,
+        or it has a non-default value.
+        This allows merging non-default params with temporary parameter values.
+
+        Args:
+            overload_params: A dictionary of overloaded values, possibly None.
+
+        Note:
+            This method has no side effects on the parameters.
+
+        Returns:
+            A string.
+        """
+        oss = StringIO()
+        self.print_info_to_stream(oss, print_defaults=print_defaults, overload_params=overload_params)
+        return oss.getvalue()

+
+    @staticmethod
+    def make(name, param_dict_fn, subgroup_fn, cplex_version):
+        # INTERNAL
+        # factory method to create one group from:
+        # 1. a lambda function taking a group as argument and returning a dict of name: param instances
+        # 2. a dict of subgroup name: subgroup_make functions
+        # 3. a possibly-None parent group. If None, we are at root.
+        root_group = RootParameterGroup(name, cplex_version)
+        root_group._initialize(param_dict_fn, subgroup_fn)
+        return root_group
+
+    def prettyprint(self, indent=0):
+        print("* CPLEX parameters version: {0}".format(self.cplex_version))
+        ParameterGroup.prettyprint(self, indent)
+
+    def __repr__(self):
+        return "docplex.mp.params.RootParameterGroup(%s)" % self.cplex_version
+
+
[docs]    def qualified_name(self, sep='.', include_root=True):
+        return 'parameters' if include_root else ''

+
+    def as_dict(self):
+        # INTERNAL: returns a dictionary of qualified name -> parameter
+        qdict = {p.qualified_name: p for p in self}
+        return qdict
+
+    def __iter__(self):
+        for p in self.iter_params():
+            yield p
+        # now recurse
+        for sg in self.iter_subgroups():
+            for nd in sg._generate_and_filter_params(predicate=None):
+                yield nd
+
+    def find_parameter(self, key):
+        if is_int(key):
+            pred = lambda p_: p_.cpx_id == key
+        elif is_string(key):
+            # eliminate initial '.'
+            pred = lambda p_: p_.get_qualified_name(include_root=False) == key
+        else:
+            docplex_fatal('Parameters.find() accepts either integer code or path-like name, got: {0!r}'.format(key))
+        for p in self:
+            if pred(p):
+                return p
+        else:
+            return None
+
+    def set_from_qualified_name(self, qname, pvalue):
+        qname_list = qname.split('.')
+        if not qname_list:
+            # empty qname
+            return
+        groups = qname_list[:-1]
+        pname = qname_list[-1]
+        group = self
+        for g in groups:
+            group = getattr(group, g)
+            if group is None:
+                raise ValueError("Bad parameter group name: {0}".format(g))
+        res = None
+        try:
+            # extract parameter from group
+            target_param = getattr(group, pname)
+            if target_param:
+                target_param.set(pvalue)
+                res = pvalue
+        except AttributeError:
+            raise ValueError("Cannot find paramater {0} in group {1}".format(pname, group))
+        except DOcplexException as dex:
+            raise
+
+        return res

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/priority.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/priority.html new file mode 100644 index 0000000..9de35c1 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/priority.html @@ -0,0 +1,220 @@ + + + + + + + + + docplex.mp.priority — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.priority

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------
+from enum import Enum
+
+from docplex.mp.utils import is_number, is_string
+
+
+
[docs]class Priority(Enum):
+    """
+    This enumerated class defines the priorities: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, MANDATORY.
+    """
+
+    def __new__(cls, value, print_name):
+        obj = object.__new__(cls)
+        # predefined
+        obj._value_ = value
+        obj._print_name = print_name
+        return obj
+
+    VERY_LOW = 100, 'Very Low'
+    LOW = 200, 'Low'
+    MEDIUM = 300, 'Medium'
+    HIGH = 400, 'High'
+    VERY_HIGH = 500, 'Very High'
+    MANDATORY = 999999999, 'Mandatory'
+
+    def __repr__(self):
+        return 'Priority<{}>'.format(self.name)
+
+    @property
+    def cplex_preference(self):
+        return self._get_geometric_preference_factor(base=10.0)
+
+    def _get_geometric_preference_factor(self, base):
+        # INTERNAL: returns a CPLEX preference factor as a power of "base"
+        # MEDIUM priority is the balance point with a preference of 1.
+        assert is_number(base)
+
+        if self.is_mandatory():
+            return 1e+20
+        else:
+            # noinspection PyTypeChecker
+            medium_index = Priority.MEDIUM.value / 100
+            # pylint complains about no value member but is wrong!
+            diff = self.value / 100 - medium_index
+            factor = 1.0
+            pdiff = diff if diff >= 0 else -diff
+            for _ in range(0, int(pdiff)):
+                factor *= base
+            return factor if diff >= 0 else 1.0 / factor
+
+    def less_than(self, other):
+        assert isinstance(other, Priority)
+        return self.value < other.value
+
+    def __lt__(self, other):
+        return self.less_than(other)
+
+    def __gt__(self, other):
+        return other.less_than(self)
+
+    def is_mandatory(self):
+        return self == Priority.MANDATORY
+
+
[docs]    @classmethod
+    def parse(cls, arg, logger, accept_none=True, do_raise=True):
+        ''' Converts its argument to a ``Priority`` object.
+
+        Returns `default_priority` if the text is not a string, empty, or does not match.
+
+        Args;
+            arg: The argument to convert.
+
+            logger: An error logger
+
+            accept_none: True if None is a possible value. Typically,
+                Constraint.set_priority accepts None as a way to
+                remove the constraint's own priority.
+
+            do_raise: A Boolean flag indicating if an exception is to be raised if the value
+                is not recognized.
+
+        Returns:
+            A Priority enumerated object.
+        '''
+        if isinstance(arg, cls):
+            return arg
+        elif is_string(arg):
+            key = arg.lower()
+            # noinspection PyTypeChecker
+            for p in cls:
+                if key == p.name.lower() or key == str(p.value):
+                    return p
+            if do_raise:
+                logger.fatal('String does not match priority type: {}', arg)
+            else:
+                logger.error('String does not match priority type: {}', arg)
+                return None
+            return None
+        elif accept_none and arg is None:
+            return None
+        else:
+            logger.fatal('Cannot convert to a priority: {0!s}'.format(arg))

+
+
+class UserPriority(object):
+
+    def __init__(self, pref, name=None):
+        assert pref >= 0
+        self._preference = pref
+        self._name = name
+
+    @property
+    def cplex_preference(self):
+        return self._preference
+
+    # noinspection PyMethodMayBeStatic
+    def is_mandatory(self):
+        return False
+
+    @property
+    def name(self):
+        return self._name or '_user_'
+
+    @property
+    def value(self):
+        return self._preference
+
+    def __str__(self):
+        name = self._name
+        sname = '%s: ' % name if name else ''
+        return 'UserPriority({0}{1})'.format(sname, self._preference)
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/progress.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/progress.html new file mode 100644 index 0000000..3119297 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/progress.html @@ -0,0 +1,753 @@ + + + + + + + + + docplex.mp.progress — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.progress

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2019
+# --------------------------------------------------------------------------
+'''This package contains classes to monitor the progress of a MIP solve.
+
+This abstract class defines protocol methods, which are called from within CPLEX's MIP search algorithm.
+
+Progress listeners are based on CPLEX's MIPInfoCallback, and work only with a
+local installation of CPLEX, not on Cplexcloud.
+
+At each node, all progress listeners attached to the model receive progress data
+through a `notify_progress` method, with an instance of :class:`~ProgressData`.
+This named tuple class contains information about solve time, objective value,
+best bound, gap and nodes, but no variable values.
+
+The base class for progress listeners is :class:`~ProgressListener`.
+DOcplex provides concrete sub-classes to handle basic cases, but
+you may also create your own sub-class of :class:`~ProgressListener` to suit your needs.
+Each instance of :class:`~ProgressListener` must be attached to a model to receive events during
+a MIP solve., using `Model.add_progress_listener`.
+
+An example of such a progress listener is :class:`TextProgressListener`,
+which prints a message to stdout in a format similar to CPLEX log, each time it receives a progress data.
+
+If you need to get the values of variables in an intermediate solution,
+you should sub-class from class :class:`~SolutionListener`.
+In this case, the :func:`~ProgressListener.notify_solution` method will be called
+each time CPLEX finds a valid intermediate solution, with an instance of :class:`docplex.mp.solution.SolveSolution`.
+
+Listeners are called from within CPLEX code, with its own frequency. It may occur that listeners are
+called with no real progress in either the objective or the best bound. To help you chose what kind
+of calls you are really interested in, DOcplex uses the enumerated class :class:`~ProgressClock'.
+The baseline clock is the CPLEX clock, but you can refine this clock: for example,
+`ProgressClock.Objective` filters all calls but those where the objective has improved.
+
+To summarize, listeners are called from within CPLEX's MIP search algorithm, when the clock
+you have chosen accepts the call. All listeners are created with a clock argument that controls which
+calls they accept.
+
+When a listener accepts a call, its method :func:`~ProgressListener.notify_progress` is called with the current progress data.
+See :class:`~TextProgressListener` as an example of a simple progress listener.
+
+In addition, if the listener derives from :class:`~SolutionListener`, its method :func:`~ProgressListener.notify_solution` is also called
+with the intermediate solution, passed as an instance of :class:`docplex.mp.solution.SolveSolution`.
+See :class:`~SolutionRecorder` as an example of solution listener
+
+'''
+from enum import Enum
+from collections import namedtuple
+
+
+from docplex.mp.utils import is_string, is_number
+from docplex.mp.error_handler import docplex_fatal
+
+_TProgressData_ = namedtuple('_TProgressData',
+                             ['id', 'has_incumbent',
+                              'current_objective', 'best_bound', 'mip_gap',
+                              'current_nb_iterations', 'current_nb_nodes', 'remaining_nb_nodes',
+                              'time', 'det_time'])
+
+
+# noinspection PyUnresolvedReferences
+
[docs]class ProgressData(_TProgressData_):
+    """ A named tuple class to hold progress data, as reeived from CPLEX.
+
+    Attributes:
+        has_incumbent: a boolean, indicating whether an incumbent solution is available (or not),
+            at the moment the listener is called.
+        current_objective: contains the current objective, if an incumbent is available, else None.
+        best_bound: The current best bound as reported by the solver.
+        mip_gap: the gap between the best integer objective and the objective of the best node remaining;
+            available if an incumbent is available.
+        current_nb_nodes: the current number of nodes.
+        current_nb_iterations: the current number of iterations.
+        remaining_nb_nodes: the remaining number of nodes.
+        time: the elapsed time since solve started.
+        det_time: the deterministic time since solve started.
+    """
+
+    def __str__(self):  # pragma: no cover
+        fmt = 'ProgressData({0}, {1}, obj={2}, bbound={3}, #nodes={4})'. \
+            format(self.id, self.has_incumbent, self.current_objective, self.best_bound, self.current_nb_nodes)
+        return fmt

+
+
+
[docs]class ProgressClock(Enum):
+    """
+    This enumerated class controls the type of events a listener listens to.
+
+    The possible values are (in order of decreasing call frequency).
+
+        - All: the listener listens to all calls from CPLEX.
+        - BestBound: listen to changes in best bound, not necessarily with a solution present.
+        - Solutions: listen to all intermediate solutions, not necessarily impriving.
+            Nothing prevents being called several times with an identical solution.
+
+        - Gap: listen to intermediate solutions, where either objective or best bound has improved.
+        - Objective: listen to intermediate solutions, where the solution objective has improved.
+
+    To determine whether objective or best bound have improved (or not), see the numerical parameters
+    `absdiff` and `reldiff` in `:class:ProgressListener` and all its descendant classes.
+
+    *New in version 2.10*
+    """
+    #
+    # An enumeration of filtering levels for listeners.
+    #
+    All = 0
+    Solutions = 1
+    BestBound = 2  # best bound clock is indepedent from solution clock
+    Objective = 5  # b101
+    Gap = 7  # the gap clock changes when there is a solution, and either bound or objective has changed
+
+    @property
+    def listens_to_solution(self):
+        # returns true if the enum listens to solutions
+        return 1 == self.value & 1
+
+    @classmethod
+    def parse(cls, arg):
+        if isinstance(arg, ProgressClock):
+            return arg
+        else:
+            # int value
+            for fl in cls:
+                if arg == fl.value:
+                    return fl
+                elif is_string(arg) and arg.lower() == fl.name.lower():
+                    return fl
+            else:
+                # pragma: no cover
+                raise ValueError('Expecting filter level, {0!r} was passed'.format(arg))

+
+
+default_absdiff = 1e-1
+default_reldiff = 1e-2
+
+
+class _AbstractProgressListener(object):
+
+    def __init__(self):
+        self._cb = None
+        self._current_progress_data = None
+
+    def _get_model(self):
+        ccb = self._cb
+        return ccb._model if ccb else None
+
+    def _set_current_progress_data(self, pdata):
+        # INTERNAL
+        self._current_progress_data = pdata
+
+    def _disconnect(self):
+        # INTERNAL
+        self._cb = None
+
+    def _connect_cb(self, cb):
+        # INTERNAL
+        self._cb = cb
+
+    def abort(self):
+        ccb = self._cb
+        if ccb is not None:
+            ccb.abort()
+        else:
+            print('!!! callback is not connected - abort() ignored')
+
+    def notify_start(self):
+        self._current_progress_data = None
+
+
+
[docs]class ProgressListener(_AbstractProgressListener):
+    '''  The base class for progress listeners.
+    '''
+
+    def __init__(self, clock_arg=ProgressClock.All, absdiff=None, reldiff=None):
+        super().__init__()
+        clock = ProgressClock.parse(clock_arg)
+        self._clock = clock
+        self._absdiff = absdiff if absdiff is not None else default_absdiff
+        self._reldiff = reldiff if reldiff is not None else default_reldiff
+        self._filter = make_clock_filter(clock, absdiff, reldiff)
+
+    @property
+    def clock(self):
+        """ Returns the clock of the listener.
+
+        :return:
+            an instance of :class:`~ProgressClock`
+
+        """
+        return self._clock
+
+    @property
+    def abs_diff(self):
+        return self._absdiff
+
+    @property
+    def relative_diff(self):
+        return self._reldiff
+
+    @property
+    def current_progress_data(self):
+        """ This property return the current progress data, if any.
+
+        Returns the latest progress data, if at least one has been received.
+
+        :return: an instance of :class:~ProgressData` or None.
+        """
+        return self._current_progress_data
+
+    def accept(self, pdata):
+        return self._filter.accept(pdata)
+
+    def requires_solution(self):
+        return False
+
+
[docs]    def notify_solution(self, s):
+        """ Redefine this method to handle an intermediate solution from the callback.
+
+        Args:
+            s: solution
+
+        Note:
+            if you need to access runtime information (time, gap, number of nodes), use
+            :func:`SolutionListener.current_progress_data`, which contains the latest
+            priogress information as a tuple.
+        """
+        pass  # pragma: no cover

+
+
[docs]    def notify_start(self):
+        """ This methods  is called on all attached listeners at the beginning of a solve().
+
+        When writing a custom listener, this method is used to restore
+        internal data which can be modified during solve.
+        Always call the superclass `notify_start` before adding specific code in a sub-class.
+        """
+        super().notify_start()
+        self._filter.reset()

+
+    def notify_jobid(self, jobid):
+        pass  # pragma: no cover
+
+
[docs]    def notify_end(self, status, objective):
+        """The method called when solve is finished on a model.
+
+        The status is the solve status from the
+        solve() method
+        """
+        pass  # pragma: no cover

+
+
[docs]    def notify_progress(self, progress_data):
+        """ This method is called from within the solve with a ProgressData instance.
+
+        :param progress_data: an instance of :class:`ProgressData` containing data about the
+            current point in the search tree.
+
+        """
+        pass  # pragma: no cover

+
+
[docs]    def abort(self):
+        ''' Aborts the CPLEX search.
+
+        This method tells CPLEX to stop the MIP search.
+        You may use this method in a custom progress listener to stop the search based on your own
+        criteria (for example, when improvements in gap is consistently below a minimum threshold).
+
+        Note:
+            This method should be called from within a :func:`notify_progress` method call, otherwise it will have
+            no effect.
+
+        '''
+        super().abort()

+
+
+# noinspection PyUnusedLocal,PyMethodMayBeStatic
+class FilterAcceptAll(object):
+
+    def accept(self, pdata):
+        return True
+
+    def reset(self):
+        pass
+
+
+# noinspection PyMethodMayBeStatic
+class FilterAcceptAllSolutions(object):
+
+    def accept(self, pdata):
+        return pdata.has_incumbent
+
+    def reset(self):
+        pass
+
+
+class Watcher(object):
+
+    def __init__(self, name, absdiff, reldiff, update_fn):
+        assert absdiff >= 0
+        assert reldiff >= 0
+
+        self.name = name
+        self._watched = None
+        self._old = None
+        self._absdiff = absdiff
+        self._reldiff = reldiff
+        self._update_fn = update_fn
+
+    def reset(self):
+        self._watched = None
+        self._old = None
+
+    def accept(self, progress_data):
+        accepted = False
+
+        old = self._watched
+        new_watched = self._update_fn(progress_data)
+        # if new_watched is None, then it is not available (e.g. objective)
+        if new_watched is not None:
+            if old is None:
+                accepted = True
+            else:
+                # assert is a number
+                delta = abs(new_watched - old)
+                reldiff = self._reldiff
+                absdiff = self._absdiff
+                if 0 < absdiff <= abs(new_watched - old):
+                    accepted = True
+                elif reldiff and delta / (1 + abs(old)) >= reldiff:
+                    accepted = True
+        return accepted
+
+    def sync(self, pdata):
+        cur = self._watched
+        self._watched = self._update_fn(pdata)
+        self._old = cur
+
+    def __str__(self):  # pragma: no cover
+        ws = '--' if self._watched is None else self._watched
+        return 'W_{0}[{1}]'.format(self.name, ws)
+
+
+def clock_filter_accept_stop_here(watcher, pdata):
+    pass
+
+
+class ClockFilter(object):
+
+    def __init__(self, level, obj_absdiff, bbound_absdiff, obj_reldiff=0, bbound_reldiff=0, node_delta=-1):
+        watchers = []
+        if obj_absdiff > 0 or obj_reldiff > 0:
+            def update_obj(pdata):
+                return pdata.current_objective if pdata.has_incumbent else None
+
+            obj_watcher = Watcher(name='obj', absdiff=obj_absdiff, reldiff=obj_reldiff, update_fn=update_obj)
+            watchers.append(obj_watcher)
+        if bbound_absdiff > 0 or bbound_reldiff > 0:
+            def update_bbound(pdata):
+                return pdata.best_bound
+
+            watchers.append(Watcher(name='gap_bound', absdiff=bbound_absdiff, reldiff=bbound_reldiff,
+                                    update_fn=update_bbound))
+        if node_delta > 0:
+            used_node_delta = max(node_delta, 1)
+
+            def update_nodes(pdata):
+                return pdata.current_nb_nodes
+
+            watchers.append(Watcher(name='nodes', absdiff=used_node_delta, reldiff=0, update_fn=update_nodes))
+        self._watchers = watchers
+        self._clock = level
+        self._listens_to_solution = level.listens_to_solution
+
+    def accept(self, progress_data):
+        if not progress_data.has_incumbent and self._listens_to_solution:
+            return False
+        # the filter accepts data as soon as one of its cells accepts it.
+        poke = self.peek(progress_data)
+        if poke is None:
+            return False
+        else:
+            clock_filter_accept_stop_here(poke, progress_data)
+            # print("- accepting event #{0}, reason: {1}".format(progress_data.id, poke.name))
+            for w in self._watchers:
+                w.sync(progress_data)
+            return True
+
+    def peek(self, progress_data):
+        for w in self._watchers:
+            if w.accept(progress_data):
+                return w
+        else:
+            return None
+
+    def reset(self):
+        for w in self._watchers:
+            w.reset()
+
+
+# noinspection PyArgumentEqualDefault
+def make_clock_filter(level, absdiff, reldiff, nodediff=0):
+    absdiff_ = 1e-1 if absdiff is None else absdiff
+    reldiff_ = 1e-2 if reldiff is None else reldiff
+    if level == ProgressClock.All:
+        return FilterAcceptAll()
+    elif level == ProgressClock.Solutions:
+        return FilterAcceptAllSolutions()
+    elif level == ProgressClock.Gap:
+        return ClockFilter(level, obj_absdiff=absdiff_, obj_reldiff=reldiff_,
+                           bbound_absdiff=absdiff_, bbound_reldiff=reldiff_, node_delta=nodediff)
+    elif level == ProgressClock.Objective:
+        return ClockFilter(level, obj_absdiff=absdiff_, obj_reldiff=reldiff_,
+                           bbound_absdiff=0, bbound_reldiff=0, node_delta=nodediff)
+    elif level == ProgressClock.BestBound:
+        return ClockFilter(level, obj_absdiff=0, obj_reldiff=0,
+                           bbound_absdiff=absdiff_, bbound_reldiff=reldiff_)
+
+    else:
+        # pragma: no cover
+        raise ValueError('unexpected level: {0!r}'.format(level))
+
+
+
[docs]class TextProgressListener(ProgressListener):
+    """ A simple implementation of Progress Listener, which prints messages to stdout,
+        in the manner of the CPLEX log.
+
+    :param clock: an enumerated value of type `:class:ProgressClock` which defines the frequency of the listener.
+    :param absdiff: a float value which controls the minimum absolute change for objective or best bound values
+    :param reldiff: a float value which controls the minimum absolute change for objective or best bound values.
+
+    Note:
+        The default behavior is to listen to an improvement in either the objective or best bound,
+        each being improved by either an absolute value change of at least `absdiff`,
+        or a relative change of at least `reldiff`.
+
+    """
+
+    def __init__(self, clock=ProgressClock.Gap, gap_fmt=None, obj_fmt=None,
+                 absdiff=None, reldiff=None):
+        ProgressListener.__init__(self, clock, absdiff, reldiff)
+        self._gap_fmt = gap_fmt or "{:.2%}"
+        self._obj_fmt = obj_fmt or "{:.4f}"
+        self._count = 0
+
+
[docs]    def notify_start(self):
+        super(TextProgressListener, self).notify_start()
+        self._count = 0

+
+
[docs]    def notify_progress(self, progress_data):
+        self._count += 1
+        pdata_has_incumbent = progress_data.has_incumbent
+        incumbent_symbol = '+' if pdata_has_incumbent else ' '
+        # if pdata_has_incumbent:
+        #     self._incumbent_count += 1
+        current_obj = progress_data.current_objective
+        if pdata_has_incumbent:
+            objs = self._obj_fmt.format(current_obj)
+        else:
+            objs = "N/A"  # pragma: no cover
+        best_bound = progress_data.best_bound
+        nb_nodes = progress_data.current_nb_nodes
+        remaining_nodes = progress_data.remaining_nb_nodes
+        if pdata_has_incumbent:
+            gap = self._gap_fmt.format(progress_data.mip_gap)
+        else:
+            gap = "N/A"  # pragma: no cover
+        raw_time = progress_data.time
+        rounded_time = round(raw_time, 1)
+
+        print("{0:>3}{7}: Node={4} Left={5} Best Integer={1}, Best Bound={2:.4f}, gap={3}, ItCnt={8} [{6}s]"
+              .format(self._count, objs, best_bound, gap, nb_nodes, remaining_nodes, rounded_time,
+                      incumbent_symbol, progress_data.current_nb_iterations))

+
+
+
[docs]class ProgressDataRecorder(ProgressListener):
+    """ A specialized class of ProgressListener, which collects all ProgressData it receives.
+
+    """
+
+    def __init__(self, clock=ProgressClock.Gap, absdiff=None, reldiff=None):
+        super(ProgressDataRecorder, self).__init__(clock, absdiff, reldiff)
+        self._recorded = []
+
+
[docs]    def notify_start(self):
+        super(ProgressDataRecorder, self).notify_start()
+        # clear recorded data
+        self._recorded = []

+
+
[docs]    def notify_progress(self, progress_data):
+        self._recorded.append(progress_data)

+
+    @property
+    def number_of_records(self):
+        return len(self._recorded)
+
+    @property
+    def iter_recorded(self):
+        """ Returns an iterator on stored progress data
+
+        :return: an iterator.
+        """
+        return iter(self._recorded)
+
+    @property
+    def recorded(self):
+        """ Returns a copy of the recorded data.
+
+        :return:
+        """
+        return self._recorded[:]

+
+
+
[docs]class SolutionListener(ProgressListener):
+    """ The base class for listeners that work on intermediate solutions.
+
+    To define a custom behavior for a subclass of this class, you need to redefine `notify_solution`.
+    The current progress data is available from the `current_progress_data` property.
+    """
+
+    # noinspection PyMethodMayBeStatic
+    def check_solution_clock(self):
+        if not self.clock.listens_to_solution:
+            docplex_fatal('Solution listener requires a solution clock among (Solutions,Objective|Gap), {0} was passed',
+                          self.clock)
+
+    def __init__(self, clock=ProgressClock.Solutions, absdiff=None, reldiff=None):
+        super(SolutionListener, self).__init__(clock, absdiff, reldiff)
+        self.check_solution_clock()
+
+    def requires_solution(self):
+        return True
+
+
[docs]    def notify_solution(self, sol):
+        """ Generic method to be redefined by custom listeners to
+        handle intermediate solutions. This method is called by the
+        CPLEX search with an intermediate solution.
+
+        :param sol: an instance of :class:`docplex.mp.solution.SolveSolution`
+
+        Note: as this method is called at each node of the MIP search, it may happen
+        that several calls are made with an identical solution, that is, different object
+        instances, but sharing the same variable values.
+        """
+        pass  # pragma: no cover

+
+
[docs]    def notify_start(self):
+        super(SolutionListener, self).notify_start()

+
+    def accept(self, pdata):
+        return pdata.has_incumbent and super(SolutionListener, self).accept(pdata)

+
+
+
[docs]class SolutionRecorder(SolutionListener):
+    """ A specialized implementation of :class:`SolutionListener`,
+    which stores --all-- intermediate solutions.
+
+    As  the listener might be called at different times with identical incumbent
+    values, thus the list of solutions list might well contain identical solutions.
+    """
+
+    def __init__(self, clock=ProgressClock.Gap, absdiff=None, reldiff=None):
+        super(SolutionRecorder, self).__init__(clock, absdiff, reldiff)
+        self._solutions = []
+
+
[docs]    def notify_start(self):
+        """ Redefinition of the generic notify_start() method to clear all data modified by solve().
+        In this case, clears the list of solutions.
+        """
+        super(SolutionListener, self).notify_start()
+        self._solutions = []

+
+
[docs]    def notify_solution(self, sol):
+        """ Redefintion of the generic `notify_solution` method, called by CPLEX.
+         For this class, appends the intermediate solution to the list of stored solutions.
+
+        """
+        self._solutions.append(sol)

+
+
[docs]    def iter_solutions(self):
+        """ Returns an iterator on the stored solutions"""
+        return iter(self._solutions)

+
+    @property
+    def number_of_solutions(self):
+        """ Returns the number of stored solutions. """
+        return len(self._solutions)
+
+    @property
+    def current_solution(self):
+        # redefinition of generic method `notify_solution`, called by CPLEX.
+        sols = self._solutions
+        return sols[-1] if sols else None

+
+
+
[docs]class FunctionalSolutionListener(SolutionListener):
+    """ A subclass of SolutionListener, which calls a function at each intermediate solution.
+
+        No exception is caught.
+    """
+
+    def __init__(self, solution_fn, clock=ProgressClock.Gap, absdiff=None, reldiff=None):
+        SolutionListener.__init__(self, clock, absdiff, reldiff)
+        self._sol_fn = solution_fn
+
+
[docs]    def notify_solution(self, sol):
+        self._sol_fn(sol)

+
+
+
[docs]class KpiListener(SolutionListener):
+    """ A refinement of SolutionListener, which computes KPIs at each intermediate solution.
+
+    Calls the `publish` method with a dicitonary of KPIs. Defaul tis to do nothing.
+
+    This listener listens to the `Gap` clock.
+
+    """
+
+    objective_kpi_name = '_current_objective'
+    time_kpi_name = '_current_time'
+
+    def __init__(self, model, clock=ProgressClock.Gap, absdiff=None, reldiff=None):
+        super(KpiListener, self).__init__(clock, absdiff, reldiff)
+        self.model = model
+
+
[docs]    def publish(self, kpi_dict):
+        """ This method is called at each improving solution, with a dictionay of name, values.
+
+        :param kpi_dict: a dicitonary of names and KPi values, computed on the intermediate solution.
+
+        """
+        pass

+
+
[docs]    def notify_solution(self, sol):
+        pdata = self.current_progress_data
+
+        # 1. build a dict from formatted names to kpi values.
+        kpis_as_dict = {kp.name: kp.compute(sol) for kp in self.model.iter_kpis()}
+        # 2. add predefined keys for obj, time.
+        kpis_as_dict[self.objective_kpi_name] = sol.objective_value
+        kpis_as_dict[self.time_kpi_name] = pdata.time
+        self.publish(kpis_as_dict)

+
+
+
[docs]class KpiPrinter(KpiListener):
+
+    def __init__(self, model, clock=ProgressClock.Gap, absdiff=None, reldiff=None,
+                 kpi_format='* ItCnt={3:d}  KPI: {1:<{0}} = '):
+        super(KpiPrinter, self).__init__(model, clock, absdiff, reldiff)
+        self.kpi_format = kpi_format
+
+
[docs]    def publish(self, kpi_dict):
+        try:
+            max_kpi_name_len = max(len(kn) for kn in kpi_dict)  # max() raises ValueError on empty
+        except ValueError:
+            max_kpi_name_len = 0
+        kpi_num_format = self.kpi_format + '{2:.3f}'
+        kpi_str_format = self.kpi_format + '{2!s}'
+        print('-' * (max_kpi_name_len + 15))
+        itcnt = self.current_progress_data.current_nb_iterations
+        for kn, kv in kpi_dict.items():
+            if is_number(kv):
+                k_format = kpi_num_format
+            else:
+                k_format = kpi_str_format
+            kps = k_format.format(max_kpi_name_len, kn, kv, itcnt)
+            print(kps)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/publish.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/publish.html new file mode 100644 index 0000000..11c54ca --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/publish.html @@ -0,0 +1,264 @@ + + + + + + + + + docplex.mp.publish — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.publish

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2019
+# --------------------------------------------------------------------------
+
+from docplex.util.environment import get_environment
+
+try:
+    import pandas as pd
+except ImportError:
+    pd = None
+
+from docplex.util.csv_utils import write_csv, write_table_as_csv
+
+
+def get_auto_publish_names(context, prop_name, default_name):
+    # comparing auto_publish to boolean values because it can be a non-boolean
+    autopubs = context.solver.auto_publish
+    if autopubs == None:
+        return None
+    if autopubs is True:
+        return [default_name]
+    elif autopubs is False:
+        return None
+    elif prop_name in autopubs:
+        name = autopubs[prop_name]
+    else:
+        name = None
+
+    if isinstance(name, str):
+        # only one string value: make this the name of the table
+        # in a list with one object
+        name = [name]
+    elif name is True:
+        # if true, then use default name:
+        name = [default_name]
+    elif name is False:
+        # Need to compare explicitely to False
+        name = None
+    else:
+        # otherwise the kpi_table_name can be a collection-like of names,
+        # just return it
+        pass
+    return name
+
+
+def auto_publishing_result_output_names(context):
+    # Return the list of result output names for saving
+    return get_auto_publish_names(context, 'result_output', 'solution.json')
+
+
+def auto_publishing_kpis_table_names(context):
+    # Return the list of kpi table names for saving
+    return get_auto_publish_names(context, 'kpis_output', 'kpis.csv')
+
+
+def get_kpis_name_field(context):
+    autopubs = context.solver.auto_publish
+    if autopubs is True:
+        field = 'Name'
+    elif autopubs is False:
+        field = None
+    else:
+        field = context.solver.auto_publish.kpis_output_field_name
+    return field
+
+
+def get_kpis_value_field(context):
+    autopubs = context.solver.auto_publish
+    if autopubs is True:
+        field = 'Value'
+    elif autopubs is False:
+        field = None
+    else:
+        field = context.solver.auto_publish.kpis_output_field_value
+    return field
+
+
+
[docs]class PublishResultAsDf(object):
+    '''Mixin for classes publishing a result as data frame
+    '''
+
+    @staticmethod
+    def value_if_defined(obj, attr_name, default=None):
+        value = getattr(obj, attr_name) if hasattr(obj, attr_name) else None
+        return value if value is not None else default
+
+
[docs]    def write_output_table(self, df, context,
+                           output_property_name=None,
+                           output_name=None):
+        '''Publishes the output `df`.
+
+        The `context` is used to control the output name:
+
+            - If context.solver.auto_publish is true, the `df` is written using
+              output_name.
+            - If context.solver.auto_publish is false, This method does nothing.
+            - If context.solver.auto_publish.output_property_name is true,
+              then `df` is written using output_name.
+            - If context.solver.auto_publish.output_propert_name is None or
+              False, this method does nothing.
+            - If context.solver.auto_publish.output_propert_name is a string,
+              it is used as a name to publish the df
+
+        Example:
+
+            A solver can be defined as publishing a result as data frame::
+
+                class SomeSolver(PublishResultAsDf)
+                   def __init__(self, output_customizer):
+                      # output something if context.solver.autopublish.somesolver_output is set
+                      self.output_table_property_name = 'somesolver_output'
+                      # output filename unless specified by somesolver_output:
+                      self.default_output_table_name = 'somesolver.csv'
+                      # customizer if users wants one
+                      self.output_table_customizer = output_customizer
+                      # uses pandas.DataFrame if possible, otherwise will use namedtuples
+                      self.output_table_using_df = True
+
+                    def solve(self):
+                        # do something here and return a result as a df
+                        result = pandas.DataFrame(columns=['A','B','C'])
+                        return result
+
+            Example usage::
+
+               solver = SomeSolver()
+               results = solver.solve()
+               solver.write_output_table(results)
+
+        '''
+
+        prop = self.value_if_defined(self, 'output_table_property_name')
+        prop = output_property_name if output_property_name else prop
+        default_name = self.value_if_defined(self, 'default_output_table_name')
+        default_name = output_name if output_name else default_name
+        names = get_auto_publish_names(context, prop, default_name)
+        use_df = self.value_if_defined(self, 'output_table_using_df', True)
+        if names:
+            env = get_environment()
+            customizer = self.value_if_defined(self, 'output_table_customizer', lambda x: x)
+            for name in names:
+                r = customizer(df)
+                if pd and use_df:
+                    env.write_df(r, name)
+                else:
+                    # assume r is a namedtuple
+                    write_csv(env, r, r[0]._fields, name)

+
+    def is_publishing_output_table(self, context):
+        prop = self.value_if_defined(self, 'output_table_property_name')
+        default_name = self.value_if_defined(self, 'default_output_table_name')
+        names = get_auto_publish_names(context, prop, default_name)
+        return names

+
+
+def write_kpis_table(env, context, model, solution, transaction=None):
+    names = auto_publishing_kpis_table_names(context)
+    kpis_table = []
+    for k in model.iter_kpis():
+        kpis_table.append([k.name, k.compute(solution)])
+    if kpis_table:
+        # do not create the kpi tables if there are no kpis to be written
+        field_names = [get_kpis_name_field(context),
+                       get_kpis_value_field(context)]
+        for name in names:
+            write_table_as_csv(env, kpis_table, name, field_names, transaction=transaction)
+
+
+def write_solution(env, solution, name, transaction=None):
+    with env.get_output_stream(name, transaction=transaction) as output:
+        output.write(solution.export_as_json_string().encode('utf-8'))
+
+
+def write_result_output(env, context, model, solution, transaction=None):
+    names = auto_publishing_result_output_names(context)
+    for name in names:
+        write_solution(env, solution, name, transaction=transaction)
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/pwl.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/pwl.html new file mode 100644 index 0000000..5c33931 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/pwl.html @@ -0,0 +1,1045 @@ + + + + + + + + + docplex.mp.pwl — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.pwl

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from docplex.mp.utils import is_iterable
+from docplex.mp.basic import ModelingObjectBase
+from docplex.mp.utils import DOcplexException, is_number
+
+from docplex.mp.sttck import StaticTypeChecker
+
+import copy
+
+
+
[docs]class PwlFunction(ModelingObjectBase):
+    """
+    This class models piecewise linear (PWL) functions. This class is not intended to be instantiated:
+    piecewise linear functions are defined by invoking :func:`docplex.mp.model.Model.piecewise`,
+    or :func:`docplex.mp.model.Model.piecewise_as_slopes`.
+
+    Piecewise-linear functions are important in many applications.
+    They are often specified either:
+
+    * by giving a set of slopes, a set of breakpoints at which the slopes change, and the value of the functions at
+      a given point, or
+    * by giving an ordered list of (x,y) points that are linearly connected, along with the slope before the first
+      point and the slope after the last point.
+
+    Note that a piecewise-linear function may be discontinuous.
+    """
+
+    @staticmethod
+    def check_number(logger, arg, caller=None):
+        StaticTypeChecker.typecheck_num_nan_inf(logger, arg, caller)
+
+    @staticmethod
+    def check_list_pair_breaksxy(logger, arg):
+        if not is_iterable(arg):
+            logger.fatal("argument 'breaksxy' expects iterable, {0!r} was passed".format(arg))
+        if isinstance(arg, tuple):
+            # Encapsulate tuple argument into a list: this allows defining a PWL with a tuple if there is only
+            #  one element in its definition
+            arg = [arg]
+        if not arg:
+            logger.fatal("argument 'breaksxy' must be a non-empty list of (x, y) tuples.")
+        prev_pair = None
+        pprev_pair = None
+        for pair in arg:
+            if isinstance(pair, tuple):
+                if len(pair) != 2:
+                    logger.fatal("invalid tuple in 'breaksxy': {0!s}. Each tuple must have 2 items.".format(pair))
+                PwlFunction.check_number(logger, pair[0])
+                PwlFunction.check_number(logger, pair[1])
+            else:
+                logger.fatal("invalid item in 'breaksxy': {0!s}. Each item must be a (x, y) tuple.".format(pair))
+            if prev_pair is not None:
+                if pair[0] < prev_pair[0]:
+                    logger.fatal("X coordinate in: {0!s} cannot be smaller than previous break abscisse: {1!s}.".
+                                 format(pair, prev_pair))
+                if pprev_pair is not None and pair[0] == prev_pair[0] and prev_pair[0] == pprev_pair[0]:
+                    logger.fatal(
+                        "invalid break: {0!s}. There cannot be more than 2 consecutive breaks with same abscisse.".
+                            format(pair))
+            pprev_pair = prev_pair
+            prev_pair = pair
+
+    @staticmethod
+    def check_number_pair(logger, arg):
+        if arg is None:
+            logger.fatal("argument 'anchor' must be defined")
+        if isinstance(arg, tuple):
+            if len(arg) != 2:
+                logger.fatal("invalid tuple for 'anchor': {0!s}. Anchor argument must have 2 items.".format(arg))
+            PwlFunction.check_number(logger, arg[0])
+            PwlFunction.check_number(logger, arg[1])
+        else:
+            logger.fatal("invalid value for 'anchor': {0!s}. Anchor argument must be a (x, y) tuple.".format(arg))
+
+    @staticmethod
+    def check_list_pair_slope_breakx(logger, arg, anchor):
+        if arg is None:
+            logger.fatal("argument 'slopebreaksx' must be defined")
+        if not is_iterable(arg):
+            logger.fatal("not an iterable: {0!s}".format(arg))
+        if len(arg) == 0:
+            return
+        if isinstance(arg, tuple):
+            # Encapsulate tuple argument into a list: this allows defining a PWL with a tuple if there is only
+            #  one element in its definition
+            arg = [arg]
+        prev_pair = None
+        pprev_pair = None
+        for pair in arg:
+            if isinstance(pair, tuple):
+                if len(pair) != 2:
+                    logger.fatal("invalid tuple in 'slopebreaksx': {0!s}. Each tuple must have 2 items.".
+                                 format(pair))
+                PwlFunction.check_number(logger, pair[0])
+                PwlFunction.check_number(logger, pair[1])
+            else:
+                logger.fatal("invalid item in 'slopebreaksx': {0!s}. Each item must be a (x, y) tuple.".format(pair))
+            if prev_pair is not None:
+                if pair[1] < prev_pair[1]:
+                    logger.fatal("X coordinate in: {0!s} cannot be smaller than previous break abscisse: {1!s}.".
+                                 format(pair, prev_pair))
+                if pprev_pair is not None and pair[1] == prev_pair[1] and prev_pair[1] == pprev_pair[1]:
+                    logger.fatal(
+                        "invalid break: {0!s}. There cannot be more than 2 consecutive breaks with same abscisse.".
+                            format(pair))
+                if pair[1] == prev_pair[1] and anchor[0] == pair[1]:
+                    logger.fatal("anchor {0!s} cannot be defined at discontinuity point: {1!s}".
+                                 format(anchor, pair))
+            pprev_pair = prev_pair
+            prev_pair = pair
+
+    class _PwlAsBreaks:
+        """
+        When using this class, the piecewise linear function is specified by:
+         - Breakpoints defined as a list of coordinate pairs `(x[i], y[i])` defining the segments of the PWL function.
+         - Before the first segment of the PWL function there is a half-line; its slope is specified by `preslope`.
+         - After the last segment of the the PWL function there is a half-line; its slope is specified by `postslope`.
+        Two consecutive breakpoints may have the same x-coordinate; in such cases there is a discontinuity in the
+        PWL function.  Three consecutive breakpoints may not have the same x-coordinate.
+        """
+
+        def __init__(self, preslope, breaksxy, postslope):
+            self._preslope = preslope
+            self._breaksxy = self._reformulate_breaksxy(breaksxy)
+            self._postslope = postslope
+            self._cpx_breaks = None
+
+        @property
+        def preslope(self):
+            return self._preslope
+
+        @property
+        def breaksxy(self):
+            return self._breaksxy
+
+        @property
+        def postslope(self):
+            return self._postslope
+
+        @property
+        def cpx_breaksxy(self):
+            if self._cpx_breaks is None:
+                cpx_breaksx = [float(bkx) for bkx, _ in self._breaksxy]
+                cpx_breaksy = [float(bky) for _, bky in self._breaksxy]
+                self._cpx_breaks = cpx_breaksx, cpx_breaksy, float(self._preslope), float(self._postslope)
+            assert self._cpx_breaks is not None
+            return self._cpx_breaks
+
+        def deepcopy(self):
+            breaksxy_copy = copy.deepcopy(self.breaksxy)
+            return PwlFunction._PwlAsBreaks(self.preslope, breaksxy_copy, self.postslope)
+
+        @staticmethod
+        def _reformulate_breaksxy(breaksxy):
+            if isinstance(breaksxy, tuple):
+                return [] if len(breaksxy) == 0 else [breaksxy]
+            return breaksxy
+
+        @staticmethod
+        def _remove_useless_intermediate_breaks(preslope, breaksxy, postslope):
+            result_breaksxy = []
+            current_slope = preslope
+            prev_break = None
+            for br in breaksxy:
+                if prev_break is None:
+                    pass
+                else:
+                    if br[0] == prev_break[0]:
+                        # Check discontinuity
+                        if br[1] != prev_break[1]:
+                            result_breaksxy.append(prev_break)
+                            result_breaksxy.append(br)
+                            current_slope = None
+                    else:
+                        slope = (br[1] - prev_break[1]) / (br[0] - prev_break[0])
+                        if current_slope is not None and current_slope != slope:
+                            # Add prev_break in list
+                            result_breaksxy.append(prev_break)
+                        current_slope = slope
+                prev_break = br
+            # Handle last break
+            if not result_breaksxy:
+                # Set result breaks = first break
+                result_breaksxy = breaksxy[0]
+            elif current_slope is not None and current_slope != postslope:
+                result_breaksxy.append(prev_break)
+            return preslope, result_breaksxy, postslope
+
+        def _get_break_at_index(self, index):
+            if len(self.breaksxy) <= index:
+                return None, None, index
+            break_1 = self.breaksxy[index]
+            if len(self.breaksxy) > (index + 1):
+                break_2 = self.breaksxy[index + 1]
+                if break_1[0] == break_2[0]:
+                    # Discontinuity
+                    return break_1, break_2, index + 1
+            return break_1, None, index
+
+        def _get_y_value(self, x_coord, prev_break_index=-1):
+            """
+            :param x_coord:
+            :param prev_break_index: this parameter is mandatory if a breakxy tuple does exist before x_coord. Otherwise
+                an exception is raised.
+            :return:
+            """
+            if prev_break_index < 0:
+                break_1, break_2, last_ind = self._get_break_at_index(0)
+                if break_1[0] < x_coord:
+                    raise DOcplexException("Invalid arguments passed to PwlAsBreaks._get_y_value()")
+                if break_1[0] == x_coord:
+                    y_coord_1 = break_1[1]
+                    y_coord_2 = None if break_2 is None else break_2[1]
+                    return y_coord_1, y_coord_2, last_ind
+                y_coord_1 = break_1[1] - self.preslope * (break_1[0] - x_coord)
+                return y_coord_1, None, -1
+            break_1, break_2, last_ind = self._get_break_at_index(prev_break_index)
+            next_break_1, next_break_2, next_last_ind = self._get_break_at_index(last_ind + 1)
+            if next_break_1 is None:
+                # x-coord is after last break
+                last_break = break_1 if break_2 is None else break_2
+                y_coord_1 = last_break[1] + self.postslope * (x_coord - last_break[0])
+                return y_coord_1, None, last_ind
+            else:
+                if x_coord == break_1[0]:
+                    # Here, one must have: x_coord > break_1[0]
+                    raise DOcplexException("Invalid arguments passed to PwlAsBreaks._get_y_value()")
+                if x_coord == next_break_1[0]:
+                    y_coord_1 = next_break_1[1]
+                    y_coord_2 = None if next_break_2 is None else next_break_2[1]
+                    return y_coord_1, y_coord_2, next_last_ind
+                y_coord_prev = break_1[1] if break_2 is None else break_2[1]
+                y_coord_next = next_break_1[1]
+                slope = (y_coord_next - y_coord_prev) / (next_break_1[0] - break_1[0])
+                y_coord_1 = y_coord_prev + slope * (x_coord - break_1[0])
+                return y_coord_1, None, last_ind
+
+        def evaluate(self, x_val):
+            """ Evaluates the breaks-based PWL function at the point whose x-coordinate is `x_val`.
+
+            Args:
+                x_val: The x value for which we want to compute the value of the function.
+
+            Returns:
+                The value of the PWL function at point `x_val`
+                A DOcplexException exception is raised when evaluating at a discontinuity of the PWL function.
+            """
+            prev_break_index, index = -1, 0
+            while index < len(self.breaksxy):
+                break_1, break_2, index = self._get_break_at_index(index)
+                if break_1 is None:
+                    raise DOcplexException("Invalid PWL definition: no break point is defined")
+                if break_1[0] < x_val:
+                    prev_break_index = index
+                else:
+                    if break_1[0] == x_val and break_2 is not None:
+                        raise DOcplexException("Cannot evaluate PWL at a discontinuity")
+                    break
+                index += 1
+            y_val, _, _ = self._get_y_value(x_val, prev_break_index)
+            return y_val
+
+        def _get_all_breaks(self, all_x_coord):
+            all_breaks = []
+            prev_break_ind = -1
+            for x_coord in all_x_coord:
+                y_coord_1, y_coord_2, prev_break_ind = self._get_y_value(x_coord, prev_break_ind)
+                all_breaks.append((x_coord, y_coord_1) if y_coord_2 is None else
+                                  [(x_coord, y_coord_1), (x_coord, y_coord_2)])
+            return all_breaks
+
+        def get_nb_intervals(self):
+            nb_discontinuities = 0
+            prev_br = None
+            for br in iter(self.breaksxy):
+                if prev_br is not None and prev_br[0] == br[0]:
+                    nb_discontinuities += 1
+                prev_br = br
+            return len(self.breaksxy) - nb_discontinuities - 1
+
+        @property
+        def number_of_breaks(self):
+            return len(self._breaksxy)
+
+        def equals_def_xy(self, other):
+            if not isinstance(other, PwlFunction._PwlAsBreaks):
+                return False
+            if self.preslope != other.preslope:
+                return False
+            if self.postslope != other.postslope:
+                return False
+            if len(self.breaksxy) != len(other.breaksxy):
+                return False
+            for b_l, b_r in zip(self.breaksxy, other.breaksxy):
+                if b_l != b_r:
+                    return False
+            return True
+
+        def __add__(self, arg):
+            if isinstance(arg, PwlFunction._PwlAsBreaks):
+                all_x_coord = sorted({br[0] for br in self.breaksxy + arg.breaksxy})
+                all_breaks_left = self._get_all_breaks(all_x_coord)
+                all_breaks_right = arg._get_all_breaks(all_x_coord)
+                result_breaksxy = []
+                # Both lists have same size, with same x-coord for breaks ==> perform the addition on each break
+                for br_l, br_r in zip(all_breaks_left, all_breaks_right):
+                    if isinstance(br_l, tuple) and isinstance(br_r, tuple):
+                        result_breaksxy.append((br_l[0], br_l[1] + br_r[1]))
+                    else:
+                        if isinstance(br_l, tuple):
+                            # br_r is a list containing 2 tuple pairs
+                            result_breaksxy.append((br_l[0], br_l[1] + br_r[0][1]))
+                            result_breaksxy.append((br_l[0], br_l[1] + br_r[1][1]))
+                        elif isinstance(br_r, tuple):
+                            # br_l is a list containing 2 tuple pairs
+                            result_breaksxy.append((br_r[0], br_l[0][1] + br_r[1]))
+                            result_breaksxy.append((br_r[0], br_l[1][1] + br_r[1]))
+                        else:
+                            # br_l and br_r are two lists, each containing 2 tuple pairs
+                            result_breaksxy.append((br_l[0][0], br_l[0][1] + br_r[0][1]))
+                            result_breaksxy.append((br_l[0][0], br_l[1][1] + br_r[1][1]))
+                result_preslope = self.preslope + arg.preslope
+                result_postslope = self.postslope + arg.postslope
+                return PwlFunction._PwlAsBreaks(*self._remove_useless_intermediate_breaks(
+                    result_preslope, result_breaksxy, result_postslope))
+
+            elif is_number(arg):
+                return PwlFunction._PwlAsBreaks(
+                    self.preslope, [(br[0], br[1] + arg) for br in self.breaksxy], self.postslope)
+
+            else:
+                raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+
+        def __sub__(self, arg):
+            if isinstance(arg, PwlFunction._PwlAsBreaks):
+                return self + arg * (-1)
+            elif is_number(arg):
+                return PwlFunction._PwlAsBreaks(
+                    self.preslope, [(br[0], br[1] - arg) for br in self.breaksxy], self.postslope)
+            else:
+                raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+
+        def __mul__(self, arg):
+            if is_number(arg):
+                return PwlFunction._PwlAsBreaks(*self._remove_useless_intermediate_breaks(
+                    self.preslope * arg, [(br[0], br[1] * arg) for br in self.breaksxy], self.postslope * arg))
+            else:
+                raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+
+        def translate(self, arg):
+            if is_number(arg):
+                return PwlFunction._PwlAsBreaks(
+                    self.preslope, [(br[0] + arg, br[1]) for br in self.breaksxy], self.postslope)
+            else:
+                raise DOcplexException("Invalid type for argument: {0!s}.".format(arg))
+
+        def __str__(self):
+            return self.to_string()
+
+        def to_string(self):
+            return '({0}, {1}, {2})'.format(self.preslope, self.breaksxy, self.postslope)
+
+        def repr_string(self):
+            return 'preslope={0},breaksxy={1},postslope={2}'.format(self.preslope, self.breaksxy, self.postslope)
+
+    class _PwlAsSlopes:
+        """
+        When using this class, the piecewise linear function is specified by:
+         - a list of tuple pairs `(slope[i], breakx[i])` of slopes and x-coordinates defining the slope of the piecewise
+           function between the previous breakpoint (or minus infinity if there is none) and the breakpoint with
+           x-coordinate `breakx[i]`,
+         - the slope after the last specified breakpoint, and
+         - the coordinates of the 'anchor point'. The purpose of the anchor point is to ground the piecewise-linear
+           function specified by the list of slopes and breakpoints.
+        Note that:
+         - The `breakx[i]` values must be increasing. If two consecutive `breakx` values have the same value, a
+           discontinuity is defined and the value associated with the second argument is considered to be a "step".
+         - The list of tuple pairs `(slope[i], breakx[i])` may be empty.
+         - The default value for the anchor point is the origin (point with coordinates (0, 0)).
+         - If the piecewise linear function defines some discontinuities, the anchor must not reside at one of
+           these discontinuities, since the function would not be uniquely defined.
+        """
+
+        def __init__(self, slopebreaksx, lastslope, anchor=(0, 0)):
+            self._slopebreaksx = self._reformulate_slopebreaksx(slopebreaksx)
+            self._lastslope = lastslope
+            self._anchor = anchor
+
+        @property
+        def slopebreaksx(self):
+            return self._slopebreaksx
+
+        @property
+        def lastslope(self):
+            return self._lastslope
+
+        @property
+        def anchor(self):
+            return self._anchor
+
+        def deepcopy(self):
+            slopebreaksx_copy = copy.deepcopy(self.slopebreaksx)
+            anchor_copy = copy.deepcopy(self.anchor)
+            return PwlFunction._PwlAsSlopes(slopebreaksx_copy, self.lastslope, anchor_copy)
+
+        @staticmethod
+        def _reformulate_slopebreaksx(slopebreaksx):
+            if isinstance(slopebreaksx, tuple):
+                return [] if len(slopebreaksx) == 0 else [slopebreaksx]
+            return slopebreaksx
+
+        @staticmethod
+        def _compute_breaksxy_after(slope_breaks, anchor):
+            breaks_xy = []
+            start_x, start_y = anchor[0], anchor[1]
+            for (slope, break_x) in slope_breaks:
+                delta_x = break_x - start_x
+                start_x = break_x
+                if delta_x > 0:
+                    start_y = start_y + slope * delta_x
+                else:
+                    # Discontinuity: slope is considered to be a "step"
+                    start_y += slope
+                breaks_xy.append((start_x, start_y))
+            return breaks_xy
+
+        @staticmethod
+        def _compute_breaksxy_before(start_slope, slope_breaks, anchor):
+            breaks_xy = []
+            start_x, start_y = anchor[0], anchor[1]
+            last_slope = start_slope
+            for (slope, break_x) in slope_breaks:
+                delta_x = break_x - start_x
+                start_x = break_x
+                if delta_x < 0 or anchor[0] == break_x:
+                    start_y = start_y + last_slope * delta_x
+                else:
+                    # Discontinuity: slope is considered to be a "step"
+                    start_y -= last_slope
+                last_slope = slope
+                breaks_xy.append((start_x, start_y))
+            return breaks_xy, last_slope
+
+        def convert_to_pwl_as_breaks(self):
+            breaks_before = [(s, b) for (s, b) in self.slopebreaksx if b <= self.anchor[0]]
+            breaks_after = [(s, b) for (s, b) in self.slopebreaksx if b > self.anchor[0]]
+            # Compute y value at each break point
+            anchor_slope = breaks_after[0][0] if len(breaks_after) > 0 else self.lastslope
+            breaks_before.reverse()
+            breaks_xy_before, preslope = self._compute_breaksxy_before(anchor_slope, breaks_before, self.anchor)
+            breaks_xy_before.reverse()
+            breaks_xy_after = self._compute_breaksxy_after(breaks_after, self.anchor)
+            # Now, we can build the PWL as breaks
+            breaksxy = breaks_xy_before + breaks_xy_after
+            if len(breaksxy) > 0:
+                return PwlFunction._PwlAsBreaks(preslope, breaksxy, self.lastslope)
+            else:
+                # No breakpoint is defined
+                return PwlFunction._PwlAsBreaks(self.lastslope, [self.anchor], self.lastslope)
+
+        def _get_safe_xy_anchor(self):
+            """
+            Return an anchor point that is on or after (if last break corresponds to a discontinuity) the largest
+            x-coord corresponding to a break or the anchor.
+            :return:
+            """
+            breaks_after = [(s, b) for (s, b) in self.slopebreaksx if b > self.anchor[0]]
+            breaks_xy_after = self._compute_breaksxy_after(breaks_after, self.anchor)
+            if len(breaks_xy_after) > 0:
+                # Check if last break corresponds to a discontinuity
+                if len(breaks_xy_after) > 1 and breaks_xy_after[-2][0] == breaks_xy_after[-1][0]:
+                    # Returns point with x-coord = last_x_coord + 1
+                    return breaks_xy_after[-1][0] + 1, breaks_xy_after[-1][1] + self.lastslope
+                return breaks_xy_after[-1]
+            return self.anchor
+
+        @staticmethod
+        def _remove_useless_intermediate_slopes(slopebreaksx, lastslope, anchor):
+            result_slopebreaksx = []
+            prev_sbr = None
+            for sbr in slopebreaksx:
+                if prev_sbr is not None:
+                    if sbr[0] != prev_sbr[0]:
+                        result_slopebreaksx.append(prev_sbr)
+                prev_sbr = sbr
+            if prev_sbr is not None and prev_sbr[0] != lastslope:
+                result_slopebreaksx.append(prev_sbr)
+            return result_slopebreaksx, lastslope, anchor
+
+        def _get_all_slopebreaks(self, all_x_coord):
+            all_slopebreaks = []
+            iter_slopebreakx = iter(self.slopebreaksx)
+            current_slopebreakx = next(iter_slopebreakx, None)
+            for x_coord in all_x_coord:
+                if current_slopebreakx is None:
+                    all_slopebreaks.append((self.lastslope, x_coord))
+                else:
+                    while current_slopebreakx is not None and x_coord > current_slopebreakx[1]:
+                        prev_slopebreakx = current_slopebreakx
+                        current_slopebreakx = next(iter_slopebreakx, None)
+                        if current_slopebreakx is not None and current_slopebreakx[1] == prev_slopebreakx[1]:
+                            # Case of a discontinuity ==> update last item in result list to a list containing 2 tuples
+                            all_slopebreaks[-1] = [(prev_slopebreakx[0], prev_slopebreakx[1]),
+                                                   (current_slopebreakx[0], current_slopebreakx[1])]
+                    if current_slopebreakx is None:
+                        all_slopebreaks.append((self.lastslope, x_coord))
+                    else:
+                        all_slopebreaks.append((current_slopebreakx[0], x_coord))
+            # Handle case where last break is a discontinuity
+            prev_slopebreakx = current_slopebreakx
+            current_slopebreakx = next(iter_slopebreakx, None)
+            if current_slopebreakx is not None:
+                # Case of a discontinuity ==> update last item in result list to a list containing 2 tuples
+                all_slopebreaks[-1] = [(prev_slopebreakx[0], prev_slopebreakx[1]),
+                                       (current_slopebreakx[0], current_slopebreakx[1])]
+            return all_slopebreaks
+
+        def __add__(self, arg):
+            if isinstance(arg, PwlFunction._PwlAsSlopes):
+                all_x_coord = sorted({sbr[1] for sbr in self.slopebreaksx + arg.slopebreaksx})
+                all_slopebreaks_left = self._get_all_slopebreaks(all_x_coord)
+                all_slopebreaks_right = arg._get_all_slopebreaks(all_x_coord)
+                result_slopebreaksxy = []
+                # Both lists have same size, with same x-coord for slopebreaks
+                #   ==> perform the addition of slopes on each break
+                for sbr_l, sbr_r in zip(all_slopebreaks_left, all_slopebreaks_right):
+                    if isinstance(sbr_l, tuple) and isinstance(sbr_r, tuple):
+                        result_slopebreaksxy.append((sbr_l[0] + sbr_r[0], sbr_l[1]))
+                    else:
+                        if isinstance(sbr_l, tuple):
+                            # sbr_r is a list containing 2 tuple pairs
+                            result_slopebreaksxy.append((sbr_l[0] + sbr_r[0][0], sbr_l[1]))
+                            result_slopebreaksxy.append((sbr_r[1][0], sbr_l[1]))
+                        elif isinstance(sbr_r, tuple):
+                            # sbr_l is a list containing 2 tuple pairs
+                            result_slopebreaksxy.append((sbr_l[0][0] + sbr_r[0], sbr_r[1]))
+                            result_slopebreaksxy.append((sbr_l[1][0], sbr_r[1]))
+                        else:
+                            # sbr_l and sbr_r are two lists, each containing 2 tuple pairs
+                            result_slopebreaksxy.append((sbr_l[0][0] + sbr_r[0][0], sbr_l[0][1]))
+                            result_slopebreaksxy.append((sbr_l[1][0] + sbr_r[1][0], sbr_l[0][1]))
+                result_lastslope = self.lastslope + arg.lastslope
+
+                if self.anchor[0] == arg.anchor[0]:
+                    result_anchor = (self.anchor[0], self.anchor[1] + arg.anchor[1])
+                else:
+                    # Compute a new anchor based on the last x-coord in the slopebreakx list + anchor point
+                    anchor_l = self._get_safe_xy_anchor()
+                    anchor_r = arg._get_safe_xy_anchor()
+                    delta = anchor_r[0] - anchor_l[0]
+                    if anchor_l[0] < anchor_r[0]:
+                        result_anchor = (anchor_r[0], anchor_l[1] + anchor_r[1] + delta * self.lastslope)
+                    else:
+                        result_anchor = (anchor_l[0], anchor_l[1] + anchor_r[1] - delta * arg.lastslope)
+
+                return PwlFunction._PwlAsSlopes(*self._remove_useless_intermediate_slopes(
+                    result_slopebreaksxy, result_lastslope, result_anchor))
+
+            elif is_number(arg):
+                return PwlFunction._PwlAsSlopes(copy.deepcopy(self.slopebreaksx),
+                                                self.lastslope, (self.anchor[0], self.anchor[1] + arg))
+            else:
+                raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+
+        def __sub__(self, arg):
+            if isinstance(arg, PwlFunction._PwlAsSlopes):
+                return self + arg * (-1)
+            elif is_number(arg):
+                return PwlFunction._PwlAsSlopes(copy.deepcopy(self.slopebreaksx),
+                                                self.lastslope, (self.anchor[0], self.anchor[1] - arg))
+            else:
+                raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+
+        def __mul__(self, arg):
+            if is_number(arg):
+                return PwlFunction._PwlAsSlopes(*self._remove_useless_intermediate_slopes(
+                    [(br[0] * arg, br[1]) for br in self.slopebreaksx],
+                    self.lastslope * arg, (self.anchor[0], self.anchor[1] * arg)))
+            else:
+                raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+
+        def translate(self, arg):
+            if is_number(arg):
+                return PwlFunction._PwlAsSlopes(
+                    [(br[0], br[1] + arg) for br in self.slopebreaksx], self.lastslope,
+                    (self.anchor[0] + arg, self.anchor[1]))
+            else:
+                raise DOcplexException("Invalid type for argument: {0!s}.".format(arg))
+
+        def __str__(self):
+            return self.to_string()
+
+        def to_string(self):
+            return '{' + ''.join(
+                repr(slope) + ' -> ' + repr(break_x) + ';' for (slope, break_x) in self._slopebreaksx) + \
+                   repr(self._lastslope) + '}(' + repr(self.anchor[0]) + ', ' + repr(self.anchor[1]) + ')'
+
+    # _name_generator = _AutomaticSymbolGenerator(pattern="pwl", offset=1)
+
+    def __init__(self, model, pwl_def, name=None):
+        ModelingObjectBase.__init__(self, model, name=name)
+        self._pwl_def = pwl_def
+        self._pwl_def_as_breaks = None
+        self._set_pwl_definition(pwl_def)
+
+    def _set_pwl_definition(self, pwl_def):
+        # INTERNAL
+        if isinstance(pwl_def, PwlFunction._PwlAsBreaks):
+            # Use the same data structure as input for internal representation (do not duplicate)
+            self._pwl_def_as_breaks = pwl_def
+        elif isinstance(pwl_def, PwlFunction._PwlAsSlopes):
+            pwl_def_as_breaks = pwl_def.convert_to_pwl_as_breaks()
+            self._set_pwl_as_breaks(pwl_def_as_breaks.preslope, pwl_def_as_breaks.breaksxy,
+                                    pwl_def_as_breaks.postslope)
+        else:
+            self.model._checker.fatal("Invalid definition for Piecewise Linear Function: {0!s}.".format(pwl_def))
+
+    def _set_pwl_as_breaks(self, preslope, breaksxy=None, postslope=None):
+        """Internal format to represent a piecewise linear function is based on the Cplex representation"""
+        self._pwl_def_as_breaks = self._PwlAsBreaks(preslope, breaksxy, postslope)
+
+    def copy(self, target_model, _):
+        pwl_def_copy = self.pwl_def.deepcopy()
+        return target_model._piecewise(pwl_def_copy, self.name)
+
+    @property
+    def pwl_def(self):
+        return self._pwl_def
+
+    def iter_breaksxy(self):
+        return iter(self._pwl_def_as_breaks._breaksxy)
+
+    @property
+    def pwl_def_as_breaks(self):
+        return self._pwl_def_as_breaks
+
+    @property
+    def number_of_breaks(self):
+        return self._pwl_def_as_breaks.number_of_breaks
+
+    def _cplex_breaks(self):
+        # INTERNAL, use by cplex only
+        pwl_def = self._pwl_def_as_breaks
+        return pwl_def.cpx_breaksxy
+
+    # __call__ builds an expression equal to the piecewise linear value of its argument, based
+    # on the definition of the PWL function.
+    #
+    # Args:
+    #     e: either an expression (a number, variable, or linear expression) or
+    #        a list of variables.
+    #
+    # Returns:
+    #     If called with an expression, return a new expression that can be freely combined
+    #     with other types of expression
+    #     If called with a list of variables, returns a lkist of expressions
+    #
+    # Note:
+    #     - Building the expression generates one auxiliary decision variable.
+    #     - Returns an empty list when called with an empty list.
+    def __call__(self, e):
+        if is_iterable(e):
+            return self._make_n_pwl_exprs(e)
+        else:
+            return self._make_one_pwl_expr(e)
+
+    def _make_one_pwl_expr(self, arg):
+        m = self._model
+        m._checker.typecheck_operand(arg, caller="Model.pwl", accept_numbers=True)
+        pwl_expr = m._add_pwl_expr(self, arg)
+        return pwl_expr
+
+    def _make_n_pwl_exprs(self, dvars):
+        mdl = self.model
+        # pwl is a pwl function
+        # var_seq is a sequence of vars
+        # return a sequence of pwl exprs
+        lfactory = mdl.lfactory
+
+        # step 1 : build a list of vars
+        arg_vars = mdl._checker.typecheck_var_seq(dvars, caller='Model.make_n_pwls')
+        if not arg_vars:
+            return []
+        nb_args = len(arg_vars)
+        vlbs = [- mdl.infinity] * nb_args
+        fvars = lfactory.new_var_list(None, range(nb_args), vartype=mdl.continuous_vartype,
+                                      lb=vlbs, ub=[], _safe_bounds=True, _add_container=False)
+        # build UNresolved pwl exprs, resolve them later on
+        pwl_exprs = [lfactory.new_pwl_expr(self, av, y_var=fv, resolve=False) for av, fv in
+                     zip(arg_vars, fvars)]
+
+        pwl_cons = [lfactory.new_pwl_constraint(pwl_expr, pwl_expr.name) for pwl_expr in pwl_exprs]
+        engine = mdl.get_engine()
+        # pwl_indices = tuple(engine.create_pwl_constraint(pwl_ct) for pwl_ct in pwl_cons)
+        pwl_indices = tuple(engine.create_batch_pwl_constraints(self, arg_vars, fvars))
+        assert len(pwl_cons) == len(pwl_indices)
+        mdl._register_block_cts(mdl._pwl_scope, pwl_cons, pwl_indices)
+        # mark all exprs as resolved
+        for ex in pwl_exprs:
+            ex.mark_resolved()
+        assert all(ex._is_resolved() for ex in pwl_exprs)
+        # nb vars is unchanged
+        return pwl_exprs
+
+    def __hash__(self):
+        return id(self)
+
+    def __str__(self):
+        return self.pwl_def.__str__()
+
+    def __repr__(self):
+        return 'docplex.mp.pwl.PwlFunction({0})'.format(self.pwl_def_as_breaks.repr_string())
+
+
[docs]    def clone(self):
+        """ Creates a copy of the PWL function on the same model.
+
+        Returns:
+            The copy of the PWL function.
+        """
+        return self.copy(self.model, None)

+
+    def __add__(self, e):
+        return self.plus(e)
+
+    def __radd__(self, e):
+        return self.plus(e)
+
+    def __iadd__(self, e):
+        self.model.fatal('Cannot modify a PWL function')
+        # self.add(e)
+        # return self
+
+    def plus(self, e):
+        cloned = self.clone()
+        return cloned.add(e)
+
+
[docs]    def add(self, arg):
+        """ Adds an expression to self.
+
+        Note:
+            This method does not create a new PWL function but modifies the `self` instance.
+
+        Args:
+            arg: The expression to be added. Can be a PWL function or a number.
+
+        Returns:
+            The modified self.
+        """
+        if isinstance(arg, PwlFunction):
+            if (isinstance(self.pwl_def, PwlFunction._PwlAsBreaks) and
+                    isinstance(arg.pwl_def, PwlFunction._PwlAsBreaks)) or \
+                    (isinstance(self.pwl_def, PwlFunction._PwlAsSlopes) and
+                         isinstance(arg.pwl_def, PwlFunction._PwlAsSlopes)):
+                self._pwl_def = self.pwl_def + arg.pwl_def
+                self._set_pwl_definition(self._pwl_def)
+            else:
+                # Use Breaks representation
+                self._pwl_def = self.pwl_def_as_breaks + arg.pwl_def_as_breaks
+                self._set_pwl_definition(self._pwl_def)
+        elif is_number(arg):
+            self._pwl_def = self.pwl_def + arg
+            self._set_pwl_definition(self._pwl_def)
+        else:
+            raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+        return self

+
+    def __sub__(self, e):
+        return self.minus(e)
+
+    def __rsub__(self, e):
+        return self * (-1) + e
+
+    def __isub__(self, e):
+        self.model.fatal('Cannot modify a PWL function')
+
+    def minus(self, e):
+        cloned = self.clone()
+        return cloned.subtract(e)
+
+
[docs]    def subtract(self, arg):
+        """ Subtracts an expression from this PWL function.
+
+        Note:
+            This method does not create a new function but modifies the `self` instance.
+
+        Args:
+            arg: The expression to be subtracted. Can be either a PWL function, or a number.
+
+        Returns:
+            The modified self.
+        """
+        if isinstance(arg, PwlFunction):
+            if (isinstance(self.pwl_def, PwlFunction._PwlAsBreaks) and
+                    isinstance(arg.pwl_def, PwlFunction._PwlAsBreaks)) or \
+                    (isinstance(self.pwl_def, PwlFunction._PwlAsSlopes) and
+                         isinstance(arg.pwl_def, PwlFunction._PwlAsSlopes)):
+                self._pwl_def = self.pwl_def - arg.pwl_def
+                self._set_pwl_definition(self._pwl_def)
+            else:
+                # Use Breaks representation
+                self._pwl_def = self.pwl_def_as_breaks - arg.pwl_def_as_breaks
+                self._set_pwl_definition(self._pwl_def)
+        elif is_number(arg):
+            self._pwl_def = self.pwl_def - arg
+            self._set_pwl_definition(self._pwl_def)
+        else:
+            raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+        return self

+
+    def __mul__(self, e):
+        return self.times(e)
+
+    def __rmul__(self, e):
+        return self.times(e)
+
+    def __imul__(self, e):
+        self.model.fatal('Cannot modify a PWL function')
+        # return self.multiply(e)
+
+    def __div__(self, e):
+        return self.quotient(e)
+
+    def __truediv__(self, e):
+        # for py3
+        # INTERNAL
+        return self.quotient(e)  # pragma: no cover
+
+    def __itruediv__(self, e):
+        # for py3
+        # INTERNAL
+        self.model.fatal('Cannot modify a PWL function')  # pragma: no cover
+
+    def __idiv__(self, other):
+        self.model.fatal('Cannot modify a PWL function')
+
+    def __rtruediv__(self, e):
+        # for py3
+        self.fatal("PWL function {0!s} cannot be used as denominator of {1!s}", self, e)  # pragma: no cover
+
+    def __rdiv__(self, e):
+        self.fatal("PWL function {0!s} cannot be used as denominator of {1!s}", self, e)
+
+    def quotient(self, e):
+        cloned = self.clone()
+        cloned.divide(e)
+        return cloned
+
+
[docs]    def divide(self, arg):
+        """ Divides this PWL function by a number.
+
+        Note:
+            This method does not create a new function but modifies the `self` instance.
+
+        Args:
+            arg: The number that is used to divide `self`.
+
+        Returns:
+            The modified `self`.
+        """
+        self.model._typecheck_as_denominator(arg, numerator=self)
+        inverse = 1.0 / float(arg)
+        return self.multiply(inverse)

+
+    def times(self, e):
+        cloned = self.clone()
+        return cloned.multiply(e)
+
+
[docs]    def multiply(self, arg):
+        """ Multiplies this PWL function by a number.
+
+        Note:
+            This method does not create a new function but modifies the `self` instance.
+
+        Args:
+            arg: The number that is used to multiply `self`.
+
+        Returns:
+            The modified `self`.
+        """
+        if is_number(arg):
+            self._pwl_def = self.pwl_def * arg
+            self._set_pwl_definition(self._pwl_def)
+        else:
+            raise DOcplexException("Invalid type for right hand side operand: {0!s}.".format(arg))
+        return self

+
+
[docs]    def translate(self, arg):
+        """ Translate this PWL function by a number.
+        This method creates a new PWL function instance for which all breakpoints have been moved
+        along the horizontal axis by the amount specified by `arg`.
+
+        Args:
+            arg: The number that is used to translate all breakpoints.
+
+        Returns:
+            The translated PWL function.
+        """
+        if is_number(arg):
+            return PwlFunction(self.model, self.pwl_def.translate(arg))
+        else:
+            raise DOcplexException("Invalid type for argument: {0!s}.".format(arg))

+
+
[docs]    def evaluate(self, x_val):
+        """ Evaluates the PWL function at the point whose x-coordinate is `x_val`.
+
+        Args:
+            x_val: The x value for which we want to compute the value of the function.
+
+        Returns:
+            The value of the PWL function at point `x_val`.
+            A DOcplexException exception is raised when evaluating at a discontinuity of the PWL function.
+        """
+        return self._pwl_def_as_breaks.evaluate(x_val)

+
+
[docs]    def plot(self, lx=None, rx=None, k=1, **kwargs):  # pragma: no cover
+        """
+        This method displays the piecewise linear function using the matplotlib package, if found.
+
+        :param lx: The value to show the `preslope` (must be before the first breakpoint x value).
+        :param rx: The value to show the `postslope` (must be after the last breakpoint x value).
+        :param k: Scaling factor to calculate default values for `rx` and/or `lx` if these arguments are not provided,
+                based on mean interval length between the `x` values of breakpoints.
+        :param kwargs: additional arguments to be passed to matplotlib plot() function
+        """
+        try:
+            import matplotlib.pyplot as plt
+        except ImportError:
+            raise DOcplexException('matplotlib is required for plot()')
+        bks = self.pwl_def_as_breaks.breaksxy
+        xs = [bk[0] for bk in bks]
+        ys = [bk[1] for bk in bks]
+        # compute mean delta_x
+        first_x = xs[0]
+        last_x = xs[-1]
+        nb_intervals = self._pwl_def_as_breaks.get_nb_intervals()
+        # k times the mean interval length is used for left/right extra points
+        kdx_m = k * (last_x - first_x) / float(nb_intervals) if nb_intervals > 0 else 1
+
+        if lx is None:
+            lx = first_x - kdx_m
+        ly = ys[0] - self.pwl_def_as_breaks.preslope * (first_x - lx)
+        xs.insert(0, lx)
+        ys.insert(0, ly)
+
+        if rx is None or rx <= last_x:
+            rx = last_x + kdx_m
+        ry = ys[-1] + self.pwl_def_as_breaks.postslope * (rx - last_x)
+        xs.append(rx)
+        ys.append(ry)
+
+        if plt:
+            plt.plot(xs, ys, **kwargs)
+            if self.name:
+                plt.title('pwl: {0}'.format(self.name))
+            plt.show()

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/quad.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/quad.html new file mode 100644 index 0000000..6f61047 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/quad.html @@ -0,0 +1,906 @@ + + + + + + + + + docplex.mp.quad — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.quad

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+from docplex.mp.constants import UpdateEvent
+from docplex.mp.basic import _SubscriptionMixin
+from docplex.mp.linear import Expr, ZeroExpr
+from docplex.mp.operand import LinearOperand
+from docplex.mp.utils import *
+from docplex.mp.xcounter import update_dict_from_item_value
+from docplex.mp.sttck import StaticTypeChecker
+
+
+def _compare_vars(v1, v2):
+    v1i = v1._index
+    v2i = v2._index
+    return (v1i > v2i) - (v2i > v1i)
+
+
+class VarPair(object):
+    __slots__ = ("first", "second", "_cached_hash")
+
+    def __init__(self, v1, v2=None):
+        if v2 is None:
+            self.first = v1
+            self.second = v1
+        else:
+            if _compare_vars(v1, v2) <= 0:
+                self.first = v1
+                self.second = v2
+            else:
+                self.first = v2
+                self.second = v1
+        self._cached_hash = self._hash_pair()
+
+    def is_square(self):
+        return self.first is self.second
+
+    def __eq__(self, other):
+        # INTERNAL: necessary for use as dict keys
+        # VarPair ensures variables are sorted by indices
+        return isinstance(other, VarPair) and (self.first is other.first) and (self.second is other.second)
+
+    def _hash_pair(self):
+        f = hash(self.first)
+        s = hash(self.second)
+        # cantor encoding. must cast to int() for py3
+        self_hash = int(((f + s) * (s + f + 1) / 2) + s)
+        if self_hash == -1:
+            # value -1 is reserved for errors
+            self_hash = -2  # pragma: no cover
+        return self_hash
+
+    def __hash__(self):
+        return self._cached_hash
+
+    def __repr__(self):
+        return "docplex.mp.quad.VarPair(first={0!s},second={1!s})".format(self.first, self.second)
+
+    def __str__(self):
+        return "VarPair({0!s}, {1!s})".format(self.first, self.second)
+
+    def __getitem__(self, item):
+        if 0 == item:
+            return self.first
+        elif 1 == item:
+            return self.second
+        else:
+            raise StopIteration
+
+    def index_tuple(self):
+        return self.first._index, self.second._index
+
+
+
[docs]class QuadExpr(_SubscriptionMixin, Expr):
+    """QuadExpr()
+
+    This class models quadratic expressions.
+    This class is not intended to be instantiated. Quadratic expressions are built
+    either by using operators or by using :func:`docplex.mp.model.Model.quad_expr`.
+
+    """
+    def _new_term_dict(self):
+        return self._model._lfactory.term_dict_type()
+
+    def copy(self, target_model, var_mapping):
+        copied_quads = self._quadterms.__class__()
+        for qv1, qv2, qk in self.iter_quad_triplets():
+            new_v1 = var_mapping[qv1]
+            new_v2 = var_mapping[qv2]
+            copied_quads[VarPair(new_v1, new_v2)] = qk
+
+        copied_linear = self._linexpr.copy(target_model, var_mapping)
+        return QuadExpr(model=target_model,
+                        quads=copied_quads,
+                        linexpr=copied_linear,
+                        safe=True)
+
+    def relaxed_copy(self, relaxed_model, var_map):
+        raise DocplexLinearRelaxationError(self, cause='quadratic')
+
+
[docs]    def is_quad_expr(self):
+        return True

+
+
[docs]    def has_quadratic_term(self):
+        """ Returns true if there is at least one quadratic term in the expression.
+        """
+        return any(qk for _, qk in self.iter_quads())

+
+    def square(self):
+        if self.has_quadratic_term():
+            self.fatal("Cannot take the square of a quadratic term: {0!s}".format(self))
+        else:
+            return self._linexpr.square()
+
+    def _raw_solution_value(self, s=None):
+        # INTERNAL
+        quad_value = 0
+        for qv0, qv1, qk in self.iter_quad_triplets():
+            quad_value += qk * (qv0._raw_solution_value(s) * qv1._raw_solution_value(s))
+        lin_value = self._linexpr._raw_solution_value(s)
+        return quad_value + lin_value
+
+    __slots__ = ('_quadterms', '_linexpr', '_transient', '_subscribers')
+
+    def __init__(self, model, quads=None, linexpr=None, safe=False):
+        Expr.__init__(self, model)
+        self._transient = False
+        self._subscribers = []  # used by subscription mixin
+        if quads is None:
+            self._quadterms = self._new_term_dict()
+        elif isinstance(quads, dict):
+            if safe:
+                self._quadterms = quads
+            else:
+                # check
+                safe_quads = self._new_term_dict()
+                for qvp, qk in quads.items():
+                    model._typecheck_num(qk)
+                    if not isinstance(qvp, VarPair):
+                        self.fatal("Expecting variable-pair, got: {0!r}", qvp)
+                    else:
+                        safe_quads[qvp] = qk
+                self._quadterms = safe_quads
+
+        elif isinstance(quads, tuple):
+            try:
+                v1, v2, qk = quads
+                if not safe:
+                    model._typecheck_var(v1)
+                    model._typecheck_var(v2)
+                    model._typecheck_num(qk, 'QuadExpr')
+                self._quadterms = model._lfactory._new_term_dict()
+                self._quadterms[VarPair(v1, v2)] = qk
+
+            except ValueError:  # pragma: no cover
+                self.fatal("QuadExpr accepts tuples of len: 3, got: {0!r}", quads)
+
+        elif is_iterable(quads):
+            qterms = model._lfactory.term_dict_type()
+            for qv1, qv2, qk in quads:
+                qterms[VarPair(qv1, qv2)] = qk
+            self._quadterms = qterms
+        else:
+            self.fatal("unexpected argument for QuadExpr: {0!r}", quads)  # pragma: no cover
+
+        if quads is not None:
+            self._model._quad_count += 1
+
+        if linexpr is None:
+            self._linexpr = model._lfactory.linear_expr()
+        else:
+            self._linexpr = model._lfactory._to_linear_expr(linexpr)
+
+    def clone_if_necessary(self):
+        #  INTERNAL
+        if self._transient and not self._model._keep_all_exprs and not self.is_in_use():
+            return self
+        else:
+            return self.clone()
+
+    def keep(self):
+        self._transient = False
+
+
[docs]    def clone(self):
+        """ Makes a copy of the quadratic expression and returns it.
+
+        Returns:
+            A quadratic expression.
+        """
+        cloned_linear = self._linexpr.clone()
+        new_quad = QuadExpr(self.model, quads=self._quadterms.copy(),
+                            linexpr=cloned_linear,
+                            safe=True)
+        return new_quad

+
+    def is_discrete(self):
+        for qv0, qv1, qk in self.iter_quad_triplets():
+            if not qv0.is_discrete or not qv1.is_discrete() or not is_int(qk):
+                return False
+        return self._linexpr.is_discrete()
+
+    def _generate_quad_triplets(self):
+        # INTERNAL
+        # a generator that returns triplets (i.e. tuples of len 3)
+        # with the variable pair and the coefficient
+        for qvp, qk in self.iter_quads():
+            yield qvp[0], qvp[1], qk
+
+    def iter_quads(self):
+        return iter(self._quadterms.items())
+
+    def iter_sorted_quads(self):
+        if self._model.keep_ordering:
+            return self.iter_quads()
+        else:
+            return self._iter_sorted_quads()
+
+    def _iter_sorted_quads(self):
+        quadterms = self._quadterms
+        for vp in sorted(quadterms.keys(), key=lambda vvp: vvp.index_tuple()):
+            yield vp, quadterms[vp]
+
+    def iter_opposite_ordered_quads(self):
+        # INTERNAL
+        for qv, qk in self.iter_sorted_quads():
+            yield qv, -qk
+
+
[docs]    def iter_quad_triplets(self):
+        """ Iterates over quadratic terms.
+
+        This iterator returns triplets of the form `v1,v2,k`, where `v1` and `v2` are decision
+        variables and `k` is a number.
+
+        Returns:
+            An iterator object.
+        """
+        return self._generate_quad_triplets()

+
+
[docs]    def iter_terms(self):
+        """ Iterates over the linear terms in the quadratic expression.
+
+        Equivalent to self.linear_part.iter_terms()
+
+        Returns:
+            An iterator over the (variable, coefficient) pairs in the linear part of the expression.
+
+        Example:
+            Calling this method on (x^2 +2x+1) will return one pair (x, 2).
+
+        See Also:
+            :func:`docplex.mp.linear.LinearExpr.iter_terms`
+        """
+        return self._linexpr.iter_terms()

+
+    @property
+    def number_of_quadratic_terms(self):
+        """ This property returns the number of quadratic terms.
+
+        Counts both the square and product terms.
+
+        Examples:
+        
+        .. code-block:: python
+
+           q1 = x**2
+           q1.number_of_quadratic_terms
+           >>> 1
+           q2 = (x+y+1)**2
+           q2.number_of_quadratic_terms
+           >>> 3
+        """
+        return len(self._quadterms)
+
+    @property
+    def size(self):
+        return self.number_of_quadratic_terms + self._linexpr.size
+
+
[docs]    def is_separable(self):
+        """ Checks if all quadratic terms are separable.
+
+        Returns:
+            True if all quadratic terms are separable.
+        """
+        return all(qv.is_square() for qv, _ in self.iter_quads())

+
+    def compute_separable_convexity(self, sense=1):
+        # INTERNAL
+        # returns 1 if separable, convex
+        # returns -1 if separable non convex
+        # return s0 if non separable
+
+        justifier = None
+        for qv, qk in self.iter_quads():
+            if not qv.is_square():
+                return 0, None  # non separable: fast exit
+            elif qk * sense < 0:
+                if justifier is None:
+                    justifier = (qk, qv[0])  # separable, non convex, kept
+        else:
+            return justifier or (1, None)  # (1, None) is for separable, convex
+
+
[docs]    def get_quadratic_coefficient(self, var1, var2=None):
+        ''' Returns the coefficient of a quadratic term in the expression.
+
+        Returns the coefficient of the quadratic term `var1*var2` in the expression, if any.
+        If the product is not present in the expression, returns 0.
+
+        Args:
+            var1: The first variable of the product (an instance of class Var)
+            var2: the second variable of the product. If passed None, returns the coefficient
+                of the square of `var1` in the expression.
+
+        Example:
+            Assuming `x` and `y` are decision variables and `q` is the expression `2*x**2 + 3*x*y + 5*y**2`, then
+
+            `q.get_quadratic_coefficient(x)` returns 2
+
+            `q.get_quadratic_coefficient(x, y)` returns 3
+
+            `q.get_quadratic_coefficient(y)` returns 5
+
+        Returns:
+            The coefficient of one quadratic product term in the expression.
+        '''
+        self.model._typecheck_var(var1)
+        if var2 is None:
+            var2 = var1
+        else:
+            self.model._typecheck_var(var2)
+        return self._get_quadratic_coefficient(var1, var2)

+
+    def _get_quadratic_coefficient(self, var1, var2):
+        # INTERNAL, no checks
+        vp = VarPair(var1, var2 or var1)
+        return self._get_quadratic_coefficient_from_var_pair(vp)
+
+    def _get_quadratic_coefficient_from_var_pair(self, vp):
+        # INTERNAL
+        return self._quadterms.get(vp, 0)
+
+    def set_quadratic_coefficient(self, var1, var2, k):
+        self.model._typecheck_var(var1)
+        if var2 is None:
+            var2 = var1
+        else:
+            self.model._typecheck_var(var2)
+        self._set_quadratic_coefficient(var1, var2, k)
+
+    def _set_quadratic_coefficient_internal(self, var1, var2, k):
+        vp = VarPair(var1, var2 or var1)
+        self_quadterms = self._quadterms
+        if not k:
+            if vp in self_quadterms:
+                del self_quadterms[vp]
+                return True
+            else:
+                return False
+        else:
+            self_quadterms[vp] = k
+            return True
+
+    def _set_quadratic_coefficient(self, var1, var2, k):
+        if self._set_quadratic_coefficient_internal(var1, var2, k):
+            self.notify_modified(event=UpdateEvent.QuadExprGlobal)
+
+    def _set_quadratic_coefficients(self, var_coef_seq):
+        nb_changes = 0
+        for (var1, var2), k in var_coef_seq:
+            if self._set_quadratic_coefficient_internal(var1, var2, k):
+                nb_changes += 1
+        if nb_changes:
+            self.notify_modified(event=UpdateEvent.QuadExprGlobal)
+
+    # ---
+    def equals(self, other):
+        if not isinstance(other, QuadExpr):
+            return False
+        if self.number_of_quadratic_terms != other.number_of_quadratic_terms:
+            return False
+
+        for qvp, qk in self.iter_quads():
+            if other._get_quadratic_coefficient_from_var_pair(qvp) != qk:
+                return False
+        return self._linexpr.equals(other._linexpr)
+
+    def is_constant(self):
+        return not self.has_quadratic_term() and self._linexpr.is_constant()
+
+    def get_constant(self):
+        return self._linexpr.constant
+
+    def set_constant(self, num):
+        linexpr = self._linexpr
+        event = None
+        if num != linexpr.get_constant():
+            linexpr._constant = num
+            event = UpdateEvent.ExprConstant
+        self.notify_modified(event)
+
+    @property
+    def constant(self):
+        """This property is used to get or set the constant part of a quadratic expression
+        """
+        return self.get_constant()
+
+    @constant.setter
+    def constant(self, new_cst):
+        self.set_constant(new_cst)
+
+    @property
+    def linear_part(self):
+        """ This property returns the linear part of a quadratic expression.
+
+        For example, the linear part of x^2 +2x+1 is (2x+1)
+
+        :return: an instance of :class:`docplex.mp.LinearExpr`
+        """
+        return self.get_linear_part()
+
+    def get_linear_part(self):
+        linexpr = self._linexpr
+        return linexpr if linexpr else 0
+
+    def iter_variables(self):
+        for qvp, _ in self.iter_quads():
+            if qvp.is_square():
+                yield qvp[0]
+            else:
+                yield qvp[0]
+                yield qvp[1]
+        linexpr = self._linexpr
+        for lv in linexpr.iter_variables():
+            yield lv
+
+    def _quad_variable_set(self):
+        # INTERNAL
+        setof_qvars = set()
+        for qvp, _ in self.iter_quads():
+            setof_qvars.add(qvp[0])
+            if not qvp.is_square():
+                setof_qvars.add(qvp[1])
+        return setof_qvars
+
+    def iter_quad_variables(self):
+        # iterates on quadratic variables,
+        # returns each variable only once
+        # order is irrelevant.
+        setof_qvars = self._quad_variable_set()
+        return iter(setof_qvars)
+
+    iter_quad_vars = iter_quad_variables
+
+    def __contains__(self, dvar):
+        return self.contains_var(dvar)
+
+
[docs]    def contains_var(self, dvar):
+        # required by tests...
+        for qv in self.iter_variables():
+            if qv is dvar:
+                return True
+        else:
+            return False

+
+    def __iter__(self):
+        # INTERNAL: this is necessary to prevent expr from being an iterable.
+        # as it follows getitem protocol, it can mistakenly be interpreted as an iterable
+        # but this would make sum loop forever.
+        raise TypeError  # pragma: no cover
+
+    def contains_quad(self, qv):
+        # INTERNAL
+        return qv in self._quadterms
+
+    def __repr__(self):
+        return "docplex.mp.quad.QuadExpr(%s)" % self.repr_str()
+
+    def to_stringio(self, oss, nb_digits, use_space, var_namer=lambda v: v.lp_name):
+        q = 0
+        # noinspection PyPep8Naming
+        SP = u' '
+        for qvp, qk in self.iter_sorted_quads():
+            if not qk:
+                continue
+            qv1 = qvp.first
+            qv2 = qvp.second
+            # ---
+            # sign is printed if  non-first OR negative
+            # at the end of this block coeff is positive
+            if q > 0 and use_space:
+                oss.write(SP)
+            if qk < 0 or q > 0:
+                oss.write(u'-' if qk < 0 else u'+')
+                if qk < 0:
+                    qk = -qk
+                if use_space and q > 0:
+                    oss.write(SP)
+
+            # write coeff if <> 1
+            varname1 = var_namer(qv1)
+            if 1 != qk:
+                self._num_to_stringio(oss, num=qk, ndigits=nb_digits)
+                if use_space:
+                    oss.write(SP)
+
+            oss.write(str(varname1))
+            if qv1 is qv2:
+                oss.write(u"^2")
+            else:
+                if use_space:
+                    oss.write(SP)
+                    oss.write(u'*')
+                    oss.write(SP)
+                else:
+                    oss.write(u'*')
+                oss.write(str(var_namer(qv2)))
+            q += 1
+        # problem for linexpr: force '+' ssi c>0
+        linexpr = self._linexpr
+        lin_constant = linexpr.get_constant()
+        if linexpr:
+            first_lk = 0
+            for lv, lk in linexpr.iter_terms():
+                if lk:
+                    first_lk = lk
+                    break
+            if q > 0 and first_lk > 0:
+                if use_space:
+                    oss.write(u' ')
+                oss.write(u"+")
+
+            if first_lk:
+                if use_space:
+                    oss.write(SP)
+                self._linexpr.to_stringio(oss, nb_digits, use_space, var_namer)
+
+            elif lin_constant:
+                self._num_to_stringio(oss, lin_constant, nb_digits, print_sign=True, force_plus=q > 0,
+                                      use_space=use_space)
+            elif not q:
+                oss.write(u'0')
+
+    def plus(self, other):
+        cloned = self.clone_if_necessary()
+        cloned.add(other)
+        return cloned
+
+    def minus(self, other):
+        cloned = self.clone_if_necessary()
+        cloned.subtract(other)
+        return cloned
+
+    def rminus(self, other):
+        # other - self
+        cloned = self.clone()
+        cloned.negate()
+        cloned.add(other)
+        return cloned
+
+    def times(self, other):
+        if is_number(other) and 0 == other:
+            return self.zero_expr()
+
+        elif isinstance(other, ZeroExpr):
+            return other
+
+        elif self.is_constant():
+            k = self.constant
+            if not k:
+                return self.zero_expr()
+            elif 1 == k:
+                return self._model._lfactory._to_linear_expr(other)
+            else:
+                return other * k
+        else:
+            cloned = self.clone()
+            cloned.multiply(other)
+            return cloned
+
+    def __add__(self, other):
+        return self.plus(other)
+
+    def __iadd__(self, other):
+        self.add(other)
+        return self
+
+    def __radd__(self, other):
+        return self.plus(other)
+
+    def __sub__(self, other):
+        return self.minus(other)
+
+    def __rsub__(self, other):
+        # e - self
+        return self.rsubtract(other)
+
+    def __isub__(self, other):
+        self.subtract(other)
+        return self
+
+    def __mul__(self, other):
+        return self.times(other)
+
+    def __rmul__(self, other):
+        return self.times(other)
+
+    def __imul__(self, other):
+        # self is modified
+        return self.multiply(other)
+
+    def __div__(self, e):
+        return self.quotient(e)
+
+    def __idiv__(self, other):
+        self.divide(other, check=True)
+        return self
+
+    def __truediv__(self, e):
+        return self.quotient(e)  # pragma: no cover
+
+    def __itruediv__(self, other):
+        # this is for Python 3.z
+        return self.divide(other)  # pragma: no cover
+
+    def __neg__(self):
+        cloned = self.clone()
+        cloned.negate()
+        return cloned
+
+    def add(self, other):
+        # increment the QuadExpr with some other argument
+        if isinstance(other, QuadExpr):
+            event = self._add_quad(other)
+        else:
+            self._linexpr.add(other)
+            event = UpdateEvent.LinExprGlobal
+        self.notify_modified(event=event)
+
+    def rsubtract(self, other):
+        # to compute (other - self) we copy self, negate the copy and add other
+        # result is always cloned even if other is zero (optimization possible here)
+        cloned = self.clone()
+        cloned.negate()
+        cloned.add(other)
+        return cloned
+
+    def subtract(self, other):
+        if isinstance(other, QuadExpr):
+            self._subtract_quad(other)
+            event = UpdateEvent.QuadExprGlobal
+        else:
+            self._linexpr.subtract(other)
+            event = UpdateEvent.LinExprGlobal
+        self.notify_modified(event=event)
+        return self
+
+    def negate(self):
+        # INTERNAL: negate sall coefficients, modify self
+        qterms = self._quadterms
+        for qvp, qk in qterms.items():
+            qterms[qvp] = -qk
+        self._linexpr.negate()
+        self.notify_modified(event=UpdateEvent.QuadExprGlobal)
+        return self
+
+    def multiply(self, other):
+        event = UpdateEvent.QuadExprGlobal
+        if is_number(other):
+            self._scale(other)
+
+        elif self.is_constant():
+            this_constant = self._linexpr.get_constant()
+            if 0 == this_constant:
+                # do nothing
+                event = None
+            else:
+                self._assign_scaled(other, this_constant)
+
+        elif self.has_quadratic_term():
+            if other.is_constant():
+                return self.multiply(other.get_constant())
+            else:
+                StaticTypeChecker.mul_quad_lin_error(self.model, self, other)
+
+        else:
+            # self is actually a linear expression
+            if is_quad_expr(other):
+                if other.has_quadratic_term():
+                    StaticTypeChecker.mul_quad_lin_error(self.model, self, other)
+                else:
+                    return self.multiply(other._linexpr)
+            else:
+                other_linexpr = other.to_linear_expr()
+                self_linexpr = self._linexpr
+                for v1, k1 in self_linexpr.iter_terms():
+                    for v2, k2 in other_linexpr.iter_terms():
+                        self._add_one_quad_term(VarPair(v1, v2), k1 * k2)
+                other_cst = other.get_constant()
+                self_cst = self_linexpr.get_constant()
+                if other_cst:
+                    self_linexpr._scale(other_cst)
+                if self_cst:
+                    for ov, ok in other.iter_terms():
+                        self_linexpr._add_term(ov, ok * self_cst)
+        self.notify_modified(event)
+        return self
+
+    def quotient(self, e):
+        self.model._typecheck_as_denominator(e, self)
+        cloned = self.clone()
+        cloned.divide(e, check=False)
+        return cloned
+
+    def divide(self, other, check=True):
+        if check:
+            self.model._typecheck_as_denominator(other, self)  # only a nonzero number is allowed...
+        inverse = 1.0 / other
+        self._scale(inverse)
+        self.notify_modified(event=UpdateEvent.QuadExprGlobal)
+        return self
+
+    def _scale(self, factor):
+        # INTERNAL: scales a quad expr from a numeric constant.
+        # no checks done!
+        # this method modifies self.
+        if 0 == factor:
+            self.clear()
+        elif 1 == factor:
+            # nothing to do
+            pass
+        else:
+            # scale quads
+            self_quadterms = self._quadterms
+            for qv, qk in self.iter_quads():
+                self_quadterms[qv] = factor * qk
+            # scale linear part
+            if self._linexpr is not None:
+                self._linexpr._scale(factor)
+
+    def _assign_scaled(self, other, factor):
+        # INTERNAL
+        if isinstance(other, LinearOperand):
+            scaled = self._model._lfactory._to_linear_expr(other, force_clone=True)
+            scaled *= factor
+            self._linexpr = scaled
+        elif isinstance(other, QuadExpr):
+            for qv, qk in other.iter_quads():
+                self._add_one_quad_term(qv, qk * factor)
+            self._assign_scaled(other.linear_part, factor)
+        else:
+            pass
+
+    def _add_one_quad_term(self, qv, qk):
+        qterms = self._quadterms
+        if qk or qv in qterms:
+            qterms[qv] = qterms.get(qv, 0) + qk
+
+    def normalize(self):  # pragma: no cover
+        # INTERNAL
+        quadterms = self._quadterms
+        if quadterms:
+            to_remove = [qvp for qvp, qk in self.iter_quads() if not qk]
+            for rvp in to_remove:
+                del quadterms[rvp]
+        self._linexpr.normalize()
+
+    def clear(self):
+        self._quadterms.clear()
+        self._linexpr._clear()
+
+    # quad-specific
+    def _add_quad(self, other_quad):
+        # add quad part
+        for oqv, oqk in other_quad.iter_quads():
+            self._add_one_quad_term(oqv, oqk)
+        # add linear part
+        if other_quad._linexpr.is_zero():
+            return UpdateEvent.QuadExprQuadCoef
+        else:
+            self._linexpr.add(other_quad._linexpr)
+            return UpdateEvent.QuadExprGlobal
+
+    def _subtract_quad(self, other_quad):
+        # subtract quad
+        quadterms = self._quadterms
+        for oqv, oqk in other_quad.iter_quads():
+            update_dict_from_item_value(quadterms, oqv, -oqk)
+        # subtract linear part
+        self._linexpr.subtract(other_quad._linexpr)
+
+    def to_linear_expr(self, msg=None):  # pragma: no cover
+        # used_msg = msg or "Quadratic expression [{0!s}] cannot be converted to a linear expression"
+        # self.fatal(used_msg, self)
+        raise DocplexQuadToLinearException(self)
+
+    def is_normalized(self):  # pragma: no cover
+        # INTERNAL
+        for _, qk in self.iter_quads():
+            if not qk:
+                return False  # pragma: no cover
+        else:
+            return True
+
+    # --- relational operators
+    def __eq__(self, other):
+        return self._model._qfactory.new_eq_constraint(self, other)
+
+    def __le__(self, other):
+        return self._model._qfactory.new_le_constraint(self, other)
+
+    def __ge__(self, other):
+        return self._model._qfactory.new_ge_constraint(self, other)
+
+    def __ne__(self, other):
+        self.model.fatal("Operator `!=` is not supported for quadratic expressions, {0!s} was passed", self)
+
+    def notify_expr_modified(self, expr, event):
+        if expr is self._linexpr:
+            # something to do..
+            self.notify_modified(event, )

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/relax_linear.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/relax_linear.html new file mode 100644 index 0000000..dad6091 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/relax_linear.html @@ -0,0 +1,278 @@ + + + + + + + + + docplex.mp.relax_linear — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.relax_linear

+# returns a relaxed model from a given model
+
+from docplex.mp.utils import DocplexLinearRelaxationError
+
+from collections import defaultdict
+
+
+
[docs]class LinearRelaxer(object):
+    """ This class returns a linear relaxation for a MIP model.
+
+    """
+
+    def __init__(self):
+        self._unrelaxables = defaultdict(list)
+
+    def iter_unrelaxables(self):
+        return self._unrelaxables.items()
+
+    def main_cause(self):
+        unrelaxables = self._unrelaxables
+        max_urx = -1
+        justifier = None
+        main_cause = None
+        for cause, urxs in unrelaxables.items():
+            if len(urxs) > max_urx:
+                max_urx = len(urxs)
+                main_cause = cause
+                justifier = urxs[0]
+        return main_cause, justifier
+
+    @staticmethod
+    def make_relaxed_model(mdl, return_partial=False, **kwargs):
+        lrx = LinearRelaxer()
+        return lrx.linear_relaxation(mdl, return_partial=return_partial, **kwargs)
+
+
[docs]    def linear_relaxation(self, mdl, return_partial=False, **kwargs):
+        """ Returns a continuous relaxation of the model.
+
+        Variable types are set to continuous (note that semi-xxx variables have their LB set to zero)
+
+        Some constructs are not relaxable, for example, piecewise-linear expressions, SOS sets,
+        logical constraints...
+        When a model contains at least one of these non-relaxable constructs, a message is printed
+        and this method returns None.
+
+        By default, model parameters are not copied. If you want to copy them, pass the
+        keyword argument `copy_parameters=True`
+
+        :param mdl: the initial model
+        :param return_partial: if True, returns the partially relaxed model anyway, default is False,
+            if an unrelaxable item is encountered, None is returned
+
+        :return: a new model with continuous relaxation, if possible, else None.
+        """
+
+        relax_name = kwargs.get('relaxed_name', None)
+        verbose = kwargs.get('verbose', True)
+        copy_parameters = kwargs.get('copy_parameters', False)
+        # relax sos by default
+        relax_sos = kwargs.get('relax_sos', True)
+
+        model_name = mdl.name
+
+        def info(msg):
+            if verbose:
+                print("* relaxation of model {0}: {1}".format(model_name, msg))
+
+        mdl_class = mdl.__class__
+        unrelaxables = defaultdict(list)
+
+        def process_unrelaxable(urx_, reason):
+            unrelaxables[reason or 'unknown'].append(urx_)
+
+        relax_model_name = relax_name or "lp_%s" % mdl.name
+        relaxed_model = mdl_class(name=relax_model_name)
+
+        # transfer kwargs
+        relaxed_model._parse_kwargs(mdl._get_kwargs())
+
+        # transfer variable containers
+        ctn_map = {}
+        for ctn in mdl.iter_var_containers():
+            copied_ctn = ctn.copy_relaxed(relaxed_model)
+            ctn_map[ctn] = copied_ctn
+
+        # transfer variables
+        var_mapping = {}
+        continuous = relaxed_model.continuous_vartype
+        for v in mdl.iter_variables():
+            cpx_code = v.cplex_typecode
+            if not v.is_generated() or cpx_code == 'C':
+                # if v has type semixxx, set lB to 0
+                if cpx_code in {'N', 'S'}:
+                    rx_lb = 0
+                else:
+                    rx_lb = v.lb
+                copied_var = relaxed_model._var(continuous, rx_lb, v.ub, v.name)
+                var_ctn = v.container
+                if var_ctn:
+                    copied_ctn = ctn_map.get(var_ctn)
+                    assert copied_ctn is not None
+                    copied_var.container = copied_ctn
+                var_mapping[v] = copied_var
+
+        # transfer all non-logical cts
+        for ct in mdl.iter_constraints():
+            if not ct.is_generated():
+                if ct.is_logical():
+                    process_unrelaxable(ct, 'logical')
+                try:
+                    copied_ct = ct.relaxed_copy(relaxed_model, var_mapping)
+                    relaxed_model.add(copied_ct)
+                except DocplexLinearRelaxationError as xe:
+                    process_unrelaxable(xe.object, xe.cause)
+                except KeyError as ke:
+                    info('failed to relax constraint: {0}'.format(ct))
+                    process_unrelaxable(ct, 'key')
+
+        # clone objective
+        relaxed_model.objective_sense = mdl.objective_sense
+        try:
+            relaxed_model.objective_expr = mdl.objective_expr.relaxed_copy(relaxed_model, var_mapping)
+        except DocplexLinearRelaxationError as xe:
+            process_unrelaxable(urx_=xe.object, reason=xe.cause)
+        except KeyError:
+            process_unrelaxable(urx_=mdl.objective_expr, reason='objective')
+
+        # clone kpis
+        for kpi in mdl.iter_kpis():
+            relaxed_model.add_kpi(kpi.copy(relaxed_model, var_mapping))
+
+        if mdl.context:
+            relaxed_model.context = mdl.context.copy()
+
+        if copy_parameters:
+            # copy parameters is not the default behavior
+            # by default, the relaxed copy has a clean, default, parameter set.
+            # if verbose:
+            #     info("copying initial model parameters to relaxed model")
+            nb_copied = 0
+            for p1, p2 in zip(mdl.parameters.generate_params(), relaxed_model.parameters.generate_params()):
+                if p1.is_nondefault():
+                    p2.set(p1.get())
+                    nb_copied += 1
+            if verbose:
+                info("copied {0} initial model parameters to relaxed model".format(nb_copied))
+
+        #
+        if relax_sos:
+            for sos in mdl.iter_sos():
+                # list of mapped variables for original sos
+                sos_vars = [var_mapping[dv1] for dv1 in sos.iter_variables()]
+                sos_type = sos.sos_type
+                sos_ctname = f"relaxed_sos{sos_type.value}#{sos.index+1}"
+                relaxed_model.add(relaxed_model.sum_vars(sos_vars) <= sos_type.value, sos_ctname)
+        else:
+            for sos in mdl.iter_sos():
+                unrelaxables['sos'].append(sos)
+
+        self._unrelaxables = unrelaxables
+        if unrelaxables:
+            nb_unrelaxables = len(unrelaxables)
+            main_cause, justifier = self.main_cause()
+
+            if verbose and not return_partial:
+                print("* model {0}: found {1} un-relaxable elements, main cause is {2} (e.g. {3})"
+                      .format(mdl.name, nb_unrelaxables, main_cause, justifier))
+            if verbose:
+                for cause, urxs in unrelaxables.items():
+                    print('* reason: {0}: {1} unrelaxables'.format(cause, len(urxs)))
+                    for u, urx in enumerate(urxs):
+                        if hasattr(urx, "is_generated") and urx.is_generated():
+                            s_gen = " [generated]"
+                        else:
+                            s_gen = ""
+                        print('--  {0}: cannot be relaxed: {1!s}{2}'.format(u + 1, urx, s_gen))
+            if return_partial:
+                if verbose:
+                    print(f"-- returning partially relaxed model")
+                return relaxed_model
+            else:
+                return None
+        else:
+            # force cplex if any...
+            cpx = relaxed_model.get_cplex(do_raise=False)
+            if cpx:
+                # force type to LP
+                cpx.set_problem_type(0)  # 0 is code for LP.
+            # sanity  check...
+            assert not relaxed_model._contains_discrete_artefacts()
+            assert not relaxed_model._solved_as_mip()
+            # ---
+            return relaxed_model

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/relaxer.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/relaxer.html new file mode 100644 index 0000000..db9c586 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/relaxer.html @@ -0,0 +1,756 @@ + + + + + + + + + docplex.mp.relaxer — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.relaxer

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from collections import defaultdict, namedtuple
+from docplex.mp.constants import RelaxationMode
+
+from docplex.mp.utils import is_function, apply_thread_limitations, _to_list
+from docplex.mp.priority import Priority
+from docplex.mp.constr import AbstractConstraint
+from docplex.mp.error_handler import docplex_fatal
+from docplex.mp.sdetails import SolveDetails
+
+from docplex.util import as_df
+from docplex.mp.publish import PublishResultAsDf
+
+try:
+    import pandas as pd
+except ImportError:  # pragma: no cover
+    pd = None
+
+TOutputTables = namedtuple('TOutputTables', ['Constraint', 'Priority', 'Amount'])
+
+
+def to_output_table(relaxer, use_pd=True):
+    if pd and use_pd:
+        return as_df(relaxer)
+    else:
+        result = []
+        prioritizer = relaxer.prioritizer
+        for ct, relaxed in relaxer.iter_relaxations():
+            result.append(TOutputTables(ct.name,
+                                        prioritizer.get_priority_internal(ct).name,
+                                        relaxed))
+        return result
+
+
+# noinspection PyAbstractClass
+
[docs]class Prioritizer(object):
+    ''' Abstract base class for prioritizers.
+        This class acts like a functor to be called on each model constraint.
+    '''
+
+    def __init__(self, override=False):
+        self._override = override
+
+    def get_priority(self, ct):
+        raise NotImplementedError("base class")  # pragma: no cover
+
+    def get_priority_internal(self, ct):
+        ct_prio = ct.priority
+        if not self._override and ct_prio:
+            return ct_prio
+        else:
+            return self.get_priority(ct)

+
+
+class IRelaxationListener(object):
+    # INTERNAL
+    # ''' Base class for relaxation listeners.'''
+
+    def notify_start_relaxation(self, priority, relaxables):
+        ''' This method is called at each step of the relaxation loop.'''
+        pass  # pragma: no cover
+
+    def notify_failed_relaxation(self, priority, relaxables):
+        ''' This method is called when a relaxation attempt fails.'''
+        pass  # pragma: no cover
+
+    def notify_successful_relaxation(self, priority, relaxables, relaxed_obj_value, violations):
+        ''' This method is called when a relaxation succeeds.'''
+        pass  # pragma: no cover
+
+
+class VerboseRelaxationListener(IRelaxationListener):
+    # INTERNAL
+    # ''' A default implementation of the listener, which prints messages.'''
+
+    def __init__(self):
+        IRelaxationListener.__init__(self)
+        self.relaxation_count = 0
+
+    def notify_start_relaxation(self, priority, relaxables):
+        self.relaxation_count += 1
+        print("-> relaxation #{0} starts with priority: {1!s}, #relaxables={2:d}"
+              .format(self.relaxation_count, priority.name, len(relaxables)))
+
+    def notify_failed_relaxation(self, priority, relaxables):
+        print("<- relaxation #{0} fails, priority: {1!s}, #relaxables={2:d}"
+              .format(self.relaxation_count, priority.name, len(relaxables)))
+
+    def notify_successful_relaxation(self, priority, relaxables, obj, violations):
+        print("<- relaxation #{0} succeeds: priority: {1!s}, #relaxables={2:d}, obj={3}, #relaxations={4}".
+              format(self.relaxation_count, priority.name, len(relaxables), obj, len(violations)))
+
+
+
[docs]class NamedPrioritizer(Prioritizer):
+    # INTERNAL
+    # """ Basic prioritizer that relaxes any constraint with a name.
+    #
+    #     More precisely, the prioritizer logic works as follows:
+    #
+    #         - If the constraint has a ``priority`` attribute, then it is assumed
+    #           to hold a priority instance and use it.
+    #         - If the constraint has a user-defined name, relax it with MEDIUM priority.
+    #         - Otherwise, the constraint is not to be relaxed (that is, it is assigned MANDATORY priority).
+    #
+    # """
+
+    def __init__(self, priority=Priority.MEDIUM, override=False):
+        Prioritizer.__init__(self, override)
+        self._priority = priority
+
+    def get_priority(self, ct):
+        return self._priority if ct.has_user_name() else Priority.MANDATORY

+
+
+
[docs]class UniformPrioritizer(Prioritizer):
+    # INTERNAL
+    # """ Constraint prioritizer that relaxes all constraints.
+    #
+    #     This prioritizer assigns MEDIUM priority to all constraints
+    #     unless an explicit priority has been set by the user.
+    #
+    # """
+
+    def __init__(self, priority=Priority.MEDIUM, override=False):
+        Prioritizer.__init__(self, override)
+        self._priority = priority
+
+    def get_priority(self, ct):
+        return self._priority

+
+
+
[docs]class MatchNamePrioritizer(Prioritizer):
+    # INTERNAL
+    # """ Constraint prioritizer based on constraint names.
+    #
+    #     This prioritizer analyzes constraint names for strings that match priority names.
+    #     If a constraint contains a string which matches a priority name,
+    #     then it is assigned this priority.
+    #
+    #     If a constraint has a priority explicitly set by the ``priority`` attribute,
+    #     this user priority is returned.
+    #
+    #     Note:
+    #         1. Unnamed constraints are considered as non-matches.
+    #         2. String matching is not case sensitive.
+    #
+    #     For example: a constraint named "ct_salary_low" will be considered as having the priority LOW.
+    # """
+
+    def __init__(self,
+                 priority_for_unnamed=Priority.MANDATORY,
+                 priority_for_non_matches=Priority.MANDATORY,
+                 case_sensitive=False,
+                 override=False):
+        Prioritizer.__init__(self, override)
+        assert isinstance(priority_for_unnamed, Priority)
+        assert isinstance(priority_for_non_matches, Priority)
+
+        self.priority_for_unnamed_cts = priority_for_unnamed
+        self.priority_for_non_matching_cts = priority_for_non_matches
+        self.priority_by_symbol = {prio.name.lower(): prio for prio in Priority}
+        self._is_case_sensitive = bool(case_sensitive)
+
+
[docs]    def get_priority(self, ct):
+        ''' Looks for known priority names inside constraint names.
+        '''
+
+        if not ct.has_user_name():
+            return self.priority_for_unnamed_cts
+        else:
+            ctname = ct.name
+            ctname_to_match = ctname if self._is_case_sensitive else ctname.lower()
+            best_matched = 0
+            best_matching_priority = self.priority_for_non_matching_cts
+            for (prio_symbol, prio) in self.priority_by_symbol.items():
+                if ctname_to_match.find(prio_symbol) >= 0:
+                    matched = len(prio_symbol)
+                    # longer matches are preferred
+                    # e.g. very_low and low both match in very_low_ctxxx
+                    # but the prioritizer will return very_low as the match is longer.
+                    if matched > best_matched:
+                        best_matched = matched
+                        best_matching_priority = prio
+            return best_matching_priority

+
+
+
[docs]class MappingPrioritizer(Prioritizer):
+    # INTERNAL
+    # """
+    # Constraint prioritizer based on a dictionary of constraints and priorities.
+    #
+    # Initialized from a dictionary and an optional default priority.
+    #
+    # Args:
+    #     priority_mapping: A dictionary with constraints as keys and priorities as values.
+    #
+    #     default_priority: An optional priority, used when a constraint is not explicitly mentioned
+    #         in the mapping. The default value is MANDATORY, meaning that any constraint not mentioned
+    #         in the mapping will not be relaxed.
+    # """
+
+    def __init__(self, priority_mapping, default_priority=Priority.MANDATORY, override=False):
+        Prioritizer.__init__(self, override)
+        # --- typecheck that this dict is a a {ct: prio} mapping.
+        if not isinstance(priority_mapping, dict):
+            raise TypeError
+        for k, v in priority_mapping.items():
+            if not isinstance(k, AbstractConstraint):
+                raise TypeError
+
+            if not hasattr(v, 'cplex_preference'):
+                raise TypeError
+        # ---
+        self._mapping = priority_mapping
+        self._default_priority = default_priority
+
+    def get_priority(self, ct):
+        # return the dict's value for ct if nay, else its own priority or the default.
+        return self._mapping.get(ct, ct.priority or self._default_priority)

+
+
+
[docs]class FunctionalPrioritizer(Prioritizer):
+    def __init__(self, fn, override=False):
+        Prioritizer.__init__(self, override)
+        self._prioritize_fn = fn
+
+    def get_priority(self, ct):
+        return self._prioritize_fn(ct)

+
+
+# internal named tuples
+_TRelaxableGroup = namedtuple("_TRelaxableGroup", ["preference", "relaxables"])
+_TParamData = namedtuple('_TParamInfo', ['short_name', 'default_value', 'accessor'])
+
+
+
[docs]class Relaxer(PublishResultAsDf, object):
+    ''' This class is an abstract algorithm, in the sense that it operates on interfaces.
+
+        It takes a prioritizer, which an implementation of ``ConstraintPrioritizer``.
+        For convenience, predefined prioritizer types are accessible  through names:
+
+            - `all` relaxes all constraints using a MEDIUM priority; this is the default.
+            - `named` relaxes all constraints with a user name but not the others.
+            - `match` looks for priority names within constraint names;
+              unnamed constraints are not relaxed.
+
+
+        Note:
+            All predefined prioritizers apply various forms of logic, but, when a constraint has been assigned
+            a priority by the user, this priority is always used. For example, the `named` prioritizer relaxes
+            all named constraints with MEDIUM, but if an unnamed constraint was assigned a HIGH priority,
+            then HIGH will be used.
+
+        See Also:
+           :class:`docplex.mp.priority.Priority`
+
+    '''
+    default_precision = 1e-5
+
+    _default_mode = RelaxationMode.OptSum
+
+    def __init__(self, prioritizer='all', verbose=False, precision=default_precision,
+                 override=False, **kwargs):
+        self.output_table_customizer = kwargs.get('output_processing')  # docplex_wml tables, internal
+        self.output_table_property_name = 'relaxations_output'
+        self.default_output_table_name = 'relaxations.csv'
+        self.output_table_using_df = True  # if pandas is available of course
+
+        self._precision = precision
+        # ---
+        if hasattr(prioritizer, 'get_priority'):
+            self._prioritizer = prioritizer
+        elif prioritizer == 'match':
+            self._prioritizer = MatchNamePrioritizer(override=override)
+        elif isinstance(prioritizer, dict):
+            self._prioritizer = MappingPrioritizer(priority_mapping=prioritizer, override=override)
+        elif prioritizer == 'named':
+            self._prioritizer = NamedPrioritizer()
+        elif prioritizer is None or prioritizer == 'all':
+            self._prioritizer = UniformPrioritizer(override=override)
+        elif is_function(prioritizer):
+            self._prioritizer = FunctionalPrioritizer(prioritizer, override=override)
+        else:
+            print("Cannot deduce a prioritizer from: {0!r} - expecting \"name\"|\"default\"| dict", prioritizer)
+            raise TypeError
+
+        self._cumulative = True
+        self._listeners = []
+
+        # result data
+        self._last_relaxation_status = False
+        self._last_relaxation_objective = -1e+75
+        self._last_successful_relaxed_priority = Priority.MANDATORY
+        self._last_relaxation_details = SolveDetails.make_dummy()
+        self._relaxations = {}
+        self._verbose = verbose
+        self._verbose_listener = VerboseRelaxationListener()
+
+        if self._verbose:
+            self.add_listener(self._verbose_listener)
+
+    @property
+    def prioritizer(self):
+        return self._prioritizer
+
+    def set_verbose(self, is_verbose):
+        if is_verbose != self._verbose:
+            self._verbose = is_verbose
+            self.set_verbose_listener_from_flag(is_verbose)
+
+    def set_verbose_listener_from_flag(self, is_verbose):
+        if is_verbose:
+            self.add_listener(self._verbose_listener)
+        else:
+            self.remove_listener(self._verbose_listener)
+
+    def get_verbose(self):
+        return self._verbose
+
+    verbose = property(get_verbose, set_verbose)
+
+    def _check_successful_relaxation(self):
+        if not self._last_relaxation_status:
+            docplex_fatal("No relaxed solution is present")
+
+    def _reset(self):
+        # INTERNAL
+        self._last_relaxation_status = False
+        self._last_relaxation_objective = -1e+75
+        self._last_successful_relaxed_priority = Priority.MANDATORY
+        self._relaxations = {}
+
+    def _accept_violation(self, violation):
+        ''' The filter method which accepts or rejects a violation.'''
+        return 0 == self._precision or abs(violation) >= self._precision
+
+    def add_listener(self, listener):
+        # INTERNAL
+        # """ Adds a relaxation listener.
+        #
+        # Args:
+        #     listener: The new listener to add. If ``listener`` is not an
+        #        instance of ``IRelaxationListener``, it is ignored.
+        #
+        # See Also:
+        #     :class:`IRelaxationListener`
+        # """
+        if isinstance(listener, IRelaxationListener):
+            self._listeners.append(listener)
+
+    def remove_listener(self, listener):
+        # INTERNAL
+        # """ Removes a relaxation listener.
+        #
+        # Args:
+        #     listener: The listener to remove.
+        # """
+        if listener in self._listeners:
+            self._listeners.remove(listener)
+
+    def clear_listeners(self):
+        # INTERNAL
+        # """ Removes all relaxation listeners.
+        # """
+        self._listeners = []
+
+    _param_data = {}
+
+
[docs]    def relax(self, mdl, relax_mode=None, **kwargs):
+        """ Runs the relaxation loop.
+
+        Args:
+            mdl: The model to be relaxed.
+            relax_mode: the relaxation mode. Accept either None (in which case the default mode is
+                used, or an instance of ``RelaxationMode`` enumerated type, or a string
+                that can be translated to a relaxation mode.
+            kwargs: Accepts named arguments similar to ``solve``.
+
+        Returns:
+            If the relaxation succeeds, the method returns a solution object, an instance of ``SolveSolution``; otherwise returns None.
+
+        See Also:
+            :func:`docplex.mp.model.Model.solve`,
+            :class:`docplex.mp.solution.SolveSolution`,
+            :class:`docplex.mp.constants.RelaxationMode`
+
+        """
+        self._reset()
+
+        # 1. build a dir {priority : cts}
+        priority_map = defaultdict(list)
+        nb_prioritized_cts = 0
+        mdl_priorities = set()
+        mandatory_justifier = None
+        nb_mandatories = 0
+        for ct in mdl.iter_constraints():
+            prio = self._prioritizer.get_priority_internal(ct)
+            if prio.is_mandatory():
+                nb_mandatories += 1
+                if mandatory_justifier is None:
+                    mandatory_justifier = ct
+            else:
+                priority_map[prio].append(ct)
+                nb_prioritized_cts += 1
+                mdl_priorities.add(prio)
+
+        sorted_priorities = sorted(list(mdl_priorities), key=lambda p: p.value)
+
+        if 0 == nb_prioritized_cts:
+            mdl.error("Relaxation algorithm found no relaxable constraints - exiting")
+            return None
+        if nb_mandatories:
+            assert mandatory_justifier is not None
+            s_justifier = mandatory_justifier.to_readable_string()
+            mdl.warning('{0} constraint(s) will not be relaxed (e.g.: {1})', nb_mandatories, s_justifier)
+
+        temp_relax_verbose = kwargs.pop('verbose', False)
+        if temp_relax_verbose != self._verbose:
+            # install/deinstall listener for this relaxation only
+            self.set_verbose_listener_from_flag(temp_relax_verbose)
+
+        # relaxation loop
+        all_groups = []
+        all_relaxable_cts = []
+        is_cumulative = self._cumulative
+        # -- relaxation mode
+        if relax_mode is None:
+            used_relax_mode = self._default_mode
+        else:
+            used_relax_mode = RelaxationMode.parse(relax_mode)
+        if not mdl.is_optimized():
+            used_relax_mode = RelaxationMode.get_no_optimization_mode(used_relax_mode)
+
+        # save this for restore later
+        saved_context_log_output = mdl.context.solver.log_output
+        saved_log_output_stream = mdl.log_output
+        saved_context = mdl.context
+
+        # take into account local argument overrides
+        relax_context = mdl.prepare_actual_context(**kwargs)
+
+        transient_engine = False
+        relax_engine = mdl.get_engine()
+
+        if temp_relax_verbose:
+            print("-- starting relaxation. mode: {0!s}, precision={1}".format(used_relax_mode.name, self._precision))
+
+        try:
+            # mdl.context has been saved in saved_context above
+            mdl.context = relax_context
+            mdl.set_log_output(mdl.context.solver.log_output)
+
+            # engine parameters, if needed to
+            parameters = apply_thread_limitations(relax_context)
+
+            mdl._apply_parameters_to_engine(parameters)
+
+            relaxed_sol = None
+            for prio in sorted_priorities:
+                if prio in priority_map:
+                    cts = priority_map[prio]
+                    if not cts:
+                        # this should not happen...
+                        continue  # pragma: no cover
+
+                    pref = prio.cplex_preference
+                    # build a new group
+                    relax_group = _TRelaxableGroup(pref, cts)
+
+                    # relaxing new batch of cts:
+                    if not is_cumulative:  # pragma: no cover
+                        # if not cumulative reset the groupset
+                        all_groups = [relax_group]
+                        all_relaxable_cts = cts
+                    else:
+                        all_groups.append(relax_group)
+                        all_relaxable_cts += cts
+
+                    # at this stage we have a sequence of groups
+                    # a group is itself a sequence of two components
+                    # - a preference factor
+                    # - a sequence of constraints
+                    for ls in self._listeners:
+                        ls.notify_start_relaxation(prio, all_relaxable_cts)
+
+                    # ----
+                    # call the engine.
+                    # ---
+
+                    try:
+                        relaxed_sol = relax_engine.solve_relaxed(mdl, prio.name, all_groups, used_relax_mode)
+                    finally:
+                        self._last_relaxation_details = relax_engine.get_solve_details()
+                    # ---
+
+                    if relaxed_sol is not None:
+                        relax_obj = relaxed_sol.objective_value
+                        self._last_successful_relaxed_priority = prio
+                        self._last_relaxation_status = True
+                        self._last_relaxation_objective = relaxed_sol.objective_value
+
+                        # filter irrelevant relaxations below some threshold
+                        for ct in all_relaxable_cts:
+                            raw_infeas = relaxed_sol.get_infeasibility(ct)
+                            if self._accept_violation(raw_infeas):
+                                self._relaxations[ct] = raw_infeas
+                        if not self._relaxations:
+                            mdl.warning(
+                                "Relaxation of model `{0}` found one relaxed solution, but no relaxed constraints - check".format(
+                                    mdl.name))
+
+                        for ls in self._listeners:
+                            ls.notify_successful_relaxation(prio, all_relaxable_cts, relax_obj, self._relaxations)
+                        # now get out
+                        break
+                    else:
+                        # TODO: maybe issue a warning that relaxation has failed?
+                        # relaxation has failed, notify the listeners
+                        for ls in self._listeners:
+                            ls.notify_failed_relaxation(prio, all_relaxable_cts)
+
+            mdl.notify_solve_relaxed(relaxed_sol, relax_engine.get_solve_details())
+
+            # write relaxation table.write_output_table() handles everything related to
+            # whether the table should be published etc...
+            if self.is_publishing_output_table(mdl.context):
+                output_table = to_output_table(self, self.output_table_using_df)
+                self.write_output_table(output_table, mdl.context)
+        finally:
+            # --- restore context, log_output if set.
+            if saved_log_output_stream != mdl.log_output:
+                mdl.set_log_output_as_stream(saved_log_output_stream)
+            if saved_context_log_output != mdl.context.solver.log_output:
+                mdl.context.solver.log_output = saved_context_log_output
+            mdl.context = saved_context
+            if transient_engine:  # pragma: no cover
+                del relax_engine
+            if temp_relax_verbose != self._verbose:
+                # realign listener with flag
+                self.set_verbose_listener_from_flag(self._verbose)
+
+        return relaxed_sol

+
+
[docs]    def iter_relaxations(self):
+        """ Iterates on relaxations.
+
+        Relaxations are built as a dictionary with constraints as keys and numeric violations as values,
+        so this iterator returns ``(ct, violation)`` pairs.
+        """
+        self._check_successful_relaxation()
+        return iter(self._relaxations.items())

+
+
[docs]    def relaxations(self):
+        """  Returns a dictionary with all relaxed constraints.
+
+        Returns:
+           A dictionary where the keys are the relaxed constraints,
+          and the values are the numerical slacks.
+
+        """
+        return self._relaxations.copy()

+
+    def __as_df__(self):
+        ''' Returns a pandas.DataFrame with all relaxed constraint.
+
+        Returns:
+           A pandas.DataFrame which columns are:
+
+              - Constraint: the constraint name
+              - Priority: The priority of the constraint
+              - Amount: The amount of relaxation
+        '''
+        if not pd:  # pragma: no cover
+            raise NotImplementedError('Cannot convert results to DataFrame, pandas is not available')
+        columns = ['Constraint', 'Priority', 'Amount']
+        results_list = []
+        prioritizer = self.prioritizer
+        for ct, relaxed in self.iter_relaxations():
+            results_list.append({'Constraint': ct.name,
+                                 'Priority': prioritizer.get_priority_internal(ct).name,
+                                 'Amount': relaxed})
+        df = pd.DataFrame(results_list, columns=columns)
+        return df
+
+    def get_total_relaxation(self):
+        self._check_successful_relaxation()
+        return sum(abs(v) for v in self._relaxations.values())
+
+    @property
+    def total_relaxation(self):
+        return self.get_total_relaxation()
+
+    def print_information(self):
+        self._check_successful_relaxation()
+        print("* number of relaxations: {0}".format(len(self._relaxations)))
+        for rct, relaxation in self.iter_relaxations():
+            arg = rct.name if rct.has_user_name() else str(rct)
+            print(" - relaxed: {0}, with relaxation: {1}".format(arg, relaxation))
+        print("* total absolute relaxation: {0}".format(self.get_total_relaxation()))
+
+    def as_dict(self):
+        rxd = {rct.name or str(rct): relaxed for rct, relaxed in self.iter_relaxations()}
+        return rxd
+
+    @property
+    def relaxed_objective_value(self):
+        """  Returns the objective value of the relaxed solution.
+
+        Raises:
+            DOCplexException
+                If the relaxation has not been successful.
+        """
+        self._check_successful_relaxation()
+        return self._last_relaxation_objective
+
+    @property
+    def number_of_relaxations(self):
+        """ This property returns the number of relaxations found.
+        """
+        return len(self._relaxations)
+
+
[docs]    def get_relaxation(self, ct):
+        """ Returns the infeasibility computed for this constraint.
+
+        Args:
+            ct: A constraint.
+
+        Returns:
+            The amount by which the constraint has been relaxed by the relaxer.
+            The method returns 0 if the constraint has not been relaxed.
+        """
+        self._check_successful_relaxation()
+        return self._relaxations.get(ct, 0)

+
+
[docs]    def is_relaxed(self, ct):
+        ''' Returns true if the constraint ``ct`` has been relaxed
+
+        Args:
+            ct: The constraint to check.
+
+        Returns:
+            True if the constraint has been relaxed, else False.
+        '''
+        self._check_successful_relaxation()
+        return ct in self._relaxations

+
+    @classmethod
+    def run_feasopt(cls, model, relaxables, relax_mode):
+        relaxable_list = _to_list(relaxables)
+        groups = []
+        checker = model._checker
+        try:
+            for pref, ctseq in relaxable_list:
+                checker.typecheck_num(pref)
+                cts = _to_list(ctseq)
+                for ct in cts:
+                    checker.typecheck_constraint(ct)
+                groups.append((pref, cts))
+        except ValueError:
+            model.fatal("expecting container with (preference, constraints), got: {0!s}", relaxable_list)
+
+        feasible = model.get_engine().solve_relaxed(mdl=model, relaxable_groups=groups,
+                                                    prio_name='feasopt',
+                                                    relax_mode=relax_mode)
+        return feasible

+
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/sdetails.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/sdetails.html new file mode 100644 index 0000000..bd00d70 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/sdetails.html @@ -0,0 +1,388 @@ + + + + + + + + + docplex.mp.sdetails — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.sdetails

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+from io import StringIO
+from docplex.mp.utils import is_almost_equal
+from docplex.mp.constants import int_probtype_to_string
+from math import isnan
+
+
+
[docs]class SolveDetails(object):
+    """
+    The :class:`SolveDetails` class contains the details of a solve.
+
+    This class should never be instantiated. You get an instance of this class from
+    the model by calling the property :data:`docplex.mp.model.Model.solve_details`.
+    """
+
+    _unknown_label = "*unknown*"
+
+    NOT_A_NUM = float('nan')
+
+    _NO_GAP = NOT_A_NUM  # value used when no gap is available
+    _NO_BEST_BOUND = NOT_A_NUM
+
+    def __init__(self, time=0, dettime=0,
+                 status_code=-1, status_string=None,
+                 problem_type=None,
+                 ncolumns=0, nonzeros=0,
+                 miprelgap=None,
+                 best_bound=None,
+                 n_iterations=0,
+                 n_nodes_processed=0):
+        self._time = max(time, 0)
+        self._dettime = max(dettime, 0)
+        self._solve_status_code = status_code
+        self._solve_status = status_string or self._unknown_label
+        self._problem_type = problem_type or self._unknown_label  # string
+        self._ncolumns = ncolumns
+        self._linear_nonzeros = nonzeros
+        # --
+        self._miprelgap = self._NO_GAP if miprelgap is None else miprelgap
+        self._best_bound = self._NO_BEST_BOUND if best_bound is None else best_bound
+        # -- progress
+        self._n_iterations = n_iterations
+        self._n_nodes_processed = n_nodes_processed
+
+        self._quality_metrics = {}
+
+    def equals(self, other, relative=1e-3, absolute=1e-5, compare_times=True):
+        if not isinstance(other, SolveDetails):
+            return False
+
+        if compare_times and not is_almost_equal(self.time, other.time, relative, absolute):
+            return False
+        elif self.status_code != other.status_code:
+            return False
+        elif self.problem_type != other.problem_type:
+            return False
+        elif self.columns != other.columns:
+            return False
+        elif self.nb_linear_nonzeros != other.nb_linear_nonzeros:
+            return False
+        elif not is_almost_equal(self.mip_relative_gap, other.mip_relative_gap, relative, absolute):
+            return False
+
+        else:
+            return True
+
+    def as_worker_dict(self):
+        # INTERNAL
+        # Converts the solve details to a dictionary for python worker...
+        # using "legacy' keys from drop-solve
+        worker_dict = {"MODEL_DETAIL_TYPE": self._problem_type,
+                       "MODEL_DETAIL_NONZEROS": self._linear_nonzeros
+                       }
+        if not isnan(self._miprelgap):
+            worker_dict["PROGRESS_GAP"] = self._miprelgap
+        if not isnan(self._best_bound):
+            worker_dict['PROGRESS_BEST_OBJECTIVE'] = self._best_bound
+        return worker_dict
+
+    @staticmethod
+    def to_plain_str(arg_s):
+        return arg_s  # in py3 do nothing.
+
+    # ---
+    # list of fields to be retrieved from the details
+    # as tuples: (<detail_attribute_name>, <json_attribute_name>, <type_conversion_fn>, <default_value>)
+    # example:
+    # _time denotes solve time, a float value, default is 0, to be found in json["cplex.time"]
+    # ---
+    _json_fields = (("_time", "cplex.time", float, 0),
+                    ("_solve_status_code", "cplex.status", int, -1),
+                    ("_solve_status", "cplex.statusstring", lambda s: SolveDetails.to_plain_str(s), ""),
+                    ("_problem_type", "cplex.problemtype", lambda p: int_probtype_to_string(p), ""),
+                    ("_ncolumns", "cplex.columns", int, 0),
+                    ("_linear_nonzeros", "MODEL_DETAIL_NON_ZEROS", int, 0),
+                    ("_miprelgap", "cplex.miprelgap", float, _NO_GAP),
+                    ('_best_bound', 'PROGRESS_BEST_OBJECTIVE', float, _NO_BEST_BOUND),
+                    ('_n_iterations', 'cplex.itcount', int, 0),
+                    ('_n_nodes_processed', 'cplex.nodes.processed', int, 0)
+                    )
+
+    @staticmethod
+    def from_json(json_details, all_json_fields=_json_fields):
+        if not json_details:
+            return SolveDetails.make_dummy()
+
+        # for k,v in json_details.items():
+        # print("{0}: {1!s}".format(k, v))
+        # print("# -------------------------")
+        details = SolveDetails()
+        for attr_name, field_name, field_conv_fn, field_default in all_json_fields:
+            field_val = json_details.get(field_name, field_default)
+            if field_conv_fn is not None:
+                field_val = field_conv_fn(field_val)  # conversion
+            setattr(details, attr_name, field_val)
+
+        return details
+
+    @staticmethod
+    def make_dummy():
+        dummy_details = SolveDetails(status_string="dummy")
+        return dummy_details
+
+    @staticmethod
+    def make_fake_details(time, feasible):
+        if feasible:
+            status_code = 1
+            status = "OPTIMAL"
+        else:
+            status_code = 3
+            status = "infeasible"
+        details = SolveDetails(time=time,
+                               status_code=status_code, status_string=status,
+                               problem_type=None)
+        return details
+
+    @property
+    def time(self):
+        """ This property returns the solve time in seconds.
+
+        """
+        return self._time
+
+    @property
+    def status_code(self):
+        """
+        This property returns the CPLEX status code as a number.
+        Possible values for the status code are described in the CPLEX documentation
+        at:
+        https://www.ibm.com/support/knowledgecenter/SSSA5P_20.1.0/ilog.odms.cplex.help/refcallablelibrary/macros/Solution_status_codes.html
+
+        :return: an integer number (a CPLEX status code)
+
+        """
+        return self._solve_status_code
+
+    @property
+    def status(self):
+        """ This property returns the solve status as a string.
+
+        This string is normally the value returned by the CPLEX callable library method
+        CPXXgetstatstring,
+        see https://www.ibm.com/support/knowledgecenter/SSSA5P_20.1.0/ilog.odms.cplex.help/refcallablelibrary/cpxapi/getstatstring.html
+
+        Example:
+            * Returns "optimal" when the solution has been proven optimal.
+            * Returns "feasible" for a feasible, but not optimal, solution.
+            * Returns "MIP_time_limit_feasible" for a MIP solution obtained before a time limit.
+
+        Note:
+            In certain cases, status may return a string that is not directly passed from CPLEX
+
+                * If an exception occurs during the CPLEX solve phase, status contains the text of the exception.
+                * If solve fails because of a promotional version limitation, the following message is returned
+                    "Promotional version. Problem size limits exceeded., CPLEX code=1016."
+                    The corresponding status  code is 1016.
+
+        """
+        return self._solve_status
+
+    @property
+    def problem_type(self):
+        """  This property returns the problem type as a string.
+
+        """
+        return self._problem_type
+
+    @property
+    def columns(self):
+        """  This property returns the number of columns.
+        """
+        return self._ncolumns
+
+    @property
+    def nb_linear_nonzeros(self):
+        """ This property returns the number of linear non-zeros in the matrix solved.
+
+        """
+        return self._linear_nonzeros
+
+    @property
+    def mip_relative_gap(self):
+        """ This property returns the MIP relative gap.
+
+        Note:
+            * This property returns NaN when the problem is not a MIP.
+            * This property returns 1e+20 for multi-objective MIP problems.
+            * The gap is returned as a floating-point value, not as a percentage.
+        """
+        return self._miprelgap
+
+    gap = mip_relative_gap
+
+    @property
+    def best_bound(self):
+        """ This property returns the MIP best bound at the end of the solve.
+
+        Note:
+            * This property returns NaN when the problem is not a MIP.
+            * This property returns 1e+20 for multi-objective MIP problems.
+        """
+        return self._best_bound
+
+    @property
+    def nb_iterations(self):
+        """ This property returns the number of iterations at the end of the solve.
+
+        Note:
+            - The nature of the iterations depend on the algorithm usd to solve the model.
+            - For multi-objective models, this property returns a tuple of numbers,
+                one for each objective solved.
+
+        """
+        return self._n_iterations
+
+    @property
+    def nb_nodes_processed(self):
+        """ This property returns the number of nodes processed at the end of solve.
+
+        Note: for multi-objective problems, this property returns a tuple of numbers,
+            one for each objective solved.
+
+        """
+        return self._n_nodes_processed
+
+    @property
+    def dettime(self):
+        """ This property returns the solve deterministic time in ticks.
+
+        """
+        return self._dettime
+
+    deterministic_time = dettime
+
+    def __repr__(self):
+        return "docplex.mp.SolveDetails(time={0:g},status={1!r})" \
+            .format(self._time, self._solve_status)
+
+    def print_information(self):
+        print("status  = {0}".format(self._solve_status))
+        print("time    = {0:g} s.".format(self._time))
+        print("problem = {0}".format(self._problem_type))
+        print("columns = {0:d}".format(self._ncolumns))
+        print("iterations={0:d}".format(self._n_iterations))
+        # print("nonzeros= {0}".format(self._linear_nonzeros))
+        if self._miprelgap >= 0:
+            print("gap     = {0:g}%".format(100 * self._miprelgap))
+
+    def to_string(self):
+        oss = StringIO()
+        oss.write("status  = {0}\n".format(self._solve_status))
+        oss.write("time    = {0:g} s.\n".format(self._time))
+        oss.write("problem = {0}\n".format(self._problem_type))
+        if self._miprelgap >= 0:
+            oss.write("gap     = {0:g}%\n".format(100.0 * self._miprelgap))
+        return oss.getvalue()
+
+    def __str__(self):
+        return self.to_string()
+
+    _limit_statuses = frozenset({10, 11, 12, 21, 22, 25}.union([i for i in range(33,38)]).union([39]).union([i for i in range(104,109)]).union({111, 112, 128, 131, 132, 306}))
+
+
[docs]    def has_hit_limit(self):
+        """
+        Checks if the solve details indicate that the solve has hit a limit.
+
+        Returns:
+          Boolean: True if the solve details indicate that the solve has hit a limit.
+
+        """
+        return self._solve_status_code in self._limit_statuses

+
+    def notify_hit_limit(self, logger):
+        if self.has_hit_limit():
+            logger.info("solve: {0}".format(self.status))
+
+    @property
+    def quality_metrics(self):
+        return self._quality_metrics

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/solution.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/solution.html new file mode 100644 index 0000000..9457730 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/solution.html @@ -0,0 +1,1562 @@ + + + + + + + + + docplex.mp.solution — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.solution

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+import sys
+import copy
+
+try:
+    from cplex._internal._subinterfaces import CutType
+except:
+    CutType = list
+
+try:  # pragma: no cover
+    from itertools import zip_longest as izip_longest
+except ImportError:  # pragma: no cover
+    # noinspection PyUnresolvedReferences
+    from itertools import izip_longest
+
+from io import StringIO
+from docplex.mp.constants import CplexScope, BasisStatus, WriteLevel
+from docplex.mp.utils import is_iterable, is_number, is_string, is_indexable, str_maxed, normalize_basename
+from docplex.mp.utils import make_output_path2, _var_match_function
+from docplex.mp.dvar import Var
+from docplex.mp.error_handler import docplex_fatal, handle_error
+
+from docplex.mp.solmst import SolutionMSTPrinter
+from docplex.mp.soljson import SolutionJSONPrinter
+from docplex.mp.solsol import SolutionSolPrinter
+
+from collections import defaultdict
+
+
+# noinspection PyAttributeOutsideInit
+
[docs]class SolveSolution(object):
+    """
+    The :class:`SolveSolution` class holds the result of a solve.
+    """
+
+    # a symbolic value for no objective ?
+    NO_OBJECTIVE_VALUE = -1e+75
+
+    @staticmethod
+    def _is_discrete_value(v):
+        return v == int(v)
+
+    def __init__(self, model, var_value_map=None, obj=None, blended_obj_by_priority=None, name=None, solved_by=None,
+                 keep_zeros=True):
+        """ SolveSolution(model, var_value_map, obj, name)
+
+        Creates a new solution object, associated to a a model.
+
+        Args:
+            model: The model to which the solution is associated. This model cannot be changed.
+
+            obj: The value of the objective in the solution. A value of None means the objective is not defined at the
+                time the solution is created, and will be set later.
+
+            blended_obj_by_priority: For multi-objective models: the value of sub-problems' objectives (each sub-problem
+                groups objectives having same priority).
+
+            var_value_map: a Python dictionary containing associations of variables to values.
+
+            name: a name for the solution. The default is None, in which case the solution is named after the
+                model name.
+
+        :return: A solution object.
+        """
+        assert model is not None
+        assert solved_by is None or is_string(solved_by)
+        assert obj is None or is_number(obj) or is_indexable(obj)
+        assert blended_obj_by_priority is None or is_indexable(blended_obj_by_priority)
+
+        self._model = model
+        self._name = name
+        self._problem_objective_expr = model.objective_expr if model.has_objective() else None
+        self._objective = self.NO_OBJECTIVE_VALUE if obj is None else obj
+        self._blended_objective_by_priority = [self.NO_OBJECTIVE_VALUE] if blended_obj_by_priority is None else \
+            blended_obj_by_priority
+        self._solved_by = solved_by
+        self._var_value_map = {}
+
+        # attributes
+        self._sensitivity = {}
+        self._cuts = None
+        self._reduced_costs = None
+        self._dual_values = None
+        self._slack_values = None
+        self._infeasibilities = {}
+        self._basis_statuses = None
+
+        self._solve_status = None
+        self._keep_zeros = keep_zeros
+        self._solve_details = None
+
+        if var_value_map is not None:
+            self._store_var_value_map(var_value_map, keep_zeros=keep_zeros)
+
+    @property
+    def _checker(self):
+        return self._model._checker
+
+    @staticmethod
+    def make_engine_solution(model, var_value_map, obj, blended_obj_by_priority, solved_by, solve_details,
+                             job_solve_status=None):
+        # INTERNAL
+        # noinspection PyArgumentEqualDefault
+        sol = SolveSolution(model,
+                            var_value_map=None,
+                            obj=obj,
+                            blended_obj_by_priority=blended_obj_by_priority,
+                            solved_by=solved_by,
+                            keep_zeros=False)
+        if solve_details is not None:
+            sol._solve_details = copy.copy(solve_details)
+
+        if model.round_solution:
+            # only for models which specify round_solution
+            roundfn = sol._model._round_function
+            for dvar, value in var_value_map.items():
+                if value and dvar.is_discrete() and value != int(value):
+                    var_value_map[dvar] = roundfn(value)
+        # do trust engines...
+        sol._var_value_map = var_value_map
+
+        if job_solve_status is not None:
+            sol._set_solve_status(job_solve_status)
+        return sol
+
+    def _get_var_by_name(self, varname):
+        return self._model.get_var_by_name(varname)
+
+    def as_mip_start(self, write_level=WriteLevel.DiscreteVars, complete_vars=False, eps_zero=1e-6):
+        write_level_ = WriteLevel.parse(write_level)
+        filter_discrete = write_level_.filter_nondiscrete()
+        filter_zeros = write_level_.filter_zeros()
+        mdl = self.model
+        mipstart_dict = {}
+
+        def generate_completed_var_values():
+            for dv_ in mdl.generate_user_variables():
+                yield dv_, self._get_var_value(dv_)
+
+        if not complete_vars:
+            vv_iter = self.iter_var_values()
+        else:
+            vv_iter = generate_completed_var_values()
+        for dv, dvv in vv_iter:
+            if filter_discrete and not dv.is_discrete():
+                continue
+            if filter_zeros and abs(dvv) <= eps_zero:
+                continue
+            mipstart_dict[dv] = dvv
+
+        mipstart = SolveSolution(self.model, name=self.name,
+                                 var_value_map=None,
+                                 obj=self.objective_value,
+                                 solved_by=self.solved_by,
+                                 keep_zeros=True)
+        mipstart._var_value_map = mipstart_dict
+        return mipstart
+
+
[docs]    def clear(self):
+        """ Clears all solve result data.
+
+        All data related to the model are left unchanged.
+        """
+        self._var_value_map = {}
+        self._objective = self.NO_OBJECTIVE_VALUE
+        self._reduced_costs = None
+        self._dual_values = None
+        self._slack_values = None
+        self._infeasibilities = {}
+        self._solve_status = None
+        self._cuts = None
+        self._sensitivity = {}

+
+
[docs]    def is_empty(self):
+        """
+        Checks whether the solution is empty.
+
+        Returns:
+            Boolean: True if the solution is empty; in other words, the solution has no defined objective and no variable value.
+        """
+        return not self.has_objective() and not self._var_value_map

+
+    @property
+    def problem_name(self):
+        return self._model.name
+
+    @property
+    def solved_by(self):
+        '''
+        Returns a string indicating how the solution was produced.
+
+        - If the solution was created by a program, this field returns None.
+        - If the solution originated from a local CPLEX solve, this method returns the string 'cplex_local'.
+        - If the solution originated from a DOcplexcloud solve, this method returns 'cplex_cloud'.
+
+        Returns:
+            A string, or None.
+
+        '''
+        return self._solved_by
+
+    def set_name(self, solution_name):
+        self._checker.typecheck_string(solution_name, accept_empty=False, accept_none=True,
+                                       caller='SolveSolution.set_name(): ')
+        self._name = solution_name
+
+    @property
+    def name(self):
+        """ This property allows to get/set a name on the solution.
+
+        In some cases , it might be interesting to build different solutions for the same model,
+        in this case, use the name property to distinguish them.
+
+        """
+        return self._name
+
+    @name.setter
+    def name(self, sol_name):
+        self.set_name(sol_name)
+
+    def _resolve_var(self, var_key, do_raise):
+        # INTERNAL: accepts either strings or variable objects
+        # returns a variable or None
+        if isinstance(var_key, Var):
+            return var_key
+        elif is_string(var_key):
+            var = self._get_var_by_name(var_key)
+            # var might be None here if the name is unknown
+            if var is not None:
+                return var
+            # var is None hereafter
+            elif do_raise:
+                self.model.fatal("No variable with named {0}", var_key)
+            else:
+                self.model.warning("No variable with named {0}", var_key)
+                return None
+
+        else:  # pragma: no cover
+            self.model.fatal("Expecting variable or name, got: {0!r}", var_key)
+
+    def _typecheck_var_key_value(self, var_key, value, caller):
+        # INTERNAL
+        self._checker.typecheck_num(value, caller=caller)
+        if not is_string(var_key) and not isinstance(var_key, Var):
+            self.model.fatal("{0} expects either Var or string, got: {1!r}", caller, var_key)
+
+
[docs]    def add_var_value(self, var_key, value):
+        """ Adds a new (variable, value) pair to this solution.
+
+        Args:
+            var_key: A decision variable (:class:`docplex.mp.dvar.Var`) or a variable name (string).
+            value (number): The value of the variable in the solution.
+        """
+        self._typecheck_var_key_value(var_key, value, caller="Solution.add_var_value")
+        self._set_var_key_value(var_key, value, keep_zero=self._keep_zeros)

+
+    def __setitem__(self, var_key, value):
+        # always keep zero, no warnings, no checks
+        self._set_var_key_value(var_key, value, keep_zero=self._keep_zeros)
+
+    def set_var_key_value(self, var_key, value, keep_zero):
+        # INTERNAL
+        self._typecheck_var_key_value(var_key, value, caller="Solution.add_var_value")
+        self._set_var_key_value(var_key, value, keep_zero)
+
+    def _set_var_key_value(self, var_key, value, keep_zero):
+        # INTERNAL: no checks done.
+        dvar = self._resolve_var(var_key, do_raise=False)
+        if dvar is not None:
+            if value or keep_zero:
+                # either value is nonzero or we keep all, store.
+                self._set_var_value_internal(dvar, value)
+            elif self.contains(dvar):
+                # value is 0 and we dont keep zeros: zap the variable, if
+                del self._var_value_map[dvar]
+
+    def _set_var_value_internal(self, var, value):
+        self._var_value_map[var] = value
+
+    def _set_var_value(self, var, value):
+        # INTERNAL
+        self._set_var_value_internal(var, value)
+
+
[docs]    def update(self, var_values_iterable):
+        """
+        Updates the solution from a dictionary. Keys can be either strings, interpreted as variable names,
+        or variables; values are the new values for the variable.
+
+        This method returns nothing, only performs a side effect on the solution object.
+
+        :param var_values_iterable: a dictionary of keys, values.
+
+        """
+        keep_zeros = self._keep_zeros
+        for k, v in var_values_iterable.items():
+            self._set_var_key_value(k, v, keep_zeros)

+
+    @property
+    def model(self):
+        """
+        This property returns the model associated with the solution.
+        """
+        return self._model
+
+    @property
+    def solve_details(self):
+        """ This property returns the solve_details associated with the solution,if any.
+
+        Note:
+            This property returns an instance of solve details if the solution is the result
+            of a solve operation. If the solution has been created by API, this property returns None
+
+        See Also:
+            :class:`docplex.mp.sdetails.SolveDetails`
+
+        Returns:
+            an instance of SolveDetails, or None.
+
+        """
+        return self._solve_details
+
+    # @property
+    # def error_handler(self):
+    #     return self.__model.error_handler
+
+
[docs]    def get_objective_value(self):
+        """
+        Gets the objective value (or list of objectives value) as defined in the solution.
+        When the objective value has not been defined, a special value `NO_SOLUTION` is returned.
+        To check whether the objective has been set, use :func:`has_objective`.
+
+        Returns:
+            float or list(float): The value of the objective (or list of values for multi-objective) as defined by
+            the solution.
+        """
+        return self._objective

+
+
[docs]    def set_objective_value(self, obj):
+        """
+        Sets the objective value (or list of values for multi-objective) of the solution.
+        
+        Args:
+            obj (float or list(float)): The value of the objective (or list of values for multi-objective) in
+            the solution.
+        """
+        self._objective = obj

+
+
[docs]    def get_blended_objective_value_by_priority(self):
+        """
+        Gets the blended objective value (or list of blended objectives value) by priority level as defined in
+        the solution.
+        When the objective value has not been defined, a special value `NO_SOLUTION` is returned.
+        To check whether the objective has been set, use :func:`has_objective`.
+
+        Returns:
+            float or list(float): The value of the objective (or list of values for multi-objective) as defined by
+            the solution.
+        """
+        return self._blended_objective_by_priority

+
+    @property
+    def blended_objective_values(self):
+        return self._blended_objective_by_priority
+
+
[docs]    def has_objective(self):
+        """
+        Checks whether or not the objective has been set.
+
+        Returns:
+            Boolean: True if the solution defines an objective value.
+        """
+        return self._objective != self.NO_OBJECTIVE_VALUE

+
+    @property
+    def objective_value(self):
+        """ This property is used to get the objective value of the solution.
+        In case of multi-objective this property returns the value for the first objective
+
+        When the objective value has not been defined, a special value `NO_SOLUTION` is returned.
+        To check whether the objective has been set, use :func:`has_objective`.
+
+        """
+        try:
+            return self._objective[0]
+        except TypeError:
+            return self._objective
+
+    @objective_value.setter
+    def objective_value(self, new_objvalue):
+        self.set_objective_value(new_objvalue)
+
+    @property
+    def multi_objective_values(self):
+        """ This property is used to get the list of objective values of the solution.
+        In case of single objective this property returns the value for the objective as a singleton list
+
+        When the objective value has not been defined, a special value `NO_SOLUTION` is returned.
+        To check whether the objective has been set, use :func:`has_objective`.
+
+        """
+        self_obj = self._objective
+        model = self.model
+        if not isinstance(self_obj, list) and model.has_multi_objective():
+            nbMultiObj = model.number_of_multi_objective_exprs
+            my_multiobj = model._multi_objective
+            return [self.get_value(my_multiobj.exprs[i]) for i in range(nbMultiObj)]
+        return self_obj if is_indexable(self_obj) else [self_obj]
+
+    @property
+    def solve_status(self):
+        return self._solve_status
+
+    def _set_solve_status(self, new_status):
+        # INTERNAL
+        self._solve_status = new_status
+
+    def _store_var_value_map(self, key_value_map, keep_zeros=False):
+        # INTERNAL
+        for e, val in key_value_map.items():
+            # need to check var_keys and values
+            self.set_var_key_value(var_key=e, value=val, keep_zero=keep_zeros)
+
+    def store_infeasibilities(self, infeasibilities):
+        assert isinstance(infeasibilities, dict)
+        self._infeasibilities = infeasibilities
+
+    @staticmethod
+    def _resolve_attribute_index_map(attr_idx_map, obj_mapper):
+        return {obj_mapper(idx): attr_val
+                for idx, attr_val in attr_idx_map.items()
+                if attr_val and obj_mapper(idx) is not None}
+
+    @classmethod
+    def _resolve_attribute_list(cls, attr_list, obj_mapper):
+        # attr list is a list of length N and obj_mapper maps indices to objs
+        return {obj_mapper(idx): attr_val for idx, attr_val in enumerate(attr_list)}
+
+    def store_attribute_lists(self, mdl, slacks):
+        def linct_mapper(idx):
+            return mdl.get_constraint_by_index(idx)
+
+        resolved_linear_slacks = self._resolve_attribute_list(slacks, linct_mapper)
+        self._slack_values = defaultdict(dict)
+        self._slack_values[CplexScope.LINEAR_CT_SCOPE] = resolved_linear_slacks
+
+
[docs]    def iter_var_values(self):
+        """Iterates over the (variable, value) pairs in the solution.
+
+        Returns:
+            iterator: A dict-style iterator which returns a two-component tuple (variable, value)
+            for all variables mentioned in the solution.
+        """
+        return self._var_value_map.items()

+
+
[docs]    def iter_variables(self):
+        """Iterates over all variables mentioned in the solution.
+
+        Returns:
+           iterator: An iterator object over all variables mentioned in the solution.
+        """
+        return self._var_value_map.keys()

+
+
[docs]    def contains(self, dvar):
+        """
+        Checks whether or not a decision variable is mentioned in the solution.
+
+        This predicate can also be used in the form `var in solution`, because the
+        :func:`__contains_` method has been redefined for this purpose.
+
+        Args:
+            dvar (:class:`docplex.mp.dvar.Var`): The variable to check.
+
+        Returns:
+            Boolean: True if the variable is mentioned in the solution.
+        """
+        return dvar in self._var_value_map

+
+    def __contains__(self, dvar):
+        return self.contains(dvar)
+
+
[docs]    def get_value(self, arg):
+        """
+        Gets the value of a variable or an expression in a solution.
+        If the variable is not mentioned in the solution,
+        the method returns 0 and does not raise an exception.
+        Note that this method can also be used as :func:`solution[arg]`
+        because the :func:`__getitem__` method has been overloaded.
+
+        Args:
+            arg: A decision variable (:class:`docplex.mp.dvar.Var`),
+                 a variable name (a string), or an expression.
+
+        Returns:
+            float: The value of the variable in the solution.
+        """
+        if is_string(arg):
+            var = self._get_var_by_name(arg)
+            if var is None:
+                self.model.fatal("No variable with name: {0}", arg)
+            else:
+                return self._get_var_value(var)
+        elif isinstance(arg, Var):
+            return self._get_var_value(arg)
+        else:
+            try:
+                v = arg._raw_solution_value(self)
+                return v
+            except AttributeError:
+                self._model.fatal("Expecting variable, variable name or expression, {0!r} was passed", arg)

+
+    def get_var_value(self, dvar):
+        self._checker.typecheck_var(dvar)
+        return self._get_var_value(dvar)
+
+    def _get_var_value(self, dvar):
+        # INTERNAL
+        return self._var_value_map.get(dvar, 0)
+
+
[docs]    def get_value_list(self, dvars):
+        """
+        Gets the value of a sequence of variables in a solution.
+        If a variable is not mentioned in the solution,
+        the method assumes a 0 value.
+
+        Args:
+            dvars: an ordered sequence of decision variables.
+
+        Returns:
+            list: A list of float values, in the same order as the variable sequence.
+
+        """
+        checker = self._checker
+        checker.check_ordered_sequence(arg=dvars,
+                                       caller='SolveSolution.get_values()')
+        dvar_seq = checker.typecheck_var_seq(dvars)
+        return self._get_values(dvar_seq)

+
+
[docs]    def get_values(self, var_seq):
+        """ Same as get_value_list
+        """
+        return self.get_value_list(var_seq)

+
+    def _get_values(self, dvars):
+        # internal: no checks are done.
+        self_value_map = self._var_value_map
+        return [self_value_map.get(dv, 0) for dv in dvars]
+
+    def _get_all_values(self):
+        # internal: no checks are done.
+        self_value_map = self._var_value_map
+        m = self._model
+        return [self_value_map.get(dv, 0) for dv in m.iter_variables()]
+
+    @staticmethod
+    def _accept_value(value, accept_zeros: bool, precision: float = 1e-6):
+        # INTERNAL
+        if not value:
+            # accepting zero values is controlled by the accept_zeros flag.
+            return accept_zeros
+        else:
+            return abs(value) >= precision
+
+
[docs]    def get_value_dict(self, var_dict, keep_zeros=True, precision=1e-6):
+        """ Converts a dictionary of variables to a dictionary of solutions
+
+        Assuming `var_dict` is a dictionary of variables
+        (for example, as returned by `Model.integer_var_dict()`,
+        returns a dictionary with the same keys and as values the solution values of the
+        variables.
+
+        :param var_dict: a dictionary of decision variables.
+        :param keep_zeros: an optional flag to keep zero values (default is True)
+        :param precision: an optional precision, used to filter small non-zero values.
+             The default is 1e-6.
+
+        :return: A dictionary from variable keys to solution values (floats).
+        """
+        # assume var_dict is a key-> variable dictionary
+
+        assert precision >= 0
+        # if precision -> abs(dvv) >= prec else dvv
+        value_dict = {}
+        for key, dvar in var_dict.items():
+            dvar_value = self._get_var_value(dvar)
+            if self._accept_value(dvar_value, keep_zeros, precision=precision):
+                value_dict[key] = dvar_value
+        return value_dict

+
+
[docs]    def get_value_df(self, var_dict, value_column_name=None, key_column_names=None):
+        """ Returns values of a dicitonary of variables, as a pandas dataframe.
+
+        If pandas is not present, returns a dicitonary of columns.
+
+        :param var_dict: the dicitonary of variables, as created by Model.xx_var_dict
+        :param value_column_name: an optional string to name the value column. Default is 'value'
+        :param key_column_names: an optional list of strings to name th ekeys of the dicitonary.
+            If not present, keys are named 'k1', 'k2', ...
+
+        :return: a pandas DataFrame, if pandas is present.
+        """
+        keys = list(var_dict.keys())
+        values = self.get_values((dv for dv in var_dict.values()))
+        if isinstance(keys[0], tuple):
+            keys = list(zip(*keys))
+            knames = None
+            if key_column_names:
+                if len(key_column_names) == len(keys):
+                    knames = key_column_names
+            if not knames:
+                knames = ['key_%d' % k for k in range(1, len(keys) + 1)]
+            kd = {kn: ks for kn, ks in zip(knames, keys)}
+        else:
+            kn = key_column_names or 'key'
+            kd = {kn: keys}
+        value_col_name = value_column_name or 'value'
+        kd[value_col_name] = values
+        try:
+            import pandas as pd
+            return pd.DataFrame(kd)
+        except ImportError:
+            self.model.warning("pandas module not found, returning a dict instead of DataFrame")
+            return kd

+
+    # def __len__(self):
+    #     return len(self.__var_value_map)
+
+    @property
+    def number_of_var_values(self):
+        """ This property returns the number of variable/value pairs stored in this solution.
+        """
+        return len(self._var_value_map)
+
+    @property
+    def size(self):
+        """ This property returns the number of variable/value pairs stored in this solution.
+        """
+        return len(self._var_value_map)
+
+    def __getitem__(self, arg):
+        return self.get_value(arg)
+
+
[docs]    def get_status(self, ct):
+        """ Returns the status of a linear constraint in the solution.
+
+        Returns 1 if the constraint is satisfied, else returns 0. This is particularly useful when using
+        the status variable of constraints.
+
+        :param ct: A linear constraint
+        :return: a number (1 or 0)
+        """
+        self._checker.typecheck_linear_constraint(ct)
+        return self._get_status(ct)

+
+    def _get_status(self, ct):
+        # INTERNAL
+        ct_status_var = ct._get_status_var()
+        if ct_status_var:
+            return self._var_value_map.get(ct_status_var, 0)
+        elif ct.is_added():
+            # a posted constraint is true if there is a solution
+            return 1
+        else:
+            return 1 if ct.is_satisfied(self) else 0
+
+    def find_unsatisfied_constraints(self, m, tolerance=1e-6):
+        unsats = []
+        for ct in m.iter_constraints():
+            if not ct.is_satisfied(self, tolerance):
+                unsats.append(ct)
+        return unsats
+
+    def number_of_var_diffs(self, other_sol, precision=1e-6, match="auto"):
+        target_model = other_sol.model
+        var_match_fn = _var_match_function(self.model, target_model, match)
+        nb_diffs = 0
+        for dv, dvv in self.iter_var_values():
+            other_dv = var_match_fn(dv, target_model)
+            if other_dv:
+                other_dvv = other_sol[other_dv]
+                if abs(dvv - other_dvv) >= precision:
+                    nb_diffs += 1
+        return nb_diffs
+
+    def restore(self, target_model, abs_tolerance=1e-6, rel_tolerance=1e-4, restore_all=False, match="auto"):
+        # restores the solution in its model, adding ranges.
+        find_matching_var = _var_match_function(self.model, target_model, match)
+        lfactory = target_model._lfactory
+        restore_ranges = []
+        for dvar, val in self.iter_var_values():
+            if not dvar.is_generated() or restore_all:
+                dvar2 = find_matching_var(dvar, target_model)
+                if dvar2 is not None:
+                    rel_prec = abs(val) * rel_tolerance
+                    used_prec = max(abs_tolerance, rel_prec)
+                    rlb = max(dvar2.lb, val - used_prec)
+                    rub = min(dvar2.ub, val + used_prec)
+                    if rlb >= rub + 1e-6:
+                        target_model.fatal("restore solution fails on empty domain, var: {)}, lb={1} > ub={2}",
+                                           dvar2, rlb, rub)
+                    restore_ranges.append(lfactory.new_range_constraint(rlb, dvar2, rub))
+                else:
+                    print("could not find matching var for {0}".format(dvar))
+        target_model.info("restored {0} variable values using range constraints".format(len(restore_ranges)))
+        return target_model.add(restore_ranges)
+
+    def find_invalid_domain_variables(self, m, tolerance=1e-6):
+        invalid_domain_vars = []
+        for dv in m.iter_variables():
+            dvv = self.get_var_value(dv)
+            if not dv.accepts_value(dvv, tolerance=tolerance):
+                invalid_domain_vars.append(dv)
+        return invalid_domain_vars
+
+
[docs]    def is_valid_solution(self, tolerance=1e-6, silent=True):
+        """ Returns True if the solution is feasible.
+
+        This method checks that solution values for variables are compatible for their types
+        and bounds. It also checks that all constraints are satisfied, within the tolerance.
+
+        :param tolerance: a float number used to check satisfaction; default is 1e-6.
+        :param silent: optional flag. If False, prints which variable (or constraint)
+          causes the solution to be invalid. default is True.
+
+        :return: True if the solution is valid, within the tolerance value.
+
+        *New in version 2.13*
+        """
+        m = self.model
+        verbose = not silent
+        invalid_domain_vars = self.find_invalid_domain_variables(m, tolerance)
+        if verbose and invalid_domain_vars:
+            m.warning("invalid domain vars: {0}".format(len(invalid_domain_vars)))
+            for v, invd_var in enumerate(invalid_domain_vars, start=1):
+                dvv = self.get_var_value(invd_var)
+                m.warning("{0} - invalid value {1} for variable {2}({5}), [{3}, {4}]".format(v, dvv, invd_var.lp_name,
+                                                                                             invd_var.lb, invd_var.ub,
+                                                                                             invd_var.cplex_typecode))
+
+        unsat_cts = self.find_unsatisfied_constraints(m, tolerance)
+        if verbose and unsat_cts:
+            m.info("unsatisfied constraints[{0}]".format(len(unsat_cts)))
+            for u, uct in enumerate(unsat_cts, start=1):
+                if uct.is_logical():
+                    # TODO: compute a measure of violation on logical cts
+                    s_violated = ''
+                else:
+                    uctv = uct._compute_violation(self, tolerance)
+                    s_violated = f', violated: {uctv:0.3g}'
+                s_uct = uct.to_readable_string()
+                ctx = uct.index + 1
+                m.warning("{0} - unsatisfied constraint[#{1}]: {2}{3}".format(u, ctx, s_uct, s_violated))
+        return not (invalid_domain_vars or unsat_cts)

+
+    is_feasible_solution = is_valid_solution
+
+    def equals(self, other, check_models=False, obj_precision=1e-3, var_precision=1e-6, assume_equal_indices=True):
+        from itertools import dropwhile
+        if check_models and (self.model is not other.model):
+            return False
+
+        if is_iterable(self.objective_value) and is_iterable(other.objective_value):
+            if len(self.objective_value) == len(other.objective_value):
+                for self_obj_val, other_obj_val in zip(self.objective_value, other.objective_value):
+                    if abs(self_obj_val - other_obj_val) >= obj_precision:
+                        return False
+            else:  # Different number of objectives
+                return False
+        elif not is_iterable(self.objective_value) and not is_iterable(other.objective_value):
+            if abs(self.objective_value - other.objective_value) >= obj_precision:
+                return False
+        else:  # One solution is for multi-objective, and not the other
+            return False
+
+        # noinspection PyPep8
+        this_triplets = [(dv.index, dv.name, svalue) for dv, svalue in dropwhile(lambda dvv: not dvv[1],
+                                                                                 self.iter_var_values())]
+        other_triplets = [(dv.index, dv.name, svalue) for dv, svalue in dropwhile(lambda dvv: not dvv[1],
+                                                                                  other.iter_var_values())]
+        # noinspection PyArgumentList
+        res = True
+        for this_triple, other_triple in zip(this_triplets, other_triplets):
+            this_index, this_name, this_val = this_triple
+            other_index, other_name, other_val = other_triple
+            if (assume_equal_indices and (other_index != this_index)) \
+                    or this_name != other_name \
+                    or abs(this_val - other_val) >= var_precision:
+                res = False
+                break
+        return res
+
+    def ensure_reduced_costs(self, model, engine):
+        if self._reduced_costs is None:
+            self._reduced_costs = engine.get_all_reduced_costs(model)
+
+    def ensure_cuts(self, model, engine):
+        if self._cuts is None:
+            self._cuts = engine.get_all_cuts(model)
+
+    def ensure_dual_values(self, model, engine):
+        if self._dual_values is None:
+            self._dual_values = engine.get_all_dual_values(model)
+
+    def ensure_slack_values(self, model, engine):
+        if self._slack_values is None:
+            self._slack_values = engine.get_all_slack_values(model)
+
+    def ensure_basis_statuses(self, model, engine):
+        if self._basis_statuses is None:
+            #  returns a tuple of two lists
+            self._basis_statuses = engine.get_basis(model)
+
+    def has_basis(self):
+        m = self.model
+        self.ensure_basis_statuses(m, m.get_engine())
+        return self._has_basis()
+
+    def _has_basis(self):
+        try:
+            return len(self._basis_statuses[0]) > 0
+        except TypeError:
+            return False
+
+
[docs]    def get_sensitivity(self, dvars):
+        """ Returns the sensitivity values for a variable iterable.
+
+        Note: The model must be solved successfully before calling this method.
+
+        :param dvars: a sequence of variables.
+        :return: a list of tuples, in the same order as the variable sequence. Each tuple contains 3 tuples: the lower lower_bounds, the upper_bounds and the objective
+        For example [((-1e+20, 2.5), (-3.0, 5.0), (-1e+20, -2.0), (0.0, 4.0)), ((-1e+20, 2.5), (-3.0, 5.0), (-1e+20, -2.0), (0.0, 4.0))]
+        """
+        ret = [None for d in dvars]
+        idx = {d : i for i,d in enumerate(dvars)}
+        todo = []
+        for d in dvars:
+            if d in self._sensitivity.keys():
+                sensitivity = self._sensitivity[d]
+                i = idx[d]
+                ret[i] = sensitivity
+            else:
+                todo.append(d)
+        if len(todo) != 0:
+            m = self.model
+            values = m.get_engine().get_sensitivity(todo)
+            for d,v in zip(todo, values):
+                i = idx[d]
+                ret[i] = v
+        return ret

+
+
+
[docs]    def get_num_cuts(self, cut_type):
+        """ Returns the number of cuts for a specific type.
+
+        :param cut_type: a cut type.
+        :return: the number of cuts associated to this type of cut. 0 if CPLEX is not present
+        """
+        cut_type_instance = CutType()
+        if cut_type in cut_type_instance:
+            cuts = self.get_cuts()
+            name = cut_type_instance[cut_type]
+            return cuts[name]
+        return 0

+
+
+
+
[docs]    def get_cuts(self):
+        """ Returns the number of cuts under the form of a dict(type -> number).
+
+        :return: the number of cuts under the form of a dict(type -> number). Empty dict if CPLEX is not present.
+        """
+        m = self.model
+        self.ensure_cuts(m, m.get_engine())
+        return self._cuts

+
+
[docs]    def get_reduced_costs(self, dvars):
+        """ Returns the reduced costs for a variable iterable.
+
+        Note: the model must a pure LP: no integer or binary variable, no piecewise, no SOS.
+        The model must also be solved successfully before calling this method.
+
+        :param dvars: a sequence of variables.
+        :return: a list of float numbers, in the same order as the variable sequence.
+        """
+        m = self.model
+        self.ensure_reduced_costs(m, m.get_engine())
+        rcs = self._reduced_costs
+        assert rcs is not None
+        return [rcs.get(dv, 0) for dv in dvars]

+
+
[docs]    def get_dual_values(self, lcts):
+        """ Returns the dual values of a sequence of linear constraints.
+
+        Note: the model must a pure LP: no integer or binary variable, no piecewise, no SOS.
+        The model must also be solved successfully before calling this method.
+
+        :param lcts: a sequence of linear constraints.
+
+        :return: a sequence of float numbers
+        """
+        duals = self._dual_values
+        assert duals is not None
+        return [duals.get(lc, 0) for lc in lcts]

+
+
[docs]    def get_slacks(self, cts):
+        """ Return the slack values for a sequence of constraints.
+
+        Slack values are available for linear, quadratic and indicator constraints.
+        The model must be solved successfully before calling this method.
+
+        :param cts: a sequence of constraints.
+        :return: a list of float values, in the same order as the constraints.
+        """
+        all_slacks = self._slack_values
+        assert all_slacks is not None
+        # first get cplex_scope, then fetch the slack: two indirections
+        return [all_slacks[ct.cplex_scope].get(ct, 0) for ct in cts]

+
+
[docs]    def slack_value(self, ct, error='raise'):
+        """ Return the slack value for a constraint.
+
+        Slack values are available for linear, quadratic and indicator constraints.
+        The model must be solved successfully before calling this method.
+
+        :param ct: a constraint.
+        :return: the float value.
+        """
+        all_slacks = self._slack_values
+        slack = 0
+        if all_slacks is None:
+            handle_error(logger=self.model, error=error, msg="Solution contains no slack data")
+        else:
+            slack = all_slacks[ct.cplex_scope].get(ct, 0)
+        return slack

+
+    def get_var_basis_statuses(self, dvars):
+        assert self._basis_statuses is not None
+        all_var_basis_statuses = self._basis_statuses[0]
+        return [BasisStatus.parse(all_var_basis_statuses.get(dv, -1)) for dv in dvars]
+
+    def get_linearct_basis_statuses(self, linear_cts):
+        assert self._basis_statuses is not None
+        all_linearct_basis_statuses = self._basis_statuses[1]
+        return [BasisStatus.parse(all_linearct_basis_statuses.get(lct, -1)) for lct in linear_cts]
+
+    def get_infeasibility(self, ct):
+        return self._infeasibilities.get(ct, 0)
+
+    def display_attributes(self):
+        pass
+
+    def display(self,
+                print_zeros=True,
+                header_fmt="solution for: {0:s}",
+                objective_fmt="{0}: {1:.{prec}f}",
+                value_fmt="{varname:s} = {value:.{prec}f}",
+                iter_vars=None,
+                **kwargs):
+        print_generated = kwargs.get("print_generated", False)
+        problem_name = self.problem_name
+        if header_fmt and problem_name:
+            print(header_fmt.format(problem_name))
+        if self._problem_objective_expr is not None and objective_fmt and self.has_objective():
+            obj_prec = self.model.objective_expr.float_precision
+            print(objective_fmt.format('objective', self._objective, prec=obj_prec))
+        if self.solve_status is not None:
+            print("status: %s(%d)" %(self.solve_status.name,self.solve_status.value))
+        if self.solve_details is not None and len(self.solve_details.quality_metrics) != 0:
+            for k,v in self.solve_details.quality_metrics.items():
+                if abs(v) > 1e-16:
+                    if isinstance(v,int):
+                        print("%s: %d" %(k,v))
+                    else:
+                        print("%s: %f16" % (k, v))
+        if iter_vars is None:
+            iter_vars = self.iter_variables()
+        print_counter = 0
+        for dvar in iter_vars:
+            if print_generated or not dvar.is_generated():
+                var_value = self._get_var_value(dvar)
+                if print_zeros or var_value:
+                    print_counter += 1
+                    varname = dvar.lp_name
+                    # if type(value_fmt) != type(varname):
+                    #     # infamous mix of str and unicode. Should happen only
+                    #     # in py2. Let's convert things
+                    #     if isinstance(value_fmt, str):
+                    #         # noinspection PyUnresolvedReferences
+                    #         value_fmt = value_fmt.decode('utf-8')
+                    #     else:
+                    #         value_fmt = value_fmt.encode('utf-8')
+                    output = value_fmt.format(varname=varname,
+                                              value=var_value,
+                                              prec=dvar.float_precision,
+                                              counter=print_counter)
+                    try:
+                        print(output)
+                    except UnicodeEncodeError:
+                        encoding = 'ascii'
+                        if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding:
+                            encoding = sys.stdout.encoding
+                        print(output.encode(encoding,
+                                            errors='backslashreplace'))
+
+    def to_string(self, print_zeros=True):
+        oss = StringIO()
+        self.to_stringio(oss, print_zeros=print_zeros)
+        return oss.getvalue()
+
+    def to_stringio(self, oss, print_zeros=True):
+        problem_name = self.problem_name
+        if problem_name:
+            oss.write("solution for: %s\n" % problem_name)
+        if self._problem_objective_expr is not None and self.has_objective():
+            oss.write("objective: %g\n" % self._objective)
+        if self.solve_status is not None:
+            oss.write("status: %s(%d)\n" %(self.solve_status.name,self.solve_status.value))
+        if self.solve_details is not None and len(self.solve_details.quality_metrics) != 0:
+            for k,v in self.solve_details.quality_metrics.items():
+                if abs(v) > 1e-16:
+                    if isinstance(v,int):
+                        oss.write("%s: %d\n" %(k,v))
+                    else:
+                        oss.write("%s: %f16\n" % (k, v))
+
+        value_fmt = "{var:s}={value:.{prec}f}"
+        for dvar, val in self.iter_var_values():
+            if not dvar.is_generated():
+                var_value = self._get_var_value(dvar)
+                if print_zeros or var_value != 0:
+                    oss.write(value_fmt.format(var=str(dvar), value=var_value, prec=dvar.float_precision))
+                    oss.write("\n")
+
+    def __str__(self):
+        return self.to_string()
+
+    def __repr__(self):
+        if self.has_objective():
+            s_obj = "obj={0:g}".format(self.objective_value)
+        else:
+            s_obj = "obj=N/A"
+        s_values = ",".join(["{0!s}:{1:g}".format(var, val) for var, val in self.iter_var_values()])
+        r = "docplex.mp.solution.SolveSolution({0},values={{{1}}})".format(s_obj, s_values)
+        return str_maxed(r, maxlen=72)
+
+    def __iter__(self):
+        # INTERNAL: this is necessary to prevent solution from being an iterable.
+        # as it follows getitem protocol, it can mistakenly be interpreted as an iterable
+        raise TypeError
+
+    def __as_df__(self, name_key='name', value_key='value'):
+        return self.as_df(name_key, value_key)
+
+
[docs]    def as_df(self, name_key='name', value_key='value'):
+        """ Converts the solution to a pandas dataframe with two columns: variable name and values
+
+        :param name_key: column name for variable names. Default is 'name'
+        :param value_key: cilumn name for values., Default is 'value'.
+
+        :return: a pandas dataframe, if pandas is present.
+
+        *New in version 2.15*
+        """
+        assert name_key
+        assert value_key
+        assert name_key != value_key
+        try:
+            import pandas as pd
+        except ImportError:
+            raise ImportError('Cannot convert solution to pandas.DataFrame if pandas is not available')
+
+        names = []
+        values = []
+        for dv, dvv in self.iter_var_values():
+            names.append(dv.to_string())
+            values.append(dvv)
+        name_value_dict = {name_key: names, value_key: values}
+        return pd.DataFrame(name_value_dict)

+
+
[docs]    def print_mst(self, outs=None, **kwargs):
+        """ Writes the solution in MST format in an output stream (default is sys.out)
+        """
+        if outs is None:
+            outs = sys.stdout
+        self.export(outs, format='mst', **kwargs)

+
+    def _export_as_string(self, format_spec, **kwargs):
+        # INTERNAL
+        printer = self._new_printer(format_spec)
+        return printer.print_to_string(self, **kwargs)
+
+    def export_as_mst_string(self, write_level=WriteLevel.Auto, **kwargs):
+        kwargs['write_level'] = WriteLevel.parse(write_level)
+        return self._export_as_string(format_spec='mst', **kwargs)
+
+
[docs]    def export_as_mst(self, path=None, basename=None, write_level=WriteLevel.Auto, **kwargs):
+        """ Exports a solution to a file in CPLEX mst format.
+
+        Args:
+            basename: Controls the basename with which the solution is printed.
+                Accepts None, a plain string, or a string format.
+                If None, the model's name is used.
+                If passed a plain string, the string is used in place of the model's name.
+                If passed a string format (either with %s or {0}), this format is used to format the
+                model name to produce the basename of the written file.
+            path: A path to write the file, expects a string path or None.
+                Can be a directory, in which case the basename
+                that was computed with the basename argument is appended to the directory to produce
+                the file.
+                If given a full path, the path is directly used to write the file, and
+                the basename argument is not used.
+                If passed None, the output directory will be ``tempfile.gettempdir()``.
+            write_level: an enumerated value which controls which variables are printed.
+                The default is WriteLevel.Auto, which prints the values of all discrete variables.
+                This parameter also accepts the number values of the corresponding CPLEX parameters
+                (1 for AllVars, 2 for DiscreteVars, 3 for NonZeroVars, 4 for NonZeroDiscreteVars)
+
+        Returns:
+            The full path of the file, when successful, else None
+
+        Examples:
+            Assuming the solution has the name "prob":
+
+            ``sol.export_as_mst()`` will write file prob.mst in a temporary directory.
+
+            ``sol.export_as_mst(write_level=WriteLevel.ALlvars)`` will write file prob.mst in a temporary directory,
+                and will print all variables in the problem.
+
+            ``sol.export_as_mst(path="c:/temp/myprob1.mst")`` will write file "c:/temp/myprob1.mst".
+
+            ``sol.export_as_mst(basename="my_%s_mipstart", path ="z:/home/")`` will write "z:/home/my_prob_mipstart.mst".
+
+        Note:
+            The complete description of MST format is found here:
+        https://www.ibm.com/support/knowledgecenter/SSSA5P_20.1.0/ilog.odms.cplex.help/CPLEX/FileFormats/topics/MST.html
+
+
+        See Also:
+            :class:`docplex.mp.constants.WriteLevel`
+        """
+        kwargs2 = kwargs.copy()
+        kwargs2['write_level'] = WriteLevel.parse(write_level)
+        return self._export(format_spec='mst', path=path, basename=basename, **kwargs2)

+
+
[docs]    def export_as_sol(self, path=None, basename=None, **kwargs):
+        """ Exports a solution to a file in CPLEX SOL format.
+
+        SOL format is valid for all types of solutions, LP or MIP, but cannot be used for warm starts.
+
+        Arguments are identical to the method :func:`export_as_mst`
+
+        Note:
+        The complete description of SOL format is found here:
+        https://www.ibm.com/support/knowledgecenter/SSSA5P_20.1.0/ilog.odms.cplex.help/CPLEX/FileFormats/topics/SOL.html
+
+        See Also:
+            :func:`docplex.mp.model.SolveSolution.export_as_mst`
+
+        """
+        return self._export(format_spec='sol', path=path, basename=basename, **kwargs)

+
+    def _export(self, format_spec, path=None, basename=None, **kwargs):
+        # INTERNAL
+        printer = self._new_printer(format_spec)
+        return self._static_export(exported=self,
+                                   basename=self.problem_name,
+                                   printer=printer,
+                                   path=path,
+                                   basename_fmt=basename,
+                                   **kwargs
+                                   )
+
+    @classmethod
+    def _static_export(cls, exported, basename, printer, path, basename_fmt, **kwargs):
+        sol_basename = normalize_basename(basename, force_lowercase=True)
+        mst_path = make_output_path2(actual_name=sol_basename,
+                                     extension=printer.extension(),
+                                     path=path,
+                                     basename_fmt=basename_fmt)
+        if mst_path:
+            printer.print_to_stream(exported, mst_path, **kwargs)
+            return mst_path
+
+    # noinspection PyPep8
+    @classmethod
+    def _new_printer(cls, format_spec):
+        printers = {'json': SolutionJSONPrinter,
+                    'xml': SolutionMSTPrinter,
+                    'mst': SolutionMSTPrinter,
+                    'sol': SolutionSolPrinter
+                    }
+        printer_type = printers.get(format_spec.lower())
+        if not printer_type:
+            raise ValueError("format key must be one of {}".format(printers.keys()))
+        return printer_type()
+
+
[docs]    def export(self, file_or_filename, format="json", **kwargs):
+        """ Export this solution.
+        
+        Args:
+            file_or_filename: If ``file_or_filename`` is a string, this argument contains the filename to
+                write to. If this is a file object, this argument contains the file object to write to.
+            format: A string, the name of format to use. Possible values are:
+                - "json"
+                - "mst": the MST cplex format for MIP starts
+                - "xml": same as MST
+            kwargs: additional kwargs passed to the actual exporter
+        """
+        printer = self._new_printer(format)
+
+        if isinstance(file_or_filename, str):
+            fp = open(file_or_filename, "w")
+            close_fp = True
+        else:
+            fp = file_or_filename
+            close_fp = False
+        try:
+            printer.print_to_stream(self, fp, **kwargs)
+        finally:
+            if close_fp:
+                fp.close()

+
+
[docs]    def export_as_json_string(self, **kwargs):
+        """ Returns the solution as a string in JSON format.
+
+        :return: a string.
+
+        *New in version 2.10*
+        """
+        return self._export_as_string(format_spec='json', **kwargs)

+
+    def export_as_sol_string(self, **kwargs):
+        return self._export_as_string(format_spec='sol', **kwargs)
+
+
[docs]    def check_as_mip_start(self, strong_check=False):
+        """Checks that this solution is a valid MIP start.
+
+        To be valid, it must have:
+            * at least one discrete variable (integer or binary), and
+            * the values for decision variables should be consistent with the type.
+
+        Returns:
+            Boolean: True if this solution is a valid MIP start.
+        """
+        count_values = 0
+        count_errors = 0
+        m = self.model
+        for dv, dvv in self.iter_var_values():
+            if dv.is_discrete() and not dv.is_generated():
+                count_values += 1
+                if not dv.accepts_value(dvv):  # pragma: no cover
+                    count_errors += 1
+                    m.warning("Solution value {1} is outside the domain of variable {0!r}: {1}, type: {2!s}",
+                              dv, dvv, dv.vartype.short_name)
+        if count_values == 0:
+            docplex_fatal("MIP start contains no discrete variable")  # pragma: no cover
+        return not count_errors if strong_check else True

+
+    def as_dict(self, keep_zeros=False):
+        var_value_dict = {}
+        # INTERNAL: return a dictionary of variable: variable_value
+        for dvar, dval in self.iter_var_values():
+            if keep_zeros or dval:
+                var_value_dict[dvar] = dval
+        return var_value_dict
+
+    def as_name_dict(self, keep_zeros=False, error='ignore'):
+        # return a dictionary of variable_name: variable_value
+        def var_name_or_lp_name(dvar_):
+            return dvar_.name or dvar_.lp_name
+
+        return self._as_dict(var_name_or_lp_name, keep_zeros, error)
+
+    def as_index_dict(self, keep_zeros=False, error='ignore'):
+        # return a dictionary of var index: variable_value
+        # invalid indices are ignored
+        def var_valid_index(dvar_):
+            var_idx = dvar_.index
+            return var_idx if var_idx >= 0 else None
+
+        return self._as_dict(var_valid_index, keep_zeros, error)
+
+    def _as_dict(self, var_to_key_fn, keep_zeros=False, error='ignore'):
+        # INTERNAL
+        key_value_dict = {}
+        for dvar, dval in self.iter_var_values():
+            if keep_zeros or dval:
+                dvar_key = var_to_key_fn(dvar)
+                if dvar_key is not None:
+                    key_value_dict[dvar_key] = dval
+                else:
+                    msg = ("Invalid variable key in solution.as_dict, variable: {0}, transformer: {1}"
+                           .format(dvar, var_to_key_fn.__name__))
+                    handle_error(logger=self.model, error=error, msg=msg)
+        return key_value_dict
+
+
[docs]    def kpi_value_by_name(self, name, match_case=False):
+        ''' Returns the solution value of a KPI from its name.
+
+        Args:
+            name (string): The string to be matched.
+
+            match_case (boolean): If True, looks for a case-exact match, else
+               ignores case. Default is False.
+
+        Returns:
+            The value of the KPI, evaluated in the solution.
+
+        Note:
+            This method raises an error when the string does not match any KPI in the model.
+
+        See:
+            :func: `docplex.mp.model.kpi_by_name`
+        '''
+        kpi = self.model.kpi_by_name(name, try_match=True, match_case=match_case)
+        return kpi._raw_solution_value(self)

+
+
[docs]    @classmethod
+    def from_file(cls, filename, mdl):
+        """ Builds solution(s) from a SOL file.
+            Assumes `filename` is in CPLEX SOL format,
+            reference: https://www.ibm.com/support/knowledgecenter/SSSA5P_20.1.0/ilog.odms.cplex.help/CPLEX/FileFormats/topics/SOL.html
+
+        Returns:
+            a list of solution objects, read from the file, or None, if an error occured.
+        """
+        from docplex.mp.sol_xml_reader import read_sol_file
+        sols = read_sol_file(filename, mdl)
+        return sols

+
+
+
[docs]class SolutionPool(object):
+    """SolutionPool()
+
+     Solutions pools as returned by `Model.populate()`
+
+    This class is not to be instantiated by users, only used after returned by Model.populate.
+
+    Instances of this class can be used like lists. They are fully iterable,
+    and accessible by index.
+
+    See Also:
+        :func:`docplex.mp.model.Model.populate`
+
+    """
+
+    def __init__(self, sols, num_replaced=0):
+        self._solutions = tuple(sols)
+        self._num_replaced = num_replaced
+
+    def __iter__(self):
+        """ Returns an iterator on pool solutions.
+        """
+        return iter(self._solutions)
+
+    def __len__(self):
+        """ Returns the number of solutions in the pool.
+
+        """
+        return self.size
+
+    @property
+    def size(self):
+        """ Returns the number of solutions in the pool.
+
+        :return:
+        """
+        return len(self._solutions)
+
+    def __getitem__(self, item):
+        return self._solutions[item]
+
+    def __str__(self):
+        return 'SolutionPool[{0}](mean={1:.3f})'.format(len(self), self.mean_objective_value)
+
+    def __repr__(self):
+        return "docplex.mp.SolutionPool[{0}]".format(len(self))
+
+    @property
+    def num_replaced(self):
+        return self._num_replaced
+
+    @property
+    def mean_objective_value(self):
+        """ This property returns the mean objective value in the pool.
+
+        """
+        return self.stats[1]
+
+
[docs]    def describe_objectives(self):
+        """ Prints statistical information about poolobjective values.
+
+        Relies on the `stats` property.
+
+        """
+        nb_solutions, obj_mean, obj_sd, obj_min, obj_med, obj_max = self.stats
+        print("count  = {0}".format(nb_solutions))
+        print("mean   = {0}".format(obj_mean))
+        print("std    = {0}".format(obj_sd))
+        print("min    = {0}".format(obj_min))
+        print("med    = {0}".format(obj_med))
+        print("max    = {0}".format(obj_max))

+
+    @property
+    def stats(self):
+        """ Returns statistics about pool objective values.
+
+        :return: a tuple of floats containing (in this order:
+            - number of solutions (same as len()
+            - mean objective value
+            - standard deviation
+            - minimum objective value
+            - median objective value
+            - maximum objective value
+
+        Note:
+            if pool is empty returns dummy values, only the first value (len of 0) is valid.
+        """
+        from math import sqrt
+        nb_solutions = len(self)
+        obj_min = 1e+75
+        obj_max = -1e+75
+        if not nb_solutions:
+            # dummy values
+            return 0, 0, 0, obj_min, obj_min, obj_max
+
+        objs = []
+        obj_sum1 = 0
+        obj_sum2 = 0
+        for ps in self._solutions:
+            obj = ps.objective_value
+            objs.append(obj)
+            if obj < obj_min:
+                obj_min = obj
+            if obj > obj_max:
+                obj_max = obj
+            obj_sum1 += obj
+            obj_sum2 += obj * obj
+        obj_med = sorted(objs)[nb_solutions // 2]
+
+        obj_mean = obj_sum1 / nb_solutions
+        variance = (obj_sum2 / nb_solutions) - (obj_mean ** 2)
+        obj_sd = sqrt(variance)
+        return nb_solutions, obj_mean, obj_sd, obj_min, obj_med, obj_max
+
+
[docs]    def export_as_sol(self, path=None, basename=None, **kwargs):
+        """ Exports the solution pool as a SOL file.
+
+        Args:
+            basename: Controls the basename with which the solution is printed.
+                Accepts None, a plain string, or a string format.
+                If None, the model name is used.
+                If passed a plain string, the string is used in place of the model's name.
+                If passed a string format (either with %s or {0}), this format is used to format the
+                model name to produce the basename of the written file.
+            path: A path to write the file, expects a string path or None.
+                Can be a directory, in which case the basename
+                that was computed with the basename argument is appended to the directory to produce
+                the file.
+                If given a full path, the path is directly used to write the file, and
+                the basename argument is not used.
+                If passed None, the output directory will be ``tempfile.gettempdir()``.
+
+        :return:
+            The path to which the solutions from the pool are written, or None if an error occured.
+        """
+        printer = SolutionSolPrinter()
+        return SolveSolution._static_export(exported=self._solutions,
+                                            basename="pool",
+                                            printer=printer,
+                                            basename_fmt=basename,
+                                            path=path,
+                                            **kwargs)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/sosvarset.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/sosvarset.html new file mode 100644 index 0000000..359b6ef --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/sosvarset.html @@ -0,0 +1,252 @@ + + + + + + + + + docplex.mp.sosvarset — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.sosvarset

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+from docplex.mp.basic import IndexableObject, _AbstractBendersAnnotated
+from docplex.mp.constants import CplexScope
+
+
+
[docs]class SOSVariableSet(IndexableObject, _AbstractBendersAnnotated):
+    ''' This class models :index:`Special Ordered Sets` (SOS) of decision variables.
+        An SOS has a type (SOS1, SOS2) and an ordered list of variables.
+
+        This class is not meant to be instantiated directly.
+        To create an SOS, use the :func:`docplex.mp.model.Model.add_sos`, :func:`docplex.mp.model.Model.add_sos1`,
+        and :func:`docplex.mp.model.Model.add_sos2` methods in Model.
+    '''
+
+    __slots__ = ('_sos_type', '_variables', '_weights')
+
+    def __init__(self, model, variable_sequence, sos_type, weights=None, name=None):
+        IndexableObject.__init__(self, model, name)
+        self._sos_type = sos_type
+        self._variables = variable_sequence[:]  # copy sequence
+        self._weights = None
+        self._set_weights(weights)
+
+    def _set_weights(self, new_weights):
+        if new_weights is None:
+            self._weights = None
+        else:
+            checker = self._model._checker
+            checked_weights = checker.typecheck_num_seq(new_weights)
+            weight_list = list(checked_weights)
+            nb_vars = len(self._variables)
+            if len(weight_list) != nb_vars:
+                self._model.fatal("Expecting {0} SOS weights, a list with size {1} was passed",
+                                  nb_vars, len(weight_list))
+            # check weights are unique
+
+            def _find_duplicate(wlist_):
+                wset_ = set()
+                for w in wlist_:
+                    if w in wset_:
+                        return w
+                    else:
+                        wset_.add(w)
+                return None
+            setof_weights = set(weight_list)
+            if len(setof_weights) != nb_vars:
+                dupw = _find_duplicate(weight_list)
+                self._model.fatal("SOS weights must be unique, duplicate weight: {}", dupw)
+
+            self._weights = weight_list[:]
+
+    @property
+    def cplex_scope(self):
+        return CplexScope.SOS_SCOPE
+
+    @property
+    def sos_type(self):
+        ''' This property returns the type of the SOS variable set.
+
+        :returns: An enumerated value of type :class:`docplex.mp.constants.SOSType`.
+        '''
+        return self._sos_type
+
+
[docs]    def iter_variables(self):
+        ''' Iterates over the variables in the SOS.
+
+        Note that the sequence of variables cannot be empty.
+
+        Returns:
+            An iterator.
+        '''
+        return iter(self._variables)

+
+    def __len__(self):
+        ''' This special method makes it possible to call the `len()` function on an SOS,
+        returning the number of variables in the SOS.
+
+        Returns:
+            The number of variables in the SOS.
+        '''
+        return len(self._variables)
+
+    @property
+    def size(self):
+        return len(self._variables)
+
+    def __getitem__(self, item):
+        ''' This special method enables the [] operator on special ordered sets,
+
+
+        Args:
+            item: an integer from 0 to the number of variables -1
+
+        Returns:
+            The variable in the set at location <item>
+        '''
+        return self._variables[item]
+
+
[docs]    def to_string(self):
+        ''' Converts an SOS of variables to a string.
+
+        This function is used by the `__str__()` method
+
+        Returns:
+            A string representation of the SOS of variables.
+        '''
+        vars_s = ', '.join(str(v) for v in self.iter_variables())
+        name_s = '(\'%s\')' % self._name if self._name else ''
+        return '{0!s}{2}[{1:s}]'.format(self._sos_type.name, vars_s, name_s)

+
+    @property
+    def weights(self):
+        return self.get_cplex_weights()
+
+    # @weights.setter
+    # def weights(self, new_weights):
+    #     self._set_weights(new_weights)
+
+    def get_cplex_weights(self):
+        self_weights = self._weights
+        return self_weights if self_weights is not None else self._model._get_cached_sos_weights(self.size)
+
+    def as_constraint(self):
+        mdl = self._model
+        lfactory = mdl.lfactory
+        lhs = mdl.sum_vars(self._variables)
+        rhs = lfactory.constant_expr(self.sos_type.value)
+        return lfactory.new_binary_constraint(lhs, "le", rhs, name=self.name)
+
+    def __str__(self):
+        ''' Redefine the standard __str__ method of Python objects to customize string conversion.
+
+        Returns:
+            A string representation of the SOS of variables.
+        '''
+        return self.to_string()
+
+    def __repr__(self):
+        name_s = ', name=\'%s\'' % self._name if self._name else ''
+        vars_s = ', '.join(str(v) for v in self.iter_variables())
+        repr_s = 'docplex.mp.SOSVariableSet(type={0}{1}{2})'.format(self.sos_type.value, vars_s, name_s)
+        return repr_s
+
+    def copy(self, target_model, var_mapping):
+        copy_variables = [var_mapping[v] for v in self.iter_variables()]
+        return SOSVariableSet(model=target_model,
+                              variable_sequence=copy_variables,
+                              sos_type=self.sos_type,
+                              weights=self._weights,
+                              name=self.name)
+
+    @property
+    def benders_annotation(self):
+        """
+        This property is used to get or set the Benders annotation of a SOS variable set.
+        The value of the annotation must be a positive integer
+
+        """
+        return self.get_benders_annotation()
+
+    @benders_annotation.setter
+    def benders_annotation(self, new_anno):
+        self.set_benders_annotation(new_anno)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/vartype.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/vartype.html new file mode 100644 index 0000000..9654f72 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/vartype.html @@ -0,0 +1,419 @@ + + + + + + + + + docplex.mp.vartype — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.vartype

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2022
+# --------------------------------------------------------------------------
+
+from docplex.mp.error_handler import docplex_fatal
+
+
[docs]class VarType(object):
+    """VarType()
+
+    This abstract class is the parent class for all types of decision variables.
+
+    This class must never be instantiated.
+    Specialized sub-classes are defined for each type of decision variable.
+
+    """
+    def __init__(self, short_name, lb, ub, cplex_typecode):
+        self._short_name = short_name
+        self._lb = lb
+        self._ub = ub
+        self._cpx_typecode = cplex_typecode
+
+    def is_semi_type(self):
+        return False
+
+    @property
+    def cplex_typecode(self):
+        """ This property returns the CPLEX type code for this type.
+        Possible values are:
+        
+            - 'B' for binary type
+            - 'I' for integer type
+            - 'C' for continuous type
+            - 'S' for semicontinuous type
+            - 'N' for semiinteger type
+
+        :return: a one-letter string.
+        """
+        return self._cpx_typecode
+
+    @property
+    def short_name(self):
+        """ This property returns a short name string for the type.
+        """
+        return self._short_name
+
+    @property
+    def default_lb(self):
+        """  This property returns the default lower bound for the type.
+        """
+        return self._lb
+
+    @property
+    def default_ub(self):
+        """  This property returns the default upper bound for the type.
+        """
+        return self._ub
+
+    def resolve_lb(self, candidate_lb, logger):
+        if candidate_lb is None:
+            resolved_lb = self._lb
+        else:
+            resolved_lb = self._compute_lb(candidate_lb, logger)
+        return resolved_lb
+
+    def resolve_ub(self, candidate_ub, logger):
+        if candidate_ub is None:
+            resolved_ub = self._ub
+        else:
+            resolved_ub = self._compute_ub(candidate_ub, logger)
+        return resolved_ub
+
+    def _compute_lb(self, candidate_lb, logger):  # pragma: no cover
+        # INTERNAL
+        raise NotImplementedError
+
+    def _compute_ub(self, candidate_ub, logger):  # pragma: no cover
+        # INTERNAL
+        raise NotImplementedError
+
+
[docs]    def is_discrete(self):
+        """ Checks if this is a discrete type.
+
+        Returns:
+            Boolean: True if the type is a discrete type.
+        """
+        raise NotImplementedError  # pragma: no cover

+
+    def accept_value(self, numeric_value, tolerance=1e-6):
+        raise NotImplementedError  # pragma: no cover
+
+    @classmethod
+    def _is_within_bounds_and_tolerance(cls, candidate_value, lb, ub, tolerance):
+        assert tolerance >= 0
+        if candidate_value < lb - tolerance:
+            res = False
+        elif candidate_value > ub + tolerance:
+            res = False
+        else:
+            res = True
+        return res
+
+    @classmethod
+    def _is_int_within_tolerance(cls, candidate_value, tolerance):
+        assert tolerance >= 0
+        return abs(candidate_value - round(candidate_value)) <= tolerance
+
+    def accept_domain_value(self, candidate_value, lb, ub, tolerance):
+        return self.accept_value(candidate_value, tolerance) and\
+               self._is_within_bounds_and_tolerance(candidate_value, lb, ub, tolerance)
+
+
[docs]    def to_string(self):
+        """
+        Returns:
+            string: A string representation of the type.
+        """
+        return "VarType_%s" % self.short_name

+
+    def __str__(self):
+        return self.to_string()
+
+    def __eq__(self, other):
+        return type(other) == type(self)
+
+    def __ne__(self, other):
+        return type(other) != type(self)
+
+    def _hash_vartype(self):  # pragma: no cover
+        return hash(self.cplex_typecode)

+
+
+
[docs]class BinaryVarType(VarType):
+    """BinaryVarType()
+
+        This class models the binary variable type and
+        is not meant to be instantiated. Each model contains one instance of
+        this type.
+    """
+
+    def __init__(self):
+        VarType.__init__(self, short_name="binary", lb=0, ub=1, cplex_typecode='B')
+
+    def _compute_lb(self, candidate_lb, logger):
+        # INTERNAL
+        if candidate_lb >= 1 + 1e-6:
+            logger.fatal('Lower bound for binary variable should be less than 1, {0} was passed '.format(candidate_lb))
+        # return the user bound anyway
+        return candidate_lb
+
+    def _compute_ub(self, candidate_ub, logger):
+        # INTERNAL
+        if candidate_ub <= -1e-6:
+            logger.fatal('Upper bound for binary variable should be greater than 0, {0} was passed'.format(candidate_ub))
+        # return the user bound anyway
+        return candidate_ub
+
+
[docs]    def is_discrete(self):
+        """ Checks if this is a discrete type.
+
+        Returns:
+            Boolean: True as this is a discrete type.
+        """
+        return True

+
+    def accept_value(self, numeric_value, tolerance=1e-6):
+        return -tolerance <= numeric_value <= tolerance or\
+               (1-tolerance <= numeric_value <= 1 + tolerance)
+
+    def __hash__(self):  # pragma: no cover
+        return VarType._hash_vartype(self)

+
+
+
[docs]class ContinuousVarType(VarType):
+    """ContinuousVarType()
+
+        This class models the continuous variable type and
+        is not meant to be instantiated. Each model contains one instance of this type.
+    """
+
+    def __init__(self, plus_infinity=1e+20):
+        VarType.__init__(self, short_name="continuous", lb=0, ub=plus_infinity, cplex_typecode='C')
+        self._plus_infinity = plus_infinity
+        self._minus_infinity = - plus_infinity
+
+    def _compute_ub(self, candidate_ub, logger):
+        return min(candidate_ub, self._plus_infinity)
+
+    def _compute_lb(self, candidate_lb, logger):
+        return max(candidate_lb, self._minus_infinity)
+
+
[docs]    def is_discrete(self):
+        """ Checks if this is a discrete type.
+
+        Returns:
+            Boolean: False because this type is not a discrete type.
+        """
+        return False

+
+    def accept_value(self, numeric_value, tolerance=1e-6):
+        return self._minus_infinity <= numeric_value <= self._plus_infinity
+
+    def __hash__(self):  # pragma: no cover
+        return VarType._hash_vartype(self)

+
+
+
[docs]class IntegerVarType(VarType):
+    """IntegerVarType()
+    This class models the integer variable type and
+    is not meant to be instantiated. Each models contains one instance
+    of this type.
+
+    """
+
+    def __init__(self, plus_infinity=1e+20):
+        VarType.__init__(self, short_name="integer", lb=0, ub=plus_infinity, cplex_typecode='I')
+        self._plus_infinity = plus_infinity
+        self._minus_infinity = -plus_infinity
+
+    def _compute_ub(self, candidate_ub, logger):
+        return min(candidate_ub, self._plus_infinity)
+
+    def _compute_lb(self, candidate_lb, logger):
+        return max(candidate_lb, self._minus_infinity)
+
+
[docs]    def is_discrete(self):
+        """  Checks if this is a discrete type.
+
+        Returns:
+            Boolean: True as this is a discrete type.
+        """
+        return True

+
+    def accept_value(self, numeric_value, tolerance=1e-6):
+        return self._is_int_within_tolerance(numeric_value, tolerance)
+
+    def __hash__(self):  # pragma: no cover
+        return VarType._hash_vartype(self)

+
+
+
[docs]class SemiContinuousVarType(VarType):
+    """SemiContinuousVarType()
+
+            This class models the :index:`semi-continuous` variable type and
+            is not meant to be instantiated.
+    """
+
+    def __init__(self, plus_infinity=1e+20):
+        VarType.__init__(self, short_name="semi-continuous", lb=1e-6, ub=plus_infinity, cplex_typecode='S')
+        self._plus_infinity = plus_infinity
+
+    def is_semi_type(self):
+        return True
+
+    def _compute_ub(self, candidate_ub, logger):
+        return self._plus_infinity if candidate_ub >= self._plus_infinity else float(candidate_ub)
+
+    def _compute_lb(self, candidate_lb, logger):
+        if candidate_lb <= 0:
+            logger.fatal(
+                'semi-continuous variable expects strict positive lower bound, not: {0}'.format(candidate_lb))
+        return candidate_lb
+
+    @property
+    def default_lb(self):
+        # there is NO default lb
+        docplex_fatal("Type {0} has no default lower bound".format(self.short_name))
+
+
[docs]    def is_discrete(self):
+        """ Checks if this is a discrete type.
+
+        Returns:
+            Boolean: False because this type is not a discrete type.
+        """
+        return False

+
+    def accept_value(self, numeric_value, tolerance=1e-6):
+        return 0 <= numeric_value <= self._plus_infinity
+
+    def accept_domain_value(self, candidate_value, lb, ub, tolerance):
+        return 0 == candidate_value or self._is_within_bounds_and_tolerance(candidate_value, lb, ub, tolerance)
+
+    def __hash__(self):  # pragma: no cover
+        return VarType._hash_vartype(self)

+
+
+
[docs]class SemiIntegerVarType(VarType):
+    """SemiIntegerVarType()
+
+            This class models the :index:`semi-integer` variable type and
+            is not meant to be instantiated.
+    """
+    def __init__(self, plus_infinity=1e+20):
+        VarType.__init__(self, short_name="semi-integer", lb=1e-6, ub=plus_infinity, cplex_typecode='N')
+        self._plus_infinity = plus_infinity
+
+    def is_semi_type(self):
+        return True
+
+    @property
+    def default_lb(self):
+        # there is NO default lb
+        docplex_fatal("Type {0} has no default lower bound".format(self.short_name))
+
+    def _compute_ub(self, candidate_ub, logger):
+        return min(candidate_ub, self._plus_infinity)
+
+    def _compute_lb(self, candidate_lb, logger):
+        if candidate_lb <= 0:
+            logger.fatal('semi-integer variable expects strict positive lower bound, not: {0}'.format(candidate_lb))
+        return candidate_lb
+
+
[docs]    def is_discrete(self):
+        """ Checks if this is a discrete type.
+
+        Returns:
+            Boolean: True because this type is an integer type.
+        """
+        return True

+
+    def accept_value(self, numeric_value, tolerance=1e-6):
+        if 0 == numeric_value:
+            return True
+        return numeric_value >= 0 and self._is_int_within_tolerance(numeric_value, tolerance)
+
+    def accept_domain_value(self, candidate_value, lb, ub, tolerance):
+        return 0 == candidate_value or self._is_within_bounds_and_tolerance(candidate_value, lb, ub, tolerance)
+
+    def __hash__(self):  # pragma: no cover
+        return VarType._hash_vartype(self)

+
+
+
+
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/mp/with_funcs.html b/docs/2.29.245/docs/mp/_modules/docplex/mp/with_funcs.html new file mode 100644 index 0000000..e085325 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/mp/with_funcs.html @@ -0,0 +1,217 @@ + + + + + + + + + docplex.mp.with_funcs — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.mp.with_funcs

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2020, 2022
+# --------------------------------------------------------------------------
+
+from contextlib import contextmanager
+
+from docplex.mp.constants import ObjectiveSense
+
+
+
[docs]@contextmanager
+def model_parameters(mdl, temp_parameters):
+    """ This contextual function is used to override a model's parameters.
+    As a contextual function, it is intended to be used with the `with` construct, for example:
+
+    >>> with model_parameters(mdl, {"timelimit": 30, "empahsis.mip": 4}) as mdl2:
+    >>>     mdl2.solve()
+
+
+    The new model returned from the `with` has temporary parameters overriding those of the initial model.
+
+    when exiting the with block, initial parameters are restored.
+
+    :param mdl: an instance of `:class:Model`.
+    :param temp_parameters: accepts either a dictionary of qualified names to values, for example
+        {"mip.tolernaces.mipgap": 0.03, "emphasis.mip": 4}, or a dictionary from parameter objects to values.
+    :return: the same model, with overridden parameters.
+
+    See Also:
+        - :func:`docplex.mp.params.Parameter.qualified_name`
+
+    *New in version 2.21*
+    """
+    if not temp_parameters:
+        try:
+            yield mdl
+        finally:
+            pass
+    else:
+        ctx = mdl.context
+        saved_context = ctx
+        temp_ctx = ctx.copy()
+        try:
+            temp_ctx.update_cplex_parameters(temp_parameters)
+            mdl.context = temp_ctx
+            yield mdl
+        finally:
+            mdl.context = saved_context
+            return mdl

+
+
+
[docs]@contextmanager
+def model_objective(mdl, temp_obj, temp_sense=None):
+    """ This contextual function is used to temporarily override the objective of a model.
+    As a contextual function, it is intended to be used with the `with` construct, for example:
+
+    >>> with model_objective(mdl, x+y) as mdl2:
+    >>>     mdl2.solve()
+
+
+    The new model returned from the `with` has a temporary objective overriding the initial objective.
+
+    when exiting the with block, the initial objective and sense are restored.
+
+    :param mdl: an instance of `:class:Model`.
+    :param temp_obj: an expression.
+    :param temp_sense: an optional objective sense to override the model's. Default is None (keep same objective).
+        Accepts either an instance of enumerated value `:class:docplex.mp.constants.ObjectiveSense` or a string
+        'min' or 'max'.
+    :return: the same model, with overridden objective.
+
+    *New in version 2.21*
+    """
+    saved_obj = mdl.objective_expr
+    saved_sense = mdl.objective_sense
+    new_sense_ = ObjectiveSense.parse(temp_sense, mdl) if temp_sense is not None else None
+
+    try:
+        mdl.set_objective_expr(temp_obj)
+        if new_sense_:
+            mdl.set_objective_sense(new_sense_)
+
+        yield mdl
+    finally:
+        mdl.set_objective_expr(saved_obj)
+        if new_sense_:
+            mdl.set_objective_sense(saved_sense)

+
+
+
[docs]@contextmanager
+def model_solvefixed(mdl):
+    """ This contextual function is used to temporarily change the type of the model
+    to "solveFixed".
+    As a contextual function, it is intended to be used with the `with` construct, for example:
+
+    >>> with model_solvefixed(mdl) as mdl2:
+    >>>     mdl2.solve()
+
+    The  model returned from the `with` has a temporary problem type set to "solveFixex overriding the
+    actual problem type.
+    This function is useful for MIP models which have been successfully solved; the modified model
+    can be solved as a LP, with all discrete values fixed to their solutions in the previous solve.
+
+    when exiting the with block, the actual problem type is restored.
+
+    :param mdl: an instance of `:class:Model`.
+
+    :return: the same model, with overridden problem type.
+
+    Note:
+        - an exception is raised if the model has not been solved
+        - LP models are returned unchanged, as this mfunction has no use.
+
+    *New in version 2.22*
+    """
+    cpx = mdl._get_cplex(do_raise=True, msgfn=lambda: "model_solvefixed requires CPLEX runtime")
+
+    # save initial problem type, to be restored.
+    saved_problem_type = cpx.get_problem_type()
+    if saved_problem_type == 0:
+        mdl.warning("Model {0} is a LP model, solvefixed does nothing".format(mdl.name))
+        return mdl
+
+    if mdl.solution is None:
+        # a solution is required.
+        mdl.fatal(f"model_solvefixed requires that the model has been solved successfully")
+    try:
+        cpx.set_problem_type(3)  # 3 is constant fixed_MILP
+        yield mdl
+    finally:
+        cpx.set_problem_type(saved_problem_type)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/util/csv_utils.html b/docs/2.29.245/docs/mp/_modules/docplex/util/csv_utils.html new file mode 100644 index 0000000..ba8d627 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/util/csv_utils.html @@ -0,0 +1,144 @@ + + + + + + + + + docplex.util.csv_utils — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.util.csv_utils

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2015, 2020
+# --------------------------------------------------------------------------
+'''Some csv utilities
+'''
+import os
+
+
+
[docs]def encode_csv_string(text):
+    """ Encode a string to be used in CSV file
+
+    Args:
+        text:  String to encode
+    Returns:
+        Encoded string, including starting and ending double quote
+    """
+    res = ['"']
+    for c in text:
+        res.append(c)
+        if c == '"':
+            res.append('"')
+    res.append('"')
+    return ''.join(res)

+
+
+def write_csv_line(output, line, encoding):
+    line = ','.join([encode_csv_string('%s' % c) for c in line])
+    output.write(line.encode(encoding))
+    output.write('\n'.encode(encoding))
+
+
+def write_csv(env, table, fields, name):
+    # table must be a named tuple
+    encoding = 'utf-8'
+    with env.get_output_stream(name) as ostr:
+        write_csv_line(ostr, fields, encoding)
+        for line in table:
+            write_csv_line(ostr, line, encoding)
+
+
+
[docs]def write_table_as_csv(env, table, name, field_names, transaction=None):
+    """Writes a dataframe as file which name is specified.
+    The data type depends of extension of name.
+
+    This uses the specified env to write data as attachments
+    """
+    _, ext = os.path.splitext(name)
+    ext = ext.lower()
+    if ext == '.csv':
+        encoding = 'utf-8'
+        with env.get_output_stream(name, transaction=transaction) as ostr:
+            write_csv_line(ostr, field_names, encoding)
+            for line in table:
+                write_csv_line(ostr, line, encoding)
+    else:
+        # right now, only csv is supported
+        raise ValueError('file format not supported for KPIs file: %s' % ext)

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/docplex/util/environment.html b/docs/2.29.245/docs/mp/_modules/docplex/util/environment.html new file mode 100644 index 0000000..8956492 --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/docplex/util/environment.html @@ -0,0 +1,1201 @@ + + + + + + + + + docplex.util.environment — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

Source code for docplex.util.environment

+# --------------------------------------------------------------------------
+# Source file provided under Apache License, Version 2.0, January 2004,
+# http://www.apache.org/licenses/
+# (c) Copyright IBM Corp. 2022
+# --------------------------------------------------------------------------
+
+'''
+Representation of the DOcplex solving environment.
+
+This module handles the various elements that allow an
+optimization program to run independently from the solving environment.
+This environment may be:
+
+ * on premise, using a local version of CPLEX Optimization Studio to solve MP problems, or
+ * on Watson Machine Learning, with the Python program running inside the Python Worker.
+ * on Decision Optimization in Watson Machine Learning.
+
+As much as possible, the adaptation to the solving environment is
+automatic. The functions that are presented here are useful for handling
+very specific use cases.
+
+The following code is a program that sums its input (``sum.py``)::
+
+    import json
+    import docplex.util.environment as environment
+
+    sum = 0
+    # open program input named "data.txt" and sum the contents
+    with environment.get_input_stream("data.txt") as input:
+        for i in input.read().split():
+            sum += int(i)
+    # write the result as a simple json in program output "solution.json"
+    with environment.get_output_stream("solution.json") as output:
+        output.write(json.dumps({'result': sum}))
+
+Let's put some data in a ``data.txt`` file::
+
+    4 7 8
+    19
+
+When you run ``sum.py`` with a Python interpreter, it opens the ``data.txt`` file and sums all of the integers
+in that file. The result is saved as a JSON fragment in file ``solution.json``::
+
+    $ python sum.py
+    $ more solution.json
+    {"result": 38}
+
+Environment representation can be accessed with different ways:
+
+    * direct object method calls, after retrieving an instance using
+      :meth:`docplex.util.environment.get_environment` and using methods of
+      :class:`docplex.util.environment.Environment`.
+    * using the function in package `docplex.util.environment`. They will call
+       the corresponding methods of Environment in the platform
+       `default_environment`:
+
+           * :meth:`docplex.util.environment.get_input_stream`
+           * :meth:`docplex.util.environment.get_output_stream`
+           * :meth:`docplex.util.environment.read_df`
+           * :meth:`docplex.util.environment.write_df`
+           * :meth:`docplex.util.environment.get_available_core_count`
+           * :meth:`docplex.util.environment.get_parameter`
+           * :meth:`docplex.util.environment.update_solve_details`
+           * :meth:`docplex.util.environment.add_abort_callback`
+           * :meth:`docplex.util.environment.remove_abort_callback`
+
+'''
+from collections import deque
+import json
+import logging
+import os
+import shutil
+import sys
+import threading
+import time
+from typing import Dict
+import warnings
+
+
+
+try:
+    from string import maketrans, translate
+except ImportError:
+    maketrans = str.maketrans
+    translate = str.translate
+
+try:
+    import pandas
+except ImportError:
+    pandas = None
+
+from six import iteritems
+
+from docplex.util import lazy
+
+
+
+def make_new_kpis_dict(allkpis=None, sense = None, model_type = None, int_vars=None, continuous_vars=None,
+                       linear_constraints=None, bin_vars=None,
+                       semicontinuous_vars = None, semiinteger_vars = None,
+                       quadratic_constraints=None, total_constraints=None,
+                       total_variables=None):
+    # This is normally called once at the beginning of a solve
+    # those are the details required for docplexcloud and DODS legacy
+    kpis_name= [ kpi.name for kpi in allkpis ]
+    kpis = {'MODEL_DETAIL_OBJECTIVE_SENSE' : sense,
+            'MODEL_DETAIL_INTEGER_VARS': int_vars,
+            'MODEL_DETAIL_CONTINUOUS_VARS': continuous_vars,
+            'MODEL_DETAIL_CONSTRAINTS': linear_constraints,
+            'MODEL_DETAIL_BOOLEAN_VARS': bin_vars,
+            'MODEL_DETAIL_KPIS': json.dumps(kpis_name)}
+    # those are the ones required per https://github.ibm.com/IBMDecisionOptimization/dd-planning/issues/2491
+    new_details = {'STAT.cplex.modelType' : model_type,
+                   'STAT.cplex.size.integerVariables': int_vars,
+                   'STAT.cplex.size.semicontinuousVariables': semicontinuous_vars,
+                   'STAT.cplex.size.semiintegerVariables': semiinteger_vars,
+                   'STAT.cplex.size.continousVariables': continuous_vars,
+                   'STAT.cplex.size.linearConstraints': linear_constraints,
+                   'STAT.cplex.size.booleanVariables': bin_vars,
+                   'STAT.cplex.size.constraints': total_constraints,
+                   'STAT.cplex.size.quadraticConstraints': quadratic_constraints,
+                   'STAT.cplex.size.variables': total_variables,
+                   }
+
+    kpis.update(new_details)
+    return kpis
+
+
+log_level_mapping = {'OFF': None,
+                     'SEVERE': logging.ERROR,
+                     'WARNING': logging.WARNING,
+                     'INFO': logging.INFO,
+                     'CONFIG': logging.INFO,
+                     'FINE': logging.DEBUG,
+                     'FINER': logging.DEBUG,
+                     'FINEST': logging.DEBUG,
+                     'ALL': logging.DEBUG}
+
+
+
[docs]class NotAvailableError(Exception):
+    ''' The exception raised when a feature is not available
+    '''
+    pass

+
+
+
[docs]def default_solution_storage_handler(env, solution):
+    ''' The default solution storage handler.
+
+    The storage handler is a function which first argument is the
+    :class:`~Environment` on which a solution should be saved. The `solution`
+    is a dict containing all the data for an optimization solution.
+
+    The storage handler is responsible for storing the solution in the
+    environment.
+
+    For each (key, value) pairs of the solution, the default solution storage
+    handler does the following depending of the type of `value`, in the
+    following order:
+
+        * If `value` is a `pandas.DataFrame`, then the data frame is saved
+          as an output with the specified `name`. Note that `name` must include
+          an extension file for the serialization. See
+          :meth:`Environment.write_df` for supported formats.
+        * If `value` is a `bytes`, it is saved as binary data with `name`.
+        * The `value` is saved as an output with the `name`, after it has been
+          converted to JSON.
+
+    Args:
+        env: The :class:`~Environment`
+        solution: a dict containing the solution.
+    '''
+    for (name, value) in iteritems(solution):
+        if pandas and isinstance(value, pandas.DataFrame):
+            _, ext = os.path.splitext(name)
+            if ext.lower() == '':
+                name = '%s.csv' % name  # defaults to csv if no format specified
+            env.write_df(value, name)
+        elif isinstance(value, bytes):
+            with env.get_output_stream(name) as fp:
+                fp.write(value)
+        else:
+            # try jsonify
+            with env.get_output_stream(name) as fp:
+                json.dump(value, fp)

+
+
+# The global output lock
+global_output_lock = threading.Lock()
+
+
+
[docs]class SolveDetailsFilter(object):
+    '''Default solve detail filter class.
+
+    This default class filters details so that there are no more than 1 solve
+    details per second.
+    '''
+    def __init__(self, interval=1):
+        self.last_accept_time = 0
+        self.interval = interval
+
+
[docs]    def filter(self, details):
+        '''Filters the details.
+
+        Returns:
+            True if the details are to be published.
+        '''
+        ret_val = None
+        now = time.time()
+        if (now - self.last_accept_time > self.interval):
+            ret_val = details
+            self.last_accept_time = now
+        return ret_val

+
+
+
[docs]class OutputAttachmentTransaction(object):
+    """Handles output attachment transactions
+
+    *New in version 2.26*
+    """
+    def __init__(self, env):
+        self.env = env
+        self.attachments = dict()
+
+
[docs]    def set_output_attachments(self, attachments: Dict[str, str]):
+        """
+        Adds new attachments to this transaction
+        """
+        self.attachments.update(attachments)

+
+
[docs]    def commit(self):
+        """
+        Commit the attachments waiting to be publushed.
+        :return:
+        """
+        if self.attachments:
+            self.env.set_output_attachments(self.attachments)
+            self.attachments.clear()

+
+
[docs]    def close(self):
+        """
+        Closes the transaction, actually setting all the attachments at once.
+        """
+        self.commit()

+
+
[docs]class Environment(object):
+    ''' Methods for interacting with the execution environment.
+
+    Internally, the ``docplex`` package provides the appropriate implementation
+    according to the actual execution environment.
+    The correct instance of this class is returned by the method
+    :meth:`docplex.util.environment.get_environment` that is provided in this
+    module.
+
+    Attributes:
+        abort_callbacks: A list of callbacks that are called when the script is
+            run on Watson Machine Learning and a job abort operation is requested. You
+            add your own callback using::
+
+                env.abort_callbacks += [your_cb]
+
+            or::
+
+                env.abort_callbacks.append(your_cb)
+
+            You remove a callback using::
+
+                env.abort_callbacks.remove(your_cb)
+
+        solution_storage_handler: A function called when a solution is to be
+            stored. The storage handler is a function which first argument is
+            the :class:`~Environment` on which a solution should be saved. The
+            `solution` is a dict containing all the data for an optimization
+            solution. The default is :meth:`~default_solution_storage_handler`.
+        record_history_fields: Fields which history is to be kept
+        record_history_size: maximum number of records in history
+        record_interval: min time between to history records
+    '''
+    def __init__(self):
+        self.output_lock = global_output_lock
+        self.solution_storage_handler = default_solution_storage_handler
+        self.abort_callbacks = []
+        self.interpret_df_type = True
+        self.update_solve_details_dict = True
+        self.last_solve_details = {}  # stores the latest published details
+        # private behaviour for now: allows to filter details
+        # the SolveDetailsFilter.filter() method returns true if the details
+        # are to be kept
+        self.details_filter = None
+        self.unpublished_details = None
+        self._record_history_fields = None
+        # self.record_history_fields = ['PROGRESS_CURRENT_OBJECTIVE']
+        self.record_history = {}  # maps name -> deque
+        self.last_history_record = {}  # we keep the last here so that we can publish at end of solve
+        self.record_history_time_decimals = 2  # number of decimals for time
+        self.record_history_size = 100
+        self.record_min_time = 1
+        self.recorded_solve_details_count = 0  # number of solve details that have been sent to recording
+        self.autoreset = True
+        self.logger = logging.getLogger("docplex.util.environment.logger")
+
+
[docs]    def create_transaction(self):
+        """
+        Creates a new output attachment transaction
+        :return: an OutputAttachmentTransaction
+
+        *New in version 2.26*
+        """
+        return OutputAttachmentTransaction(self)

+
+
+    def _reset_record_history(self, force=False):
+        if self.autoreset or force:
+            self.record_history = {}
+            self.unpublished_details = None
+            self.last_history_record = {}
+            self.recorded_solve_details_count = 0
+
+    def get_record_history_fields(self):
+        if self._record_history_fields is None:
+            if self.is_wmlworker:
+                self._record_history_fields = ['PROGRESS_BEST_OBJECTIVE',
+                                               'PROGRESS_CURRENT_OBJECTIVE',
+                                               'PROGRESS_GAP']
+            else:
+                # the default out of dods is to not record any history
+                self._record_history_fields = []
+        return self._record_history_fields
+
+    def set_record_history_fields(self, value):
+        self._record_history_fields = value
+
+    # let record_history_fields be a property that is lazy initialized
+    # this gives the opportunity to set is_wmlworker before record history fields are needed
+    record_history_fields = property(get_record_history_fields, set_record_history_fields)
+
+
[docs]    def store_solution(self, solution):
+        '''Stores the specified solution.
+
+        This method guarantees that the solution is fully saved if the model
+        is running on Watson Machine Learning python worker and an abort of the job is
+        triggered.
+
+        For each (key, value) pairs of the solution, the default solution
+        storage handler does the following depending of the type of `value`, in
+        the following order:
+
+        * If `value` is a `pandas.DataFrame`, then the data frame is saved
+          as an output with the specified `name`. Note that `name` must include
+          an extension file for the serialization. See
+          :meth:`Environment.write_df` for supported formats.
+        * If `value` is a `bytes`, it is saved as binary data with `name`.
+        * The `value` is saved as an output with the `name`, after it has been
+          converted to JSON.
+
+        Args:
+            solution: a dict containing the solution.
+        '''
+        with self.output_lock:
+            self.solution_storage_handler(self, solution)

+
+
[docs]    def get_input_stream(self, name):
+        ''' Get an input of the program as a stream (file-like object).
+
+        An input of the program is a file that is available in the working directory.
+
+        When run on Watson Machine Learning, all input attachments are copied to the working directory before
+        the program is run. ``get_input_stream`` lets you open the input attachments of the job.
+
+        Args:
+            name: Name of the input object.
+        Returns:
+            A file object to read the input from.
+        '''
+        self.logger.debug(lazy(lambda: f"set input stream: name={name}"))
+        return None

+
+
[docs]    def read_df(self, name, reader=None, **kwargs):
+        ''' Reads an input of the program as a ``pandas.DataFrame``.
+
+        ``pandas`` must be installed.
+
+        ``name`` is the name of the input object, as a filename. If a reader
+        is not user provided, the reader used depends on the filename extension.
+
+        The default reader used depending on extension are:
+
+            * ``.csv``: ``pandas.read_csv()``
+            * ``.msg``: ``pandas.read_msgpack()``
+
+        Args:
+            name: The name of the input object
+            reader: an optional reader function
+            **kwargs: additional parameters passed to the reader
+        Raises:
+            NotAvailableError: raises this error when ``pandas`` is not
+                available.
+        '''
+        if pandas is None:
+            raise NotAvailableError('read_df() is only available if pandas is installed')
+        _, ext = os.path.splitext(name)
+        default_kwargs = None
+        if reader is None:
+            default_readers = {'.csv': (pandas.read_csv, {'index_col': 0}),
+                               '.msg': (pandas.read_msgpack, None)}
+            reader, default_kwargs = default_readers.get(ext.lower(), None)
+        if reader is None:
+            raise ValueError('no default reader defined for files with extension: \'%s\'' % ext)
+        with self.get_input_stream(name) as ost:
+            # allow
+            params = {}
+            if default_kwargs:
+                params.update(default_kwargs)
+            if kwargs:
+                params.update(kwargs)
+            return reader(ost, **params)

+
+
[docs]    def write_df(self, df, name, writer=None, **kwargs):
+        ''' Write a ``pandas.DataFrame`` as an output of the program.
+
+        ``pandas`` must be installed.
+
+        ``name`` is the name of the input object, as a filename. If a writer
+        is not user provided, the writer used depends on the filename extension.
+
+        This currently only supports csv output.
+
+        Args:
+            name: The name of the input object
+            writer: an optional writer function
+            **kwargs: additional parameters passed to the writer
+        Raises:
+            NotAvailableError: raises this error when ``pandas`` is not
+                available.
+        '''
+        if pandas is None:
+            raise NotAvailableError('write_df() is only available if pandas is installed')
+        _, ext = os.path.splitext(name)
+        if writer is None:
+            try:
+                default_writers = {'.csv': df.to_csv}
+                writer = default_writers.get(ext.lower(), None)
+            except AttributeError:
+                raise NotAvailableError('Could not write writer function for extension: %s' % ext)
+        if writer is None:
+            raise ValueError('no default writer defined for files with extension: \'%s\'' % ext)
+        with self.get_output_stream(name) as ost:
+            if sys.version_info[0] < 3:
+                ost.write(writer(index=False, encoding='utf8'))
+            else:
+                ost.write(writer(index=False).encode(encoding='utf8'))

+
+
[docs]    def set_output_attachment(self, name, filename):
+        '''Attach the file which filename is specified as an output of the
+        program.
+
+        The file is recorded as being part of the program output.
+        This method can be called multiple times if the program contains
+        multiple output objects.
+
+        When run on premise, ``filename`` is copied to the the working
+        directory (if not already there) under the name ``name``.
+
+        When run on Watson Machine Learning, the file is attached as output attachment.
+
+        Args:
+            name: Name of the output object.
+            filename: The name of the file to attach.
+        '''
+        self.logger.debug(lazy(lambda: f"set output attachment: name={name}, filename={filename}"))
+        self.set_output_attachments({name: filename})

+
+
[docs]    def set_output_attachments(self, attachments):
+        """Sets the output attachments.
+
+        Attachments are recorded as being part of the program output.
+
+        Each attachment is a pair of `name`,`filename` entries.
+
+        When run on premise, ``filename`` is copied to the the working
+        directory (if not already there) under the name ``name``.
+
+        When run on Watson Machine Learning, attachments are set as output.
+
+        Args:
+            attachments: a dict with pairs of `name`,`filename` association.
+
+        *New in version 2.26*
+        """
+        self.logger.debug(lazy(lambda: f"set output attachment: attachments={attachments}"))

+
+
[docs]    def get_output_stream(self, name, transaction = None):
+        ''' Get a file-like object to write the output of the program.
+
+        The file is recorded as being part of the program output.
+        This method can be called multiple times if the program contains
+        multiple output objects.
+
+        When run on premise, the output of the program is written as files in
+        the working directory. When run on Watson Machine Learning, the files are attached
+        as output attachments.
+
+        The stream is opened in binary mode, and will accept 8 bits data.
+
+        Args:
+            name: Name of the output object.
+            transaction (optional): The transaction handler. Can be ignored if the environment does not support
+                transactions.
+        Returns:
+            A file object to write the output to.
+        '''
+        self.logger.debug(lazy(lambda: f"set output stream: name={name}"))
+        return open(os.devnull, "w+b")

+
+
[docs]    def get_available_core_count(self):
+        ''' Returns the number of cores available for processing if the environment
+        sets a limit.
+
+        This number is used in the solving engine as the number of threads.
+
+        Returns:
+            The available number of cores or ``None`` if the environment does not
+            limit the number of cores.
+        '''
+        return None

+
+
[docs]    def get_parameters(self):
+        ''' Returns a dict containing all parameters of the program.
+
+        on Watson Machine Learning, this method returns the job parameters.
+        On local solver, this method returns ``os.environ``.
+
+        Returns:
+            The job parameters
+        '''
+        return None

+
+
[docs]    def get_parameter(self, name):
+        ''' Returns a parameter of the program.
+
+        on Watson Machine Learning, this method returns the job parameter whose name is specified.
+        On local solver, this method returns the environment variable whose name is specified.
+
+        Args:
+            name: The name of the parameter.
+        Returns:
+            The parameter whose name is specified or None if the parameter does
+            not exists.
+        '''
+        return None

+
+    def notify_start_solve(self, solve_details, engine_type=None):
+        # ===============================================================================
+        #         '''Notify the solving environment that a solve is starting.
+        #
+        #         If ``context.solver.auto_publish.solve_details`` is set, the underlying solver will automatically
+        #         send details. If you want to craft and send your own solve details, you can use the following
+        #         keys (non exhaustive list):
+        #
+        #             - MODEL_DETAIL_TYPE : Model type
+        #             - MODEL_DETAIL_CONTINUOUS_VARS : Number of continuous variables
+        #             - MODEL_DETAIL_INTEGER_VARS : Number of integer variables
+        #             - MODEL_DETAIL_BOOLEAN_VARS : Number of boolean variables
+        #             - MODEL_DETAIL_INTERVAL_VARS : Number of interval variables
+        #             - MODEL_DETAIL_SEQUENCE_VARS : Number of sequence variables
+        #             - MODEL_DETAIL_NON_ZEROS : Number of non zero variables
+        #             - MODEL_DETAIL_CONSTRAINTS : Number of constraints
+        #             - MODEL_DETAIL_LINEAR_CONSTRAINTS : Number of linear constraints
+        #             - MODEL_DETAIL_QUADRATIC_CONSTRAINTS : Number of quadratic constraints
+        #
+        #         Args:
+        #             solve_details: A ``dict`` with solve details as key/value pairs
+        #         See:
+        #             :attr:`.Context.solver.auto_publish.solve_details`
+        #         '''
+        # ===============================================================================
+        self.logger.debug(lazy(lambda: f"Notify start solve: engine_type={engine_type}, solve_details={json.dumps(solve_details, indent=3)}"))
+        self._reset_record_history()
+
+
[docs]    def update_solve_details(self, details, transaction=None):
+        """Update the solve details.
+
+        You use this method to send solve details to the solve service.
+        If ``context.solver.auto_publish`` is set, the underlying
+        solver will automatically update solve details once the solve has
+        finished.
+
+        This method might filter details and publish them with rate limitations.
+        It actually publish de details by calling `publish_solve_details`.
+
+        Args:
+            details: A ``dict`` with solve details as key/value pairs.
+            transaction: The transaction to publish output attachments
+        """
+        self.logger.debug(lazy(lambda: f"Update solve details: {json.dumps(details, indent=3)}"))
+        # publish details
+        to_publish = None
+        if self.update_solve_details_dict:
+            previous = self.last_solve_details
+            to_publish = {}
+            if details:
+                to_publish.update(previous)
+                to_publish.update(details)
+            self.last_solve_details = to_publish
+        else:
+            to_publish = details
+        # process history
+        to_publish = self.record_in_history(to_publish)
+
+        if self.details_filter:
+            if self.details_filter.filter(details):
+                self.logger.debug("Published as filtered details")
+                self.publish_solve_details(to_publish, transaction=transaction)
+            else:
+                # just store the details for later use
+                self.logger.debug("Publish filter refused details, stored as unpublished")
+                self.unpublished_details = to_publish
+        else:
+            self.logger.debug("Published as unfiltered details")
+            self.publish_solve_details(to_publish, transaction=transaction)

+
+    def record_in_history(self, details):
+        self.recorded_solve_details_count += 1
+        self.logger.debug(lazy(lambda: f"record in history: {json.dumps(details)}"))
+        current_ts = round(time.time(), self.record_history_time_decimals)
+        for f in self.record_history_fields:
+            if f in details:
+                current_history_element = [current_ts, details[f]]
+                l = self.record_history.get(f, deque([], self.record_history_size))
+                self.record_history[f] = l
+                last_ts = l[-1][0] if len(l) >= 1 else -9999
+                if (current_ts - last_ts) >= self.record_min_time:
+                    self.logger.debug(lazy(lambda: f"record added in history for field {f}"))
+                    l.append(current_history_element)
+                    details['%s.history' % f] = json.dumps(list(l))  # make new copy
+                    # make current also last history record
+                    self.last_history_record[f] = current_history_element
+                else:
+                    self.logger.debug(lazy(lambda: f"record stored as current for field {f}"))
+                    self.last_history_record[f] = current_history_element
+        return details
+
+    def prepare_last_history(self):
+        details = {}
+        details.update(self.last_solve_details)
+        any_added = False
+        for k, v in self.last_history_record.items():
+            the_list = self.record_history[k]
+            do_append = True
+            if len(the_list) >= 1:
+                last_date_history = the_list[-1][0]
+                last_date = v[0]
+                do_append = (abs(last_date - last_date_history) >= 0.01)
+            if do_append:
+                the_list.append(v)
+                any_added = True
+            details['%s.history' % k] = json.dumps(list(the_list))
+        return details if any_added else False
+
+
[docs]    def publish_solve_details(self, details, transaction=None):
+        """Actually publish the solve specified details.
+
+        Returns:
+            The published details
+        """
+        self.logger.debug(lazy(lambda: f"Publish solve details: {json.dumps(details, indent=3)}"))

+
+    def notify_end_solve(self, status, solve_time=None, transaction=None):
+        # ===============================================================================
+        #         '''Notify the solving environment that the solve as ended.
+        #
+        #         The ``status`` can be a JobSolveStatus enum or an integer.
+        #
+        #         When ``status`` is an integer, it is converted with the following conversion table:
+        #
+        #             0 - UNKNOWN: The algorithm has no information about the solution.
+        #             1 - FEASIBLE_SOLUTION: The algorithm found a feasible solution.
+        #             2 - OPTIMAL_SOLUTION: The algorithm found an optimal solution.
+        #             3 - INFEASIBLE_SOLUTION: The algorithm proved that the model is infeasible.
+        #             4 - UNBOUNDED_SOLUTION: The algorithm proved the model unbounded.
+        #             5 - INFEASIBLE_OR_UNBOUNDED_SOLUTION: The model is infeasible or unbounded.
+        #
+        #         Args:
+        #             status: The solve status
+        #             solve_time: The solve time
+        #         '''
+        # ===============================================================================
+        self.logger.debug(f"Notify end solve, status={status}, solve_time={solve_time}")
+        if self.unpublished_details:
+            self.logger.debug("Notify end solve: has unpublished details, so publish them")
+            self.publish_solve_details(self.unpublished_details, transaction=transaction)
+        if self.recorded_solve_details_count >= 1 and self.last_history_record:
+            self.logger.debug("Notify end solve: has more than 1 solve details, prepare and publish history")
+            last_details = self.prepare_last_history()
+            if last_details:
+                self.publish_solve_details(last_details, transaction=transaction)
+
+
[docs]    def set_stop_callback(self, cb):
+        '''Sets a callback that is called when the script is run on
+        DOcplexcloud and a job abort operation is requested.
+
+        You can also use the ``stop_callback`` property to set the callback.
+
+        Deprecated since 2.4 - Use self.abort_callbacks += [cb] instead'
+
+        Args:
+            cb: The callback function
+        '''
+        warnings.warn('set_stop_callback() is deprecated since 2.4 - Use Environment.abort_callbacks.append(cb) instead')

+
+
[docs]    def get_stop_callback(self):
+        '''Returns the stop callback that is called when the script is run on
+        DOcplexcloud and a job abort operation is requested.
+
+        You can also use the ``stop_callback`` property to get the callback.
+
+        Deprecated since 2.4 - Use the abort_callbacks property instead')
+
+        '''
+        warnings.warn('get_stop_callback() is deprecated since 2.4 - Use the abort_callbacks property instead')
+        return None

+
+    stop_callback = property(get_stop_callback, set_stop_callback)
+
+
[docs]    def get_engine_log_level(self):
+        '''Returns the engine log level as set by job parameter oaas.engineLogLevel.
+
+        oaas.engineLogLevel values are: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL
+
+        The mapping to logging levels in python are:
+
+           * OFF: None
+           * SEVERE: logging.ERROR
+           * WARNING: logging.WARNING
+           * INFO, CONFIG: logging.INFO
+           * FINE, FINER, FINEST: logging.DEBUG
+           * ALL: logging.DEBUG
+
+
+        All other values are considered invalid values and will return None.
+
+        Returns:
+            The logging level or None if not set (off)
+        '''
+        oaas_level = self.get_parameter('oaas.engineLogLevel')
+        log_level = log_level_mapping.get(oaas_level.upper(), None) if oaas_level else None
+        return log_level

+
+
[docs]    def is_debug_mode(self):
+        '''Returns true if the engine should run in debug mode.
+
+        This is equivalent to ``env.get_engine_log_level() <= logging.DEBUG``
+        '''
+        lvl = self.get_engine_log_level()
+        # logging.NOTSET is zero so will return false
+        return (self.get_engine_log_level() <= logging.DEBUG) if lvl is not None else False

+
+
+
+    @property
+    def is_local(self):
+        return False
+    @property
+    def is_wmlworker(self):
+        return False
+    @property
+    def is_wsnotebook(self):
+        return False

+
+
+
[docs]class AbstractLocalEnvironment(Environment):
+    # The environment solving environment using all local input and outputs.
+    def __init__(self):
+        super(AbstractLocalEnvironment, self).__init__()
+        self.logger = logging.getLogger('docplex.util.environment.logger')
+
+        # init number of cores. Default is no limits (engines will use
+        # number of cores reported by system).
+        # On Watson studio runtimes, the system reports the total number
+        # of physical cores but not the number of cores available to the
+        # runtime. The number of cores available to the runtime are
+        # specified in an environment variable instead.
+        self._available_cores = None
+        #TODO VB: Is it useful? We have a priori call to self.solve_hook.get_available_core_count() in WorkerEnv?
+        RUNTIME_HARDWARE_SPEC = os.environ.get('RUNTIME_HARDWARE_SPEC', None)
+        if RUNTIME_HARDWARE_SPEC:
+            try:
+                spec = json.loads(RUNTIME_HARDWARE_SPEC)
+                num = int(spec.get('num_cpu')) if ('num_cpu' in spec) else None
+                self._available_cores = num
+            except:
+                pass
+
+
[docs]    def get_input_stream(self, name):
+        return open(name, "rb")

+
+
[docs]    def get_output_stream(self, name, transaction = None):
+        return open(name, "wb")

+
+
[docs]    def get_parameter(self, name):
+        return os.environ.get(name, None)

+
+
[docs]    def get_parameters(self):
+        return os.environ

+
+
[docs]    def set_output_attachment(self, name, filename):
+        self.set_output_attachments({name: filename})

+
+
[docs]    def set_output_attachments(self, attachments):
+        for name, filename in attachments.items():
+            # check that name leads to a file in cwd
+            attachment_abs_path = os.path.dirname(os.path.abspath(name))
+            if attachment_abs_path != os.getcwd():
+                raise ValueError(f'Illegal attachment name: {name}')
+
+            if os.path.dirname(os.path.abspath(filename)) != os.getcwd():
+                shutil.copyfile(filename, name)  # copy to current

+
+
[docs]    def get_available_core_count(self):
+        return self._available_cores

+
+
+
[docs]class LocalEnvironment(AbstractLocalEnvironment):
+    def __init__(self):
+        super(LocalEnvironment, self).__init__()
+    @property
+    def is_local(self):
+        return True

+
+
[docs]class OverrideEnvironment(object):
+    '''Allows to temporarily replace the default environment.
+
+    If the override environment is None, nothing happens and the default
+    environment is not replaced
+    '''
+    def __init__(self, new_env=None):
+        self.set_env = new_env
+        self.saved_env = None
+
+    def __enter__(self):
+        if self.set_env:
+            global default_environment
+            self.saved_env = default_environment
+            default_environment = self.set_env
+        else:
+            self.saved_env = None
+
+    def __exit__(self, type, value, traceback):
+        if self.saved_env:
+            global default_environment
+            default_environment = self.saved_env

+
+
+def _get_default_environment():
+    try:
+        try:
+            from docplex_wml.util import _get_wml_default_environment
+            return _get_wml_default_environment()
+        except ImportError:
+            pass
+        return LocalEnvironment()
+    except Exception as e:
+        print("We should never get here")
+        print(e)
+
+default_environment = _get_default_environment()
+
+
+def _get_cplex_edition():
+    import docplex.mp.model
+    import docplex.mp.environment
+    version = docplex.mp.environment.Environment().cplex_version
+    if default_environment.is_wmlworker:
+        return "%s%s" % (version, "")
+    with OverrideEnvironment(Environment()):
+        edition = " ce" if docplex.mp.model.Model.is_cplex_ce() else ""
+        return "%s%s" % (version, edition)
+
+
+
[docs]def get_environment():
+    ''' Returns the Environment object that represents the actual execution
+    environment.
+
+    Note: the default environment is the value of the
+    ``docplex.util.environment.default_environment`` property.
+
+    Returns:
+        An instance of the :class:`.Environment` class that implements methods
+        corresponding to actual execution environment.
+    '''
+    return default_environment

+
+
+
[docs]def get_input_stream(name):
+    ''' Get an input of the program as a stream (file-like object),
+    with the default environment.
+
+    An input of the program is a file that is available in the working directory.
+
+    When run on Watson Machine Learning, all input attachments are copied to the working directory before
+    the program is run. ``get_input_stream`` lets you open the input attachments of the job.
+
+    Args:
+        name: Name of the input object.
+    Returns:
+        A file object to read the input from.
+    '''
+    return default_environment.get_input_stream(name)

+
+
+
[docs]def set_output_attachment(name, filename):
+    ''' Attach the file which filename is specified as an output of the
+    program.
+
+    The file is recorded as being part of the program output.
+    This method can be called multiple times if the program contains
+    multiple output objects.
+
+    When run on premise, ``filename`` is copied to the the working
+    directory (if not already there) under the name ``name``.
+
+    When run on Watson Machine Learning, the file is attached as output attachment.
+
+    Args:
+        name: Name of the output object.
+        filename: The name of the file to attach.
+    '''
+    return set_output_attachments({name, filename})

+
+
+
[docs]def set_output_attachments(attachments):
+    """Sets the specified attachments
+
+    The attachments are recorded as being part of the program output.
+
+    The `attachments` are a dict of `name` to `filename` mapping.
+
+    When run on premise, filenames are copied to the working
+    directory (if not already there) under the names.
+
+    When run on Watson Machine Learning, the files are attached as output attachment.
+
+    Args:
+        attachments: a dict of `name`:`filename` mapping
+
+    *New in version 2.26*
+    """
+    return default_environment.set_output_attachments(attachments)

+
+
+
[docs]def get_output_stream(name, transaction = None):
+    ''' Get a file-like object to write the output of the program.
+
+    The file is recorded as being part of the program output.
+    This method can be called multiple times if the program contains
+    multiple output objects.
+
+    When run on premise, the output of the program is written as files in
+    the working directory. When run on Watson Machine Learning, the files are attached
+    as output attachments.
+
+    The stream is opened in binary mode, and will accept 8 bits data.
+
+    Args:
+        name: Name of the output object.
+        transaction (optional): The transaction handler. Can be ignored if the environment does not support
+           transactions.
+    Returns:
+        A file object to write the output to.
+    '''
+    return default_environment.get_output_stream(name)

+
+
+
[docs]def read_df(name, reader=None, **kwargs):
+    ''' Reads an input of the program as a ``pandas.DataFrame`` with the
+    default environment.
+
+    ``pandas`` must be installed.
+
+    ``name`` is the name of the input object, as a filename. If a reader
+    is not user provided, the reader used depends on the filename extension.
+
+    The default reader used depending on extension are:
+
+        * ``.csv``: ``pandas.read_csv()``
+        * ``.msg``: ``pandas.read_msgpack()``
+
+    Args:
+        name: The name of the input object
+        reader: an optional reader function
+        **kwargs: additional parameters passed to the reader
+    Raises:
+        NotAvailableError: raises this error when ``pandas`` is not
+            available.
+    '''
+    return default_environment.read_df(name, reader=reader, **kwargs)

+
+
+
[docs]def write_df(df, name, writer=None, **kwargs):
+    ''' Write a ``pandas.DataFrame`` as an output of the program with the
+    default environment.
+
+    ``pandas`` must be installed.
+
+    ``name`` is the name of the input object, as a filename. If a writer
+    is not user provided, the writer used depends on the filename extension.
+
+    The default writer used depending on extension are:
+
+        * ``.csv``: ``DataFrame.to_csv()``
+        * ``.msg``: ``DataFrame.to_msgpack()``
+
+    Args:
+        name: The name of the input object
+        writer: an optional writer function
+        **kwargs: additional parameters passed to the writer
+    Raises:
+        NotAvailableError: raises this error when ``pandas`` is not
+            available.
+    '''
+    return default_environment.write_df(df, name, writer=writer, **kwargs)

+
+
+
[docs]def get_available_core_count():
+    ''' Returns the number of cores available for processing if the environment
+    sets a limit, with the default environment.
+
+    This number is used in the solving engine as the number of threads.
+
+    Returns:
+        The available number of cores or ``None`` if the environment does not
+        limit the number of cores.
+    '''
+    return default_environment.get_available_core_count()

+
+
+
[docs]def get_parameter(name):
+    ''' Returns a parameter of the program, with the default environment.
+
+    on Watson Machine Learning, this method returns the job parameter whose name is specified.
+
+    Args:
+        name: The name of the parameter.
+    Returns:
+        The parameter whose name is specified.
+    '''
+    return default_environment.get_parameter(name)

+
+
+
[docs]def update_solve_details(details):
+    '''Update the solve details, with the default environment
+
+    You use this method to send solve details to the DOcplexcloud service.
+    If ``context.solver.auto_publish`` is set, the underlying
+    solver will automatically update solve details once the solve has
+    finished.
+
+    Args:
+        details: A ``dict`` with solve details as key/value pairs.
+    '''
+    return default_environment.update_solve_details(details)

+
+
+
[docs]def add_abort_callback(cb):
+    '''Adds the specified callback to the default environment.
+
+    The abort callback is called when the script is run on
+    DOcplexcloud and a job abort operation is requested.
+
+    Args:
+        cb: The abort callback
+    '''
+    default_environment.abort_callbacks += [cb]

+
+
+
[docs]def remove_abort_callback(cb):
+    '''Adds the specified callback to the default environment.
+
+    The abort callback is called when the script is run on
+    DOcplexcloud and a job abort operation is requested.
+
+    Args:
+        cb: The abort callback
+    '''
+    default_environment.abort_callbacks.remove(cb)

+
+
+attachment_invalid_characters = '/\\?%*:|"#<> '
+attachment_trans_table = maketrans(attachment_invalid_characters, '_' * len(attachment_invalid_characters))
+
+
+
[docs]def make_attachment_name(name):
+    '''From `name`, create an attachment name that is correct for DOcplexcloud.
+
+    Attachment filenames in DOcplexcloud has certain restrictions. A file name:
+
+        - is limited to 255 characters;
+        - can include only ASCII characters;
+        - cannot include the characters `/\?%*:|"<>`, the space character, or the null character; and
+        - cannot include _ as the first character.
+
+    This method replace all unauthorized characters with _, then removing leading
+    '_'.
+
+    Args:
+        name: The original attachment name
+    Returns:
+        An attachment name that conforms to the restrictions.
+    Raises:
+        ValueError if the attachment name is more than 255 characters
+    '''
+    new_name = translate(name, attachment_trans_table)
+    while (new_name.startswith('_')):
+        new_name = new_name[1:]
+    if len(new_name) > 255:
+        raise ValueError('Attachment names are limited to 255 characters')
+    return new_name

+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_modules/index.html b/docs/2.29.245/docs/mp/_modules/index.html new file mode 100644 index 0000000..f62a24c --- /dev/null +++ b/docs/2.29.245/docs/mp/_modules/index.html @@ -0,0 +1,112 @@ + + + + + + + + + Overview: module code — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +

All modules for which code is available

+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_static/background_b01.png b/docs/2.29.245/docs/mp/_static/background_b01.png new file mode 100644 index 0000000..353f26d Binary files /dev/null and b/docs/2.29.245/docs/mp/_static/background_b01.png differ diff --git a/docs/2.29.245/docs/mp/_static/basic.css b/docs/2.29.245/docs/mp/_static/basic.css new file mode 100644 index 0000000..2a1ca75 --- /dev/null +++ b/docs/2.29.245/docs/mp/_static/basic.css @@ -0,0 +1,921 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 210px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_static/bizstyle.css b/docs/2.29.245/docs/mp/_static/bizstyle.css new file mode 100644 index 0000000..9a6c900 --- /dev/null +++ b/docs/2.29.245/docs/mp/_static/bizstyle.css @@ -0,0 +1,508 @@ +/* + * bizstyle.css_t + * ~~~~~~~~~~~~~~ + * + * Sphinx stylesheet -- business style theme. + * + * :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 14px; + letter-spacing: -0.01em; + line-height: 150%; + text-align: center; + background-color: white; + background-image: url(background_b01.png); + color: black; + padding: 0; + border-right: 1px solid #336699; + border-left: 1px solid #336699; + + margin: 0px 40px 0px 40px; +} + +div.document { + background-color: white; + text-align: left; + background-repeat: repeat-x; + + -moz-box-shadow: 2px 2px 5px #000; + -webkit-box-shadow: 2px 2px 5px #000; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 240px; + border-left: 1px solid #ccc; +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} +div.bodywrapper { + margin: 0 0 0 calc(210px + 30px); +} + +div.related { + font-size: 1em; + + -moz-box-shadow: 2px 2px 5px #000; + -webkit-box-shadow: 2px 2px 5px #000; +} + +div.related ul { + background-color: #336699; + height: 100%; + overflow: hidden; + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; +} + +div.related ul li { + color: white; + margin: 0; + padding: 0; + height: 2em; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + +div.related ul li a { + margin: 0; + padding: 0 5px 0 5px; + line-height: 1.75em; + color: #fff; +} + +div.related ul li a:hover { + color: #fff; + text-decoration: underline; +} + +div.sphinxsidebarwrapper { + padding: 0; +} + +div.sphinxsidebar { + padding: 0.5em 12px 12px 12px; + width: 210px; + font-size: 1em; + text-align: left; +} + +div.sphinxsidebar h3, div.sphinxsidebar h4 { + margin: 1em 0 0.5em 0; + font-size: 1em; + padding: 0.1em 0 0.1em 0.5em; + color: white; + border: 1px solid #336699; + background-color: #336699; +} + +div.sphinxsidebar h3 a { + color: white; +} + +div.sphinxsidebar ul { + padding-left: 1.5em; + margin-top: 7px; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + margin-left: 20px; +} + +div.sphinxsidebar input { + border: 1px solid #336699; +} + +div.footer { + background-color: white; + color: #336699; + padding: 3px 8px 3px 0; + clear: both; + font-size: 0.8em; + text-align: right; + border-bottom: 1px solid #336699; + + -moz-box-shadow: 2px 2px 5px #000; + -webkit-box-shadow: 2px 2px 5px #000; +} + +div.footer a { + color: #336699; + text-decoration: underline; +} + +/* -- body styles ----------------------------------------------------------- */ + +p { + margin: 0.8em 0 0.5em 0; +} + +a { + color: #336699; + text-decoration: none; +} + +a:hover { + color: #336699; + text-decoration: underline; +} + +div.body a { + text-decoration: underline; +} + +h1, h2, h3 { + color: #336699; +} + +h1 { + margin: 0; + padding: 0.7em 0 0.3em 0; + font-size: 1.5em; +} + +h2 { + margin: 1.3em 0 0.2em 0; + font-size: 1.35em; + padding-bottom: .5em; + border-bottom: 1px solid #336699; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.2em; + padding-bottom: .3em; + border-bottom: 1px solid #CCCCCC; +} + +div.body h1 a, div.body h2 a, div.body h3 a, +div.body h4 a, div.body h5 a, div.body h6 a { + color: black!important; +} + +h1 a.anchor, h2 a.anchor, h3 a.anchor, +h4 a.anchor, h5 a.anchor, h6 a.anchor { + display: none; + margin: 0 0 0 0.3em; + padding: 0 0.2em 0 0.2em; + color: #aaa!important; +} + +h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, +h5:hover a.anchor, h6:hover a.anchor { + display: inline; +} + +h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover, +h5 a.anchor:hover, h6 a.anchor:hover { + color: #777; + background-color: #eee; +} + +a.headerlink { + color: #c60f0f!important; + font-size: 1em; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none!important; +} + +a.headerlink:hover { + background-color: #ccc; + color: white!important; +} + +cite, code, tt { + font-family: 'Consolas', 'Deja Vu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.01em; +} + +code { + background-color: #F2F2F2; + border-bottom: 1px solid #ddd; + color: #333; +} + +code.descname, code.descclassname, code.xref { + border: 0; +} + +hr { + border: 1px solid #abc; + margin: 2em; +} + +a code { + border: 0; + color: #CA7900; +} + +a code:hover { + color: #2491CF; +} + +pre { + background-color: transparent !important; + font-family: 'Consolas', 'Deja Vu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 0.95em; + letter-spacing: 0.015em; + line-height: 120%; + padding: 0.5em; + border-right: 5px solid #ccc; + border-left: 5px solid #ccc; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +td.linenos pre { + padding: 0.5em 0; +} + +div.quotebar { + background-color: #f8f8f8; + max-width: 250px; + float: right; + padding: 2px 7px; + border: 1px solid #ccc; +} + +nav.contents, +aside.topic, +div.topic { + background-color: #f8f8f8; +} + +table { + border-collapse: collapse; + margin: 0 -0.5em 0 -0.5em; +} + +table td, table th { + padding: 0.2em 0.5em 0.2em 0.5em; +} + +div.admonition { + font-size: 0.9em; + margin: 1em 0 1em 0; + border: 3px solid #cccccc; + background-color: #f7f7f7; + padding: 0; +} + +div.admonition p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition li p { + margin-left: 0; +} + +div.admonition pre, div.warning pre { + margin: 0; +} + +div.highlight { + margin: 0.4em 1em; +} + +div.admonition p.admonition-title { + margin: 0; + padding: 0.1em 0 0.1em 0.5em; + color: white; + border-bottom: 3px solid #cccccc; + font-weight: bold; + background-color: #165e83; +} + +div.danger { border: 3px solid #f0908d; background-color: #f0cfa0; } +div.error { border: 3px solid #f0908d; background-color: #ede4cd; } +div.warning { border: 3px solid #f8b862; background-color: #f0cfa0; } +div.caution { border: 3px solid #f8b862; background-color: #ede4cd; } +div.attention { border: 3px solid #f8b862; background-color: #f3f3f3; } +div.important { border: 3px solid #f0cfa0; background-color: #ede4cd; } +div.note { border: 3px solid #f0cfa0; background-color: #f3f3f3; } +div.hint { border: 3px solid #bed2c3; background-color: #f3f3f3; } +div.tip { border: 3px solid #bed2c3; background-color: #f3f3f3; } + +div.danger p.admonition-title, div.error p.admonition-title { + background-color: #b7282e; + border-bottom: 3px solid #f0908d; +} + +div.caution p.admonition-title, +div.warning p.admonition-title, +div.attention p.admonition-title { + background-color: #f19072; + border-bottom: 3px solid #f8b862; +} + +div.note p.admonition-title, div.important p.admonition-title { + background-color: #f8b862; + border-bottom: 3px solid #f0cfa0; +} + +div.hint p.admonition-title, div.tip p.admonition-title { + background-color: #7ebea5; + border-bottom: 3px solid #bed2c3; +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + +div.versioninfo { + margin: 1em 0 0 0; + border: 1px solid #ccc; + background-color: #DDEAF0; + padding: 8px; + line-height: 1.3em; + font-size: 0.9em; +} + +.viewcode-back { + font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} + +p.versionchanged span.versionmodified { + font-size: 0.9em; + margin-right: 0.2em; + padding: 0.1em; + background-color: #DCE6A0; +} + +dl.field-list > dt { + color: white; + background-color: #82A0BE; +} + +dl.field-list > dd { + background-color: #f7f7f7; +} + +/* -- table styles ---------------------------------------------------------- */ + +table.docutils { + margin: 1em 0; + padding: 0; + border: 1px solid white; + background-color: #f7f7f7; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 1px solid white; + border-bottom: 1px solid white; +} + +table.docutils td p { + margin-top: 0; + margin-bottom: 0.3em; +} + +table.field-list td, table.field-list th { + border: 0 !important; + word-break: break-word; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + color: white; + text-align: left; + padding-right: 5px; + background-color: #82A0BE; +} + +div.literal-block-wrapper div.code-block-caption { + background-color: #EEE; + border-style: solid; + border-color: #CCC; + border-width: 1px 5px; +} + +/* WIDE DESKTOP STYLE */ +@media only screen and (min-width: 1176px) { +body { + margin: 0 40px 0 40px; +} +} + +/* TABLET STYLE */ +@media only screen and (min-width: 768px) and (max-width: 991px) { +body { + margin: 0 40px 0 40px; +} +} + +/* MOBILE LAYOUT (PORTRAIT/320px) */ +@media only screen and (max-width: 767px) { +body { + margin: 0; +} +div.bodywrapper { + margin: 0; + width: 100%; + border: none; +} +div.sphinxsidebar { + display: none; +} +} + +/* MOBILE LAYOUT (LANDSCAPE/480px) */ +@media only screen and (min-width: 480px) and (max-width: 767px) { +body { + margin: 0 20px 0 20px; +} +} + +/* RETINA OVERRIDES */ +@media +only screen and (-webkit-min-device-pixel-ratio: 2), +only screen and (min-device-pixel-ratio: 2) { +} + +/* -- end ------------------------------------------------------------------- */ \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_static/bizstyle.js b/docs/2.29.245/docs/mp/_static/bizstyle.js new file mode 100644 index 0000000..a53f440 --- /dev/null +++ b/docs/2.29.245/docs/mp/_static/bizstyle.js @@ -0,0 +1,30 @@ +// +// bizstyle.js +// ~~~~~~~~~~~ +// +// Sphinx javascript -- for bizstyle theme. +// +// This theme was created by referring to 'sphinxdoc' +// +// :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS. +// :license: BSD, see LICENSE for details. +// +const initialiseBizStyle = () => { + if (navigator.userAgent.indexOf("iPhone") > 0 || navigator.userAgent.indexOf("Android") > 0) { + document.querySelector("li.nav-item-0 a").innerText = "Top" + } + const truncator = item => {if (item.textContent.length > 20) { + item.title = item.innerText + item.innerText = item.innerText.substr(0, 17) + "..." + } + } + document.querySelectorAll("div.related:first ul li:not(.right) a").slice(1).forEach(truncator); + document.querySelectorAll("div.related:last ul li:not(.right) a").slice(1).forEach(truncator); +} + +window.addEventListener("resize", + () => (document.querySelector("li.nav-item-0 a").innerText = (window.innerWidth <= 776) ? "Top" : "DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation") +) + +if (document.readyState !== "loading") initialiseBizStyle() +else document.addEventListener("DOMContentLoaded", initialiseBizStyle) \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/_static/css3-mediaqueries.js b/docs/2.29.245/docs/mp/_static/css3-mediaqueries.js new file mode 100644 index 0000000..59735f5 --- /dev/null +++ b/docs/2.29.245/docs/mp/_static/css3-mediaqueries.js @@ -0,0 +1 @@ +if(typeof Object.create!=="function"){Object.create=function(e){function t(){}t.prototype=e;return new t}}var ua={toString:function(){return navigator.userAgent},test:function(e){return this.toString().toLowerCase().indexOf(e.toLowerCase())>-1}};ua.version=(ua.toString().toLowerCase().match(/[\s\S]+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1];ua.webkit=ua.test("webkit");ua.gecko=ua.test("gecko")&&!ua.webkit;ua.opera=ua.test("opera");ua.ie=ua.test("msie")&&!ua.opera;ua.ie6=ua.ie&&document.compatMode&&typeof document.documentElement.style.maxHeight==="undefined";ua.ie7=ua.ie&&document.documentElement&&typeof document.documentElement.style.maxHeight!=="undefined"&&typeof XDomainRequest==="undefined";ua.ie8=ua.ie&&typeof XDomainRequest!=="undefined";var domReady=function(){var e=[];var t=function(){if(!arguments.callee.done){arguments.callee.done=true;for(var t=0;t=200&&r.status<300||r.status===304||navigator.userAgent.indexOf("Safari")>-1&&typeof r.status==="undefined"){t(r.responseText)}else{n()}document.documentElement.style.cursor="";r=null}};r.send("")};var l=function(t){t=t.replace(e.REDUNDANT_COMPONENTS,"");t=t.replace(e.REDUNDANT_WHITESPACE,"$1");t=t.replace(e.WHITESPACE_IN_PARENTHESES,"($1)");t=t.replace(e.MORE_WHITESPACE," ");t=t.replace(e.FINAL_SEMICOLONS,"}");return t};var c={stylesheet:function(t){var n={};var r=[],i=[],s=[],o=[];var u=t.cssHelperText;var a=t.getAttribute("media");if(a){var f=a.toLowerCase().split(",")}else{var f=["all"]}for(var l=0;l-1&&a.href&&a.href.length!==0&&!a.disabled){r[r.length]=a}}if(r.length>0){var c=0;var d=function(){c++;if(c===r.length){i()}};var v=function(t){var n=t.href;f(n,function(r){r=l(r).replace(e.RELATIVE_URLS,"url("+n.substring(0,n.lastIndexOf("/"))+"/$1)");t.cssHelperText=r;d()},d)};for(u=0;u0){r.setAttribute("media",t.join(","))}document.getElementsByTagName("head")[0].appendChild(r);if(r.styleSheet){r.styleSheet.cssText=e}else{r.appendChild(document.createTextNode(e))}r.addedWithCssHelper=true;if(typeof n==="undefined"||n===true){cssHelper.parsed(function(t){var n=p(r,e);for(var i in n){if(n.hasOwnProperty(i)){g(i,n[i])}}a("newStyleParsed",r)})}else{r.parsingDisallowed=true}return r},removeStyle:function(e){return e.parentNode.removeChild(e)},parsed:function(e){if(n){s(e)}else{if(typeof t!=="undefined"){if(typeof e==="function"){e(t)}}else{s(e);d()}}},stylesheets:function(e){cssHelper.parsed(function(t){e(m.stylesheets||y("stylesheets"))})},mediaQueryLists:function(e){cssHelper.parsed(function(t){e(m.mediaQueryLists||y("mediaQueryLists"))})},rules:function(e){cssHelper.parsed(function(t){e(m.rules||y("rules"))})},selectors:function(e){cssHelper.parsed(function(t){e(m.selectors||y("selectors"))})},declarations:function(e){cssHelper.parsed(function(t){e(m.declarations||y("declarations"))})},properties:function(e){cssHelper.parsed(function(t){e(m.properties||y("properties"))})},broadcast:a,addListener:function(e,t){if(typeof t==="function"){if(!u[e]){u[e]={listeners:[]}}u[e].listeners[u[e].listeners.length]=t}},removeListener:function(e,t){if(typeof t==="function"&&u[e]){var n=u[e].listeners;for(var r=0;r=a||s&&l0}}else if("device-height"===e.substring(r-13,r)){c=screen.height;if(t!==null){if(u==="length"){return i&&c>=a||s&&c0}}else if("width"===e.substring(r-5,r)){l=document.documentElement.clientWidth||document.body.clientWidth;if(t!==null){if(u==="length"){return i&&l>=a||s&&l0}}else if("height"===e.substring(r-6,r)){c=document.documentElement.clientHeight||document.body.clientHeight;if(t!==null){if(u==="length"){return i&&c>=a||s&&c0}}else if("device-aspect-ratio"===e.substring(r-19,r)){return u==="aspect-ratio"&&screen.width*a[1]===screen.height*a[0]}else if("color-index"===e.substring(r-11,r)){var h=Math.pow(2,screen.colorDepth);if(t!==null){if(u==="absolute"){return i&&h>=a||s&&h0}}else if("color"===e.substring(r-5,r)){var p=screen.colorDepth;if(t!==null){if(u==="absolute"){return i&&p>=a||s&&p0}}else if("resolution"===e.substring(r-10,r)){var d;if(f==="dpcm"){d=o("1cm")}else{d=o("1in")}if(t!==null){if(u==="resolution"){return i&&d>=a||s&&d0}}else{return false}};var a=function(e){var t=e.getValid();var n=e.getExpressions();var r=n.length;if(r>0){for(var i=0;i0){u=false;for(var f=0;f0){l[c++]=","}l[c++]=h}}if(l.length>0){r[r.length]=cssHelper.addStyle("@media "+l.join("")+"{"+e.getCssText()+"}",t,false)}};var l=function(e,t){for(var n=0;n0}}var o=[],u=[];for(var f in i){if(i.hasOwnProperty(f)){o[o.length]=f;if(i[f]){u[u.length]=f}if(f==="all"){n=true}}}if(u.length>0){r[r.length]=cssHelper.addStyle(e.getCssText(),u,false)}var c=e.getMediaQueryLists();if(n){l(c)}else{l(c,o)}};var h=function(e){for(var t=0;td||Math.abs(s-t)>d){e=n;t=s;clearTimeout(r);r=setTimeout(function(){if(!i()){p()}else{cssHelper.broadcast("cssMediaQueriesTested")}},500)}};window.onresize=function(){var e=window.onresize||function(){};return function(){e();s()}}()};var m=document.documentElement;m.style.marginLeft="-32767px";setTimeout(function(){m.style.marginLeft=""},5e3);return function(){if(!i()){cssHelper.addListener("newStyleParsed",function(e){c(e.cssHelperParsed.stylesheet)});cssHelper.addListener("cssMediaQueriesTested",function(){if(ua.ie){m.style.width="1px"}setTimeout(function(){m.style.width="";m.style.marginLeft=""},0);cssHelper.removeListener("cssMediaQueriesTested",arguments.callee)});s();p()}else{m.style.marginLeft=""}v()}}());try{document.execCommand("BackgroundImageCache",false,true)}catch(e){} diff --git a/docs/2.29.245/docs/mp/_static/css3-mediaqueries_src.js b/docs/2.29.245/docs/mp/_static/css3-mediaqueries_src.js new file mode 100644 index 0000000..7878620 --- /dev/null +++ b/docs/2.29.245/docs/mp/_static/css3-mediaqueries_src.js @@ -0,0 +1,1104 @@ +/* +css3-mediaqueries.js - CSS Helper and CSS3 Media Queries Enabler + +author: Wouter van der Graaf +version: 1.0 (20110330) +license: MIT +website: http://code.google.com/p/css3-mediaqueries-js/ + +W3C spec: http://www.w3.org/TR/css3-mediaqueries/ + +Note: use of embedded + + + + + +
+

Indices and tables

+ +
+ + +
+ + + + +
+ + + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/lagrangian_relaxation.html b/docs/2.29.245/docs/mp/lagrangian_relaxation.html new file mode 100644 index 0000000..2440e1c --- /dev/null +++ b/docs/2.29.245/docs/mp/lagrangian_relaxation.html @@ -0,0 +1,251 @@ + + + + + + + + + + lagrangian_relaxation.py — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

lagrangian_relaxation.py

+

This example is inspired by an entry on the “adventures in optimization” blog. +The sources of the article can be found here. +This example solves the generalized assignment problem, with or without Lagrangian relaxation.

+
  1# --------------------------------------------------------------------------
+  2# Source file provided under Apache License, Version 2.0, January 2004,
+  3# http://www.apache.org/licenses/
+  4# (c) Copyright IBM Corp. 2015, 2018
+  5# --------------------------------------------------------------------------
+  6
+  7import json
+  8import builtins
+  9
+ 10from docplex.util.environment import get_environment
+ 11from docplex.mp.model import Model
+ 12
+ 13
+ 14# ----------------------------------------------------------------------------
+ 15# Initialize the problem data
+ 16# ----------------------------------------------------------------------------
+ 17B = [15, 15, 15]
+ 18C = [
+ 19    [ 6, 10, 1],
+ 20    [12, 12, 5],
+ 21    [15,  4, 3],
+ 22    [10,  3, 9],
+ 23    [8,   9, 5]
+ 24]
+ 25A = [
+ 26    [ 5,  7,  2],
+ 27    [14,  8,  7],
+ 28    [10,  6, 12],
+ 29    [ 8,  4, 15],
+ 30    [ 6, 12,  5]
+ 31]
+ 32
+ 33
+ 34# ----------------------------------------------------------------------------
+ 35# Build the model
+ 36# ----------------------------------------------------------------------------
+ 37def run_GAP_model(As, Bs, Cs, **kwargs):
+ 38    with Model('GAP per Wolsey -without- Lagrangian Relaxation', **kwargs) as mdl:
+ 39        print("#As={}, #Bs={}, #Cs={}".format(len(As), len(Bs), len(Cs)))
+ 40        number_of_cs = len(C)
+ 41        # variables
+ 42        x_vars = [mdl.binary_var_list(c, name=None) for c in Cs]
+ 43
+ 44        # constraints
+ 45        mdl.add_constraints(mdl.sum(xv) <= 1 for xv in x_vars)
+ 46
+ 47        mdl.add_constraints(mdl.sum(x_vars[ii][j] * As[ii][j] for ii in range(number_of_cs)) <= bs
+ 48                            for j, bs in enumerate(Bs))
+ 49
+ 50        # objective
+ 51        total_profit = mdl.sum(mdl.scal_prod(x_i, c_i) for c_i, x_i in zip(Cs, x_vars))
+ 52        mdl.maximize(total_profit)
+ 53        #  mdl.print_information()
+ 54        s = mdl.solve()
+ 55        assert s is not None
+ 56        obj = s.objective_value
+ 57        print("* GAP with no relaxation run OK, best objective is: {:g}".format(obj))
+ 58    return obj
+ 59
+ 60
+ 61def run_GAP_model_with_Lagrangian_relaxation(As, Bs, Cs, max_iters=101, **kwargs):
+ 62    with Model('GAP per Wolsey -with- Lagrangian Relaxation', **kwargs) as mdl:
+ 63        print("#As={}, #Bs={}, #Cs={}".format(len(As), len(Bs), len(Cs)))
+ 64        number_of_cs = len(Cs)
+ 65        c_range = range(number_of_cs)
+ 66        # variables
+ 67        x_vars = [mdl.binary_var_list(c, name=None) for c in Cs]
+ 68        p_vars = mdl.continuous_var_list(Cs, name='p')  # new for relaxation
+ 69
+ 70        mdl.add_constraints(mdl.sum(xv) == 1 - pv for xv, pv in zip(x_vars, p_vars))
+ 71
+ 72        mdl.add_constraints(mdl.sum(x_vars[ii][j] * As[ii][j] for ii in c_range) <= bs
+ 73                            for j, bs in enumerate(Bs))
+ 74
+ 75        # lagrangian relaxation loop
+ 76        eps = 1e-6
+ 77        loop_count = 0
+ 78        best = 0
+ 79        initial_multiplier = 1
+ 80        multipliers = [initial_multiplier] * len(Cs)
+ 81
+ 82        total_profit = mdl.sum(mdl.scal_prod(x_i, c_i) for c_i, x_i in zip(Cs, x_vars))
+ 83        mdl.add_kpi(total_profit, "Total profit")
+ 84
+ 85        while loop_count <= max_iters:
+ 86            loop_count += 1
+ 87            # rebuilt at each loop iteration
+ 88            total_penalty = mdl.scal_prod(p_vars, multipliers)
+ 89            mdl.maximize(total_profit + total_penalty)
+ 90            s = mdl.solve()
+ 91            if not s:
+ 92                print("*** solve fails, stopping at iteration: %d" % loop_count)
+ 93                break
+ 94            best = s.objective_value
+ 95            penalties = [pv.solution_value for pv in p_vars]
+ 96            print('%d> new lagrangian iteration:\n\t obj=%g, m=%s, p=%s' % (loop_count, best, str(multipliers), str(penalties)))
+ 97
+ 98            do_stop = True
+ 99            justifier = 0
+100            for k in c_range:
+101                penalized_violation = penalties[k] * multipliers[k]
+102                if penalized_violation >= eps:
+103                    do_stop = False
+104                    justifier = penalized_violation
+105                    break
+106
+107            if do_stop:
+108                print("* Lagrangian relaxation succeeds, best={:g}, penalty={:g}, #iterations={}"
+109                      .format(best, total_penalty.solution_value, loop_count))
+110                break
+111            else:
+112                # update multipliers and start loop again.
+113                scale_factor = 1.0 / float(loop_count)
+114                multipliers = [builtins.max(multipliers[i] - scale_factor * penalties[i], 0.) for i in c_range]
+115                print('{0}> -- loop continues, m={1!s}, justifier={2:g}'.format(loop_count, multipliers, justifier))
+116
+117    return best
+118
+119
+120def run_default_GAP_model_with_lagrangian_relaxation(**kwargs):
+121    return run_GAP_model_with_Lagrangian_relaxation(As=A, Bs=B, Cs=C, **kwargs)
+122
+123
+124# ----------------------------------------------------------------------------
+125# Solve the model and display the result
+126# ----------------------------------------------------------------------------
+127if __name__ == '__main__':
+128    # Run the model. If a key has been specified above, the model will run on
+129    # IBM Decision Optimization on cloud.
+130    gap_best_obj = run_GAP_model(A, B, C)
+131    relaxed_best = run_GAP_model_with_Lagrangian_relaxation(A, B, C)
+132    # save the relaxed solution
+133    with get_environment().get_output_stream("solution.json") as fp:
+134        fp.write(json.dumps({"objectiveValue": relaxed_best}).encode('utf-8'))
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/load_balancing.html b/docs/2.29.245/docs/mp/load_balancing.html new file mode 100644 index 0000000..a322420 --- /dev/null +++ b/docs/2.29.245/docs/mp/load_balancing.html @@ -0,0 +1,366 @@ + + + + + + + + + + load_balancing.py — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

load_balancing.py

+

This example looks at cloud load balancing to keep a service running in the cloud at reasonable cost +by reducing the expense of running cloud servers, +minimizing risk and human time due to rebalancing, and doing balance sleeping models across servers.

+

The different KPIs are optimized using multiobjective solve. +This optimization is achieved by the minimize_static_lex() method.

+
  1# --------------------------------------------------------------------------
+  2# Source file provided under Apache License, Version 2.0, January 2004,
+  3# http://www.apache.org/licenses/
+  4# (c) Copyright IBM Corp. 2015, 2018
+  5# --------------------------------------------------------------------------
+  6
+  7# Source: http://blog.yhathq.com/posts/how-yhat-does-cloud-balancing.html
+  8
+  9from collections import namedtuple
+ 10
+ 11from docplex.mp.model import Model
+ 12
+ 13
+ 14# ----------------------------------------------------------------------------
+ 15# Initialize the problem data
+ 16# ----------------------------------------------------------------------------
+ 17class TUser(namedtuple("TUser", ["id", "running", "sleeping", "current_server"])):
+ 18    def __str__(self):
+ 19        return self.id
+ 20
+ 21
+ 22SERVERS = ["server002", "server003", "server001", "server006", "server007", "server004", "server005"]
+ 23
+ 24USERS = [("user013", 2, 1, "server002"),
+ 25         ("user014", 0, 2, "server002"),
+ 26         ("user015", 0, 4, "server002"),
+ 27         ("user016", 1, 4, "server002"),
+ 28         ("user017", 0, 3, "server002"),
+ 29         ("user018", 0, 2, "server002"),
+ 30         ("user019", 0, 2, "server002"),
+ 31         ("user020", 0, 1, "server002"),
+ 32         ("user021", 4, 4, "server002"),
+ 33         ("user022", 0, 1, "server002"),
+ 34         ("user023", 0, 3, "server002"),
+ 35         ("user024", 1, 2, "server002"),
+ 36         ("user025", 0, 1, "server003"),
+ 37         ("user026", 0, 1, "server003"),
+ 38         ("user027", 1, 1, "server003"),
+ 39         ("user028", 0, 1, "server003"),
+ 40         ("user029", 2, 1, "server003"),
+ 41         ("user030", 0, 5, "server003"),
+ 42         ("user031", 0, 2, "server003"),
+ 43         ("user032", 0, 3, "server003"),
+ 44         ("user033", 1, 1, "server003"),
+ 45         ("user034", 0, 1, "server003"),
+ 46         ("user035", 0, 1, "server003"),
+ 47         ("user036", 4, 1, "server003"),
+ 48         ("user037", 7, 1, "server003"),
+ 49         ("user038", 2, 1, "server003"),
+ 50         ("user039", 0, 3, "server003"),
+ 51         ("user040", 1, 2, "server003"),
+ 52         ("user001", 0, 2, "server001"),
+ 53         ("user002", 0, 3, "server001"),
+ 54         ("user003", 5, 4, "server001"),
+ 55         ("user004", 0, 1, "server001"),
+ 56         ("user005", 0, 1, "server001"),
+ 57         ("user006", 0, 2, "server001"),
+ 58         ("user007", 0, 4, "server001"),
+ 59         ("user008", 0, 1, "server001"),
+ 60         ("user009", 5, 1, "server001"),
+ 61         ("user010", 7, 1, "server001"),
+ 62         ("user011", 4, 5, "server001"),
+ 63         ("user012", 0, 4, "server001"),
+ 64         ("user062", 0, 1, "server006"),
+ 65         ("user063", 3, 5, "server006"),
+ 66         ("user064", 0, 1, "server006"),
+ 67         ("user065", 0, 3, "server006"),
+ 68         ("user066", 3, 1, "server006"),
+ 69         ("user067", 0, 1, "server006"),
+ 70         ("user068", 0, 1, "server006"),
+ 71         ("user069", 0, 2, "server006"),
+ 72         ("user070", 3, 2, "server006"),
+ 73         ("user071", 0, 1, "server006"),
+ 74         ("user072", 5, 3, "server006"),
+ 75         ("user073", 0, 1, "server006"),
+ 76         ("user074", 0, 1, "server006"),
+ 77         ("user075", 0, 2, "server007"),
+ 78         ("user076", 1, 1, "server007"),
+ 79         ("user077", 1, 1, "server007"),
+ 80         ("user078", 0, 1, "server007"),
+ 81         ("user079", 0, 3, "server007"),
+ 82         ("user080", 0, 1, "server007"),
+ 83         ("user081", 4, 1, "server007"),
+ 84         ("user082", 1, 1, "server007"),
+ 85         ("user041", 0, 1, "server004"),
+ 86         ("user042", 2, 1, "server004"),
+ 87         ("user043", 5, 2, "server004"),
+ 88         ("user044", 5, 2, "server004"),
+ 89         ("user045", 0, 2, "server004"),
+ 90         ("user046", 1, 5, "server004"),
+ 91         ("user047", 0, 1, "server004"),
+ 92         ("user048", 0, 3, "server004"),
+ 93         ("user049", 5, 1, "server004"),
+ 94         ("user050", 0, 2, "server004"),
+ 95         ("user051", 0, 3, "server004"),
+ 96         ("user052", 0, 3, "server004"),
+ 97         ("user053", 0, 1, "server004"),
+ 98         ("user054", 0, 2, "server004"),
+ 99         ("user055", 0, 3, "server005"),
+100         ("user056", 3, 1, "server005"),
+101         ("user057", 0, 3, "server005"),
+102         ("user058", 0, 2, "server005"),
+103         ("user059", 0, 1, "server005"),
+104         ("user060", 0, 5, "server005"),
+105         ("user061", 0, 2, "server005")
+106         ]
+107
+108# ----------------------------------------------------------------------------
+109# Prepare the data for modeling
+110# ----------------------------------------------------------------------------
+111DEFAULT_MAX_PROCESSES_PER_SERVER = 50
+112
+113
+114def _is_migration(user, server):
+115    """ Returns True if server is not the user's current
+116        Used in setup of constraints.
+117    """
+118    return server != user.current_server
+119
+120
+121# ----------------------------------------------------------------------------
+122# Build the model
+123# ----------------------------------------------------------------------------
+124
+125def build_load_balancing_model(servers, users_, max_process_per_server=DEFAULT_MAX_PROCESSES_PER_SERVER, **kwargs):
+126    m = Model(name='load_balancing', **kwargs)
+127
+128    # decision objects
+129
+130    users = [TUser(*user_row) for user_row in users_]
+131
+132    active_var_by_server = m.binary_var_dict(servers, name='isActive')
+133
+134    def user_server_pair_namer(u_s):
+135        u, s = u_s
+136        return '%s_to_%s' % (u.id, s)
+137
+138    assign_user_to_server_vars = m.binary_var_matrix(users, servers, user_server_pair_namer)
+139
+140    m.add_constraints(
+141        m.sum(assign_user_to_server_vars[u, s] * u.running for u in users) <= max_process_per_server for s in servers)
+142    # each assignment var <u, s>  is <= active_server(s)
+143    for s in servers:
+144        for u in users:
+145            ct_name = 'ct_assign_to_active_{0!s}_{1!s}'.format(u, s)
+146            m.add_constraint(assign_user_to_server_vars[u, s] <= active_var_by_server[s], ct_name)
+147
+148        # sum of assignment vars for (u, all s in servers) == 1
+149        for u in users:
+150            ct_name = 'ct_unique_server_%s' % (u[0])
+151            m.add_constraint(m.sum((assign_user_to_server_vars[u, s] for s in servers)) == 1, ct_name)
+152
+153    number_of_active_servers = m.sum((active_var_by_server[svr] for svr in servers))
+154    m.add_kpi(number_of_active_servers, "Number of active servers")
+155
+156    number_of_migrations = m.sum(
+157        assign_user_to_server_vars[u, s] for u in users for s in servers if
+158        _is_migration(u, s))
+159    m.add_kpi(number_of_migrations, "Total number of migrations")
+160
+161    max_sleeping_workload = m.integer_var(name="max_sleeping_processes")
+162    for s in servers:
+163        ct_name = 'ct_define_max_sleeping_%s' % s
+164        m.add_constraint(
+165            m.sum(
+166                assign_user_to_server_vars[u, s] * u.sleeping for u in users) <= max_sleeping_workload,
+167            ct_name)
+168    m.add_kpi(max_sleeping_workload, "Max sleeping workload")
+169    # Set objective function
+170    # m.minimize(number_of_active_servers)
+171    m.minimize_static_lex([number_of_active_servers, number_of_migrations, max_sleeping_workload])
+172
+173    # attach artefacts to model for reporting
+174    m.users = users
+175    m.servers = servers
+176    m.active_var_by_server = active_var_by_server
+177    m.assign_user_to_server_vars = assign_user_to_server_vars
+178    m.max_sleeping_workload = max_sleeping_workload
+179
+180    return m
+181
+182
+183def lb_report(mdl):
+184    active_servers = sorted([s for s in mdl.servers if mdl.active_var_by_server[s].solution_value == 1])
+185    print("Active Servers: {0} = {1}".format(len(active_servers), active_servers))
+186    print("*** User/server assignments , #migrations={0} ***".format(
+187        mdl.kpi_by_name("number of migrations").solution_value))
+188    # for (u, s) in sorted(mdl.assign_user_to_server_vars):
+189    #     if mdl.assign_user_to_server_vars[(u, s)].solution_value == 1:
+190    #         print("{} uses {}, migration: {}".format(u, s, "yes" if _is_migration(u, s) else "no"))
+191    print("*** Servers sleeping processes ***")
+192    for s in active_servers:
+193        sleeping = sum(mdl.assign_user_to_server_vars[u, s].solution_value * u.sleeping for u in mdl.users)
+194        print("Server: {} #sleeping={}".format(s, sleeping))
+195
+196
+197def make_default_load_balancing_model(**kwargs):
+198    return build_load_balancing_model(SERVERS, USERS, **kwargs)
+199
+200
+201def lb_save_solution_as_json(mdl, json_file):
+202    """Saves the solution for this model as JSON.
+203
+204    Note that this is not a CPLEX Solution file, as this is the result of post-processing a CPLEX solution
+205    """
+206    import json
+207    solution_dict = {}
+208    # active server
+209    active_servers = sorted([s for s in mdl.servers if mdl.active_var_by_server[s].solution_value == 1])
+210    solution_dict["active servers"] = active_servers
+211
+212    # sleeping processes by server
+213    sleeping_processes = {}
+214    for s in active_servers:
+215        sleeping = sum(mdl.assign_user_to_server_vars[u, s].solution_value * u.sleeping for u in mdl.users)
+216        sleeping_processes[s] = sleeping
+217    solution_dict["sleeping processes by server"] = sleeping_processes
+218
+219# user assignment
+220    user_assignment = []
+221    for (u, s) in sorted(mdl.assign_user_to_server_vars):
+222        if mdl.assign_user_to_server_vars[(u, s)].solution_value == 1:
+223            n = {
+224                'user': u.id,
+225                'server': s,
+226                'migration': "yes" if _is_migration(u, s) else "no"
+227            }
+228            user_assignment.append(n)
+229    solution_dict['user assignment'] = user_assignment
+230    json_file.write(json.dumps(solution_dict, indent=3).encode('utf-8'))
+231
+232# ----------------------------------------------------------------------------
+233# Solve the model and display the result
+234# ----------------------------------------------------------------------------
+235
+236if __name__ == '__main__':
+237    lbm = make_default_load_balancing_model()
+238
+239    # Run the model.
+240    lbs = lbm.solve(log_output=True)
+241    lb_report(lbm)
+242    # save json, used in worker tests
+243    from docplex.util.environment import get_environment
+244    with get_environment().get_output_stream("solution.json") as fp:
+245        lb_save_solution_as_json(lbm, fp)
+246    lbm.end()
+247
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/marketing_campaign.html b/docs/2.29.245/docs/mp/marketing_campaign.html new file mode 100644 index 0000000..262e212 --- /dev/null +++ b/docs/2.29.245/docs/mp/marketing_campaign.html @@ -0,0 +1,976 @@ + + + + + + + + + + How to make targeted offers to customers? — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

How to make targeted offers to customers?

+

This tutorial includes everything you need to set up IBM Decision +Optimization CPLEX Modeling for Python (DOcplex), build a Mathematical +Programming model, and get its solution by solving the model with IBM +ILOG CPLEX Optimizer.

+

When you finish this tutorial, you’ll have a foundational knowledge of +Prescriptive Analytics.

+
+

This notebook is part of Prescriptive Analytics for +Python

+

It requires either an installation of CPLEX +Optimizers +or it can be run on IBM Watson Studio +Cloud (Sign up for a +free IBM Cloud +account +and you can start using Watson Studio Cloud right away).

+
+

Table of contents:

+ +
+

Describe the business problem

+
    +

  • The Self-Learning Response Model (SLRM) node enables you to build a +model that you can continually update. Such updates are useful in +building a model that assists with predicting which offers are most +appropriate for customers and the probability of the offers being +accepted. These sorts of models are most beneficial in customer +relationship management, such as marketing applications or call +centers.

    • +

  • This example is based on a fictional banking company.

    • +

  • The marketing department wants to achieve more profitable results in +future campaigns by matching the right offer of financial services to +each customer.

    • +

  • Specifically, the datascience department identified the +characteristics of customers who are most likely to respond favorably +based on previous offers and responses and to promote the best +current offer based on the results and now need to compute the best +offerig plan.

    • +
+

A set of business constraints have to be respected:

+
    +

  • We have a limited budget to run a marketing campaign based on +“gifts”, “newsletter”, “seminar”.

    • +

  • We want to determine which is the best way to contact the customers.

    • +

  • We need to identify which customers to contact.

    • +
+
+
+

How decision optimization can help

+
    +

  • Prescriptive analytics technology recommends actions based on desired +outcomes, taking into account specific scenarios, resources, and +knowledge of past and current events. This insight can help your +organization make better decisions and have greater control of +business outcomes.

    • +

  • Prescriptive analytics is the next step on the path to insight-based +actions. It creates value through synergy with predictive analytics, +which analyzes data to predict future outcomes.

    • +
  • +
    Prescriptive analytics takes that insight to the next level by +suggesting the optimal way to handle that future situation. +Organizations that can act fast in dynamic conditions and make +superior decisions in uncertain environments gain a strong +competitive advantage.
    +

    +
    +
    • +

  • For example:

    +
      +

    • Automate complex decisions and trade-offs to better manage limited +resources.

      • +

    • Take advantage of a future opportunity or mitigate a future risk.

      • +

    • Proactively update recommendations based on changing events.

      • +

    • Meet operational goals, increase customer loyalty, prevent threats +and fraud, and optimize business processes.

      • +
    +
    • +
+
+
+

Prepare the data

+

The predictions show which offers a customer is most likely to accept, +and the confidence that they will accept, depending on each customer’s +details.

+

For example: (139987, “Pension”, 0.13221, “Mortgage”, 0.10675) indicates +that customer Id=139987 will certainly not buy a Pension as the level +is only 13.2%, whereas (140030, “Savings”, 0.95678, “Pension”, 0.84446) +is more than likely to buy Savings and a Pension as the rates are +95.7% and 84.4%.

+

This data is taken from a SPSS example, except that the names of the +customers were modified.

+

A Python data analysis library, pandas, +is used to store the data. Let’s set up and declare the data.

+
import pandas as pd
+
+names = {
+    139987 : "Guadalupe J. Martinez", 140030 : "Michelle M. Lopez", 140089 : "Terry L. Ridgley",
+    140097 : "Miranda B. Roush", 139068 : "Sandra J. Wynkoop", 139154 : "Roland Gu�rette", 139158 : "Fabien Mailhot",
+    139169 : "Christian Austerlitz", 139220 : "Steffen Meister", 139261 : "Wolfgang Sanger",
+    139416 : "Lee Tsou", 139422 : "Sanaa' Hikmah Hakimi", 139532 : "Miroslav Skaroupka",
+    139549 : "George Blomqvist", 139560 : "Will Henderson", 139577 : "Yuina Ohira", 139580 : "Vlad Alekseeva",
+    139636 : "Cassio Lombardo", 139647 : "Trinity Zelaya Miramontes", 139649 : "Eldar Muravyov", 139665 : "Shu T'an",
+    139667 : "Jameel Abdul-Ghani Gerges", 139696 : "Zeeb Longoria Marrero", 139752 : "Matheus Azevedo Melo",
+    139832 : "Earl B. Wood", 139859 : "Gabrielly Sousa Martins", 139881 : "Franca Palermo"}
+
+
+data = [(139987, "Pension", 0.13221, "Mortgage", 0.10675), (140030, "Savings", 0.95678, "Pension", 0.84446), (140089, "Savings", 0.95678, "Pension", 0.80233),
+                        (140097, "Pension", 0.13221, "Mortgage", 0.10675), (139068, "Pension", 0.80506, "Savings", 0.28391), (139154, "Pension", 0.13221, "Mortgage", 0.10675),
+                        (139158, "Pension", 0.13221, "Mortgage", 0.10675),(139169, "Pension", 0.13221, "Mortgage", 0.10675), (139220, "Pension", 0.13221, "Mortgage", 0.10675),
+                        (139261, "Pension", 0.13221, "Mortgage", 0.10675), (139416, "Pension", 0.13221, "Mortgage", 0.10675), (139422, "Pension", 0.13221, "Mortgage", 0.10675),
+                        (139532, "Savings", 0.95676, "Mortgage", 0.82269), (139549, "Savings", 0.16428, "Pension", 0.13221), (139560, "Savings", 0.95678, "Pension", 0.86779),
+                        (139577, "Pension", 0.13225, "Mortgage", 0.10675), (139580, "Pension", 0.13221, "Mortgage", 0.10675), (139636, "Pension", 0.13221, "Mortgage", 0.10675),
+                        (139647, "Savings", 0.28934, "Pension", 0.13221), (139649, "Pension", 0.13221, "Mortgage", 0.10675), (139665, "Savings", 0.95675, "Pension", 0.27248),
+                        (139667, "Pension", 0.13221, "Mortgage", 0.10675), (139696, "Savings", 0.16188, "Pension", 0.13221), (139752, "Pension", 0.13221, "Mortgage", 0.10675),
+                        (139832, "Savings", 0.95678, "Pension", 0.83426), (139859, "Savings", 0.95678, "Pension", 0.75925), (139881, "Pension", 0.13221, "Mortgage", 0.10675)]
+
+products = ["Car loan", "Savings", "Mortgage", "Pension"]
+productValue = [100, 200, 300, 400]
+budgetShare = [0.6, 0.1, 0.2, 0.1]
+
+availableBudget = 500
+channels =  pd.DataFrame(data=[("gift", 20.0, 0.20), ("newsletter", 15.0, 0.05), ("seminar", 23.0, 0.30)], columns=["name", "cost", "factor"])
+
+
+

Offers are stored in a pandas +DataFrame.

+
try: # Python 2
+    offers = pd.DataFrame(data=data, index=xrange(0, len(data)), columns=["customerid", "Product1", "Confidence1", "Product2", "Confidence2"])
+except: # Python 3
+    offers = pd.DataFrame(data=data, index=range(0, len(data)), columns=["customerid", "Product1", "Confidence1", "Product2", "Confidence2"])
+offers.insert(0,'name',pd.Series(names[i[0]] for i in data))
+
+
+

Let’s customize the display of this data and show the confidence +forecast for each customer.

+
CSS = """
+body {
+    margin: 0;
+    font-family: Helvetica;
+}
+table.dataframe {
+    border-collapse: collapse;
+    border: none;
+}
+table.dataframe tr {
+    border: none;
+}
+table.dataframe td, table.dataframe th {
+    margin: 0;
+    border: 1px solid white;
+    padding-left: 0.25em;
+    padding-right: 0.25em;
+}
+table.dataframe th:not(:empty) {
+    background-color: #fec;
+    text-align: left;
+    font-weight: normal;
+}
+table.dataframe tr:nth-child(2) th:empty {
+    border-left: none;
+    border-right: 1px dashed #888;
+}
+table.dataframe td {
+    border: 2px solid #ccf;
+    background-color: #f4f4ff;
+}
+    table.dataframe thead th:first-child {
+        display: none;
+    }
+    table.dataframe tbody th {
+        display: none;
+    }
+"""
+
+
+
from IPython.core.display import HTML
+HTML('<style>{}</style>'.format(CSS))
+
+from IPython.display import display
+try:
+    display(offers.drop('customerid',axis=1).sort_values(by='name')) #Pandas >= 0.17
+except:
+    display(offers.drop('customerid',axis=1).sort('name')) #Pandas < 0.17
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nameProduct1Confidence1Product2Confidence2
17Cassio LombardoPension0.13221Mortgage0.10675
7Christian AusterlitzPension0.13221Mortgage0.10675
24Earl B. WoodSavings0.95678Pension0.83426
19Eldar MuravyovPension0.13221Mortgage0.10675
6Fabien MailhotPension0.13221Mortgage0.10675
26Franca PalermoPension0.13221Mortgage0.10675
25Gabrielly Sousa MartinsSavings0.95678Pension0.75925
13George BlomqvistSavings0.16428Pension0.13221
0Guadalupe J. MartinezPension0.13221Mortgage0.10675
21Jameel Abdul-Ghani GergesPension0.13221Mortgage0.10675
10Lee TsouPension0.13221Mortgage0.10675
23Matheus Azevedo MeloPension0.13221Mortgage0.10675
1Michelle M. LopezSavings0.95678Pension0.84446
3Miranda B. RoushPension0.13221Mortgage0.10675
12Miroslav SkaroupkaSavings0.95676Mortgage0.82269
5Roland Gu�rettePension0.13221Mortgage0.10675
11Sanaa' Hikmah HakimiPension0.13221Mortgage0.10675
4Sandra J. WynkoopPension0.80506Savings0.28391
20Shu T'anSavings0.95675Pension0.27248
8Steffen MeisterPension0.13221Mortgage0.10675
2Terry L. RidgleySavings0.95678Pension0.80233
18Trinity Zelaya MiramontesSavings0.28934Pension0.13221
16Vlad AlekseevaPension0.13221Mortgage0.10675
14Will HendersonSavings0.95678Pension0.86779
9Wolfgang SangerPension0.13221Mortgage0.10675
15Yuina OhiraPension0.13225Mortgage0.10675
22Zeeb Longoria MarreroSavings0.16188Pension0.13221
+
+
+

Use IBM Decision Optimization CPLEX Modeling for Python

+

Let’s create the optimization model to select the best ways to contact +customers and stay within the limited budget.

+
+

Step 1: Import the library

+

Run the following code to import the Decision Optimization CPLEX +Modeling library. The DOcplex library contains the two modeling +packages, Mathematical Programming (docplex.mp) and Constraint +Programming (docplex.cp).

+
import sys
+try:
+    import docplex.mp
+except:
+    raise Exception('Please install docplex. See https://pypi.org/project/docplex/')
+
+
+

If cplex is not installed, install CPLEX Community edition.

+
try:
+    import cplex
+except:
+    raise Exception('Please install CPLEX. See https://pypi.org/project/cplex/')
+
+
+
+
+

Step 2: Set up the prescriptive model

+
+

Create the model

+
from docplex.mp.model import Model
+
+mdl = Model(name="marketing_campaign")
+
+
+
+
+

Define the decision variables

+
    +

  • The integer decision variables channelVars, represent whether or +not a customer will be made an offer for a particular product via a +particular channel.

    • +

  • The integer decision variable totaloffers represents the total +number of offers made.

    • +

  • The continuous variable budgetSpent represents the total cost of +the offers made.

    • +
+
try: # Python 2
+    offersR = xrange(0, len(offers))
+    productsR = xrange(0, len(products))
+    channelsR = xrange(0, len(channels))
+except: # Python 3
+    offersR = range(0, len(offers))
+    productsR = range(0, len(products))
+    channelsR = range(0, len(channels))
+
+channelVars = mdl.binary_var_cube(offersR, productsR, channelsR)
+totaloffers = mdl.integer_var(lb=0)
+budgetSpent = mdl.continuous_var()
+
+
+
+
+

Set up the constraints

+
    +

  • Offer only one product per customer.

    • +

  • Compute the budget and set a maximum on it.

    • +

  • Compute the number of offers to be made.

    • +
+
# Only 1 product is offered to each customer
+mdl.add_constraints( mdl.sum(channelVars[o,p,c] for p in productsR for c in channelsR) <=1
+                   for o in offersR)
+
+mdl.add_constraint( totaloffers == mdl.sum(channelVars[o,p,c]
+                                           for o in offersR
+                                           for p in productsR
+                                           for c in channelsR) )
+
+mdl.add_constraint( budgetSpent == mdl.sum(channelVars[o,p,c]*channels.at[c, "cost"]
+                                           for o in offersR
+                                           for p in productsR
+                                           for c in channelsR) )
+
+# Balance the offers among products
+for p in productsR:
+    mdl.add_constraint( mdl.sum(channelVars[o,p,c] for o in offersR for c in channelsR)
+                       <= budgetShare[p] * totaloffers )
+
+# Do not exceed the budget
+mdl.add_constraint( mdl.sum(channelVars[o,p,c]*channels.at[c, "cost"]
+                            for o in offersR
+                            for p in productsR
+                            for c in channelsR)  <= availableBudget )
+
+mdl.print_information()
+
+
+
Model: marketing_campaign
+ - number of variables: 326
+   - binary=324, integer=1, continuous=1
+ - number of constraints: 34
+   - linear=34
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+

Express the objective

+

We want to maximize the expected revenue.

+
mdl.maximize(
+    mdl.sum( channelVars[idx,p,idx2] * c.factor * productValue[p]* o.Confidence1
+            for p in productsR
+            for idx,o in offers[offers['Product1'] == products[p]].iterrows()
+            for idx2, c in channels.iterrows())
+    +
+    mdl.sum( channelVars[idx,p,idx2] * c.factor * productValue[p]* o.Confidence2
+            for p in productsR
+            for idx,o in offers[offers['Product2'] == products[p]].iterrows()
+            for idx2, c in channels.iterrows())
+    )
+
+
+
+
+

Solve the model

+

If you’re using a Community Edition of CPLEX runtimes, depending on the +size of the problem, the solve stage may fail and will need a paying +subscription or product installation.

+
s = mdl.solve()
+assert s, "No Solution !!!"
+
+
+
+
+
+

Step 3: Analyze the solution

+

First, let’s display the Optimal Marketing Channel per customer.

+
report = [(channels.at[c, "name"], products[p], names[offers.at[o, "customerid"]])
+          for c in channelsR
+          for p in productsR
+          for o in offersR  if channelVars[o,p,c].solution_value==1]
+
+assert len(report) == totaloffers.solution_value
+
+print("Marketing plan has {0} offers costing {1}".format(totaloffers.solution_value, budgetSpent.solution_value))
+
+report_bd = pd.DataFrame(report, columns=['channel', 'product', 'customer'])
+display(report_bd)
+
+
+
Marketing plan has 20 offers costing 364.0
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
channelproductcustomer
0newsletterCar loanFabien Mailhot
1newsletterCar loanChristian Austerlitz
2newsletterCar loanLee Tsou
3newsletterCar loanSanaa' Hikmah Hakimi
4newsletterCar loanGeorge Blomqvist
5newsletterCar loanYuina Ohira
6newsletterCar loanVlad Alekseeva
7newsletterCar loanCassio Lombardo
8newsletterCar loanTrinity Zelaya Miramontes
9newsletterCar loanEldar Muravyov
10newsletterCar loanJameel Abdul-Ghani Gerges
11newsletterCar loanZeeb Longoria Marrero
12seminarSavingsTerry L. Ridgley
13seminarSavingsGabrielly Sousa Martins
14seminarMortgageMiranda B. Roush
15seminarMortgageMiroslav Skaroupka
16seminarMortgageMatheus Azevedo Melo
17seminarMortgageFranca Palermo
18seminarPensionMichelle M. Lopez
19seminarPensionWill Henderson
+

Then let’s focus on seminar.

+
display(report_bd[report_bd['channel'] == "seminar"].drop('channel',axis=1))
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
productcustomer
12SavingsTerry L. Ridgley
13SavingsGabrielly Sousa Martins
14MortgageMiranda B. Roush
15MortgageMiroslav Skaroupka
16MortgageMatheus Azevedo Melo
17MortgageFranca Palermo
18PensionMichelle M. Lopez
19PensionWill Henderson
+
+
+
+

Summary

+

You learned how to set up and use IBM Decision Optimization CPLEX +Modeling for Python to formulate a Mathematical Programming model and +solve it with CPLEX.

+
+
+

References

+ +

Copyright � 2017-2019 IBM. IPLA licensed Sample Materials.

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/mining_pandas.html b/docs/2.29.245/docs/mp/mining_pandas.html new file mode 100644 index 0000000..0f6ae6a --- /dev/null +++ b/docs/2.29.245/docs/mp/mining_pandas.html @@ -0,0 +1,1266 @@ + + + + + + + + + + Optimizing mining operations — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Optimizing mining operations

+

This tutorial includes everything you need to set up IBM Decision +Optimization CPLEX Modeling for Python (DOcplex), build a Mathematical +Programming model, and get its solution by solving the model on Cloud +with IBM ILOG CPLEX Optimizer.

+

When you finish this tutorial, you’ll have a foundational knowledge of +Prescriptive Analytics.

+
+

This notebook is part of Prescriptive Analytics for +Python

+

It requires either an installation of CPLEX +Optimizers +or it can be run on IBM Watson Studio +Cloud (Sign up for a +free IBM Cloud +account +and you can start using Watson Studio Cloud right away).

+
+

Table of contents:

+ +
+
+

Describe the business problem

+

This mining operations optimization problem is an implementation of +Problem 7 from “Model Building in Mathematical Programming” by H.P. +Williams. The operational decisions that need to be made are which mines +should be operated each year and how much each mine should produce.

+
+

Business constraints

+
    +

  • A mine that is closed cannot be worked.

    • +

  • Once closed, a mine stays closed until the end of the horizon.

    • +

  • Each year, a maximum number of mines can be worked.

    • +

  • For each mine and year, the quantity extracted is limited by the +mine’s maximum extracted quantity.

    • +

  • The average blend quality must be greater than or equal to the +requirement of the year.

    • +
+
+
+

Objective and KPIs

+
+

Total actualized revenue

+

Each year, the total revenue is equal to the total quantity extracted +multiplied by the blend price. The time series of revenues is aggregated +in one expected revenue by applying the discount rate; in other terms, a +revenue of $1000 next year is counted as $900 actualized, $810 if the +revenue is expected in two years, etc.

+
+
+

Total expected royalties

+

A mine that stays open must pay royalties (see the column royalties +in the DataFrame). Again, royalties from different years are actualized +using the discount rate.

+
+
+

Business objective

+

The business objective is to maximize the net actualized profit, that is +the difference between the total actualized revenue and total actualized +royalties.

+
+
+
+
+

How decision optimization can help

+
    +

  • Prescriptive analytics (decision optimization) technology recommends +actions that are based on desired outcomes. It takes into account +specific scenarios, resources, and knowledge of past and current +events. With this insight, your organization can make better +decisions and have greater control of business outcomes.

    • +

  • Prescriptive analytics is the next step on the path to insight-based +actions. It creates value through synergy with predictive analytics, +which analyzes data to predict future outcomes.

    • +
  • +
    Prescriptive analytics takes that insight to the next level by +suggesting the optimal way to handle that future situation. +Organizations that can act fast in dynamic conditions and make +superior decisions in uncertain environments gain a strong +competitive advantage.
    +

    +
    +
    • +
+

With prescriptive analytics, you can:

+
    +

  • Automate the complex decisions and trade-offs to better manage your +limited resources.

    • +

  • Take advantage of a future opportunity or mitigate a future risk.

    • +

  • Proactively update recommendations based on changing events.

    • +

  • Meet operational goals, increase customer loyalty, prevent threats +and fraud, and optimize business processes.

    • +
+
+
+

Checking minimum requirements

+

This notebook uses some features of pandas that are available in version +0.17.1 or above.

+
import pip
+REQUIRED_MINIMUM_PANDAS_VERSION = '0.17.1'
+try:
+    import pandas as pd
+    assert pd.__version__ >= REQUIRED_MINIMUM_PANDAS_VERSION
+except:
+    raise Exception("Version %s or above of Pandas is required to run this notebook" % REQUIRED_MINIMUM_PANDAS_VERSION)
+
+
+
+
+

Use decision optimization

+
+

Step 1: Import the library

+

Run the following code to import the Decision Optimization CPLEX +Modeling library. The DOcplex library contains the two modeling +packages, Mathematical Programming and Constraint Programming, referred +to earlier.

+
import sys
+try:
+    import docplex.mp
+except:
+    raise Exception('Please install docplex. See https://pypi.org/project/docplex/')
+
+
+

If CPLEX is not installed, install CPLEX Community edition.

+
try:
+    import cplex
+except:
+    raise Exception('Please install CPLEX. See https://pypi.org/project/cplex/')
+
+
+
+
+

Step 2: Model the data

+
+

Mining Data

+

The mine data is provided as a pandas DataFrame. For each mine, we are +given the amount of royalty to pay when operating the mine, its ore +quality, and the maximum quantity that we can extract from the mine.

+
# If needed, install the module pandas prior to executing this cell
+import pandas as pd
+from pandas import DataFrame, Series
+
+
+
df_mines = DataFrame({"royalties":   [ 5  ,   4,   4, 5  ],
+                      "ore_quality": [ 1.0, 0.7, 1.5, 0.5],
+                      "max_extract": [ 2  , 2.5, 1.3, 3  ]})
+nb_mines = len(df_mines)
+df_mines.index.name='range_mines'
+df_mines
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
royaltiesore_qualitymax_extract
range_mines
051.02.0
140.72.5
241.51.3
350.53.0
+
+
+

Blend quality data

+

Each year, the average blend quality of all ore extracted from the mines +must be greater than a minimum quality. This data is provided as a +pandas Series, the length of which is the plan horizon in years.

+
blend_qualities = Series([0.9, 0.8, 1.2, 0.6, 1.0])
+nb_years = len(blend_qualities)
+print("* Planning mining operations for: {} years".format(nb_years))
+blend_qualities.describe()
+
+
+
* Planning mining operations for: 5 years
+
+
+
count    5.000000
+mean     0.900000
+std      0.223607
+min      0.600000
+25%      0.800000
+50%      0.900000
+75%      1.000000
+max      1.200000
+dtype: float64
+
+
+
+
+

Additional (global) data

+

We need extra global data to run our planning model:

+
    +

  • a blend price (supposedly flat),

    • +

  • a maximum number of worked mines for any given years (typically 3), +and

    • +

  • a discount rate to compute the actualized revenue over the horizon.

    • +
+
# global data
+blend_price = 10
+max_worked_mines = 3  # work no more than 3 mines each year
+discount_rate = 0.10  # 10% interest rate each year
+
+
+
+
+
+

Step 3: Prepare the data

+

The data is clean and does not need any cleansing.

+
+
+

Step 4: Set up the prescriptive model

+
from docplex.mp.environment import Environment
+env = Environment()
+env.print_information()
+
+
+
* system is: Windows 64bit
+* Python version 3.7.3, located at: c:\local\python373\python.exe
+* docplex is present, version is (2, 11, 0)
+* pandas is present, version is 0.25.1
+
+

Create DOcplex model

+

The model contains all the business constraints and defines the +objective.

+
from docplex.mp.model import Model
+
+mm = Model("mining_pandas")
+
+
+

What are the decisions we need to make?

+
    +

  • What mines do we work each year? (a yes/no decision)

    • +

  • What mine do we keep open each year? (again a yes/no decision)

    • +

  • What quantity is extracted from each mine, each year? (a positive +number)

    • +
+

We need to define some decision variables and add constraints to our +model related to these decisions.

+
+
+

Define the decision variables

+
# auxiliary data: ranges
+range_mines = range(nb_mines)
+range_years = range(nb_years)
+
+# binary decisions: work the mine or not
+work_vars  = mm.binary_var_matrix(keys1=range_mines, keys2=range_years, name='work')
+# open the mine or not
+open_vars  = mm.binary_var_matrix(range_mines, range_years, name='open')
+# quantity to extract
+ore_vars   = mm.continuous_var_matrix(range_mines, range_years, name='ore')
+mm.print_information()
+
+
+
Model: mining_pandas
+ - number of variables: 60
+   - binary=40, integer=0, continuous=20
+ - number of constraints: 0
+   - linear=0
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+

Express the business constraints

+
+
Constraint 1: Only open mines can be worked.
+

In order to take advantage of the pandas operations to create the +optimization model, decision variables are organized in a DataFrame +which is automatically indexed by ‘range_mines’ and ‘range_years’ +(that is, the same keys as the dictionary created by the +binary_var_matrix() method).

+
# Organize all decision variables in a DataFrame indexed by 'range_mines' and 'range_years'
+df_decision_vars = DataFrame({'work': work_vars, 'open': open_vars, 'ore': ore_vars})
+# Set index names
+df_decision_vars.index.names=['range_mines', 'range_years']
+
+# Display rows of 'df_decision_vars' DataFrame for first mine
+df_decision_vars[:nb_years]
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
workopenore
range_minesrange_years
00work_0_0open_0_0ore_0_0
1work_0_1open_0_1ore_0_1
2work_0_2open_0_2ore_0_2
3work_0_3open_0_3ore_0_3
4work_0_4open_0_4ore_0_4
+

Now, let’s iterate over rows of the DataFrame “df_decision_vars” and +enforce the desired constraints.

+

The pandas method itertuples() returns a named tuple for each row of +a DataFrame. This method is efficient and convenient for iterating over +all rows.

+
mm.add_constraints(t.work <= t.open for t in df_decision_vars.itertuples())
+mm.print_information()
+
+
+
Model: mining_pandas
+ - number of variables: 60
+   - binary=40, integer=0, continuous=20
+ - number of constraints: 20
+   - linear=20
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Constraint 2: Once closed, a mine stays closed.
+

These constraints are a little more complex: we state that the series of +open_vars[m,y] for a given mine m is decreasing. In other terms, +once some open_vars[m,y] is zero, all subsequent values for future +years are also zero.

+

Let’s use the pandas groupby operation to collect all “open” +decision variables for each mine in separate pandas Series. Then, we +iterate over the mines and invoke the aggregate() method, passing the +postOpenCloseConstraint() function as the argument. The pandas +aggregate() method invokes postOpenCloseConstraint() for each mine, +passing the associated Series of “open” decision variables as +argument. The postOpenCloseConstraint() function posts a set of +constraints on the sequence of “open” decision variables to enforce +that a mine cannot re-open.

+
# Once closed, a mine stays closed
+def postOpenCloseConstraint(open_vars):
+    mm.add_constraints(open_next <= open_curr
+                      for (open_next, open_curr) in zip(open_vars[1:], open_vars))
+    # Optionally: return a string to display information regarding the aggregate operation in the Output cell
+    return "posted {0} open/close constraints".format(len(open_vars) - 1)
+
+# Constraints on sequences of decision variables are posted for each mine,
+# using pandas' "groupby" operation.
+df_decision_vars.open.groupby(level='range_mines').aggregate(postOpenCloseConstraint)
+
+
+
range_mines
+0    posted 4 open/close constraints
+1    posted 4 open/close constraints
+2    posted 4 open/close constraints
+3    posted 4 open/close constraints
+Name: open, dtype: object
+
+
+
+
+
Constraint 3: The number of worked mines each year is limited.
+

This time, we use the pandas groupby operation to collect all +“work” decision variables for each year in separate pandas +Series. Each Series contains the “work” decision variables for all +mines. Then, the maximum number of worked mines constraint is enforced +by making sure that the sum of all the terms of each Series is smaller +or equal to the maximum number of worked mines. The aggregate() method +is used to post this constraint for each year.

+
# Maximum number of worked mines each year
+# Note that Model.sum() accepts a pandas Series of variables.
+df_decision_vars.work.groupby(level='range_years').aggregate(
+    lambda works: mm.add_constraint(mm.sum(works) <= max_worked_mines))
+
+
+
range_years
+0    work_0_0+work_1_0+work_2_0+work_3_0 <= 3
+1    work_0_1+work_1_1+work_2_1+work_3_1 <= 3
+2    work_0_2+work_1_2+work_2_2+work_3_2 <= 3
+3    work_0_3+work_1_3+work_2_3+work_3_3 <= 3
+4    work_0_4+work_1_4+work_2_4+work_3_4 <= 3
+Name: work, dtype: object
+
+
+
+
+
Constraint 4: The quantity extracted is limited.
+

This constraint expresses two things: * Only a worked mine can give +ore. (Note that there is no minimum on the quantity extracted, this +model is very simplified). * The quantity extracted is less than the +mine’s maximum extracted quantity.

+

To illustrate the pandas join operation, let’s build a DataFrame +that joins the “df_decision_vars” DataFrame and the +“df_mines.max_extract” Series such that each row contains the +information to enforce the quantity extracted limit constraint. The +default behaviour of the pandas join operation is to look at the +index of left DataFrame and to append columns of the right Series or +DataFrame which have same index. Here is the result of this operation in +our case:

+
# Display rows of 'df_decision_vars' joined with 'df_mines.max_extract' Series for first two mines
+df_decision_vars.join(df_mines.max_extract)[:(nb_years * 2)]
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
workopenoremax_extract
range_minesrange_years
00work_0_0open_0_0ore_0_02.0
1work_0_1open_0_1ore_0_12.0
2work_0_2open_0_2ore_0_22.0
3work_0_3open_0_3ore_0_32.0
4work_0_4open_0_4ore_0_42.0
10work_1_0open_1_0ore_1_02.5
1work_1_1open_1_1ore_1_12.5
2work_1_2open_1_2ore_1_22.5
3work_1_3open_1_3ore_1_32.5
4work_1_4open_1_4ore_1_42.5
+

Now, the constraint to limit quantity extracted is easily created by +iterating over all rows of the joined DataFrames:

+
# quantity extracted is limited
+mm.add_constraints(t.ore <= t.max_extract * t.work
+                  for t in df_decision_vars.join(df_mines.max_extract).itertuples())
+mm.print_information()
+
+
+
Model: mining_pandas
+ - number of variables: 60
+   - binary=40, integer=0, continuous=20
+ - number of constraints: 61
+   - linear=61
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Blend constraints
+

We need to compute the total production of each year, stored in +auxiliary variables.

+

Again, we use the pandas groupby operation, this time to collect all +“ore” decision variables for each year in separate pandas +Series. The “blend” variable for a given year is the sum of “ore” +decision variables for the corresponding Series.

+
# blend variables
+blend_vars = mm.continuous_var_list(nb_years, name='blend')
+
+# define blend variables as sum of extracted quantities
+mm.add_constraints(mm.sum(ores.values) == blend_vars[year]
+                 for year, ores in df_decision_vars.ore.groupby(level='range_years'))
+mm.print_information()
+
+
+
Model: mining_pandas
+ - number of variables: 65
+   - binary=40, integer=0, continuous=25
+ - number of constraints: 66
+   - linear=66
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Minimum average blend quality constraint
+

The average quality of the blend is the weighted sum of extracted +quantities, divided by the total extracted quantity. Because we cannot +use division here, we transform the inequality:

+
# Quality requirement on blended ore
+mm.add_constraints(mm.sum(ores.values * df_mines.ore_quality) >= blend_qualities[year] * blend_vars[year]
+                 for year, ores in df_decision_vars.ore.groupby(level='range_years'))
+mm.print_information()
+
+
+
Model: mining_pandas
+ - number of variables: 65
+   - binary=40, integer=0, continuous=25
+ - number of constraints: 71
+   - linear=71
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
+

KPIs and objective

+

Since both revenues and royalties are actualized using the same rate, we +compute an auxiliary discount rate array.

+
+
The discount rate array
+
actualization = 1.0 - discount_rate
+assert actualization > 0
+assert actualization <= 1
+#
+s_discounts = Series((actualization ** y for y in range_years), index=range_years, name='discounts')
+s_discounts.index.name='range_years'
+# e.g. [1, 0.9, 0.81, ... 0.9**y...]
+print(s_discounts)
+
+
+
range_years
+0    1.0000
+1    0.9000
+2    0.8100
+3    0.7290
+4    0.6561
+Name: discounts, dtype: float64
+
+
+
+
+
Total actualized revenue
+

Total expected revenue is the sum of actualized yearly revenues, +computed as total extracted quantities multiplied by the blend price +(assumed to be constant over the years in this simplified model).

+
expected_revenue = blend_price * mm.dot(blend_vars, s_discounts)
+mm.add_kpi(expected_revenue, "Total Actualized Revenue");
+
+
+
+
+
Total actualized royalty cost
+

The total actualized royalty cost is computed for all open mines, also +actualized using the discounts array.

+

This time, we use the pandas join operation twice to build a +DataFrame that joins the “df_decision_vars” DataFrame with the +“df_mines.royalties” and “s_discounts” Series such that each row +contains the relevant information to calculate its contribution to the +total actualized royalty cost. The join with the “df_mines.royalties” +Series is performed by looking at the common “range_mines” index, +while the join with the “s_discounts” Series is performed by looking +at the common “range_years” index.

+
df_royalties_data = df_decision_vars.join(df_mines.royalties).join(s_discounts)
+# add a new column to compute discounted roylaties using pandas multiplication on columns
+df_royalties_data['disc_royalties'] = df_royalties_data['royalties'] * df_royalties_data['discounts']
+df_royalties_data[:nb_years]
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
workopenoreroyaltiesdiscountsdisc_royalties
range_minesrange_years
00work_0_0open_0_0ore_0_051.00005.0000
1work_0_1open_0_1ore_0_150.90004.5000
2work_0_2open_0_2ore_0_250.81004.0500
3work_0_3open_0_3ore_0_350.72903.6450
4work_0_4open_0_4ore_0_450.65613.2805
+

The total royalty is now calculated by multiplying the columns “open”, +“royalties” and “discounts”, and to sum over all rows. Using +pandas constructs, this can be written in a very compact way as +follows:

+
total_royalties = mm.dot(df_royalties_data.open, df_royalties_data.disc_royalties)
+
+mm.add_kpi(total_royalties, "Total Actualized Royalties");
+
+
+
+
+
+

Express the objective

+

The business objective is to maximize the expected net profit, which is +the difference between revenue and royalties.

+
mm.maximize(expected_revenue - total_royalties)
+
+
+
+
+

Solve with Decision Optimization

+
mm.print_information()
+# turn this flag on to see the solve log
+print_cplex_log = False
+# start the solve
+s1 = mm.solve(log_output=print_cplex_log)
+assert s1, "!!! Solve of the model fails"
+mm.report()
+
+
+
Model: mining_pandas
+ - number of variables: 65
+   - binary=40, integer=0, continuous=25
+ - number of constraints: 71
+   - linear=71
+ - parameters: defaults
+ - problem type is: MILP
+* model mining_pandas solved with objective = 161.438
+*  KPI: Total Actualized Revenue   = 214.674
+*  KPI: Total Actualized Royalties = 53.236
+
+
+
+
+
+

Step 5: Investigate the solution and then run an example analysis

+

To analyze the results, we again leverage pandas, by storing the +solution value of the ore variables in a new DataFrame. Note that we +use the float function of Python to convert the variable to its +solution value. Of course, this requires that the model be successfully +solved. For convenience, we want to organize the ore solution values +in a pivot table with years as row index and mines as columns. The +pandas unstack operation does this for us.

+
mine_labels = [("mine%d" % (m+1)) for m in range_mines]
+ylabels = [("y%d" % (y+1)) for y in range_years]
+
+# Add a column to DataFrame containing 'ore' decision variables value
+# Note that we extract the solution values of ore variables in one operation with get_values().
+df_decision_vars['ore_values'] = s1.get_values(df_decision_vars.ore)
+
+# Create a pivot table by (years, mines), using pandas' "unstack" method to transform the 'range_mines' row index
+#  into columns
+df_res = df_decision_vars.ore_values.unstack(level='range_mines')
+
+# Set user-friendly labels for column and row indices
+df_res.columns = mine_labels
+df_res.index = ylabels
+
+df_res
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
mine1mine2mine3mine4
y12.002.5000001.30.0
y22.002.5000001.30.0
y31.950.0000001.30.0
y42.002.5000001.30.0
y52.002.1666671.30.0
+
+

Visualize results

+

In this section you’ll need the matplotlib module to visualize the +results of the solve.

+
# import matplotlib library for visualization
+import matplotlib.pyplot as plt
+# matplotlib graphics are printed -inside- the notebook
+%matplotlib inline
+
+df_res.plot(kind="bar", figsize=(10,4.5))
+plt.xlabel("year")
+plt.ylabel("ore")
+plt.title('ore values per year');
+
+
+_images/mining_pandas_61_0.png +
+
+
+
+

Adding operational constraints.

+

What if we wish to add operational constraints? For example, let us +forbid work on certain pairs of (mines, years). Let’s see how this +impacts profit.

+

First, we add extra constraints to forbid work on those tuples.

+
# a list of (mine, year) tuples on which work is not possible.
+forced_stops = [(1, 2), (0, 1), (1, 0), (3, 2), (2, 3), (3, 4)]
+
+mm.add_constraints(work_vars[stop_m, stop_y] == 0
+                   for stop_m, stop_y in forced_stops)
+mm.print_information()
+
+
+
Model: mining_pandas
+ - number of variables: 65
+   - binary=40, integer=0, continuous=25
+ - number of constraints: 77
+   - linear=77
+ - parameters: defaults
+ - problem type is: MILP
+
+
+

The previous solution does not satisfy these constraints; for example +(0, 1) means mine 1 should not be worked on year 2, but it was in fact +worked in the above solution.

+

To help CPLEX find a feasible solution, we will build a heuristic +feasible solution and pass it to CPLEX.

+
+
+

Using an heuristic start solution

+

In this section, we show how one can provide a start solution to CPLEX, +based on heuristics.

+

First, we build a solution in which mines are worked whenever possible, +that is for all couples (m,y) except for those in forced_stops.

+
# build a new, empty solution
+full_mining = mm.new_solution()
+
+# define the worked
+for m in range_mines:
+    for y in range_years:
+        if (m,y) not in forced_stops:
+            full_mining.add_var_value(work_vars[m,y], 1)
+#full_mining.display()
+
+
+

Then we pass this solution to the model as a MIP start solution and +re-solve, this time with CPLEX logging turned on.

+
mm.add_mip_start(full_mining)
+s2 = mm.solve(log_output=True)  # turns on CPLEX logging
+assert s2, "solve failed"
+mm.report()
+
+
+
CPXPARAM_Read_DataCheck                          1
+2 of 5 MIP starts provided solutions.
+MIP start 'm1' defined initial solution with objective 108.9605.
+Tried aggregator 5 times.
+MIP Presolve eliminated 41 rows and 29 columns.
+MIP Presolve modified 23 coefficients.
+Aggregator did 36 substitutions.
+All rows and columns eliminated.
+Presolve time = 0.00 sec. (0.18 ticks)
+
+Root node processing (before b&c):
+  Real time             =    0.00 sec. (0.27 ticks)
+Parallel b&c, 12 threads:
+  Real time             =    0.00 sec. (0.00 ticks)
+  Sync time (average)   =    0.00 sec.
+  Wait time (average)   =    0.00 sec.
+                          ------------
+Total (root+branch&cut) =    0.00 sec. (0.27 ticks)
+* model mining_pandas solved with objective = 157.936
+*  KPI: Total Actualized Revenue   = 228.367
+*  KPI: Total Actualized Royalties = 70.431
+
+
+

You can see in the CPLEX log above, that our MIP start solution provided +a good start for CPLEX, defining an initial solution with objective +157.9355

+

Now we can again visualize the results with pandas and matplotlib.

+
# Add a column to DataFrame containing 'ore' decision variables value and create a pivot table by (years, mines)
+df_decision_vars['ore_values2'] = s2.get_values(df_decision_vars.ore)
+df_res2 = df_decision_vars.ore_values2.unstack(level='range_mines')
+df_res2.columns = mine_labels
+df_res2.index = ylabels
+
+df_res2.plot(kind="bar", figsize=(10,4.5))
+plt.xlabel("year")
+plt.ylabel("ore")
+plt.title('ore values per year - what-if scenario');
+
+
+_images/mining_pandas_70_0.png +

As expected, mine1 is not worked in year 2: there is no blue bar at y2.

+
+
+

Summary

+

You learned how to set up and use IBM Decision Optimization CPLEX +Modeling for Python to formulate a Mathematical Programming model and +solve it with CPLEX.

+
+
+

References

+ +

Copyright � 2017-2019 IBM. IPLA licensed Sample Materials.

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/nurses.html b/docs/2.29.245/docs/mp/nurses.html new file mode 100644 index 0000000..c7a9ee1 --- /dev/null +++ b/docs/2.29.245/docs/mp/nurses.html @@ -0,0 +1,647 @@ + + + + + + + + + + nurses.py — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

nurses.py

+

This example solves the problem of finding an optimal assignment of nurses to shifts.

+
  1# --------------------------------------------------------------------------
+  2# Source file provided under Apache License, Version 2.0, January 2004,
+  3# http://www.apache.org/licenses/
+  4# (c) Copyright IBM Corp. 2015, 2018
+  5# --------------------------------------------------------------------------
+  6
+  7from collections import namedtuple
+  8
+  9from docplex.mp.model import Model
+ 10from docplex.util.environment import get_environment
+ 11
+ 12# ----------------------------------------------------------------------------
+ 13# Initialize the problem data
+ 14# ----------------------------------------------------------------------------
+ 15
+ 16# utility to convert a weekday string to an index in 0..6
+ 17_all_days = ["monday",
+ 18             "tuesday",
+ 19             "wednesday",
+ 20             "thursday",
+ 21             "friday",
+ 22             "saturday",
+ 23             "sunday"]
+ 24
+ 25
+ 26def day_to_day_week(day):
+ 27    day_map = {day: d for d, day in enumerate(_all_days)}
+ 28    return day_map[day.lower()]
+ 29
+ 30
+ 31TWorkRules = namedtuple("TWorkRules", ["work_time_max"])
+ 32TVacation = namedtuple("TVacation", ["nurse", "day"])
+ 33TNursePair = namedtuple("TNursePair", ["firstNurse", "secondNurse"])
+ 34TSkillRequirement = namedtuple("TSkillRequirement", ["department", "skill", "required"])
+ 35
+ 36
+ 37NURSES = [("Anne", 11, 1, 25),
+ 38          ("Bethanie", 4, 5, 28),
+ 39          ("Betsy", 2, 2, 17),
+ 40          ("Cathy", 2, 2, 17),
+ 41          ("Cecilia", 9, 5, 38),
+ 42          ("Chris", 11, 4, 38),
+ 43          ("Cindy", 5, 2, 21),
+ 44          ("David", 1, 2, 15),
+ 45          ("Debbie", 7, 2, 24),
+ 46          ("Dee", 3, 3, 21),
+ 47          ("Gloria", 8, 2, 25),
+ 48          ("Isabelle", 3, 1, 16),
+ 49          ("Jane", 3, 4, 23),
+ 50          ("Janelle", 4, 3, 22),
+ 51          ("Janice", 2, 2, 17),
+ 52          ("Jemma", 2, 4, 22),
+ 53          ("Joan", 5, 3, 24),
+ 54          ("Joyce", 8, 3, 29),
+ 55          ("Jude", 4, 3, 22),
+ 56          ("Julie", 6, 2, 22),
+ 57          ("Juliet", 7, 4, 31),
+ 58          ("Kate", 5, 3, 24),
+ 59          ("Nancy", 8, 4, 32),
+ 60          ("Nathalie", 9, 5, 38),
+ 61          ("Nicole", 0, 2, 14),
+ 62          ("Patricia", 1, 1, 13),
+ 63          ("Patrick", 6, 1, 19),
+ 64          ("Roberta", 3, 5, 26),
+ 65          ("Suzanne", 5, 1, 18),
+ 66          ("Vickie", 7, 1, 20),
+ 67          ("Wendie", 5, 2, 21),
+ 68          ("Zoe", 8, 3, 29)
+ 69          ]
+ 70
+ 71SHIFTS = [("Emergency", "monday", 2, 8, 3, 5),
+ 72          ("Emergency", "monday", 8, 12, 4, 7),
+ 73          ("Emergency", "monday", 12, 18, 2, 5),
+ 74          ("Emergency", "monday", 18, 2, 3, 7),
+ 75          ("Consultation", "monday", 8, 12, 10, 13),
+ 76          ("Consultation", "monday", 12, 18, 8, 12),
+ 77          ("Cardiac_Care", "monday", 8, 12, 10, 13),
+ 78          ("Cardiac_Care", "monday", 12, 18, 8, 12),
+ 79          ("Emergency", "tuesday", 8, 12, 4, 7),
+ 80          ("Emergency", "tuesday", 12, 18, 2, 5),
+ 81          ("Emergency", "tuesday", 18, 2, 3, 7),
+ 82          ("Consultation", "tuesday", 8, 12, 10, 13),
+ 83          ("Consultation", "tuesday", 12, 18, 8, 12),
+ 84          ("Cardiac_Care", "tuesday", 8, 12, 4, 7),
+ 85          ("Cardiac_Care", "tuesday", 12, 18, 2, 5),
+ 86          ("Cardiac_Care", "tuesday", 18, 2, 3, 7),
+ 87          ("Emergency", "wednesday", 2, 8, 3, 5),
+ 88          ("Emergency", "wednesday", 8, 12, 4, 7),
+ 89          ("Emergency", "wednesday", 12, 18, 2, 5),
+ 90          ("Emergency", "wednesday", 18, 2, 3, 7),
+ 91          ("Consultation", "wednesday", 8, 12, 10, 13),
+ 92          ("Consultation", "wednesday", 12, 18, 8, 12),
+ 93          ("Emergency", "thursday", 2, 8, 3, 5),
+ 94          ("Emergency", "thursday", 8, 12, 4, 7),
+ 95          ("Emergency", "thursday", 12, 18, 2, 5),
+ 96          ("Emergency", "thursday", 18, 2, 3, 7),
+ 97          ("Consultation", "thursday", 8, 12, 10, 13),
+ 98          ("Consultation", "thursday", 12, 18, 8, 12),
+ 99          ("Emergency", "friday", 2, 8, 3, 5),
+100          ("Emergency", "friday", 8, 12, 4, 7),
+101          ("Emergency", "friday", 12, 18, 2, 5),
+102          ("Emergency", "friday", 18, 2, 3, 7),
+103          ("Consultation", "friday", 8, 12, 10, 13),
+104          ("Consultation", "friday", 12, 18, 8, 12),
+105          ("Emergency", "saturday", 2, 12, 5, 7),
+106          ("Emergency", "saturday", 12, 20, 7, 9),
+107          ("Emergency", "saturday", 20, 2, 12, 12),
+108          ("Emergency", "sunday", 2, 12, 5, 7),
+109          ("Emergency", "sunday", 12, 20, 7, 9),
+110          ("Emergency", "sunday", 20, 2, 12, 12),
+111          ("Geriatrics", "sunday", 8, 10, 2, 5)]
+112
+113NURSE_SKILLS = {"Anne": ["Anaesthesiology", "Oncology", "Pediatrics"],
+114                "Betsy": ["Cardiac_Care"],
+115                "Cathy": ["Anaesthesiology"],
+116                "Cecilia": ["Anaesthesiology", "Oncology", "Pediatrics"],
+117                "Chris": ["Cardiac_Care", "Oncology", "Geriatrics"],
+118                "Gloria": ["Pediatrics"], "Jemma": ["Cardiac_Care"],
+119                "Joyce": ["Anaesthesiology", "Pediatrics"],
+120                "Julie": ["Geriatrics"], "Juliet": ["Pediatrics"],
+121                "Kate": ["Pediatrics"], "Nancy": ["Cardiac_Care"],
+122                "Nathalie": ["Anaesthesiology", "Geriatrics"],
+123                "Patrick": ["Oncology"], "Suzanne": ["Pediatrics"],
+124                "Wendie": ["Geriatrics"],
+125                "Zoe": ["Cardiac_Care"]
+126                }
+127
+128VACATIONS = [("Anne", "friday"),
+129             ("Anne", "sunday"),
+130             ("Cathy", "thursday"),
+131             ("Cathy", "tuesday"),
+132             ("Joan", "thursday"),
+133             ("Joan", "saturday"),
+134             ("Juliet", "monday"),
+135             ("Juliet", "tuesday"),
+136             ("Juliet", "thursday"),
+137             ("Nathalie", "sunday"),
+138             ("Nathalie", "thursday"),
+139             ("Isabelle", "monday"),
+140             ("Isabelle", "thursday"),
+141             ("Patricia", "saturday"),
+142             ("Patricia", "wednesday"),
+143             ("Nicole", "friday"),
+144             ("Nicole", "wednesday"),
+145             ("Jude", "tuesday"),
+146             ("Jude", "friday"),
+147             ("Debbie", "saturday"),
+148             ("Debbie", "wednesday"),
+149             ("Joyce", "sunday"),
+150             ("Joyce", "thursday"),
+151             ("Chris", "thursday"),
+152             ("Chris", "tuesday"),
+153             ("Cecilia", "friday"),
+154             ("Cecilia", "wednesday"),
+155             ("Patrick", "saturday"),
+156             ("Patrick", "sunday"),
+157             ("Cindy", "sunday"),
+158             ("Dee", "tuesday"),
+159             ("Dee", "friday"),
+160             ("Jemma", "friday"),
+161             ("Jemma", "wednesday"),
+162             ("Bethanie", "wednesday"),
+163             ("Bethanie", "tuesday"),
+164             ("Betsy", "monday"),
+165             ("Betsy", "thursday"),
+166             ("David", "monday"),
+167             ("Gloria", "monday"),
+168             ("Jane", "saturday"),
+169             ("Jane", "sunday"),
+170             ("Janelle", "wednesday"),
+171             ("Janelle", "friday"),
+172             ("Julie", "sunday"),
+173             ("Kate", "tuesday"),
+174             ("Kate", "monday"),
+175             ("Nancy", "sunday"),
+176             ("Roberta", "friday"),
+177             ("Roberta", "saturday"),
+178             ("Janice", "tuesday"),
+179             ("Janice", "friday"),
+180             ("Suzanne", "monday"),
+181             ("Vickie", "wednesday"),
+182             ("Vickie", "friday"),
+183             ("Wendie", "thursday"),
+184             ("Wendie", "saturday"),
+185             ("Zoe", "saturday"),
+186             ("Zoe", "sunday")]
+187
+188NURSE_ASSOCIATIONS = [("Isabelle", "Dee"),
+189                      ("Anne", "Patrick")]
+190
+191NURSE_INCOMPATIBILITIES = [("Patricia", "Patrick"),
+192                           ("Janice", "Wendie"),
+193                           ("Suzanne", "Betsy"),
+194                           ("Janelle", "Jane"),
+195                           ("Gloria", "David"),
+196                           ("Dee", "Jemma"),
+197                           ("Bethanie", "Dee"),
+198                           ("Roberta", "Zoe"),
+199                           ("Nicole", "Patricia"),
+200                           ("Vickie", "Dee"),
+201                           ("Joan", "Anne")
+202                           ]
+203
+204SKILL_REQUIREMENTS = [("Emergency", "Cardiac_Care", 1)]
+205
+206DEFAULT_WORK_RULES = TWorkRules(40)
+207
+208
+209# ----------------------------------------------------------------------------
+210# Prepare the data for modeling
+211# ----------------------------------------------------------------------------
+212# subclass the namedtuple to refine the str() method as the nurse's name
+213class TNurse(namedtuple("TNurse1", ["name", "seniority", "qualification", "pay_rate"])):
+214    def __str__(self):
+215        return self.name
+216
+217
+218# specialized namedtuple to redefine its str() method
+219class TShift(namedtuple("TShift",
+220                        ["department", "day", "start_time", "end_time", "min_requirement", "max_requirement"])):
+221
+222    def __str__(self):
+223        # keep first two characters in department, uppercase
+224        dept2 = self.department[0:4].upper()
+225        # keep 3 days of weekday
+226        dayname = self.day[0:3]
+227        return '{}_{}_{:02d}'.format(dept2, dayname, self.start_time).replace(" ", "_")
+228
+229
+230class ShiftActivity(object):
+231    @staticmethod
+232    def to_abstime(day_index, time_of_day):
+233        """ Convert a pair (day_index, time) into a number of hours since Monday 00:00
+234
+235        :param day_index: The index of the day from 1 to 7 (Monday is 1).
+236        :param time_of_day: An integer number of hours.
+237
+238        :return:
+239        """
+240        time = 24 * (day_index - 1)
+241        time += time_of_day
+242        return time
+243
+244    def __init__(self, weekday, start_time_of_day, end_time_of_day):
+245        assert (start_time_of_day >= 0)
+246        assert (start_time_of_day <= 24)
+247        assert (end_time_of_day >= 0)
+248        assert (end_time_of_day <= 24)
+249
+250        self._weekday = weekday
+251        self._start_time_of_day = start_time_of_day
+252        self._end_time_of_day = end_time_of_day
+253        # conversion to absolute time.
+254        start_day_index = day_to_day_week(self._weekday)
+255        self.start_time = self.to_abstime(start_day_index, start_time_of_day)
+256        end_day_index = start_day_index if end_time_of_day > start_time_of_day else start_day_index + 1
+257        self.end_time = self.to_abstime(end_day_index, end_time_of_day)
+258        assert self.end_time > self.start_time
+259
+260    @property
+261    def duration(self):
+262        return self.end_time - self.start_time
+263
+264    def overlaps(self, other_shift):
+265        if not isinstance(other_shift, ShiftActivity):
+266            return False
+267        else:
+268            return other_shift.end_time > self.start_time and other_shift.start_time < self.end_time
+269
+270
+271def solve(model, **kwargs):
+272    # Here, we set the number of threads for CPLEX to 2 and set the time limit to 2mins.
+273    model.parameters.threads = 2
+274    model.parameters.timelimit = 120  # nurse should not take more than that !
+275    sol = model.solve(log_output=True, **kwargs)
+276    if sol is not None:
+277        print("solution for a cost of {}".format(model.objective_value))
+278        print_information(model)
+279        print_solution(model)
+280        return model.objective_value
+281    else:
+282        print("* model is infeasible")
+283        return None
+284
+285
+286def load_data(model, shifts_, nurses_, nurse_skills, vacations_=None,
+287              nurse_associations_=None, nurse_imcompatibilities_=None, verbose=True):
+288    """ Usage: load_data(shifts, nurses, nurse_skills, vacations) """
+289    model.number_of_overlaps = 0
+290    model.work_rules = DEFAULT_WORK_RULES
+291    model.shifts = [TShift(*shift_row) for shift_row in shifts_]
+292    model.nurses = [TNurse(*nurse_row) for nurse_row in nurses_]
+293    model.skill_requirements = SKILL_REQUIREMENTS
+294    model.nurse_skills = nurse_skills
+295    # transactional data
+296    model.vacations = [TVacation(*vacation_row) for vacation_row in vacations_] if vacations_ else []
+297    model.nurse_associations = [TNursePair(*npr) for npr in nurse_associations_]\
+298    if nurse_associations_ else []
+299    model.nurse_incompatibilities = [TNursePair(*npr) for npr in nurse_imcompatibilities_]\
+300    if nurse_imcompatibilities_ else []
+301
+302    # computed
+303    model.departments = set(sh.department for sh in model.shifts)
+304
+305    if verbose:
+306        print('#nurses: {0}'.format(len(model.nurses)))
+307        print('#shifts: {0}'.format(len(model.shifts)))
+308        print('#vacations: {0}'.format(len(model.vacations)))
+309        print("#associations=%d" % len(model.nurse_associations))
+310        print("#incompatibilities=%d" % len(model.nurse_incompatibilities))
+311
+312
+313def setup_data(model):
+314    """ compute internal data """
+315    # compute shift activities (start, end duration) and stor ethem in a dict indexed by shifts
+316    model.shift_activities = {s: ShiftActivity(s.day, s.start_time, s.end_time) for s in model.shifts}
+317    # map from nurse names to nurse tuples.
+318    model.nurses_by_id = {n.name: n for n in model.nurses}
+319
+320
+321def setup_variables(model):
+322    all_nurses, all_shifts = model.nurses, model.shifts
+323    # one binary variable for each pair (nurse, shift) equal to 1 iff nurse n is assigned to shift s
+324    model.nurse_assignment_vars = model.binary_var_matrix(all_nurses, all_shifts, 'NurseAssigned')
+325    # for each nurse, allocate one variable for work time
+326    model.nurse_work_time_vars = model.continuous_var_dict(all_nurses, lb=0, name='NurseWorkTime')
+327    # and two variables for over_average and under-average work time
+328    model.nurse_over_average_time_vars = model.continuous_var_dict(all_nurses, lb=0,
+329                                                                   name='NurseOverAverageWorkTime')
+330    model.nurse_under_average_time_vars = model.continuous_var_dict(all_nurses, lb=0,
+331                                                                    name='NurseUnderAverageWorkTime')
+332    # finally the global average work time
+333    model.average_nurse_work_time = model.continuous_var(lb=0, name='AverageWorkTime')
+334
+335
+336def setup_constraints(model):
+337    all_nurses = model.nurses
+338    all_shifts = model.shifts
+339    nurse_assigned = model.nurse_assignment_vars
+340    nurse_work_time = model.nurse_work_time_vars
+341    shift_activities = model.shift_activities
+342    nurses_by_id = model.nurses_by_id
+343    max_work_time = model.work_rules.work_time_max
+344
+345    # define average
+346    model.add_constraint(
+347        len(all_nurses) * model.average_nurse_work_time == model.sum(nurse_work_time[n] for n in all_nurses), "average")
+348
+349    # compute nurse work time , average and under, over
+350    for n in all_nurses:
+351        work_time_var = nurse_work_time[n]
+352        model.add_constraint(
+353            work_time_var == model.sum(nurse_assigned[n, s] * shift_activities[s].duration for s in all_shifts),
+354            "work_time_{0!s}".format(n))
+355
+356        # relate over/under average worktime variables to the worktime variables
+357        # the trick here is that variables have zero lower bound
+358        # however, thse variables are not completely defined by this constraint,
+359        # only their difference is.
+360        # if these variables are part of the objective, CPLEX wil naturally minimize their value,
+361        # as expected
+362        model.add_constraint(
+363            work_time_var == model.average_nurse_work_time
+364            + model.nurse_over_average_time_vars[n]
+365            - model.nurse_under_average_time_vars[n],
+366            "average_work_time_{0!s}".format(n))
+367
+368        # state the maximum work time as a constraint, so that is can be relaxed,
+369        # should the problem become infeasible.
+370        model.add_constraint(work_time_var <= max_work_time, "max_time_{0!s}".format(n))
+371
+372    # vacations
+373    v = 0
+374    for vac_nurse_id, vac_day in model.vacations:
+375        vac_n = nurses_by_id[vac_nurse_id]
+376        for shift in (s for s in all_shifts if s.day == vac_day):
+377            v += 1
+378            model.add_constraint(nurse_assigned[vac_n, shift] == 0,
+379                                 "medium_vacations_{0!s}_{1!s}_{2!s}".format(vac_n, vac_day, shift))
+380    #print('#vacation cts: {0}'.format(v))
+381
+382    # a nurse cannot be assigned overlapping shifts
+383    # post only one constraint per couple(s1, s2)
+384    number_of_overlaps = 0
+385    nb_shifts = len(all_shifts)
+386    for i1 in range(nb_shifts):
+387        for i2 in range(i1 + 1, nb_shifts):
+388            s1 = all_shifts[i1]
+389            s2 = all_shifts[i2]
+390            if shift_activities[s1].overlaps(shift_activities[s2]):
+391                number_of_overlaps += 1
+392                for n in all_nurses:
+393                    model.add_constraint(nurse_assigned[n, s1] + nurse_assigned[n, s2] <= 1,
+394                                         "high_overlapping_{0!s}_{1!s}_{2!s}".format(s1, s2, n))
+395    #print('# overlapping cts: {0}'.format(number_of_overlaps))
+396
+397    for s in all_shifts:
+398        demand_min = s.min_requirement
+399        demand_max = s.max_requirement
+400        total_assigned = model.sum(nurse_assigned[n, s] for n in model.nurses)
+401        model.add_constraint(total_assigned >= demand_min,
+402                             "high_req_min_{0!s}_{1}".format(s, demand_min))
+403        model.add_constraint(total_assigned <= demand_max,
+404                             "medium_req_max_{0!s}_{1}".format(s, demand_max))
+405        model.add_constraint(total_assigned >= 1, "mandatory_presence_{0!s}".format(s))
+406
+407    for (dept, skill, required) in model.skill_requirements:
+408        if required > 0:
+409            for dsh in (s for s in all_shifts if dept == s.department):
+410                model.add_constraint(model.sum(nurse_assigned[skilled_nurse, dsh] for skilled_nurse in
+411                                               (n for n in all_nurses if
+412                                                n.name in model.nurse_skills.keys() and skill in model.nurse_skills[
+413                                                    n.name])) >= required,
+414                                     "high_required_{0!s}_{1!s}_{2!s}_{3!s}".format(dept, skill, required, dsh))
+415
+416    # nurse-nurse associations
+417    # for each pair of associated nurses, their assignment variables are equal
+418    # over all shifts.
+419    c = 0
+420    for (nurse_id1, nurse_id2) in model.nurse_associations:
+421        if nurse_id1 in nurses_by_id and nurse_id2 in nurses_by_id:
+422            nurse1 = nurses_by_id[nurse_id1]
+423            nurse2 = nurses_by_id[nurse_id2]
+424            for s in all_shifts:
+425                c += 1
+426                ctname = 'medium_ct_nurse_assoc_{0!s}_{1!s}_{2:d}'.format(nurse_id1, nurse_id2, c)
+427                model.add_constraint(nurse_assigned[nurse1, s] == nurse_assigned[nurse2, s], ctname)
+428
+429    # nurse-nurse incompatibilities
+430    # for each pair of incompatible nurses, the sum of assigned variables is less than one
+431    # in other terms, both nurses can never be assigned to the same shift
+432    c = 0
+433    for (nurse_id1, nurse_id2) in model.nurse_incompatibilities:
+434        if nurse_id1 in nurses_by_id and nurse_id2 in nurses_by_id:
+435            nurse1 = nurses_by_id[nurse_id1]
+436            nurse2 = nurses_by_id[nurse_id2]
+437            for s in all_shifts:
+438                c += 1
+439                ctname = 'medium_ct_nurse_incompat_{0!s}_{1!s}_{2:d}'.format(nurse_id1, nurse_id2, c)
+440                model.add_constraint(nurse_assigned[nurse1, s] + nurse_assigned[nurse2, s] <= 1, ctname)
+441
+442    model.total_number_of_assignments = model.sum(nurse_assigned[n, s] for n in all_nurses for s in all_shifts)
+443    # model.nurse_costs = [model.nurse_assignment_vars[n, s] * n.pay_rate * model.shift_activities[s].duration
+444    #                      for n in model.nurses for s in model.shifts]
+445
+446    def assignment_cost_f(ns):
+447        n, s = ns
+448        return n.pay_rate * model.shift_activities[s].duration
+449
+450    model.nurse_costs = model.scal_prod_f(nurse_assigned, assignment_cost_f)
+451    model.total_salary_cost = model.sum(model.nurse_costs)
+452
+453
+454def setup_objective(model):
+455    model.add_kpi(model.total_salary_cost, "Total salary cost")
+456    model.add_kpi(model.total_number_of_assignments, "Total number of assignments")
+457    model.add_kpi(model.average_nurse_work_time, "average work time")
+458
+459    total_over_average_worktime = model.sum(model.nurse_over_average_time_vars[n] for n in model.nurses)
+460    total_under_average_worktime = model.sum(model.nurse_under_average_time_vars[n] for n in model.nurses)
+461    model.add_kpi(total_over_average_worktime, "Total over-average worktime")
+462    model.add_kpi(total_under_average_worktime, "Total under-average worktime")
+463    total_fairness = total_over_average_worktime + total_under_average_worktime
+464    model.add_kpi(total_fairness, "Total fairness")
+465
+466    model.minimize(model.total_salary_cost + total_fairness + model.total_number_of_assignments)
+467
+468
+469def print_information(model):
+470    print("#shifts=%d" % len(model.shifts))
+471    print("#nurses=%d" % len(model.nurses))
+472    print("#vacations=%d" % len(model.vacations))
+473    print("#nurse skills=%d" % len(model.nurse_skills))
+474    print("#nurse associations=%d" % len(model.nurse_associations))
+475    print("#incompatibilities=%d" % len(model.nurse_incompatibilities))
+476    model.print_information()
+477    model.report_kpis()
+478
+479
+480def print_solution(model):
+481    print("*************************** Solution ***************************")
+482    print("Allocation By Department:")
+483    for d in model.departments:
+484        print("\t{}: {}".format(d, sum(
+485            model.nurse_assignment_vars[n, s].solution_value for n in model.nurses for s in model.shifts if
+486            s.department == d)))
+487    print("Cost By Department:")
+488    for d in model.departments:
+489        cost = sum(
+490            model.nurse_assignment_vars[n, s].solution_value * n.pay_rate * model.shift_activities[s].duration for n in
+491            model.nurses for s in model.shifts if s.department == d)
+492        print("\t{}: {}".format(d, cost))
+493    print("Nurses Assignments")
+494    for n in sorted(model.nurses):
+495        total_hours = sum(
+496            model.nurse_assignment_vars[n, s].solution_value * model.shift_activities[s].duration for s in model.shifts)
+497        print("\t{}: total hours:{}".format(n.name, total_hours))
+498        for s in model.shifts:
+499            if model.nurse_assignment_vars[n, s].solution_value == 1:
+500                print("\t\t{}: {} {}-{}".format(s.day, s.department, s.start_time, s.end_time))
+501
+502
+503# ----------------------------------------------------------------------------
+504# Build the model
+505# ----------------------------------------------------------------------------
+506
+507def build(context=None, verbose=False, **kwargs):
+508    mdl = Model("Nurses", context=context, **kwargs)
+509    load_data(mdl, SHIFTS, NURSES, NURSE_SKILLS, VACATIONS, NURSE_ASSOCIATIONS,
+510              NURSE_INCOMPATIBILITIES, verbose=verbose)
+511    setup_data(mdl)
+512    setup_variables(mdl)
+513    setup_constraints(mdl)
+514    setup_objective(mdl)
+515    return mdl
+516
+517
+518# ----------------------------------------------------------------------------
+519# Solve the model and display the result
+520# ----------------------------------------------------------------------------
+521
+522if __name__ == '__main__':
+523    # Build model
+524    model = build()
+525
+526    # Solve the model and print solution
+527    solve(model)
+528
+529    # Save the CPLEX solution as "solution.json" program output
+530    with get_environment().get_output_stream("solution.json") as fp:
+531        model.solution.export(fp, "json")
+532    model.end()
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/nurses_multiobj.html b/docs/2.29.245/docs/mp/nurses_multiobj.html new file mode 100644 index 0000000..343d871 --- /dev/null +++ b/docs/2.29.245/docs/mp/nurses_multiobj.html @@ -0,0 +1,667 @@ + + + + + + + + + + nurses_multiobj.py — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

nurses_multiobj.py

+

This example solves the problem of finding an optimal assignment of nurses to shifts, +using multi-objectives. Instead of minimizing an overall cost made of salary cost, +fairness and number of assignments, we use COS 12.9 multiobjective solve +to specify the 3 kpis.

+

This sample require COS 12.9.

+
  1# --------------------------------------------------------------------------
+  2# Source file provided under Apache License, Version 2.0, January 2004,
+  3# http://www.apache.org/licenses/
+  4# (c) Copyright IBM Corp. 2015, 2018
+  5# --------------------------------------------------------------------------
+  6
+  7from collections import namedtuple
+  8
+  9from docplex.mp.model import Model
+ 10from docplex.mp.constants import ObjectiveSense
+ 11from docplex.util.environment import get_environment
+ 12
+ 13# ----------------------------------------------------------------------------
+ 14# Initialize the problem data
+ 15# ----------------------------------------------------------------------------
+ 16
+ 17# utility to convert a weekday string to an index in 0..6
+ 18_all_days = ["monday",
+ 19             "tuesday",
+ 20             "wednesday",
+ 21             "thursday",
+ 22             "friday",
+ 23             "saturday",
+ 24             "sunday"]
+ 25
+ 26
+ 27def day_to_day_week(day):
+ 28    day_map = {day: d for d, day in enumerate(_all_days)}
+ 29    return day_map[day.lower()]
+ 30
+ 31
+ 32TWorkRules = namedtuple("TWorkRules", ["work_time_max"])
+ 33TVacation = namedtuple("TVacation", ["nurse", "day"])
+ 34TNursePair = namedtuple("TNursePair", ["firstNurse", "secondNurse"])
+ 35TSkillRequirement = namedtuple("TSkillRequirement", ["department", "skill", "required"])
+ 36
+ 37
+ 38NURSES = [("Anne", 11, 1, 25),
+ 39          ("Bethanie", 4, 5, 28),
+ 40          ("Betsy", 2, 2, 17),
+ 41          ("Cathy", 2, 2, 17),
+ 42          ("Cecilia", 9, 5, 38),
+ 43          ("Chris", 11, 4, 38),
+ 44          ("Cindy", 5, 2, 21),
+ 45          ("David", 1, 2, 15),
+ 46          ("Debbie", 7, 2, 24),
+ 47          ("Dee", 3, 3, 21),
+ 48          ("Gloria", 8, 2, 25),
+ 49          ("Isabelle", 3, 1, 16),
+ 50          ("Jane", 3, 4, 23),
+ 51          ("Janelle", 4, 3, 22),
+ 52          ("Janice", 2, 2, 17),
+ 53          ("Jemma", 2, 4, 22),
+ 54          ("Joan", 5, 3, 24),
+ 55          ("Joyce", 8, 3, 29),
+ 56          ("Jude", 4, 3, 22),
+ 57          ("Julie", 6, 2, 22),
+ 58          ("Juliet", 7, 4, 31),
+ 59          ("Kate", 5, 3, 24),
+ 60          ("Nancy", 8, 4, 32),
+ 61          ("Nathalie", 9, 5, 38),
+ 62          ("Nicole", 0, 2, 14),
+ 63          ("Patricia", 1, 1, 13),
+ 64          ("Patrick", 6, 1, 19),
+ 65          ("Roberta", 3, 5, 26),
+ 66          ("Suzanne", 5, 1, 18),
+ 67          ("Vickie", 7, 1, 20),
+ 68          ("Wendie", 5, 2, 21),
+ 69          ("Zoe", 8, 3, 29)
+ 70          ]
+ 71
+ 72SHIFTS = [("Emergency", "monday", 2, 8, 3, 5),
+ 73          ("Emergency", "monday", 8, 12, 4, 7),
+ 74          ("Emergency", "monday", 12, 18, 2, 5),
+ 75          ("Emergency", "monday", 18, 2, 3, 7),
+ 76          ("Consultation", "monday", 8, 12, 10, 13),
+ 77          ("Consultation", "monday", 12, 18, 8, 12),
+ 78          ("Cardiac_Care", "monday", 8, 12, 10, 13),
+ 79          ("Cardiac_Care", "monday", 12, 18, 8, 12),
+ 80          ("Emergency", "tuesday", 8, 12, 4, 7),
+ 81          ("Emergency", "tuesday", 12, 18, 2, 5),
+ 82          ("Emergency", "tuesday", 18, 2, 3, 7),
+ 83          ("Consultation", "tuesday", 8, 12, 10, 13),
+ 84          ("Consultation", "tuesday", 12, 18, 8, 12),
+ 85          ("Cardiac_Care", "tuesday", 8, 12, 4, 7),
+ 86          ("Cardiac_Care", "tuesday", 12, 18, 2, 5),
+ 87          ("Cardiac_Care", "tuesday", 18, 2, 3, 7),
+ 88          ("Emergency", "wednesday", 2, 8, 3, 5),
+ 89          ("Emergency", "wednesday", 8, 12, 4, 7),
+ 90          ("Emergency", "wednesday", 12, 18, 2, 5),
+ 91          ("Emergency", "wednesday", 18, 2, 3, 7),
+ 92          ("Consultation", "wednesday", 8, 12, 10, 13),
+ 93          ("Consultation", "wednesday", 12, 18, 8, 12),
+ 94          ("Emergency", "thursday", 2, 8, 3, 5),
+ 95          ("Emergency", "thursday", 8, 12, 4, 7),
+ 96          ("Emergency", "thursday", 12, 18, 2, 5),
+ 97          ("Emergency", "thursday", 18, 2, 3, 7),
+ 98          ("Consultation", "thursday", 8, 12, 10, 13),
+ 99          ("Consultation", "thursday", 12, 18, 8, 12),
+100          ("Emergency", "friday", 2, 8, 3, 5),
+101          ("Emergency", "friday", 8, 12, 4, 7),
+102          ("Emergency", "friday", 12, 18, 2, 5),
+103          ("Emergency", "friday", 18, 2, 3, 7),
+104          ("Consultation", "friday", 8, 12, 10, 13),
+105          ("Consultation", "friday", 12, 18, 8, 12),
+106          ("Emergency", "saturday", 2, 12, 5, 7),
+107          ("Emergency", "saturday", 12, 20, 7, 9),
+108          ("Emergency", "saturday", 20, 2, 12, 12),
+109          ("Emergency", "sunday", 2, 12, 5, 7),
+110          ("Emergency", "sunday", 12, 20, 7, 9),
+111          ("Emergency", "sunday", 20, 2, 12, 12),
+112          ("Geriatrics", "sunday", 8, 10, 2, 5)]
+113
+114NURSE_SKILLS = {"Anne": ["Anaesthesiology", "Oncology", "Pediatrics"],
+115                "Betsy": ["Cardiac_Care"],
+116                "Cathy": ["Anaesthesiology"],
+117                "Cecilia": ["Anaesthesiology", "Oncology", "Pediatrics"],
+118                "Chris": ["Cardiac_Care", "Oncology", "Geriatrics"],
+119                "Gloria": ["Pediatrics"], "Jemma": ["Cardiac_Care"],
+120                "Joyce": ["Anaesthesiology", "Pediatrics"],
+121                "Julie": ["Geriatrics"], "Juliet": ["Pediatrics"],
+122                "Kate": ["Pediatrics"], "Nancy": ["Cardiac_Care"],
+123                "Nathalie": ["Anaesthesiology", "Geriatrics"],
+124                "Patrick": ["Oncology"], "Suzanne": ["Pediatrics"],
+125                "Wendie": ["Geriatrics"],
+126                "Zoe": ["Cardiac_Care"]
+127                }
+128
+129VACATIONS = [("Anne", "friday"),
+130             ("Anne", "sunday"),
+131             ("Cathy", "thursday"),
+132             ("Cathy", "tuesday"),
+133             ("Joan", "thursday"),
+134             ("Joan", "saturday"),
+135             ("Juliet", "monday"),
+136             ("Juliet", "tuesday"),
+137             ("Juliet", "thursday"),
+138             ("Nathalie", "sunday"),
+139             ("Nathalie", "thursday"),
+140             ("Isabelle", "monday"),
+141             ("Isabelle", "thursday"),
+142             ("Patricia", "saturday"),
+143             ("Patricia", "wednesday"),
+144             ("Nicole", "friday"),
+145             ("Nicole", "wednesday"),
+146             ("Jude", "tuesday"),
+147             ("Jude", "friday"),
+148             ("Debbie", "saturday"),
+149             ("Debbie", "wednesday"),
+150             ("Joyce", "sunday"),
+151             ("Joyce", "thursday"),
+152             ("Chris", "thursday"),
+153             ("Chris", "tuesday"),
+154             ("Cecilia", "friday"),
+155             ("Cecilia", "wednesday"),
+156             ("Patrick", "saturday"),
+157             ("Patrick", "sunday"),
+158             ("Cindy", "sunday"),
+159             ("Dee", "tuesday"),
+160             ("Dee", "friday"),
+161             ("Jemma", "friday"),
+162             ("Jemma", "wednesday"),
+163             ("Bethanie", "wednesday"),
+164             ("Bethanie", "tuesday"),
+165             ("Betsy", "monday"),
+166             ("Betsy", "thursday"),
+167             ("David", "monday"),
+168             ("Gloria", "monday"),
+169             ("Jane", "saturday"),
+170             ("Jane", "sunday"),
+171             ("Janelle", "wednesday"),
+172             ("Janelle", "friday"),
+173             ("Julie", "sunday"),
+174             ("Kate", "tuesday"),
+175             ("Kate", "monday"),
+176             ("Nancy", "sunday"),
+177             ("Roberta", "friday"),
+178             ("Roberta", "saturday"),
+179             ("Janice", "tuesday"),
+180             ("Janice", "friday"),
+181             ("Suzanne", "monday"),
+182             ("Vickie", "wednesday"),
+183             ("Vickie", "friday"),
+184             ("Wendie", "thursday"),
+185             ("Wendie", "saturday"),
+186             ("Zoe", "saturday"),
+187             ("Zoe", "sunday")]
+188
+189NURSE_ASSOCIATIONS = [("Isabelle", "Dee"),
+190                      ("Anne", "Patrick")]
+191
+192NURSE_INCOMPATIBILITIES = [("Patricia", "Patrick"),
+193                           ("Janice", "Wendie"),
+194                           ("Suzanne", "Betsy"),
+195                           ("Janelle", "Jane"),
+196                           ("Gloria", "David"),
+197                           ("Dee", "Jemma"),
+198                           ("Bethanie", "Dee"),
+199                           ("Roberta", "Zoe"),
+200                           ("Nicole", "Patricia"),
+201                           ("Vickie", "Dee"),
+202                           ("Joan", "Anne")
+203                           ]
+204
+205SKILL_REQUIREMENTS = [("Emergency", "Cardiac_Care", 1)]
+206
+207DEFAULT_WORK_RULES = TWorkRules(40)
+208
+209
+210# ----------------------------------------------------------------------------
+211# Prepare the data for modeling
+212# ----------------------------------------------------------------------------
+213# subclass the namedtuple to refine the str() method as the nurse's name
+214class TNurse(namedtuple("TNurse1", ["name", "seniority", "qualification", "pay_rate"])):
+215    def __str__(self):
+216        return self.name
+217
+218
+219# specialized namedtuple to redefine its str() method
+220class TShift(namedtuple("TShift",
+221                        ["department", "day", "start_time", "end_time", "min_requirement", "max_requirement"])):
+222
+223    def __str__(self):
+224        # keep first two characters in department, uppercase
+225        dept2 = self.department[0:4].upper()
+226        # keep 3 days of weekday
+227        dayname = self.day[0:3]
+228        return '{}_{}_{:02d}'.format(dept2, dayname, self.start_time).replace(" ", "_")
+229
+230
+231class ShiftActivity(object):
+232    @staticmethod
+233    def to_abstime(day_index, time_of_day):
+234        """ Convert a pair (day_index, time) into a number of hours since Monday 00:00
+235
+236        :param day_index: The index of the day from 1 to 7 (Monday is 1).
+237        :param time_of_day: An integer number of hours.
+238
+239        :return:
+240        """
+241        time = 24 * (day_index - 1)
+242        time += time_of_day
+243        return time
+244
+245    def __init__(self, weekday, start_time_of_day, end_time_of_day):
+246        assert (start_time_of_day >= 0)
+247        assert (start_time_of_day <= 24)
+248        assert (end_time_of_day >= 0)
+249        assert (end_time_of_day <= 24)
+250
+251        self._weekday = weekday
+252        self._start_time_of_day = start_time_of_day
+253        self._end_time_of_day = end_time_of_day
+254        # conversion to absolute time.
+255        start_day_index = day_to_day_week(self._weekday)
+256        self.start_time = self.to_abstime(start_day_index, start_time_of_day)
+257        end_day_index = start_day_index if end_time_of_day > start_time_of_day else start_day_index + 1
+258        self.end_time = self.to_abstime(end_day_index, end_time_of_day)
+259        assert self.end_time > self.start_time
+260
+261    @property
+262    def duration(self):
+263        return self.end_time - self.start_time
+264
+265    def overlaps(self, other_shift):
+266        if not isinstance(other_shift, ShiftActivity):
+267            return False
+268        else:
+269            return other_shift.end_time > self.start_time and other_shift.start_time < self.end_time
+270
+271
+272def solve(model, **kwargs):
+273    # Here, we set the number of threads for CPLEX to 2 and set the time limit to 2mins.
+274    if kwargs.pop('parameter_sets', None) == None:
+275        model.parameters.threads = 2
+276        model.parameters.mip.tolerances.mipgap = 0.000001
+277        model.parameters.timelimit = 120  # nurse should not take more than that !
+278    sol = model.solve(log_output=True, **kwargs)
+279    if sol is not None:
+280        print("solution for a cost of {}".format(model.objective_value))
+281        print_information(model)
+282        # print_solution(model)
+283        return model.objective_value
+284    else:
+285        print("* model is infeasible")
+286        return None
+287
+288
+289def load_data(model, shifts_, nurses_, nurse_skills, vacations_=None,
+290              nurse_associations_=None, nurse_imcompatibilities_=None):
+291    """ Usage: load_data(shifts, nurses, nurse_skills, vacations) """
+292    model.number_of_overlaps = 0
+293    model.work_rules = DEFAULT_WORK_RULES
+294    model.shifts = [TShift(*shift_row) for shift_row in shifts_]
+295    model.nurses = [TNurse(*nurse_row) for nurse_row in nurses_]
+296    model.skill_requirements = SKILL_REQUIREMENTS
+297    model.nurse_skills = nurse_skills
+298    # transactional data
+299    model.vacations = [TVacation(*vacation_row) for vacation_row in vacations_] if vacations_ else []
+300    model.nurse_associations = [TNursePair(*npr) for npr in nurse_associations_]\
+301    if nurse_associations_ else []
+302    model.nurse_incompatibilities = [TNursePair(*npr) for npr in nurse_imcompatibilities_]\
+303    if nurse_imcompatibilities_ else []
+304
+305    # computed
+306    model.departments = set(sh.department for sh in model.shifts)
+307
+308
+309    print('#nurses: {0}'.format(len(model.nurses)))
+310    print('#shifts: {0}'.format(len(model.shifts)))
+311    print('#vacations: {0}'.format(len(model.vacations)))
+312    print("#associations=%d" % len(model.nurse_associations))
+313    print("#incompatibilities=%d" % len(model.nurse_incompatibilities))
+314
+315
+316def setup_data(model):
+317    """ compute internal data """
+318    # compute shift activities (start, end duration) and stor ethem in a dict indexed by shifts
+319    model.shift_activities = {s: ShiftActivity(s.day, s.start_time, s.end_time) for s in model.shifts}
+320    # map from nurse names to nurse tuples.
+321    model.nurses_by_id = {n.name: n for n in model.nurses}
+322
+323
+324def setup_variables(model):
+325    all_nurses, all_shifts = model.nurses, model.shifts
+326    # one binary variable for each pair (nurse, shift) equal to 1 iff nurse n is assigned to shift s
+327    model.nurse_assignment_vars = model.binary_var_matrix(all_nurses, all_shifts, 'NurseAssigned')
+328    # for each nurse, allocate one variable for work time
+329    model.nurse_work_time_vars = model.continuous_var_dict(all_nurses, lb=0, name='NurseWorkTime')
+330    # and two variables for over_average and under-average work time
+331    model.nurse_over_average_time_vars = model.continuous_var_dict(all_nurses, lb=0,
+332                                                                   name='NurseOverAverageWorkTime')
+333    model.nurse_under_average_time_vars = model.continuous_var_dict(all_nurses, lb=0,
+334                                                                    name='NurseUnderAverageWorkTime')
+335    # finally the global average work time
+336    model.average_nurse_work_time = model.continuous_var(lb=0, name='AverageWorkTime')
+337
+338
+339def setup_constraints(model):
+340    all_nurses = model.nurses
+341    all_shifts = model.shifts
+342    nurse_assigned = model.nurse_assignment_vars
+343    nurse_work_time = model.nurse_work_time_vars
+344    shift_activities = model.shift_activities
+345    nurses_by_id = model.nurses_by_id
+346    max_work_time = model.work_rules.work_time_max
+347
+348    # define average
+349    model.add_constraint(
+350        len(all_nurses) * model.average_nurse_work_time == model.sum(nurse_work_time[n] for n in all_nurses), "average")
+351
+352    # compute nurse work time , average and under, over
+353    for n in all_nurses:
+354        work_time_var = nurse_work_time[n]
+355        model.add_constraint(
+356            work_time_var == model.sum(nurse_assigned[n, s] * shift_activities[s].duration for s in all_shifts),
+357            "work_time_{0!s}".format(n))
+358
+359        # relate over/under average worktime variables to the worktime variables
+360        # the trick here is that variables have zero lower bound
+361        # however, thse variables are not completely defined by this constraint,
+362        # only their difference is.
+363        # if these variables are part of the objective, CPLEX wil naturally minimize their value,
+364        # as expected
+365        model.add_constraint(
+366            work_time_var == model.average_nurse_work_time
+367            + model.nurse_over_average_time_vars[n]
+368            - model.nurse_under_average_time_vars[n],
+369            "average_work_time_{0!s}".format(n))
+370
+371        # state the maximum work time as a constraint, so that is can be relaxed,
+372        # should the problem become infeasible.
+373        model.add_constraint(work_time_var <= max_work_time, "max_time_{0!s}".format(n))
+374
+375    # vacations
+376    v = 0
+377    for vac_nurse_id, vac_day in model.vacations:
+378        vac_n = nurses_by_id[vac_nurse_id]
+379        for shift in (s for s in all_shifts if s.day == vac_day):
+380            v += 1
+381            model.add_constraint(nurse_assigned[vac_n, shift] == 0,
+382                                 "medium_vacations_{0!s}_{1!s}_{2!s}".format(vac_n, vac_day, shift))
+383    #print('#vacation cts: {0}'.format(v))
+384
+385    # a nurse cannot be assigned overlapping shifts
+386    # post only one constraint per couple(s1, s2)
+387    number_of_overlaps = 0
+388    nb_shifts = len(all_shifts)
+389    for i1 in range(nb_shifts):
+390        for i2 in range(i1 + 1, nb_shifts):
+391            s1 = all_shifts[i1]
+392            s2 = all_shifts[i2]
+393            if shift_activities[s1].overlaps(shift_activities[s2]):
+394                number_of_overlaps += 1
+395                for n in all_nurses:
+396                    model.add_constraint(nurse_assigned[n, s1] + nurse_assigned[n, s2] <= 1,
+397                                         "high_overlapping_{0!s}_{1!s}_{2!s}".format(s1, s2, n))
+398    #print('# overlapping cts: {0}'.format(number_of_overlaps))
+399
+400    for s in all_shifts:
+401        demand_min = s.min_requirement
+402        demand_max = s.max_requirement
+403        total_assigned = model.sum(nurse_assigned[n, s] for n in model.nurses)
+404        model.add_constraint(total_assigned >= demand_min,
+405                             "high_req_min_{0!s}_{1}".format(s, demand_min))
+406        model.add_constraint(total_assigned <= demand_max,
+407                             "medium_req_max_{0!s}_{1}".format(s, demand_max))
+408
+409    for (dept, skill, required) in model.skill_requirements:
+410        if required > 0:
+411            for dsh in (s for s in all_shifts if dept == s.department):
+412                model.add_constraint(model.sum(nurse_assigned[skilled_nurse, dsh] for skilled_nurse in
+413                                               (n for n in all_nurses if
+414                                                n.name in model.nurse_skills.keys() and skill in model.nurse_skills[
+415                                                    n.name])) >= required,
+416                                     "high_required_{0!s}_{1!s}_{2!s}_{3!s}".format(dept, skill, required, dsh))
+417
+418    # nurse-nurse associations
+419    # for each pair of associated nurses, their assignment variables are equal
+420    # over all shifts.
+421    c = 0
+422    for (nurse_id1, nurse_id2) in model.nurse_associations:
+423        if nurse_id1 in nurses_by_id and nurse_id2 in nurses_by_id:
+424            nurse1 = nurses_by_id[nurse_id1]
+425            nurse2 = nurses_by_id[nurse_id2]
+426            for s in all_shifts:
+427                c += 1
+428                ctname = 'medium_ct_nurse_assoc_{0!s}_{1!s}_{2:d}'.format(nurse_id1, nurse_id2, c)
+429                model.add_constraint(nurse_assigned[nurse1, s] == nurse_assigned[nurse2, s], ctname)
+430
+431    # nurse-nurse incompatibilities
+432    # for each pair of incompatible nurses, the sum of assigned variables is less than one
+433    # in other terms, both nurses can never be assigned to the same shift
+434    c = 0
+435    for (nurse_id1, nurse_id2) in model.nurse_incompatibilities:
+436        if nurse_id1 in nurses_by_id and nurse_id2 in nurses_by_id:
+437            nurse1 = nurses_by_id[nurse_id1]
+438            nurse2 = nurses_by_id[nurse_id2]
+439            for s in all_shifts:
+440                c += 1
+441                ctname = 'medium_ct_nurse_incompat_{0!s}_{1!s}_{2:d}'.format(nurse_id1, nurse_id2, c)
+442                model.add_constraint(nurse_assigned[nurse1, s] + nurse_assigned[nurse2, s] <= 1, ctname)
+443
+444    model.total_number_of_assignments = model.sum(nurse_assigned[n, s] for n in all_nurses for s in all_shifts)
+445    model.nurse_costs = [model.nurse_assignment_vars[n, s] * n.pay_rate * model.shift_activities[s].duration for n in
+446                         model.nurses
+447                         for s in model.shifts]
+448    model.total_salary_cost = model.sum(model.nurse_costs)
+449
+450
+451def setup_objective(model):
+452    model.add_kpi(model.total_salary_cost, "Total salary cost")
+453    model.add_kpi(model.total_number_of_assignments, "Total number of assignments")
+454    model.add_kpi(model.average_nurse_work_time, "average work time")
+455
+456    total_over_average_worktime = model.sum(model.nurse_over_average_time_vars[n] for n in model.nurses)
+457    total_under_average_worktime = model.sum(model.nurse_under_average_time_vars[n] for n in model.nurses)
+458    model.add_kpi(total_over_average_worktime, "Total over-average worktime")
+459    model.add_kpi(total_under_average_worktime, "Total under-average worktime")
+460    total_fairness = total_over_average_worktime + total_under_average_worktime
+461    model.add_kpi(total_fairness, "Total fairness")
+462
+463    model.minimize_static_lex([model.total_salary_cost, total_fairness, model.total_number_of_assignments])
+464
+465
+466def print_information(model):
+467    print("#shifts=%d" % len(model.shifts))
+468    print("#nurses=%d" % len(model.nurses))
+469    print("#vacations=%d" % len(model.vacations))
+470    print("#nurse skills=%d" % len(model.nurse_skills))
+471    print("#nurse associations=%d" % len(model.nurse_associations))
+472    print("#incompatibilities=%d" % len(model.nurse_incompatibilities))
+473    model.print_information()
+474    model.report_kpis()
+475
+476
+477def print_solution(model):
+478    print("*************************** Solution ***************************")
+479    print("Allocation By Department:")
+480    for d in model.departments:
+481        print("\t{}: {}".format(d, sum(
+482            model.nurse_assignment_vars[n, s].solution_value for n in model.nurses for s in model.shifts if
+483            s.department == d)))
+484    print("Cost By Department:")
+485    for d in model.departments:
+486        cost = sum(
+487            model.nurse_assignment_vars[n, s].solution_value * n.pay_rate * model.shift_activities[s].duration for n in
+488            model.nurses for s in model.shifts if s.department == d)
+489        print("\t{}: {}".format(d, cost))
+490    print("Nurses Assignments")
+491    for n in sorted(model.nurses):
+492        total_hours = sum(
+493            model.nurse_assignment_vars[n, s].solution_value * model.shift_activities[s].duration for s in model.shifts)
+494        print("\t{}: total hours:{}".format(n.name, total_hours))
+495        for s in model.shifts:
+496            if model.nurse_assignment_vars[n, s].solution_value == 1:
+497                print("\t\t{}: {} {}-{}".format(s.day, s.department, s.start_time, s.end_time))
+498
+499
+500# ----------------------------------------------------------------------------
+501# Build the model
+502# ----------------------------------------------------------------------------
+503
+504def build(context=None, **kwargs):
+505    mdl = Model("Nurses", context=context, **kwargs)
+506    load_data(mdl, SHIFTS, NURSES, NURSE_SKILLS, VACATIONS, NURSE_ASSOCIATIONS,
+507              NURSE_INCOMPATIBILITIES)
+508    setup_data(mdl)
+509    setup_variables(mdl)
+510    setup_constraints(mdl)
+511    setup_objective(mdl)
+512    return mdl
+513
+514
+515# ----------------------------------------------------------------------------
+516# Solve the model and display the result
+517# ----------------------------------------------------------------------------
+518
+519if __name__ == '__main__':
+520    # Build model
+521    model = build()
+522
+523    # Solve the model and print solution
+524    solve(model)
+525
+526    print(model.solve_details)
+527
+528    # Save the CPLEX solution as "solution.json" program output
+529    with get_environment().get_output_stream("solution.json") as fp:
+530        model.solution.export(fp, "json")
+531
+532    model.end()
+533
+534    model = build()
+535    paramsets = model.build_multiobj_paramsets(timelimits=[70,60,50] , mipgaps=[0.000003, 0.000002, 0.000001])
+536    solve(model, clean_before_solve=True, parameter_sets=paramsets)
+537    print(model.solve_details)
+538
+539    model = build()
+540    paramsets = model.create_parameter_sets()
+541    cplex = model.get_cplex()
+542    for i,p in enumerate(paramsets):
+543        p.add(cplex.parameters.timelimit, 70+i)
+544        p.add(cplex.parameters.mip.tolerances.mipgap, 0.000001*i)
+545        p.add(cplex.parameters.threads, 2+i)
+546    solve(model, clean_before_solve=True, parameter_sets=paramsets)
+547    print(model.solve_details)
+548    model.end()
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/nurses_pandas.html b/docs/2.29.245/docs/mp/nurses_pandas.html new file mode 100644 index 0000000..1b4e181 --- /dev/null +++ b/docs/2.29.245/docs/mp/nurses_pandas.html @@ -0,0 +1,3858 @@ + + + + + + + + + + The Nurse Assignment Problem — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

The Nurse Assignment Problem

+

This tutorial includes everything you need to set up IBM Decision +Optimization CPLEX Modeling for Python (DOcplex), build a Mathematical +Programming model, and get its solution by solving the model on the +cloud with IBM ILOG CPLEX Optimizer.

+

When you finish this tutorial, you’ll have a foundational knowledge of +Prescriptive Analytics.

+
+

This notebook is part of Prescriptive Analytics for +Python

+

It requires either an installation of CPLEX +Optimizers +or it can be run on IBM Watson Studio +Cloud (Sign up for a +free IBM Cloud +account +and you can start using Watson Studio Cloud right away).

+
+

Table of contents:

+ +
+
+

Describe the business problem

+

This notebook describes how to use CPLEX Modeling for Python together +with pandas to manage the assignment of nurses to shifts in a +hospital.

+

Nurses must be assigned to hospital shifts in accordance with various +skill and staffing constraints.

+

The goal of the model is to find an efficient balance between the +different objectives:

+
    +

  • minimize the overall cost of the plan and

    • +

  • assign shifts as fairly as possible.

    • +
+
+
+

How decision optimization can help

+
    +

  • Prescriptive analytics (decision optimization) technology recommends +actions that are based on desired outcomes. It takes into account +specific scenarios, resources, and knowledge of past and current +events. With this insight, your organization can make better +decisions and have greater control of business outcomes.

    • +

  • Prescriptive analytics is the next step on the path to insight-based +actions. It creates value through synergy with predictive analytics, +which analyzes data to predict future outcomes.

    • +
  • +
    Prescriptive analytics takes that insight to the next level by +suggesting the optimal way to handle that future situation. +Organizations that can act fast in dynamic conditions and make +superior decisions in uncertain environments gain a strong +competitive advantage.
    +

    +
    +
    • +
+

With prescriptive analytics, you can:

+
    +

  • Automate the complex decisions and trade-offs to better manage your +limited resources.

    • +

  • Take advantage of a future opportunity or mitigate a future risk.

    • +

  • Proactively update recommendations based on changing events.

    • +

  • Meet operational goals, increase customer loyalty, prevent threats +and fraud, and optimize business processes.

    • +
+
+
+

Checking minimum requirements

+

This notebook uses some features of pandas that are available in version +0.17.1 or above.

+
import pip
+REQUIRED_MINIMUM_PANDAS_VERSION = '0.17.1'
+try:
+    import pandas as pd
+    assert pd.__version__ >= REQUIRED_MINIMUM_PANDAS_VERSION
+except:
+    raise Exception("Version %s or above of Pandas is required to run this notebook" % REQUIRED_MINIMUM_PANDAS_VERSION)
+
+
+
+
+

Use decision optimization

+
+

Step 1: Import the library

+

Run the following code to import the Decision Optimization CPLEX +Modeling library. The DOcplex library contains the two modeling +packages, Mathematical Programming (docplex.mp) and Constraint +Programming (docplex.cp).

+
import sys
+try:
+    import docplex.mp
+except:
+    raise Exception('Please install docplex. See https://pypi.org/project/docplex/')
+
+
+
+
+

Step 2: Model the data

+

The input data consists of several tables:

+
    +

  • The Departments table lists all departments in the scope of the +assignment.

    • +

  • The Skills table list all skills.

    • +

  • The Shifts table lists all shifts to be staffed. A shift contains a +department, a day in the week, plus the start and end times.

    • +

  • The Nurses table lists all nurses, identified by their names.

    • +

  • The NurseSkills table gives the skills of each nurse.

    • +

  • The SkillRequirements table lists the minimum number of persons +required for a given department and skill.

    • +

  • The NurseVacations table lists days off for each nurse.

    • +

  • The NurseAssociations table lists pairs of nurses who wish to work +together.

    • +

  • The NurseIncompatibilities table lists pairs of nurses who do not +want to work together.

    • +
+
+

Loading data from Excel with pandas

+

We load the data from an Excel file using pandas. Each sheet is read +into a separate pandas DataFrame.

+
CSS = """
+body {
+    margin: 0;
+    font-family: Helvetica;
+}
+table.dataframe {
+    border-collapse: collapse;
+    border: none;
+}
+table.dataframe tr {
+    border: none;
+}
+table.dataframe td, table.dataframe th {
+    margin: 0;
+    border: 1px solid white;
+    padding-left: 0.25em;
+    padding-right: 0.25em;
+}
+table.dataframe th:not(:empty) {
+    background-color: #fec;
+    text-align: left;
+    font-weight: normal;
+}
+table.dataframe tr:nth-child(2) th:empty {
+    border-left: none;
+    border-right: 1px dashed #888;
+}
+table.dataframe td {
+    border: 2px solid #ccf;
+    background-color: #f4f4ff;
+}
+    table.dataframe thead th:first-child {
+        display: none;
+    }
+    table.dataframe tbody th {
+        display: none;
+    }
+"""
+
+
+
from IPython.core.display import HTML
+HTML('<style>{}</style>'.format(CSS))
+
+from IPython.display import display
+
+
+
try:
+    from StringIO import StringIO
+except ImportError:
+    from io import StringIO
+
+
+
# This notebook requires pandas to work
+import pandas as pd
+from pandas import DataFrame
+
+# Make sure that xlrd package, which is a pandas optional dependency, is installed
+# This package is required for Excel I/O
+try:
+    import xlrd
+except:
+    if hasattr(sys, 'real_prefix'):
+        #we are in a virtual env.
+        !pip install xlrd
+    else:
+        !pip install --user xlrd
+
+# Use pandas to read the file, one tab for each table.
+data_url = "https://github.com/IBMDecisionOptimization/docplex-examples/blob/master/examples/mp/jupyter/nurses_data.xls?raw=true"
+nurse_xls_file = pd.ExcelFile(data_url)
+
+df_skills = nurse_xls_file.parse('Skills')
+df_depts = nurse_xls_file.parse('Departments')
+df_shifts = nurse_xls_file.parse('Shifts')
+# Rename df_shifts index
+df_shifts.index.name = 'shiftId'
+
+# Index is column 0: name
+df_nurses = nurse_xls_file.parse('Nurses', header=0, index_col=0)
+df_nurse_skills = nurse_xls_file.parse('NurseSkills')
+df_vacations = nurse_xls_file.parse('NurseVacations')
+df_associations = nurse_xls_file.parse('NurseAssociations')
+df_incompatibilities = nurse_xls_file.parse('NurseIncompatibilities')
+
+# Display the nurses dataframe
+print("#nurses = {}".format(len(df_nurses)))
+print("#shifts = {}".format(len(df_shifts)))
+print("#vacations = {}".format(len(df_vacations)))
+
+
+
#nurses = 32
+#shifts = 41
+#vacations = 59
+
+
+

In addition, we introduce some extra global data:

+
    +

  • The maximum work time for each nurse.

    • +

  • The maximum and minimum number of shifts worked by a nurse in a week.

    • +
+
# maximum work time (in hours)
+max_work_time = 40
+
+# maximum number of shifts worked in a week.
+max_nb_shifts = 5
+
+
+

Shifts are stored in a separate DataFrame.

+
df_shifts
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
departmentdaystart_timeend_timemin_reqmax_req
shiftId
0EmergencyMonday2835
1EmergencyMonday81247
2EmergencyMonday121825
3EmergencyMonday18237
4ConsultationMonday8121013
5ConsultationMonday1218812
6Cardiac CareMonday8121013
7Cardiac CareMonday1218812
8EmergencyTuesday81247
9EmergencyTuesday121825
10EmergencyTuesday18237
11ConsultationTuesday8121013
12ConsultationTuesday1218812
13Cardiac CareTuesday81247
14Cardiac CareTuesday121825
15Cardiac CareTuesday18237
16EmergencyWednesday2835
17EmergencyWednesday81247
18EmergencyWednesday121825
19EmergencyWednesday18237
20ConsultationWednesday8121013
21ConsultationWednesday1218812
22EmergencyThursday2835
23EmergencyThursday81247
24EmergencyThursday121825
25EmergencyThursday18237
26ConsultationThursday8121013
27ConsultationThursday1218812
28EmergencyFriday2835
29EmergencyFriday81247
30EmergencyFriday121825
31EmergencyFriday18237
32ConsultationFriday8121013
33ConsultationFriday1218812
34EmergencySaturday21257
35EmergencySaturday122079
36EmergencySaturday2021212
37EmergencySunday21257
38EmergencySunday122079
39EmergencySunday202812
40GeriatricsSunday81025
+
+
+
+

Step 3: Prepare the data

+

We need to precompute additional data for shifts. For each shift, we +need the start time and end time expressed in hours, counting from the +beginning of the week: Monday 8am is converted to 8, Tuesday 8am is +converted to 24+8 = 32, and so on.

+
+

Sub-step #1

+

We start by adding an extra column dow (day of week) which converts +the string “day” into an integer in 0..6 (Monday is 0, Sunday is 6).

+
days = ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
+day_of_weeks = dict(zip(days, range(7)))
+
+# utility to convert a day string e.g. "Monday" to an integer in 0..6
+def day_to_day_of_week(day):
+    return day_of_weeks[day.strip().lower()]
+
+# for each day name, we normalize it by stripping whitespace and converting it to lowercase
+# " Monday" -> "monday"
+df_shifts["dow"] = df_shifts.day.apply(day_to_day_of_week)
+df_shifts
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
departmentdaystart_timeend_timemin_reqmax_reqdow
shiftId
0EmergencyMonday28350
1EmergencyMonday812470
2EmergencyMonday1218250
3EmergencyMonday182370
4ConsultationMonday81210130
5ConsultationMonday12188120
6Cardiac CareMonday81210130
7Cardiac CareMonday12188120
8EmergencyTuesday812471
9EmergencyTuesday1218251
10EmergencyTuesday182371
11ConsultationTuesday81210131
12ConsultationTuesday12188121
13Cardiac CareTuesday812471
14Cardiac CareTuesday1218251
15Cardiac CareTuesday182371
16EmergencyWednesday28352
17EmergencyWednesday812472
18EmergencyWednesday1218252
19EmergencyWednesday182372
20ConsultationWednesday81210132
21ConsultationWednesday12188122
22EmergencyThursday28353
23EmergencyThursday812473
24EmergencyThursday1218253
25EmergencyThursday182373
26ConsultationThursday81210133
27ConsultationThursday12188123
28EmergencyFriday28354
29EmergencyFriday812474
30EmergencyFriday1218254
31EmergencyFriday182374
32ConsultationFriday81210134
33ConsultationFriday12188124
34EmergencySaturday212575
35EmergencySaturday1220795
36EmergencySaturday20212125
37EmergencySunday212576
38EmergencySunday1220796
39EmergencySunday2028126
40GeriatricsSunday810256
+
+
+

Sub-step #2 : Compute the absolute start time of each shift.

+

Computing the start time in the week is easy: just add 24*dow to +column start_time. The result is stored in a new column wstart.

+
df_shifts["wstart"] = df_shifts.start_time + 24 * df_shifts.dow
+
+
+
+
+

Sub-Step #3 : Compute the absolute end time of each shift.

+

Computing the absolute end time is a little more complicated as certain +shifts span across midnight. For example, Shift #3 starts on Monday at +18:00 and ends Tuesday at 2:00 AM. The absolute end time of Shift #3 is +26, not 2. The general rule for computing absolute end time is:

+

abs_end_time = end_time + 24 * dow + (start_time>= end_time ? 24 : 0)

+

Again, we use pandas to add a new calculated column wend. This is +done by using the pandas apply method with an anonymous lambda +function over rows. The raw=True parameter prevents the creation of +a pandas Series for each row, which improves the performance +significantly on large data sets.

+
# an auxiliary function to calculate absolute end time of a shift
+def calculate_absolute_endtime(start, end, dow):
+    return 24*dow + end + (24 if start>=end else 0)
+
+# store the results in a new column
+df_shifts["wend"] = df_shifts.apply(lambda row: calculate_absolute_endtime(
+        row.start_time, row.end_time, row.dow), axis=1, raw=True)
+
+
+
+
+

Sub-step #4 : Compute the duration of each shift.

+

Computing the duration of each shift is now a straightforward difference +of columns. The result is stored in column duration.

+
df_shifts["duration"] = df_shifts.wend - df_shifts.wstart
+
+
+
+
+

Sub-step #5 : Compute the minimum demand for each shift.

+

Minimum demand is the product of duration (in hours) by the minimum +required number of nurses. Thus, in number of nurse-hours, this demand +is stored in another new column min_demand.

+

Finally, we display the updated shifts DataFrame with all calculated +columns.

+
# also compute minimum demand in nurse-hours
+df_shifts["min_demand"] = df_shifts.min_req * df_shifts.duration
+
+# finally check the modified shifts dataframe
+df_shifts
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
departmentdaystart_timeend_timemin_reqmax_reqdowwstartwenddurationmin_demand
shiftId
0EmergencyMonday2835028618
1EmergencyMonday812470812416
2EmergencyMonday12182501218612
3EmergencyMonday1823701826824
4ConsultationMonday81210130812440
5ConsultationMonday121881201218648
6Cardiac CareMonday81210130812440
7Cardiac CareMonday121881201218648
8EmergencyTuesday8124713236416
9EmergencyTuesday12182513642612
10EmergencyTuesday1823714250824
11ConsultationTuesday812101313236440
12ConsultationTuesday121881213642648
13Cardiac CareTuesday8124713236416
14Cardiac CareTuesday12182513642612
15Cardiac CareTuesday1823714250824
16EmergencyWednesday283525056618
17EmergencyWednesday8124725660416
18EmergencyWednesday12182526066612
19EmergencyWednesday1823726674824
20ConsultationWednesday812101325660440
21ConsultationWednesday121881226066648
22EmergencyThursday283537480618
23EmergencyThursday8124738084416
24EmergencyThursday12182538490612
25EmergencyThursday1823739098824
26ConsultationThursday812101338084440
27ConsultationThursday121881238490648
28EmergencyFriday2835498104618
29EmergencyFriday812474104108416
30EmergencyFriday1218254108114612
31EmergencyFriday182374114122824
32ConsultationFriday81210134104108440
33ConsultationFriday12188124108114648
34EmergencySaturday2125751221321050
35EmergencySaturday1220795132140856
36EmergencySaturday20212125140146672
37EmergencySunday2125761461561050
38EmergencySunday1220796156164856
39EmergencySunday2028126164170648
40GeriatricsSunday81025615215424
+
+
+
+

Step 4: Set up the prescriptive model

+
from docplex.mp.environment import Environment
+env = Environment()
+env.print_information()
+
+
+
* system is: Windows 64bit
+* Python version 3.7.3, located at: c:\local\python373\python.exe
+* docplex is present, version is (2, 11, 0)
+* pandas is present, version is 0.25.1
+
+

Create the DOcplex model

+

The model contains all the business constraints and defines the +objective.

+

We now use CPLEX Modeling for Python to build a Mixed Integer +Programming (MIP) model for this problem.

+
from docplex.mp.model import Model
+mdl = Model(name="nurses")
+
+
+
+
+

Define the decision variables

+

For each (nurse, shift) pair, we create one binary variable that is +equal to 1 when the nurse is assigned to the shift.

+

We use the binary_var_matrix method of class Model, as each +binary variable is indexed by two objects: one nurse and one shift.

+
# first global collections to iterate upon
+all_nurses = df_nurses.index.values
+all_shifts = df_shifts.index.values
+
+# the assignment variables.
+assigned = mdl.binary_var_matrix(keys1=all_nurses, keys2=all_shifts, name="assign_%s_%s")
+
+
+
+
+

Express the business constraints

+
+
Overlapping shifts
+

Some shifts overlap in time, and thus cannot be assigned to the same +nurse. To check whether two shifts overlap in time, we start by ordering +all shifts with respect to their wstart and duration properties. +Then, for each shift, we iterate over the subsequent shifts in this +ordered list to easily compute the subset of overlapping shifts.

+

We use pandas operations to implement this algorithm. But first, we +organize all decision variables in a DataFrame.

+

For convenience, we also organize the decision variables in a pivot +table with nurses as row index and shifts as columns. The pandas +unstack operation does this.

+
# Organize decision variables in a DataFrame
+df_assigned = DataFrame({'assigned': assigned})
+df_assigned.index.names=['all_nurses', 'all_shifts']
+
+# Re-organize the Data Frame as a pivot table with nurses as row index and shifts as columns:
+df_assigned_pivot = df_assigned.unstack(level='all_shifts')
+
+# Create a pivot using nurses and shifts index as dimensions
+#df_assigned_pivot = df_assigned.reset_index().pivot(index='all_nurses', columns='all_shifts', values='assigned')
+
+# Display first rows of the pivot table
+df_assigned_pivot.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
assigned
all_shifts0123456789...31323334353637383940
all_nurses
Anneassign_Anne_0assign_Anne_1assign_Anne_2assign_Anne_3assign_Anne_4assign_Anne_5assign_Anne_6assign_Anne_7assign_Anne_8assign_Anne_9...assign_Anne_31assign_Anne_32assign_Anne_33assign_Anne_34assign_Anne_35assign_Anne_36assign_Anne_37assign_Anne_38assign_Anne_39assign_Anne_40
Bethanieassign_Bethanie_0assign_Bethanie_1assign_Bethanie_2assign_Bethanie_3assign_Bethanie_4assign_Bethanie_5assign_Bethanie_6assign_Bethanie_7assign_Bethanie_8assign_Bethanie_9...assign_Bethanie_31assign_Bethanie_32assign_Bethanie_33assign_Bethanie_34assign_Bethanie_35assign_Bethanie_36assign_Bethanie_37assign_Bethanie_38assign_Bethanie_39assign_Bethanie_40
Betsyassign_Betsy_0assign_Betsy_1assign_Betsy_2assign_Betsy_3assign_Betsy_4assign_Betsy_5assign_Betsy_6assign_Betsy_7assign_Betsy_8assign_Betsy_9...assign_Betsy_31assign_Betsy_32assign_Betsy_33assign_Betsy_34assign_Betsy_35assign_Betsy_36assign_Betsy_37assign_Betsy_38assign_Betsy_39assign_Betsy_40
Cathyassign_Cathy_0assign_Cathy_1assign_Cathy_2assign_Cathy_3assign_Cathy_4assign_Cathy_5assign_Cathy_6assign_Cathy_7assign_Cathy_8assign_Cathy_9...assign_Cathy_31assign_Cathy_32assign_Cathy_33assign_Cathy_34assign_Cathy_35assign_Cathy_36assign_Cathy_37assign_Cathy_38assign_Cathy_39assign_Cathy_40
Ceciliaassign_Cecilia_0assign_Cecilia_1assign_Cecilia_2assign_Cecilia_3assign_Cecilia_4assign_Cecilia_5assign_Cecilia_6assign_Cecilia_7assign_Cecilia_8assign_Cecilia_9...assign_Cecilia_31assign_Cecilia_32assign_Cecilia_33assign_Cecilia_34assign_Cecilia_35assign_Cecilia_36assign_Cecilia_37assign_Cecilia_38assign_Cecilia_39assign_Cecilia_40
+

5 rows � 41 columns

+

We create a DataFrame representing a list of shifts sorted by “wstart” +and “duration”. This sorted list will be used to easily detect +overlapping shifts.

+

Note that indices are reset after sorting so that the DataFrame can be +indexed with respect to the index in the sorted list and not the +original unsorted list. This is the purpose of the reset_index() +operation which also adds a new column named “shiftId” with the +original index.

+
# Create a Data Frame representing a list of shifts sorted by wstart and duration.
+# One keeps only the three relevant columns: 'shiftId', 'wstart' and 'wend' in the resulting Data Frame
+df_sorted_shifts = df_shifts.sort_values(['wstart','duration']).reset_index()[['shiftId', 'wstart', 'wend']]
+
+# Display the first rows of the newly created Data Frame
+df_sorted_shifts.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
shiftIdwstartwend
0028
11812
24812
36812
421218
+

Next, we state that for any pair of shifts that overlap in time, a nurse +can be assigned to only one of the two.

+
number_of_incompatible_shift_constraints = 0
+for shift in df_sorted_shifts.itertuples():
+    # Iterate over following shifts
+    # 'shift[0]' contains the index of the current shift in the df_sorted_shifts Data Frame
+    for shift_2 in df_sorted_shifts.iloc[shift[0] + 1:].itertuples():
+        if (shift_2.wstart < shift.wend):
+            # Iterate over all nurses to force incompatible assignment for the current pair of overlapping shifts
+            for nurse_assignments in df_assigned_pivot.iloc[:, [shift.shiftId, shift_2.shiftId]].itertuples():
+                # this is actually a logical OR
+                mdl.add_constraint(nurse_assignments[1] + nurse_assignments[2] <= 1)
+                number_of_incompatible_shift_constraints += 1
+        else:
+            # No need to test overlap with following shifts
+            break
+print("#incompatible shift constraints: {}".format(number_of_incompatible_shift_constraints))
+
+
+
#incompatible shift constraints: 640
+
+
+
+
+
Vacations
+

When the nurse is on vacation, he cannot be assigned to any shift +starting that day.

+

We use the pandas merge operation to create a join between the +“df_vacations”, “df_shifts”, and “df_assigned” DataFrames. Each +row of the resulting DataFrame contains the assignment decision variable +corresponding to the matching (nurse, shift) pair.

+
# Add 'day of week' column to vacations Data Frame
+df_vacations['dow'] = df_vacations.day.apply(day_to_day_of_week)
+
+# Join 'df_vacations', 'df_shifts' and 'df_assigned' Data Frames to create the list of 'forbidden' assigments.
+# The 'reset_index()' function is invoked to move 'shiftId' index as a column in 'df_shifts' Data Frame, and
+# to move the index pair ('all_nurses', 'all_shifts') as columns in 'df_assigned' Data Frame.
+# 'reset_index()' is invoked so that a join can be performed between Data Frame, based on column names.
+df_assigned_reindexed = df_assigned.reset_index()
+df_vacation_forbidden_assignments = df_vacations.merge(df_shifts.reset_index()[['dow', 'shiftId']]).merge(
+    df_assigned_reindexed, left_on=['nurse', 'shiftId'], right_on=['all_nurses', 'all_shifts'])
+
+# Here are the first few rows of the resulting Data Frames joins
+df_vacation_forbidden_assignments.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nursedaydowshiftIdall_nursesall_shiftsassigned
0AnneFriday428Anne28assign_Anne_28
1AnneFriday429Anne29assign_Anne_29
2AnneFriday430Anne30assign_Anne_30
3AnneFriday431Anne31assign_Anne_31
4AnneFriday432Anne32assign_Anne_32
+
for forbidden_assignment in df_vacation_forbidden_assignments.itertuples():
+    # to forbid an assignment just set the variable to zero.
+    mdl.add_constraint(forbidden_assignment.assigned == 0)
+print("# vacation forbids: {} assignments".format(len(df_vacation_forbidden_assignments)))
+
+
+
# vacation forbids: 342 assignments
+
+
+
+
+
Associations
+

Some pairs of nurses get along particularly well, so we wish to assign +them together as a team. In other words, for every such couple and for +each shift, both assignment variables should always be equal. Either +both nurses work the shift, or both do not.

+

In the same way we modeled vacations, we use the pandas merge +operation to create a DataFrame for which each row contains the pair of +nurse-shift assignment decision variables matching each association.

+
# Join 'df_assignment' Data Frame twice, based on associations to get corresponding decision variables pairs for all shifts
+# The 'suffixes' parameter in the second merge indicates our preference for updating the name of columns that occur both
+# in the first and second argument Data Frames (in our case, these columns are 'all_nurses' and 'assigned').
+df_preferred_assign = df_associations.merge(
+    df_assigned_reindexed, left_on='nurse1', right_on='all_nurses').merge(
+    df_assigned_reindexed, left_on=['nurse2', 'all_shifts'], right_on=['all_nurses', 'all_shifts'], suffixes=('_1','_2'))
+
+# Here are the first few rows of the resulting Data Frames joins
+df_preferred_assign.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nurse1nurse2all_nurses_1all_shiftsassigned_1all_nurses_2assigned_2
0IsabelleDeeIsabelle0assign_Isabelle_0Deeassign_Dee_0
1IsabelleDeeIsabelle1assign_Isabelle_1Deeassign_Dee_1
2IsabelleDeeIsabelle2assign_Isabelle_2Deeassign_Dee_2
3IsabelleDeeIsabelle3assign_Isabelle_3Deeassign_Dee_3
4IsabelleDeeIsabelle4assign_Isabelle_4Deeassign_Dee_4
+

The associations constraint can now easily be formulated by iterating on +the rows of the “df_preferred_assign” DataFrame.

+
for preferred_assign in df_preferred_assign.itertuples():
+    mdl.add_constraint(preferred_assign.assigned_1 == preferred_assign.assigned_2)
+
+
+
+
+
Incompatibilities
+

Similarly, certain pairs of nurses do not get along well, and we want to +avoid having them together on a shift. In other terms, for each shift, +both nurses of an incompatible pair cannot be assigned together to the +sift. Again, we state a logical OR between the two assignments: at most +one nurse from the pair can work the shift.

+

We first create a DataFrame whose rows contain pairs of invalid +assignment decision variables, using the same pandas merge +operations as in the previous step.

+
# Join assignment Data Frame twice, based on incompatibilities Data Frame to get corresponding decision variables pairs
+#  for all shifts
+df_incompatible_assign = df_incompatibilities.merge(
+    df_assigned_reindexed, left_on='nurse1', right_on='all_nurses').merge(
+    df_assigned_reindexed, left_on=['nurse2', 'all_shifts'], right_on=['all_nurses', 'all_shifts'], suffixes=('_1','_2'))
+
+# Here are the first few rows of the resulting Data Frames joins
+df_incompatible_assign.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nurse1nurse2all_nurses_1all_shiftsassigned_1all_nurses_2assigned_2
0PatriciaPatrickPatricia0assign_Patricia_0Patrickassign_Patrick_0
1PatriciaPatrickPatricia1assign_Patricia_1Patrickassign_Patrick_1
2PatriciaPatrickPatricia2assign_Patricia_2Patrickassign_Patrick_2
3PatriciaPatrickPatricia3assign_Patricia_3Patrickassign_Patrick_3
4PatriciaPatrickPatricia4assign_Patricia_4Patrickassign_Patrick_4
+

The incompatibilities constraint can now easily be formulated, by +iterating on the rows of the “df_incompatible_assign” DataFrame.

+
for incompatible_assign in df_incompatible_assign.itertuples():
+    mdl.add_constraint(incompatible_assign.assigned_1 + incompatible_assign.assigned_2 <= 1)
+
+
+
+
+
Constraints on work time
+

Regulations force constraints on the total work time over a week; and we +compute this total work time in a new variable. We store the variable in +an extra column in the nurse DataFrame.

+

The variable is declared as continuous though it contains only integer +values. This is done to avoid adding unnecessary integer variables for +the branch and bound algorithm. These variables are not true decision +variables; they are used to express work constraints.

+

From a pandas perspective, we apply a function over the rows of the +nurse DataFrame to create this variable and store it into a new column +of the DataFrame.

+
# auxiliary function to create worktime variable from a row
+def make_var(row, varname_fmt):
+    return mdl.continuous_var(name=varname_fmt % row.name, lb=0)
+
+# apply the function over nurse rows and store result in a new column
+df_nurses["worktime"] = df_nurses.apply(lambda r: make_var(r, "worktime_%s"), axis=1)
+
+# display nurse dataframe
+df_nurses
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
seniorityqualificationpay_rateworktime
name
Anne11125worktime_Anne
Bethanie4528worktime_Bethanie
Betsy2217worktime_Betsy
Cathy2217worktime_Cathy
Cecilia9538worktime_Cecilia
Chris11438worktime_Chris
Cindy5221worktime_Cindy
David1215worktime_David
Debbie7224worktime_Debbie
Dee3321worktime_Dee
Gloria8225worktime_Gloria
Isabelle3116worktime_Isabelle
Jane3423worktime_Jane
Janelle4322worktime_Janelle
Janice2217worktime_Janice
Jemma2422worktime_Jemma
Joan5324worktime_Joan
Joyce8329worktime_Joyce
Jude4322worktime_Jude
Julie6222worktime_Julie
Juliet7431worktime_Juliet
Kate5324worktime_Kate
Nancy8432worktime_Nancy
Nathalie9538worktime_Nathalie
Nicole0214worktime_Nicole
Patricia1113worktime_Patricia
Patrick6119worktime_Patrick
Roberta3526worktime_Roberta
Suzanne5118worktime_Suzanne
Vickie7120worktime_Vickie
Wendie5221worktime_Wendie
Zoe8329worktime_Zoe
+

Define total work time

+

Work time variables must be constrained to be equal to the sum of hours +actually worked.

+

We use the pandas groupby operation to collect all assignment +decision variables for each nurse in a separate series. Then, we iterate +over nurses to post a constraint calculating the actual worktime for +each nurse as the dot product of the series of nurse-shift assignments +with the series of shift durations.

+
# Use pandas' groupby operation to enforce constraint calculating worktime for each nurse as the sum of all assigned
+#  shifts times the duration of each shift
+for nurse, nurse_assignments in df_assigned.groupby(level='all_nurses'):
+    mdl.add_constraint(df_nurses.worktime[nurse] == mdl.dot(nurse_assignments.assigned, df_shifts.duration))
+
+# print model information and check we now have 32 extra continuous variables
+mdl.print_information()
+
+
+
Model: nurses
+ - number of variables: 1344
+   - binary=1312, integer=0, continuous=32
+ - number of constraints: 1547
+   - linear=1547
+ - parameters: defaults
+ - problem type is: MILP
+
+
+

Maximum work time

+

For each nurse, we add a constraint to enforce the maximum work time for +a week. Again we use the apply method, this time with an anonymous +lambda function.

+
# we use pandas' apply() method to set an upper bound on all worktime variables.
+def set_max_work_time(v):
+    v.ub = max_work_time
+    # Optionally: return a string for fancy display of the constraint in the Output cell
+    return str(v) + ' <= ' + str(v.ub)
+
+df_nurses["worktime"].apply(convert_dtype=False, func=set_max_work_time)
+
+
+
name
+Anne            worktime_Anne <= 40
+Bethanie    worktime_Bethanie <= 40
+Betsy          worktime_Betsy <= 40
+Cathy          worktime_Cathy <= 40
+Cecilia      worktime_Cecilia <= 40
+Chris          worktime_Chris <= 40
+Cindy          worktime_Cindy <= 40
+David          worktime_David <= 40
+Debbie        worktime_Debbie <= 40
+Dee              worktime_Dee <= 40
+Gloria        worktime_Gloria <= 40
+Isabelle    worktime_Isabelle <= 40
+Jane            worktime_Jane <= 40
+Janelle      worktime_Janelle <= 40
+Janice        worktime_Janice <= 40
+Jemma          worktime_Jemma <= 40
+Joan            worktime_Joan <= 40
+Joyce          worktime_Joyce <= 40
+Jude            worktime_Jude <= 40
+Julie          worktime_Julie <= 40
+Juliet        worktime_Juliet <= 40
+Kate            worktime_Kate <= 40
+Nancy          worktime_Nancy <= 40
+Nathalie    worktime_Nathalie <= 40
+Nicole        worktime_Nicole <= 40
+Patricia    worktime_Patricia <= 40
+Patrick      worktime_Patrick <= 40
+Roberta      worktime_Roberta <= 40
+Suzanne      worktime_Suzanne <= 40
+Vickie        worktime_Vickie <= 40
+Wendie        worktime_Wendie <= 40
+Zoe              worktime_Zoe <= 40
+Name: worktime, dtype: object
+
+
+
+
+
Minimum requirement for shifts
+

Each shift requires a minimum number of nurses. For each shift, the sum +over all nurses of assignments to this shift must be greater than the +minimum requirement.

+

The pandas groupby operation is invoked to collect all assignment +decision variables for each shift in a separate series. Then, we iterate +over shifts to post the constraint enforcing the minimum number of nurse +assignments for each shift.

+
# Use pandas' groupby operation to enforce minimum requirement constraint for each shift
+for shift, shift_nurses in df_assigned.groupby(level='all_shifts'):
+    mdl.add_constraint(mdl.sum(shift_nurses.assigned) >= df_shifts.min_req[shift])
+
+
+
+
+
+

Express the objective

+

The objective mixes different (and contradictory) KPIs.

+

The first KPI is the total salary cost, computed as the sum of work +times over all nurses, weighted by pay rate.

+

We compute this KPI as an expression from the variables we previously +defined by using the panda summation over the DOcplex objects.

+
# again leverage pandas to create a series of expressions: costs of each nurse
+total_salary_series = df_nurses.worktime * df_nurses.pay_rate
+
+# compute global salary cost using pandas sum()
+# Note that the result is a DOcplex expression: DOcplex if fully compatible with pandas
+total_salary_cost = total_salary_series.sum()
+mdl.add_kpi(total_salary_cost, "Total salary cost")
+
+
+
DecisionKPI(name=Total salary cost,expr=25worktime_Anne+28worktime_Bethanie+17worktime_Betsy+17worktime_..)
+
+
+
+
Minimizing salary cost
+

In a preliminary version of the model, we minimize the total salary +cost. This is accomplished using the Model.minimize() method.

+
mdl.minimize(total_salary_cost)
+mdl.print_information()
+
+
+
Model: nurses
+ - number of variables: 1344
+   - binary=1312, integer=0, continuous=32
+ - number of constraints: 1588
+   - linear=1588
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
+

Solve with Decision Optimization

+

Now we have everything we need to solve the model, using +Model.solve(). The following cell solves using your local CPLEX (if +any, and provided you have added it to your PYTHONPATH variable).

+
# Set Cplex mipgap to 1e-5 to enforce precision to be of the order of a unit (objective value magnitude is ~1e+5).
+mdl.parameters.mip.tolerances.mipgap = 1e-5
+
+s = mdl.solve(log_output=True)
+assert s, "solve failed"
+mdl.report()
+
+
+
CPXPARAM_Read_DataCheck                          1
+CPXPARAM_MIP_Tolerances_MIPGap                   1.0000000000000001e-05
+Tried aggregator 2 times.
+MIP Presolve eliminated 997 rows and 379 columns.
+MIP Presolve modified 90 coefficients.
+Aggregator did 41 substitutions.
+Reduced MIP has 550 rows, 922 columns, and 2862 nonzeros.
+Reduced MIP has 892 binaries, 0 generals, 0 SOSs, and 0 indicators.
+Presolve time = 0.00 sec. (3.68 ticks)
+Probing time = 0.00 sec. (0.50 ticks)
+Tried aggregator 1 time.
+Reduced MIP has 550 rows, 922 columns, and 2862 nonzeros.
+Reduced MIP has 892 binaries, 30 generals, 0 SOSs, and 0 indicators.
+Presolve time = 0.00 sec. (2.03 ticks)
+Probing time = 0.00 sec. (0.50 ticks)
+Clique table members: 479.
+MIP emphasis: balance optimality and feasibility.
+MIP search method: dynamic search.
+Parallel mode: deterministic, using up to 12 threads.
+Root relaxation solution time = 0.00 sec. (4.56 ticks)
+
+        Nodes                                         Cuts/
+   Node  Left     Objective  IInf  Best Integer    Best Bound    ItCnt     Gap
+
+      0     0    28824.0000    48                  28824.0000      473
+      0     0    28824.0000    62                    Cuts: 98      649
+      0     0    28824.0000    35                    Cuts: 44      716
+      0     0    28824.0000    41                    Cuts: 55      795
+*     0+    0                        29100.0000    28824.0000             0.95%
+*     0+    0                        29068.0000    28824.0000             0.84%
+      0     2    28824.0000    10    29068.0000    28824.0000      795    0.84%
+Elapsed time = 0.24 sec. (139.30 ticks, tree = 0.02 MB, solutions = 2)
+*    10+    4                        29014.0000    28824.0000             0.65%
+*    11+    2                        29010.0000    28824.0000             0.64%
+*    15+    2                        28982.0000    28824.0000             0.55%
+*    26+    1                        28944.0000    28824.0000             0.41%
+*    47+   10                        28936.0000    28824.0000             0.39%
+*  1611+ 1392                        28888.0000    28824.0000             0.22%
+*  4006+ 3397                        28842.0000    28824.0000             0.06%
+*  4152+ 3293                        28824.0000    28824.0000             0.00%
+   4253  3414    28824.0000     6    28824.0000    28824.0000    73849    0.00%
+
+GUB cover cuts applied:  12
+Cover cuts applied:  76
+Flow cuts applied:  5
+Mixed integer rounding cuts applied:  11
+Zero-half cuts applied:  13
+Lift and project cuts applied:  5
+
+Root node processing (before b&c):
+  Real time             =    0.24 sec. (139.27 ticks)
+Parallel b&c, 12 threads:
+  Real time             =    0.47 sec. (270.80 ticks)
+  Sync time (average)   =    0.08 sec.
+  Wait time (average)   =    0.00 sec.
+                          ------------
+Total (root+branch&cut) =    0.70 sec. (410.07 ticks)
+* model nurses solved with objective = 28824.000
+*  KPI: Total salary cost = 28824.000
+
+
+
+
+
+

Step 5: Investigate the solution and then run an example analysis

+

We take advantage of pandas to analyze the results. First we store the +solution values of the assignment variables into a new pandas Series.

+

Calling solution_value on a DOcplex variable returns its value in +the solution (provided the model has been successfully solved).

+
# Create a pandas Series containing actual shift assignment decision variables value
+s_assigned = df_assigned.assigned.apply(lambda v: v.solution_value)
+
+# Create a pivot table by (nurses, shifts), using pandas' "unstack" method to transform the 'all_shifts' row index
+#  into columns
+df_res = s_assigned.unstack(level='all_shifts')
+
+# Display the first few rows of the resulting pivot table
+df_res.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
all_shifts0123456789...31323334353637383940
all_nurses
Anne0.01.00.00.00.01.00.00.00.00.0...0.00.00.00.00.00.00.00.00.00.0
Bethanie0.01.00.00.00.00.00.01.00.00.0...0.00.01.01.00.00.00.00.00.00.0
Betsy0.00.00.00.00.00.00.00.00.00.0...1.01.00.00.00.00.00.00.00.00.0
Cathy0.00.00.00.00.00.01.01.00.00.0...0.01.01.00.00.01.01.00.00.00.0
Cecilia0.00.00.01.00.01.01.00.00.00.0...0.00.00.00.00.00.00.00.00.00.0
+

5 rows � 41 columns

+
+

Analyzing how worktime is distributed

+

Let’s analyze how worktime is distributed among nurses.

+

First, we compute the global average work time as the total minimum +requirement in hours, divided by number of nurses.

+
s_demand  = df_shifts.min_req * df_shifts.duration
+total_demand = s_demand.sum()
+avg_worktime = total_demand / float(len(all_nurses))
+print("* theoretical average work time is {0:g} h".format(avg_worktime))
+
+
+
* theoretical average work time is 39 h
+
+
+

Let’s analyze the series of deviations to the average, stored in a +pandas Series.

+
# a pandas series of worktimes solution values
+s_worktime = df_nurses.worktime.apply(lambda v: v.solution_value)
+
+# returns a new series computed as deviation from average
+s_to_mean = s_worktime - avg_worktime
+
+# take the absolute value
+s_abs_to_mean = s_to_mean.apply(abs)
+
+
+total_to_mean = s_abs_to_mean.sum()
+print("* the sum of absolute deviations from mean is {}".format(total_to_mean))
+
+
+
* the sum of absolute deviations from mean is 58.0
+
+
+

To see how work time is distributed among nurses, print a histogram of +work time values. Note that, as all time data are integers, work times +in the solution can take only integer values.

+
import matplotlib.pyplot as plt
+%matplotlib inline
+
+# we can also plot as a histogram the distribution of worktimes
+s_worktime.plot.hist(color='LightBlue')
+plt.xlabel("worktime")
+
+
+
Text(0.5, 0, 'worktime')
+
+
+_images/nurses_pandas_72_1.png +
+
+

How shifts are distributed

+

Let’s now analyze the solution from the number of shifts perspective. +How many shifts does each nurse work? Are these shifts fairly +distributed amongst nurses?

+

We compute a new column in our result DataFrame for the number of shifts +worked, by summing rows (the “axis=1” argument in the sum() call +indicates to pandas that each sum is performed by row instead of +column):

+
# a pandas series of #shifts worked
+df_worked = df_res[all_shifts].sum(axis=1)
+df_res["worked"] = df_worked
+
+df_worked.plot.hist(color="gold", xlim=(0,10))
+plt.ylabel("#shifts worked")
+
+
+
Text(0, 0.5, '#shifts worked')
+
+
+_images/nurses_pandas_74_1.png +

We see that one nurse works significantly fewer shifts than others do. +What is the average number of shifts worked by a nurse? This is equal to +the total demand divided by the number of nurses.

+

Of course, this yields a fractional number of shifts that is not +practical, but nonetheless will help us quantify the fairness in shift +distribution.

+
avg_worked = df_shifts["min_req"].sum() / float(len(all_nurses))
+print("-- expected avg #shifts worked is {}".format(avg_worked))
+
+worked_to_avg = df_res["worked"] - avg_worked
+total_to_mean = worked_to_avg.apply(abs).sum()
+print("-- total absolute deviation to mean #shifts is {}".format(total_to_mean))
+
+
+
-- expected avg #shifts worked is 6.875
+-- total absolute deviation to mean #shifts is 16.25
+
+
+
+
+
+

Introducing a fairness goal

+

As the above diagram suggests, the distribution of shifts could be +improved. We implement this by adding one extra objective, fairness, +which balances the shifts assigned over nurses.

+

Note that we can edit the model, that is add (or remove) constraints, +even after it has been solved.

+
+
+

Step #1 : Introduce three new variables per nurse to model the

+

number of shifts worked and positive and negative deviations to the +average.

+
# add two extra variables per nurse: deviations above and below average
+df_nurses["worked"]      = df_nurses.apply(lambda r: make_var(r, "worked%s"), axis=1)
+df_nurses["overworked"]  = df_nurses.apply(lambda r: make_var(r, "overw_%s"), axis=1)
+df_nurses["underworked"] = df_nurses.apply(lambda r: make_var(r, "underw_%s"), axis=1)
+
+
+
+
+

Step #2 : Post the constraint that links these variables together.

+
# Use the pandas groupby operation to enforce the constraint calculating number of worked shifts for each nurse
+for nurse, nurse_assignments in df_assigned.groupby(level='all_nurses'):
+    # nb of worked shifts is sum of assigned shifts
+    mdl.add_constraint(df_nurses.worked[nurse] == mdl.sum(nurse_assignments.assigned))
+
+for nurse in df_nurses.itertuples():
+    # nb worked is average + over - under
+    mdl.add_constraint(nurse.worked == avg_worked + nurse.overworked - nurse.underworked)
+
+
+
+
+

Step #3 : Define KPIs to measure the result after solve.

+
# finally, define kpis for over and under average quantities
+total_overw = mdl.sum(df_nurses["overworked"])
+mdl.add_kpi(total_overw, "Total over-worked")
+total_underw = mdl.sum(df_nurses["underworked"])
+mdl.add_kpi(total_underw, "Total under-worked")
+
+
+
DecisionKPI(name=Total under-worked,expr=underw_Anne+underw_Bethanie+underw_Betsy+underw_Cathy+underw_Cec..)
+
+
+

Finally, let’s modify the objective by adding the sum of +over_worked and under_worked to the previous objective.

+

Note: The definitions of over_worked and under_worked as +described above are not sufficient to give them an unambiguous value. +However, as all these variables are minimized, CPLEX ensures that these +variables take the minimum possible values in the solution.

+
mdl.minimize(total_salary_cost + total_overw + total_underw)  # incorporate over_worked and under_worked in objective
+
+
+

Our modified model is ready to solve.

+

The log_output=True parameter tells CPLEX to print the log on the +standard output.

+
sol2 = mdl.solve(log_output=True)  # solve again and get a new solution
+assert sol2, "Solve failed"
+mdl.report()
+
+
+
CPXPARAM_Read_DataCheck                          1
+CPXPARAM_MIP_Tolerances_MIPGap                   1.0000000000000001e-05
+1 of 31 MIP starts provided solutions.
+MIP start 'm1' defined initial solution with objective 28840.2500.
+Tried aggregator 2 times.
+MIP Presolve eliminated 997 rows and 379 columns.
+MIP Presolve modified 90 coefficients.
+Aggregator did 73 substitutions.
+Reduced MIP has 582 rows, 986 columns, and 3859 nonzeros.
+Reduced MIP has 892 binaries, 0 generals, 0 SOSs, and 0 indicators.
+Presolve time = 0.02 sec. (4.35 ticks)
+Probing time = 0.00 sec. (0.59 ticks)
+Tried aggregator 1 time.
+MIP Presolve eliminated 2 rows and 4 columns.
+Reduced MIP has 580 rows, 982 columns, and 3814 nonzeros.
+Reduced MIP has 892 binaries, 30 generals, 0 SOSs, and 0 indicators.
+Presolve time = 0.00 sec. (2.41 ticks)
+Probing time = 0.00 sec. (0.58 ticks)
+Clique table members: 479.
+MIP emphasis: balance optimality and feasibility.
+MIP search method: dynamic search.
+Parallel mode: deterministic, using up to 12 threads.
+Root relaxation solution time = 0.01 sec. (11.48 ticks)
+
+        Nodes                                         Cuts/
+   Node  Left     Objective  IInf  Best Integer    Best Bound    ItCnt     Gap
+
+*     0+    0                        28840.2500        0.0000           100.00%
+      0     0    28827.9167    76    28840.2500    28827.9167      885    0.04%
+      0     0    28829.2500    51    28840.2500      Cuts: 89     1053    0.04%
+      0     0    28829.9063    59    28840.2500     Cuts: 107     1359    0.04%
+      0     0    28831.0000    33    28840.2500      Cuts: 55     1530    0.03%
+      0     0    28831.0000    45    28840.2500      Cuts: 36     1649    0.03%
+      0     0    28831.0000    35    28840.2500       Cuts: 8     1715    0.03%
+      0     0    28831.0000    34    28840.2500      Cuts: 29     1783    0.03%
+*     0+    0                        28831.2500    28831.0000             0.00%
+
+GUB cover cuts applied:  19
+Cover cuts applied:  4
+Flow cuts applied:  21
+Mixed integer rounding cuts applied:  69
+Zero-half cuts applied:  14
+Gomory fractional cuts applied:  4
+
+Root node processing (before b&c):
+  Real time             =    0.36 sec. (211.92 ticks)
+Parallel b&c, 12 threads:
+  Real time             =    0.00 sec. (0.00 ticks)
+  Sync time (average)   =    0.00 sec.
+  Wait time (average)   =    0.00 sec.
+                          ------------
+Total (root+branch&cut) =    0.36 sec. (211.92 ticks)
+* model nurses solved with objective = 28831.250
+*  KPI: Total salary cost  = 28824.000
+*  KPI: Total over-worked  = 3.625
+*  KPI: Total under-worked = 3.625
+
+
+
+
+

Analyzing new results

+

Let’s recompute the new total deviation from average on this new +solution.

+
# Create a pandas Series containing actual shift assignment decision variables value
+s_assigned2 = df_assigned.assigned.apply(lambda v: v.solution_value)
+
+# Create a pivot table by (nurses, shifts), using pandas' "unstack" method to transform the 'all_shifts' row index
+#  into columns
+df_res2 = s_assigned2.unstack(level='all_shifts')
+
+# Add a new column to the pivot table containing the #shifts worked by summing over each row
+df_res2["worked"] = df_res2[all_shifts].sum(axis=1)
+
+# total absolute deviation from average is directly read on expressions
+new_total_to_mean = total_overw.solution_value + total_underw.solution_value
+print("-- total absolute deviation to mean #shifts is now {0} down from {1}".format(new_total_to_mean, total_to_mean))
+
+# Display the first few rows of the result Data Frame
+df_res2.head()
+
+
+
-- total absolute deviation to mean #shifts is now 7.25 down from 16.25
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
all_shifts0123456789...323334353637383940worked
all_nurses
Anne0.01.00.01.00.00.00.00.00.01.0...0.00.00.00.00.00.00.00.00.07.0
Bethanie0.00.00.00.01.00.00.01.00.00.0...0.01.01.00.00.00.00.00.00.07.0
Betsy0.00.00.00.00.00.00.00.01.00.0...1.01.01.00.00.00.00.00.00.07.0
Cathy0.00.00.00.00.00.01.00.00.00.0...0.01.00.00.01.01.00.01.00.07.0
Cecilia0.00.00.00.00.01.01.00.00.00.0...0.00.00.00.01.00.00.00.00.07.0
+

5 rows � 42 columns

+

Let’s print the new histogram of shifts worked.

+
df_res2["worked"].plot(kind="hist", color="gold", xlim=(3,8))
+
+
+
<matplotlib.axes._subplots.AxesSubplot at 0x279df51e710>
+
+
+_images/nurses_pandas_90_1.png +

The breakdown of shifts over nurses is much closer to the average than +it was in the previous version.

+
+
+

But what would be the minimal fairness level?

+

But what is the absolute minimum for the deviation to the ideal average +number of shifts? CPLEX can tell us: simply minimize only the the total +deviation from average, ignoring the salary cost. Of course this is +unrealistic, but it will help us quantify how far our fairness result is +to the absolute optimal fairness.

+

We modify the objective and solve for the third time.

+
mdl.minimize(total_overw + total_underw)
+assert mdl.solve(), "solve failed"
+mdl.report()
+
+
+
* model nurses solved with objective = 4.000
+*  KPI: Total salary cost  = 29606.000
+*  KPI: Total over-worked  = 4.000
+*  KPI: Total under-worked = 0.000
+
+
+

In the fairness-optimal solution, we have zero under-average shifts and +4 over-average. Salary cost is now higher than the previous value of +28884 but this was expected as salary cost was not part of the +objective.

+

To summarize, the absolute minimum for this measure of fairness is 4, +and we have found a balance with fairness=7.

+

Finally, we display the histogram for this optimal-fairness solution.

+
# Create a pandas Series containing actual shift assignment decision variables value
+s_assigned_fair = df_assigned.assigned.apply(lambda v: v.solution_value)
+
+# Create a pivot table by (nurses, shifts), using pandas' "unstack" method to transform the 'all_shifts' row index
+#  into columns
+df_res_fair = s_assigned_fair.unstack(level='all_shifts')
+
+# Add a new column to the pivot table containing the #shifts worked by summing over each row
+df_res_fair["solution_value_fair"] = df_res_fair[all_shifts].sum(axis=1)
+df_res_fair["worked"] = df_res_fair[all_shifts].sum(axis=1)
+df_res_fair["worked"].plot.hist(color="plum", xlim=(3,8))
+
+
+
<matplotlib.axes._subplots.AxesSubplot at 0x279e05915f8>
+
+
+_images/nurses_pandas_95_1.png +

In the above figure, all nurses but one are assigned the average of 7 +shifts, which is what we expected.

+
+
+
+

Summary

+

You learned how to set up and use IBM Decision Optimization CPLEX +Modeling for Python to formulate a Mathematical Programming model and +solve it with IBM Decision Optimization on Cloud.

+
+
+

References

+ +

Copyright � 2017-2019 IBM. IPLA licensed Sample Materials.

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/nurses_scheduling.html b/docs/2.29.245/docs/mp/nurses_scheduling.html new file mode 100644 index 0000000..03e327f --- /dev/null +++ b/docs/2.29.245/docs/mp/nurses_scheduling.html @@ -0,0 +1,1186 @@ + + + + + + + + + + The Nurses Model — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

The Nurses Model

+

This tutorial includes everything you need to set up IBM Decision +Optimization CPLEX Modeling for Python (DOcplex), build a Mathematical +Programming model, and get its solution by solving the model on the +cloud with IBM ILOG CPLEX Optimizer.

+

When you finish this tutorial, you’ll have a foundational knowledge of +Prescriptive Analytics.

+
+

This notebook is part of Prescriptive Analytics for +Python

+

It requires either an installation of CPLEX +Optimizers +or it can be run on IBM Watson Studio +Cloud (Sign up for a +free IBM Cloud +account +and you can start using Watson Studio Cloud right away).

+
+

Table of contents:

+ +
+
+

Describe the business problem

+

This model deals with nurse scheduling. Nurses must be assigned to +hospital shifts in accordance with various skill and staffing +constraints.

+

The goal of the model is to find an efficient balance between the +different objectives:

+
    +

  • minimize the overall cost of the plan and

    • +

  • assign shifts as fairly as possible.

    • +
+
+
+

How decision optimization can help

+
    +

  • Prescriptive analytics (decision optimization) technology recommends +actions that are based on desired outcomes. It takes into account +specific scenarios, resources, and knowledge of past and current +events. With this insight, your organization can make better +decisions and have greater control of business outcomes.

    • +

  • Prescriptive analytics is the next step on the path to insight-based +actions. It creates value through synergy with predictive analytics, +which analyzes data to predict future outcomes.

    • +
  • +
    Prescriptive analytics takes that insight to the next level by +suggesting the optimal way to handle that future situation. +Organizations that can act fast in dynamic conditions and make +superior decisions in uncertain environments gain a strong +competitive advantage.
    +

    +
    +
    • +
+

With prescriptive analytics, you can:

+
    +

  • Automate the complex decisions and trade-offs to better manage your +limited resources.

    • +

  • Take advantage of a future opportunity or mitigate a future risk.

    • +

  • Proactively update recommendations based on changing events.

    • +

  • Meet operational goals, increase customer loyalty, prevent threats +and fraud, and optimize business processes.

    • +
+
+
+

Use decision optimization

+
+

Step 1: Import the library

+

Run the following code to import Decision Optimization CPLEX Modeling +library. The DOcplex library contains the two modeling packages, +Mathematical Programming and Constraint Programming.

+
import sys
+try:
+    import docplex.mp
+except:
+    raise Exception('Please install docplex. See https://pypi.org/project/docplex/')
+
+
+
+
+

Step 2: Model the data

+

Input data consists of several tables:

+
    +

  • The Departments table lists all departments in the scope of the +assignment.

    • +

  • The Skills table list all skills.

    • +

  • The Shifts table lists all shifts to be staffed. A shift contains a +department, a day in the week, plus the start and end times.

    • +

  • The Nurses table lists all nurses, identified by their names.

    • +

  • The NurseSkills table gives the skills of each nurse.

    • +

  • The SkillRequirements table lists the minimum number of persons +required for a given department and skill.

    • +

  • The NurseVacations table lists days off for each nurse.

    • +

  • The NurseAssociations table lists pairs of nurses who wish to work +together.

    • +

  • The NurseIncompatibilities table lists pairs of nurses who do not +want to work together . In addition, the plan has to satisfy a +maximum worktime for all nurses, for example 40 hours a week.

    • +
+
+
+

Step 3: Prepare the data

+

Now we need some basic data structures to store information.

+
from enum import Enum
+from collections import namedtuple
+
+# utility to conevrt a weekday string to an index in 0..6
+_all_days = ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
+
+
+def day_to_day_week(day):
+    day_map = {day: d for d, day in enumerate(_all_days)}
+    return day_map[day.lower()]
+
+TWorkRules = namedtuple("TWorkRules", ["work_time_max"])
+TVacation = namedtuple("TVacation", ["nurse", "day"])
+TNursePair = namedtuple("TNursePair", ["firstNurse", "secondNurse"])
+TNurseSkill = namedtuple("TNurseSkill", ["nurse", "skill"])
+TSkillRequirement = namedtuple("TSkillRequirement", ["department", "skill", "required"])
+
+
+# subclass the namedtuple to refine the str() method as the nurse's name
+class TNurse(namedtuple("TNurse1", ["name", "pay_rate"])):
+    """ A subclass to redefine the default str() of namedtuple.
+    This class is used in variable naming, so we need to redefine the str() method
+    used by variable naming.
+    """
+
+    def __str__(self):
+        return self.name
+
+
+class TShift(
+    namedtuple("TShift1", ["department", "day", "start_time", "end_time", "min_requirement", "max_requirement"])):
+    """ specialize namedtuple to redefine its str() method
+    """
+
+    def __str__(self):
+        # keep first two characters in departement, uppercased
+        dept2 = self.department[0:4].upper()
+        # keep 3 days of weekday
+        dayname = self.day[0:3]
+        return '%s_%s_%02d' % (dept2, dayname, self.start_time)
+
+
+class ShiftActivity(object):
+    @staticmethod
+    def to_abstime(day_index, time_of_day):
+        """ Convert a pair (day_index, time) into a number of hours since Monday 00:00
+
+        :param day_index: The index of the day from 1 to 7 (Monday is 1).
+        :param time_of_day: An integer number of hours.
+
+        :return:
+        """
+        time = 24 * (day_index - 1)
+        time += time_of_day
+        return time
+
+    def __init__(self, weekday, start_time_of_day, end_time_of_day):
+        assert (start_time_of_day >= 0)
+        assert (start_time_of_day <= 24)
+        assert (end_time_of_day >= 0)
+        assert (end_time_of_day <= 24)
+
+        self._weekday = weekday
+        self._start_time_of_day = start_time_of_day
+        self._end_time_of_day = end_time_of_day
+        # conversion to absolute time.
+        start_day_index = day_to_day_week(self._weekday)
+        self.start_time = self.to_abstime(start_day_index, start_time_of_day)
+        self.day_start_time = self.to_abstime(start_day_index, 0)
+        end_day_index = start_day_index if end_time_of_day > start_time_of_day else start_day_index + 1
+        self.end_time = self.to_abstime(end_day_index, end_time_of_day)
+        assert self.end_time > self.start_time
+
+    @property
+    def duration(self):
+        return self.end_time - self.start_time
+
+    def overlaps(self, other_shift):
+        if not isinstance(other_shift, ShiftActivity):
+            return False
+        else:
+            return other_shift.end_time > self.start_time and other_shift.start_time < self.end_time
+
+
+
+

Loading data from Excel with pandas

+

We load the data from an Excel file using pandas. Each sheet is read +into a separate pandas DataFrame.

+
CSS = """
+body {
+    margin: 0;
+    font-family: Helvetica;
+}
+table.dataframe {
+    border-collapse: collapse;
+    border: none;
+}
+table.dataframe tr {
+    border: none;
+}
+table.dataframe td, table.dataframe th {
+    margin: 0;
+    border: 1px solid white;
+    padding-left: 0.25em;
+    padding-right: 0.25em;
+}
+table.dataframe th:not(:empty) {
+    background-color: #fec;
+    text-align: left;
+    font-weight: normal;
+}
+table.dataframe tr:nth-child(2) th:empty {
+    border-left: none;
+    border-right: 1px dashed #888;
+}
+table.dataframe td {
+    border: 2px solid #ccf;
+    background-color: #f4f4ff;
+}
+    table.dataframe thead th:first-child {
+        display: none;
+    }
+    table.dataframe tbody th {
+        display: none;
+    }
+"""
+
+
+
from IPython.core.display import HTML
+HTML('<style>{}</style>'.format(CSS))
+
+from IPython.display import display
+
+
+
try:
+    from StringIO import StringIO
+except ImportError:
+    from io import StringIO
+
+
+
# This notebook requires pandas to work
+import pandas as pd
+
+# Make sure that xlrd package, which is a pandas optional dependency, is installed
+# This package is required for Excel I/O
+try:
+    import xlrd
+except:
+    if hasattr(sys, 'real_prefix'):
+        #we are in a virtual env.
+        !pip install xlrd
+    else:
+        !pip install --user xlrd
+
+data_url = "https://github.com/IBMDecisionOptimization/docplex-examples/blob/master/examples/mp/jupyter/nurses_data.xls?raw=true"
+nurse_xls_file = pd.ExcelFile(data_url)
+
+SkillTable = nurse_xls_file.parse('Skills')
+DeptTable  = nurse_xls_file.parse('Departments')
+ShiftTable = nurse_xls_file.parse('Shifts')
+SkillRequirementTable = nurse_xls_file.parse('SkillRequirements')
+NurseTable = nurse_xls_file.parse('Nurses')
+NurseSkillTable = nurse_xls_file.parse('NurseSkills')
+NurseVacationTable = nurse_xls_file.parse('NurseVacations')
+NurseAssociationTable = nurse_xls_file.parse('NurseAssociations')
+NurseIncompatibilityTable = nurse_xls_file.parse('NurseIncompatibilities')
+
+display(NurseTable)
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
nameseniorityqualificationpay_rate
0Anne11125
1Bethanie4528
2Betsy2217
3Cathy2217
4Cecilia9538
5Chris11438
6Cindy5221
7David1215
8Debbie7224
9Dee3321
10Gloria8225
11Isabelle3116
12Jane3423
13Janelle4322
14Janice2217
15Jemma2422
16Joan5324
17Joyce8329
18Jude4322
19Julie6222
20Juliet7431
21Kate5324
22Nancy8432
23Nathalie9538
24Nicole0214
25Patricia1113
26Patrick6119
27Roberta3526
28Suzanne5118
29Vickie7120
30Wendie5221
31Zoe8329
+

Now, we create some additional data structures to be used for building +the prescriptive model. The goal is to not depend on pandas when +defining decision variables and constraints. The ‘nurses_pandas’ +notebook illustrates how to benefit from pandas to build the +prescriptive model.

+
skills = [SkillTable["name"][i] for i in range(len(SkillTable))]
+depts  = [DeptTable["name"][i] for i in range(len(DeptTable))]
+nurses =[TNurse(NurseTable["name"][i], NurseTable["pay_rate"][i]) for i in range(len(NurseTable))]
+
+nurses = [nurse for nurse in nurses if nurse.pay_rate <25 and nurse.pay_rate >15]
+# Build {nurse: [skills]} dictionary
+nurse_skills = {}
+for nsk in NurseSkillTable.itertuples(index=False):
+    nskt= TNurseSkill(*nsk)
+    nurse_skills.setdefault(nskt.nurse, []).append(nskt.skill)
+
+shifts = [TShift(*shift_row) for shift_row in ShiftTable.itertuples(index=False)]
+skill_requirements = [TSkillRequirement(*skill_requirement_row) for skill_requirement_row in
+                      SkillRequirementTable.itertuples(index=False)]
+vacations = [TVacation(*vacation_row) for vacation_row in NurseVacationTable.itertuples(index=False)]
+nurse_associations = [TNursePair(*na) for na in NurseAssociationTable.itertuples(index=False)]
+nurse_incompatibilities = [TNursePair(*na) for na in NurseIncompatibilityTable.itertuples(index=False)]
+
+# compute shift activities (start, end, duration) and store them in a dict indexed by shifts
+shift_activities = {s: ShiftActivity(s.day, s.start_time, s.end_time) for s in shifts}
+
+# map from nurse names to nurse tuples.
+nurses_by_id = {n.name: n for n in nurses}
+
+# Work rules: max work time
+work_rules = TWorkRules(40)
+
+
+
+
+
+

Step 4: Set up the prescriptive model

+
from docplex.mp.environment import Environment
+env = Environment()
+env.print_information()
+
+
+
* system is: Windows 64bit
+* Python version 3.7.3, located at: c:\local\python373\python.exe
+* docplex is present, version is (2, 11, 0)
+* pandas is present, version is 0.25.1
+
+

Create the DOcplex model

+

This model contains all the business constraints and defines the +objective.

+
from docplex.mp.model import Model
+
+mdl = Model("nurses")
+
+
+
+
+

Define the decision variables

+

The basic decisions are “which nurse works which shift”, which is +modeled by binary variables for each (nurse, shift) pair.

+

The output of the model is, for each shift, the list of nurses that work +the shift.

+
# One binary variable for each pair (nurse, shift) equal to 1 if nurse n is assigned to shift s
+nurse_assignment_vars = mdl.binary_var_matrix(nurses, shifts, 'NurseAssigned')
+
+# For each nurse, allocate one variable for worktime
+nurse_work_time_vars = mdl.continuous_var_dict(nurses, lb=0, name='NurseWorkTime')
+
+# And two variables for over_average and under-average work time
+nurse_over_average_time_vars = mdl.continuous_var_dict(nurses, lb=0, name='NurseOverAverageWorkTime')
+nurse_under_average_time_vars = mdl.continuous_var_dict(nurses, lb=0, name='NurseUnderAverageWorkTime')
+
+# Finally the global average work time
+average_nurse_work_time = mdl.continuous_var(lb=0, name='AverageWorkTime')
+
+
+
+
+

Express the business constraints

+
+
First constraint: define average work time
+

The average work time over all nurses will be used in particular to +calculate the over/under average work time for each nurse, and to +formulate a fairness rule.

+
mdl.add_constraint(len(nurses) * average_nurse_work_time ==
+                   mdl.sum(nurse_work_time_vars[n] for n in nurses), "average")
+
+
+
docplex.mp.LinearConstraint[average](18AverageWorkTime,EQ,NurseWorkTime_Betsy+NurseWorkTime_Cathy+NurseWorkTime_Cindy+NurseWorkTime_Debbie+NurseWorkTime_Dee+NurseWorkTime_Isabelle+NurseWorkTime_Jane+NurseWorkTime_Janelle+NurseWorkTime_Janice+NurseWorkTime_Jemma+NurseWorkTime_Joan+NurseWorkTime_Jude+NurseWorkTime_Julie+NurseWorkTime_Kate+NurseWorkTime_Patrick+NurseWorkTime_Suzanne+NurseWorkTime_Vickie+NurseWorkTime_Wendie)
+
+
+
+
+
Second constraint: compute nurse work time, average and under/over time
+
for n in nurses:
+    work_time_var = nurse_work_time_vars[n]
+    mdl.add_constraint(
+        work_time_var == mdl.sum(nurse_assignment_vars[n, s] * shift_activities[s].duration for s in shifts),
+        "work_time_{0!s}".format(n))
+
+    # Relate over/under average worktime variables to the worktime variables.
+    # The trick here is that variables have zero lower bound
+    # however, these variables are not completely defined by this constraint,
+    # only their difference is.
+    # If these variables are part of the objective, CPLEX will naturally minimize their value,
+    # as expected.
+    mdl.add_constraint(
+        work_time_var == average_nurse_work_time + nurse_over_average_time_vars[n] - nurse_under_average_time_vars[n],
+        "average_work_time_{0!s}".format(n))
+
+    # State the maximum work time as a constraint, so that it can be relaxed,
+    # should the problem become infeasible.
+    mdl.add_constraint(work_time_var <= work_rules.work_time_max, "max_time_{0!s}".format(n))
+
+
+
+
+
Third constraint: vacations
+

When a nurse is on vacation, he or she cannot be assigned to any shift +starting that day.

+
for vac_nurse_id, vac_day in vacations:
+        vac_n = nurses_by_id.get(vac_nurse_id, -1)
+        if vac_n != -1:
+            for shift in (s for s in shifts if s.day == vac_day):
+                mdl.add_constraint(nurse_assignment_vars[vac_n, shift] == 0,
+                                     "medium_vacations_{0!s}_{1!s}_{2!s}".format(vac_n, vac_day, shift))
+
+
+
+
+
Fourth constraint: a nurse cannot be assigned overlapping shifts
+

Some shifts overlap in time and thus cannot be assigned to the same +nurse.

+
# Post only one constraint per couple(s1, s2)
+number_of_overlaps = 0
+nb_shifts = len(shifts)
+for i1 in range(nb_shifts):
+    for i2 in range(i1 + 1, nb_shifts):
+        s1 = shifts[i1]
+        s2 = shifts[i2]
+        if shift_activities[s1].overlaps(shift_activities[s2]):
+            number_of_overlaps += 1
+            for n in nurses:
+                mdl.add_constraint(nurse_assignment_vars[n, s1] + nurse_assignment_vars[n, s2] <= 1,
+                                   "high_overlapping_{0!s}_{1!s}_{2!s}".format(s1, s2, n))
+print("# overlapping shifts: {}".format(number_of_overlaps))
+
+
+
# overlapping shifts: 20
+
+
+
+
+
Fifth constraint: enforce minimum and maximum requirements for shifts
+

Each shift requires a minimum and a maximum number of nurses. For each +shift, the sum over all nurses of assignments to this shift must be +greater than or equal to the minimum requirement and lesser than or +equal to the maximum requirement.

+
for s in shifts:
+    demand_min = s.min_requirement
+    demand_max = s.max_requirement
+    total_assigned = mdl.sum(nurse_assignment_vars[n, s] for n in nurses)
+    mdl.add_constraint(total_assigned >= demand_min,
+                       "high_req_min_{0!s}_{1}".format(s, demand_min))
+    mdl.add_constraint(total_assigned <= demand_max,
+                       "medium_req_max_{0!s}_{1}".format(s, demand_max))
+
+
+
+
+
Sixth constraint: enforce skill requirements for selected shifts
+

Some shifts require at least x nurses with a specified skill.

+
for (dept, skill, required) in skill_requirements:
+    if required > 0:
+        for dsh in (s for s in shifts if dept == s.department):
+            mdl.add_constraint(mdl.sum(nurse_assignment_vars[skilled_nurse, dsh] for skilled_nurse in
+                                       (n for n in nurses if n.name in nurse_skills.keys() and
+                                        skill in nurse_skills[n.name])) >= required,
+                               "high_required_{0!s}_{1!s}_{2!s}_{3!s}".format(dept, skill, required, dsh))
+
+
+
+
+
Seventh constraint: associations
+

Some pairs of nurses get along particularly well, so we wish to assign +them together as a team. In other words, for every such pair and for +each shift, both assignment variables should always be equal. Either +both nurses work the shift, or both do not.

+
# for each pair of associted nurses, their assignement variables are equal over all shifts.
+c = 0
+for (nurse_id1, nurse_id2) in nurse_associations:
+    if nurse_id1 in nurses_by_id and nurse_id2 in nurses_by_id:
+        nurse1 = nurses_by_id[nurse_id1]
+        nurse2 = nurses_by_id[nurse_id2]
+        for s in shifts:
+            c += 1
+            ctname = 'medium_ct_nurse_assoc_{0!s}_{1!s}_{2:d}'.format(nurse_id1, nurse_id2, c)
+            mdl.add_constraint(nurse_assignment_vars[nurse1, s] == nurse_assignment_vars[nurse2, s], ctname)
+
+
+
+
+
Eighth constraint: incompatibilities
+

Similarly, certain pairs of nurses do not get along well, and we want to +avoid having them together on a shift. In other words, for each shift, +both nurses of an incompatible pair cannot be assigned together to the +shift.

+
# For each pair of incompatible nurses, the sum of assigned variables is less than one
+c = 0
+for (nurse_id1, nurse_id2) in nurse_incompatibilities:
+    if nurse_id1 in nurses_by_id and nurse_id2 in nurses_by_id:
+        nurse1 = nurses_by_id[nurse_id1]
+        nurse2 = nurses_by_id[nurse_id2]
+        for s in shifts:
+            c += 1
+            ctname = 'medium_ct_nurse_incompat_{0!s}_{1!s}_{2:d}'.format(nurse_id1, nurse_id2, c)
+            mdl.add_constraint(nurse_assignment_vars[nurse1, s] + nurse_assignment_vars[nurse2, s] <= 1, ctname)
+
+
+
+
+
+

Express the objective

+

The objective mixes different (and contradictory) KPIs.

+

The first KPI is the total salary cost, computed as the sum of work +times over all nurses, weighted by pay rate. The second KPI is the total +number of assignments (nurse, shift). The third KPI is the average total +work time over all nurses. The fourth KPI represents the total number of +hours that is above the average work time (summed over all nurses), +while the fifth KPI represents the total number of hours that is below +this average. Finally, the last KPI is a measure of fairness, which is +evaluated as the total deviation from the average work time.

+
total_number_of_assignments = mdl.sum(nurse_assignment_vars[n,s] for n in nurses for s in shifts)
+nurse_costs = [nurse_assignment_vars[n, s] * n.pay_rate * shift_activities[s].duration for n in nurses for s in shifts]
+total_salary_cost = mdl.sum(nurse_costs)
+mdl.add_kpi(total_salary_cost, "Total salary cost")
+mdl.add_kpi(total_number_of_assignments, "Total number of assignments")
+mdl.add_kpi(average_nurse_work_time)
+
+total_over_average_worktime = mdl.sum(nurse_over_average_time_vars[n] for n in nurses)
+total_under_average_worktime = mdl.sum(nurse_under_average_time_vars[n] for n in nurses)
+mdl.add_kpi(total_over_average_worktime, "Total over-average worktime")
+mdl.add_kpi(total_under_average_worktime, "Total under-average worktime")
+
+total_fairness = total_over_average_worktime + total_under_average_worktime
+mdl.add_kpi(total_fairness, "Total fairness")
+
+mdl.print_information()
+
+
+
Model: nurses
+ - number of variables: 793
+   - binary=738, integer=0, continuous=55
+ - number of constraints: 961
+   - linear=961
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
Minimizing objective
+

The goal is to minimize the non-weighted sum of the total salary cost, +fairness and total number of assignment. This is accomplished using +the Model.minimize() method.

+

This definition is arbitrary and could be revised. For instance, one +could emphasize minimizing salary cost by adding a weight on this term +in the objective.

+
mdl.minimize(total_salary_cost + total_fairness + total_number_of_assignments)
+
+
+
+
+
+

Solve with Decision Optimization

+

Now we have everything we need to solve the model, using +Model.solve(). The following cell solves using your local CPLEX (if +any, and provided you have added it to your PYTHONPATH variable).

+
# Set Cplex mipgap to 1e-5 to enforce precision to be of the order of a unit (objective value magnitude is ~1e+5).
+mdl.parameters.mip.tolerances.mipgap = 1e-5
+
+s = mdl.solve(log_output=True)
+if not s:
+    # solve has failed, we try relaxation, based on constraint names
+    # constraints are prioritized according to their names
+    # if a name contains "low", it has priority LOW
+    # if a ct name contains "medium" it has priority MEDIUM
+    # same for HIGH
+    # if a constraint has no name or does not match any, it is not relaxable.
+    from docplex.mp.relaxer import Relaxer
+    relaxer = Relaxer(prioritizer='match', verbose=True)
+    # self.enable_trace()
+    #self.parameters.mip.tolerances.mipgap = 0.03 # 3%
+    relaxed_sol = relaxer.relax(mdl)
+    relaxed_ok = relaxed_sol is not None
+    assert relaxed_ok, "relaxation failed"
+    relaxer.print_information()
+
+mdl.report()
+
+
+
CPXPARAM_Read_DataCheck                          1
+CPXPARAM_MIP_Tolerances_MIPGap                   1.0000000000000001e-05
+Bound infeasibility column 'NurseWorkTime_Betsy'.
+Presolve time = 0.00 sec. (0.29 ticks)
+
+Root node processing (before b&c):
+  Real time             =    0.00 sec. (0.45 ticks)
+Parallel b&c, 12 threads:
+  Real time             =    0.00 sec. (0.00 ticks)
+  Sync time (average)   =    0.00 sec.
+  Wait time (average)   =    0.00 sec.
+                          ------------
+Total (root+branch&cut) =    0.00 sec. (0.45 ticks)
+Warning: 55 constraint(s) will not be relaxed (e.g.: average: 18AverageWorkTime == NurseWorkTime_Betsy+NurseWorkTime_Cathy+NurseWorkTime_Cindy+NurseWorkTime_Debbie+NurseWorkTime_Dee+NurseWorkTime_Isabelle+NurseWorkTime_Jane+NurseWorkTime_Janelle+NurseWorkTime_Janice+NurseWorkTime_Jemma+NurseWorkTime_Joan+NurseWorkTime_Jude+NurseWorkTime_Julie+NurseWorkTime_Kate+NurseWorkTime_Patrick+NurseWorkTime_Suzanne+NurseWorkTime_Vickie+NurseWorkTime_Wendie)
+* number of relaxations: 35
+ - relaxed: high_req_min_EMER_Mon_18_3, with relaxation: -3.0
+ - relaxed: high_req_min_CONS_Mon_08_10, with relaxation: -5.0
+ - relaxed: high_req_min_CONS_Mon_12_8, with relaxation: -3.0
+ - relaxed: high_req_min_CARD_Mon_08_10, with relaxation: -6.0
+ - relaxed: high_req_min_CARD_Mon_12_8, with relaxation: -6.0
+ - relaxed: high_req_min_EMER_Tue_08_4, with relaxation: -2.0
+ - relaxed: high_req_min_EMER_Tue_18_3, with relaxation: -3.0
+ - relaxed: high_req_min_CONS_Tue_08_10, with relaxation: -4.0
+ - relaxed: high_req_min_CONS_Tue_12_8, with relaxation: -5.0
+ - relaxed: high_req_min_CARD_Tue_08_4, with relaxation: -1.0
+ - relaxed: high_req_min_CARD_Tue_18_3, with relaxation: -3.0
+ - relaxed: high_req_min_EMER_Wed_18_3, with relaxation: -1.0
+ - relaxed: high_req_min_EMER_Thu_02_3, with relaxation: -1.0
+ - relaxed: high_req_min_EMER_Thu_18_3, with relaxation: -3.0
+ - relaxed: high_req_min_CONS_Thu_08_10, with relaxation: -2.0
+ - relaxed: high_req_min_CONS_Thu_12_8, with relaxation: -1.0
+ - relaxed: high_req_min_EMER_Fri_18_3, with relaxation: -3.0
+ - relaxed: high_req_min_CONS_Fri_08_10, with relaxation: -3.0
+ - relaxed: high_req_min_CONS_Fri_12_8, with relaxation: -3.0
+ - relaxed: high_req_min_EMER_Sat_02_5, with relaxation: -5.0
+ - relaxed: high_req_min_EMER_Sat_12_7, with relaxation: -7.0
+ - relaxed: high_req_min_EMER_Sat_20_12, with relaxation: -4.0
+ - relaxed: high_req_min_EMER_Sun_02_5, with relaxation: -5.0
+ - relaxed: high_req_min_EMER_Sun_12_7, with relaxation: -7.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Mon_02, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Mon_18, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Tue_18, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Wed_12, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Wed_18, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Thu_18, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Fri_18, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Sat_02, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Sat_12, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Sun_02, with relaxation: -1.0
+ - relaxed: high_required_Emergency_Cardiac Care_1_EMER_Sun_12, with relaxation: -1.0
+* total absolute relaxation: 97.0
+* model nurses solved with objective = 14097.333
+*  KPI: Total salary cost            = 13940.000
+*  KPI: Total number of assignments  = 134.000
+*  KPI: AverageWorkTime              = 37.667
+*  KPI: Total over-average worktime  = 11.667
+*  KPI: Total under-average worktime = 11.667
+*  KPI: Total fairness               = 23.333
+
+
+
+
+
+

Step 5: Investigate the solution and then run an example analysis

+

Let’s display some charts to visualize the results: a Gantt chart +displaying the assignment of nurses to shifts in a Gantt chart, and +another chart showing the number of assigned nurses to each department +over time.

+
min(shift_activities, key=lambda i: shift_activities[i].day_start_time)
+min(s.day_start_time for s in shift_activities.values())
+
+
+
-24
+
+
+
import matplotlib.pyplot as plt
+import matplotlib.gridspec as gridspec
+%matplotlib inline
+
+# Build set of all departments and assign a color to each of them to be used in figures
+departments = {s.department for s in shifts}
+colorByDepartment = {}
+for d, c in zip(departments, ['r', 'm', 'b', 'g', 'y', 'c', 'k']):
+    colorByDepartment[d] = c
+
+# Build dictionary with number of assigned nurses for each shift
+nbAssignmentsByShift={}
+for n in nurses:
+    for s in shifts:
+        if nurse_assignment_vars[n,s].solution_value > 0:
+            nbAssignmentsByShift[s] = nbAssignmentsByShift.get(s,0) + 1
+
+# Build a dictionary with the list of each shift corresponding to each department
+shiftsByDepartment = {}
+for s in shifts:
+    shiftsByDepartment.setdefault(s.department, []).append(s)
+
+
+# Shared code
+def createLabels(ax, title, xlabel, ylabel):
+    shiftInfoByDay = {s1.day : s1 for s1 in shifts}
+    try: # Python 2
+        plt.xticks([shift_activities[s].day_start_time + w * 7 * 24 for w in [0,1] for (d, s) in shiftInfoByDay.iteritems()],
+              ["{}".format(s.day) for w in [0,1] for (d, s) in shiftInfoByDay.iteritems()])
+    except:
+        plt.xticks([shift_activities[s].day_start_time + w * 7 * 24 for w in [0,1] for (d, s) in shiftInfoByDay.items()],
+              ["{}".format(s.day) for w in [0,1] for (d, s) in shiftInfoByDay.items()])
+
+    plt.xlim([min(s.day_start_time for s in shift_activities.values()) - 6,
+              max(s.day_start_time for s in shift_activities.values()) + 30])
+    ax.set_xlabel(xlabel)
+    ax.set_ylabel(ylabel)
+    ax.grid()
+    ax.set_title(title)
+
+# Plot shift assignments for each nurse
+def displayNursesAssignmentsGantt(ax):
+    ylabels, tickloc = [], []
+    for i, n in enumerate(nurses):
+        for s in shifts:
+            if nurse_assignment_vars[n,s].solution_value > 0:
+                shift_activity = shift_activities[s]
+                ax.bar(shift_activity.start_time, 0.8,
+                       width=shift_activity.end_time - shift_activity.start_time, bottom=i + 0.1,
+                       color=colorByDepartment[s.department])
+
+        ylabels.append("{} (worked: {} hours)".format(str(n), nurse_work_time_vars[n].solution_value))
+        tickloc.append(i + 0.5)
+
+    plt.ylim(0, len(nurses))
+    plt.yticks(tickloc, ylabels)
+
+    # Create labels on x/y axis
+    createLabels(ax, 'SHIFTS ASSIGNMENTS', 'DAY OF WEEK', 'NURSES')
+
+# Plot number of assigned nurses for each shift, by department
+def displayDepartmentsAssignments(ax):
+    ylabels, tickloc = [], []
+    maxNbAssignements = max(nbAssignmentsByShift.values())
+    for i, d in enumerate(departments):
+        for s in shiftsByDepartment[d]:
+            shift_activity = shift_activities[s]
+            ax.bar(shift_activity.start_time, nbAssignmentsByShift.get(s, 0) / float(maxNbAssignements + 1),
+                   width=shift_activity.end_time - shift_activity.start_time, bottom=i + 0.5,
+                   color=colorByDepartment[s.department])
+        ylabels.append("{}".format(d))
+        tickloc.append(i + 0.5)
+
+    plt.ylim(0, len(departments) + 0.5)
+    plt.yticks(tickloc, ylabels)
+
+    # Create labels on x/y axis
+    createLabels(ax, 'NUMBER OF ASSIGNED NURSES', 'DAY OF WEEK', 'DEPARTMENTS')
+
+# Display figures as two sub-plots so that they are vertically aligned
+fig = plt.figure(figsize=[14,12])
+gs = gridspec.GridSpec(2, 1, height_ratios=[3,1])
+
+ax = plt.subplot(gs[0])
+displayNursesAssignmentsGantt(ax)
+
+ax = plt.subplot(gs[1])
+displayDepartmentsAssignments(ax)
+
+
+_images/nurses_scheduling_47_0.png +
+
+
+

Summary

+

You learned how to set up and use IBM Decision Optimization CPLEX +Modeling for Python to formulate a Mathematical Programming model and +solve it with IBM Decision Optimization on Cloud.

+
+
+

References

+ +

Copyright � 2017-2019 IBM. IPLA licensed Sample Materials.

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/objects.inv b/docs/2.29.245/docs/mp/objects.inv new file mode 100644 index 0000000..19497a5 Binary files /dev/null and b/docs/2.29.245/docs/mp/objects.inv differ diff --git a/docs/2.29.245/docs/mp/oil_blending.html b/docs/2.29.245/docs/mp/oil_blending.html new file mode 100644 index 0000000..ec7e7ee --- /dev/null +++ b/docs/2.29.245/docs/mp/oil_blending.html @@ -0,0 +1,847 @@ + + + + + + + + + + Maximizing the profit of an oil company — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Maximizing the profit of an oil company

+

This tutorial includes everything you need to set up the decision +optimization engines and build mathematical programming models.

+

When you finish this tutorial, you’ll have a foundational knowledge of +Prescriptive Analytics.

+
+

This notebook is part of Prescriptive Analytics for +Python

+

It requires either an installation of CPLEX +Optimizers +or it can be run on IBM Watson Studio +Cloud (Sign up for a +free IBM Cloud +account +and you can start using Watson Studio Cloud right away).

+
+

Table of contents:

+ +
+

Describe the business problem

+
    +

  • An oil company manufactures different types of gasoline and diesel. +Each type of gasoline is produced by blending different types of +crude oils that must be purchased. The company must decide how much +crude oil to buy in order to maximize its profit while respecting +processing capacities and quality levels as well as satisfying +customer demand.

    • +

  • Blending problems are a typical industry application of Linear +Programming (LP). LP represents real life problems mathematically +using an objective function to represent the goal that is to be +minimized or maximized, together with a set of linear constraints +which define the conditions to be satisfied and the limitations of +the real life problem. The function and constraints are expressed in +terms of decision variables and the solution, obtained from +optimization engines such as IBM� ILOG� CPLEX�, provides the best +values for these variables so that the objective function is +optimized.

    • +

  • The oil-blending problem consists of calculating different blends of +gasoline according to specific quality criteria.

    • +

  • Three types of gasoline are manufactured: super, regular, and diesel.

    • +

  • Each type of gasoline is produced by blending three types of crude +oil: crude1, crude2, and crude3.

    • +

  • The gasoline must satisfy some quality criteria with respect to their +lead content and their octane ratings, thus constraining the possible +blendings.

    • +

  • The company must also satisfy its customer demand, which is 3,000 +barrels a day of super, 2,000 of regular, and 1,000 of diesel.

    • +

  • The company can purchase 5,000 barrels of each type of crude oil per +day and can process at most 14,000 barrels a day.

    • +

  • In addition, the company has the option of advertising a gasoline, in +which case the demand for this type of gasoline increases by ten +barrels for every dollar spent.

    • +

  • Finally, it costs four dollars to transform a barrel of oil into a +barrel of gasoline.

    • +
+
+
+

How decision optimization can help

+
    +

  • Prescriptive analytics technology recommends actions based on desired +outcomes, taking into account specific scenarios, resources, and +knowledge of past and current events. This insight can help your +organization make better decisions and have greater control of +business outcomes.

    • +

  • Prescriptive analytics is the next step on the path to insight-based +actions. It creates value through synergy with predictive analytics, +which analyzes data to predict future outcomes.

    • +
  • +
    Prescriptive analytics takes that insight to the next level by +suggesting the optimal way to handle that future situation. +Organizations that can act fast in dynamic conditions and make +superior decisions in uncertain environments gain a strong +competitive advantage.
    +

    +
    +
    • +

  • For example:

    +
      +

    • Automate complex decisions and trade-offs to better manage limited +resources.

      • +

    • Take advantage of a future opportunity or mitigate a future risk.

      • +

    • Proactively update recommendations based on changing events.

      • +

    • Meet operational goals, increase customer loyalty, prevent threats +and fraud, and optimize business processes.

      • +
    +
    • +
+
+
+

Use decision optimization

+
+

Step 1: Import the library

+

Run the following code to import the Decision Optimization CPLEX +Modeling library. The DOcplex library contains the two modeling +packages, Mathematical Programming (docplex.mp) and Constraint +Programming (docplex.cp).

+
import sys
+try:
+    import docplex.mp
+except:
+    raise Exception('Please install docplex. See https://pypi.org/project/docplex/')
+
+
+

If CPLEX is not installed, install CPLEX Community edition.

+
try:
+    import cplex
+except:
+    raise Exception('Please install CPLEX. See https://pypi.org/project/cplex/')
+
+
+
+
+

Step 2: Model the data

+
    +

  • For each type of crude oil, there are capacities of what can be +bought, the buying price, the octane level, and the lead level.

    • +

  • For each type of gasoline or diesel, there is customer demand, +selling prices, and octane and lead levels.

    • +

  • There is a maximum level of production imposed by the factory’s limit +as well as a fixed production cost.

    • +

  • There are inventory costs for each type of final product and blending +proportions. All of these have actual values in the model.

    • +

  • The maginal production cost and maximum production are assumed to be +identical for all oil types.

    • +
+

Input data comes as NumPy arrays with two dimensions. +NumPy is the fundamental package for +scientific computing with Python.

+

The first dimension of the NumPy array is the number of gasoline +types; and for each gasoline type, we have a NumPy array containing +capacity, price, octane and lead level, in that order.

+
import numpy as np
+
+gas_names = ["super", "regular", "diesel"]
+
+gas_data = np.array([[3000, 70, 10, 1], [2000, 60, 8, 2], [1000, 50, 6, 1]])
+
+oil_names = ["crude1", "crude2", "crude3"]
+
+oil_data = np.array([[5000, 45, 12, 0.5], [5000, 35, 6, 2], [5000, 25, 8, 3]])
+
+nb_gas  = len(gas_names)
+nb_oils = len(oil_names)
+range_gas = range(nb_gas)
+range_oil = range(nb_oils)
+print("Number of gasoline types = {0}".format(nb_gas))
+print("Number of crude types = {0}".format(nb_oils))
+
+# global data
+production_cost = 4
+production_max = 14000
+# each $1 spent on advertising increases demand by 10.
+advert_return = 10
+
+
+
Number of gasoline types = 3
+Number of crude types = 3
+
+
+
+
+

Step 3: Prepare the data

+

Pandas is another Python library that we +use to store data. pandas contains data structures and data analysis +tools for the Python programming language.

+
import pandas as pd
+gaspd = pd.DataFrame([(gas_names[i],int(gas_data[i][0]),int(gas_data[i][1]),int(gas_data[i][2]),int(gas_data[i][3]))
+                      for i in range_gas])
+oilpd = pd.DataFrame([(oil_names[i],int(oil_data[i][0]),int(oil_data[i][1]),int(oil_data[i][2]),oil_data[i][3])
+                      for i in range_oil])
+gaspd.columns = ['name','demand','price','octane','lead']
+oilpd.columns= ['name','capacity','price','octane','lead']
+
+
+

Use basic HTML and a stylesheet to format the data.

+
CSS = """
+body {
+    margin: 0;
+    font-family: Helvetica;
+}
+table.dataframe {
+    border-collapse: collapse;
+    border: none;
+}
+table.dataframe tr {
+    border: none;
+}
+table.dataframe td, table.dataframe th {
+    margin: 0;
+    border: 1px solid white;
+    padding-left: 0.25em;
+    padding-right: 0.25em;
+}
+table.dataframe th:not(:empty) {
+    background-color: #fec;
+    text-align: left;
+    font-weight: normal;
+}
+table.dataframe tr:nth-child(2) th:empty {
+    border-left: none;
+    border-right: 1px dashed #888;
+}
+table.dataframe td {
+    border: 2px solid #ccf;
+    background-color: #f4f4ff;
+}
+    table.dataframe thead th:first-child {
+        display: none;
+    }
+    table.dataframe tbody th {
+        display: none;
+    }
+"""
+
+from IPython.core.display import HTML
+HTML('<style>{}</style>'.format(CSS))
+
+
+

Let’s display the data we just prepared.

+
from IPython.display import display
+print("Gas data:")
+display(gaspd)
+print("Oil data:")
+display(oilpd)
+
+
+
Gas data:
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
namedemandpriceoctanelead
0super300070101
1regular20006082
2diesel10005061
+
Oil data:
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
namecapacitypriceoctanelead
0crude1500045120.5
1crude250003562.0
2crude350002583.0
+
+
+

Step 4: Set up the prescriptive model

+
+

Create the DOcplex model

+

A model is needed to store all the variables and constraints needed to +formulate the business problem and submit the problem to the solve +service.

+
from docplex.mp.model import Model
+
+mdl = Model(name="oil_blending")
+
+
+
+
+

Define the decision variables

+

For each combination of oil and gas, we have to decide the quantity of +oil to use to produce a gasoline. A decision variable will be needed to +represent that amount. A matrix of continuous variables, indexed by the +set of oils and the set of gasolines needs to be created.

+
blends = mdl.continuous_var_matrix(keys1=nb_oils, keys2=nb_gas, lb=0)
+
+
+

We also have to decide how much should be spent in advertising for each +time of gasoline. To do so, we will create a list of continuous +variables, indexed by the gasolines.

+
adverts = mdl.continuous_var_list(nb_gas, lb=0)
+
+
+
+
+

Express the business constraints

+

The business constraints are the following:

+
    +

  • The demand for each gasoline type must be satisfied. The total demand +includes the initial demand as stored in the data,plus a variable +demand caused by the advertising. This increase is assumed to be +proportional to the advertising cost.

    • +

  • The capacity constraint on each oil type must also be satisfied.

    • +

  • For each gasoline type, the octane level must be above a minimum +level, and the lead level must be below a maximum level.

    • +
+
+
Demand
+
    +

  • For each gasoline type, the total quantity produced must equal the +raw demand plus the demand increase created by the advertising.

    • +
+
# gasoline demand is numpy array field #0
+mdl.add_constraints(mdl.sum(blends[o, g] for o in range(nb_oils)) == gas_data[g][0] + advert_return * adverts[g]
+                   for g in range(nb_gas))
+mdl.print_information()
+
+
+
Model: oil_blending
+ - number of variables: 12
+   - binary=0, integer=0, continuous=12
+ - number of constraints: 3
+   - linear=3
+ - parameters: defaults
+ - problem type is: LP
+
+
+
+
+
Maximum capacity
+
    +

  • For each type of oil, the total quantity used in all types of +gasolines must not exceed the maximum capacity for this oil.

    • +
+
mdl.add_constraints(mdl.sum(blends[o,g] for g in range_gas) <= oil_data[o][0]
+                    for o in range_oil)
+mdl.print_information()
+
+
+
Model: oil_blending
+ - number of variables: 12
+   - binary=0, integer=0, continuous=12
+ - number of constraints: 6
+   - linear=6
+ - parameters: defaults
+ - problem type is: LP
+
+
+
+
+
Octane and Lead levels
+
    +

  • For each gasoline type, the octane level must be above a minimum +level, and the lead level must be below a maximum level.

    • +
+
# minimum octane level
+# octane is numpy array field #2
+mdl.add_constraints(mdl.sum(blends[o,g]*(oil_data[o][2] - gas_data[g][2]) for o in range_oil) >= 0
+                   for g in range_gas)
+
+# maximum lead  level
+# lead level is numpy array field #3
+mdl.add_constraints(mdl.sum(blends[o,g]*(oil_data[o][3] - gas_data[g][3]) for o in range_oil) <= 0
+                   for g in range_gas)
+
+mdl.print_information()
+
+
+
Model: oil_blending
+ - number of variables: 12
+   - binary=0, integer=0, continuous=12
+ - number of constraints: 12
+   - linear=12
+ - parameters: defaults
+ - problem type is: LP
+
+
+
+
+
Maximum total production
+
    +

  • The total production must not exceed the maximum (here 14000).

    • +
+
# -- maximum global production
+mdl.add_constraint(mdl.sum(blends) <= production_max)
+
+mdl.print_information()
+
+
+
Model: oil_blending
+ - number of variables: 12
+   - binary=0, integer=0, continuous=12
+ - number of constraints: 13
+   - linear=13
+ - parameters: defaults
+ - problem type is: LP
+
+
+
+
+
+

Express the objective

+
    +

  • The objective or goal is to maximize profit, which is made from sales +of the final products minus total costs. The costs consist of the +purchase cost of the crude oils, production costs, and inventory +costs.

    • +

  • The model maximizes the net revenue, that is revenue minus oil cost +and production cost, to which we subtract the total advertising cost.

    • +

  • To define business objective, let’s define a few KPIs :

    +
      +

    • Total advertising cost

      • +

    • Total Oil cost

      • +

    • Total production cost

      • +

    • Total revenue

      • +
    +
    • +
+
# KPIs
+total_advert_cost = mdl.sum(adverts)
+mdl.add_kpi(total_advert_cost, "Total advertising cost")
+total_oil_cost = mdl.sum(blends[o,g] * oil_data[o][1] for o in range_oil for g in range_gas)
+mdl.add_kpi(total_oil_cost, "Total Oil cost")
+total_production_cost = production_cost * mdl.sum(blends)
+mdl.add_kpi(total_production_cost, "Total production cost")
+total_revenue = mdl.sum(blends[o,g] * gas_data[g][1] for g in range(nb_gas) for o in range(nb_oils))
+mdl.add_kpi(total_revenue, "Total revenue")
+
+# finally the objective
+mdl.maximize(total_revenue - total_oil_cost - total_production_cost - total_advert_cost)
+
+
+
+
+

Solve with Decision Optimization

+

If you’re using a Community Edition of CPLEX runtimes, depending on the +size of the problem, the solve stage may fail and will need a paying +subscription or product installation.

+

We display the objective and KPI values after the solve by calling the +method report() on the model.

+
assert mdl.solve(), "Solve failed"
+mdl.report()
+
+
+
* model oil_blending solved with objective = 287750.000
+*  KPI: Total advertising cost = 750.000
+*  KPI: Total Oil cost         = 487500.000
+*  KPI: Total production cost  = 54000.000
+*  KPI: Total revenue          = 830000.000
+
+
+
+
+
+

Step 5: Investigate the solution and then run an example analysis

+
+

Displaying the solution

+

First, get the KPIs values and store them in a pandas DataFrame.

+
all_kpis = [(kp.name, kp.compute()) for kp in mdl.iter_kpis()]
+kpis_bd = pd.DataFrame(all_kpis, columns=['kpi', 'value'])
+
+
+
blend_values = [ [ blends[o,g].solution_value for g in range_gas] for o in range_oil]
+total_gas_prods = [sum(blend_values[o][g] for o in range_oil) for g in range_gas]
+
+prods = list(zip(gas_names, total_gas_prods))
+prods_bd = pd.DataFrame(prods)
+
+
+

Let’s display some KPIs in pie charts using the Python package +matplotlib.

+
%matplotlib inline
+import matplotlib.pyplot as plt
+def display_pie(pie_values, pie_labels, colors=None,title=''):
+    plt.axis("equal")
+    plt.pie(pie_values, labels=pie_labels, colors=colors, autopct="%1.1f%%")
+    plt.title(title)
+    plt.show()
+
+display_pie( [kpnv[1] for kpnv in all_kpis], [kpnv[0] for kpnv in all_kpis],title='KPIs: Revenue - Oil Cost - Production Cost')
+
+
+_images/oil_blending_41_0.png +
+
Production
+
display_pie(total_gas_prods, gas_names, colors=["green", "goldenrod", "lightGreen"],title='Gasoline Total Production')
+
+
+_images/oil_blending_43_0.png +

We see that the most produced gasoline type is by far regular.

+

Now, let’s plot the breakdown of oil blend quantities per gasoline type. +We are using a multiple bar chart diagram, displaying all blend values +for each couple of oil and gasoline type.

+
sblends = [(gas_names[n], oil_names[o], round(blends[o,n].solution_value)) for n in range_gas for o in range_oil]
+
+blends_bd = pd.DataFrame(sblends)
+
+
+
f, barplot = plt.subplots(1, figsize=(16,5))
+
+bar_width = 0.1
+offset = 0.12
+rho = 0.7
+
+# position of left-bar boundaries
+bar_l = [o for o in range_oil]
+
+mbar_w = 3*bar_width+2*max(0, offset-bar_width)
+
+tick_pos = [b*rho + mbar_w/2.0 for b in bar_l]
+
+colors = ['olive', 'lightgreen', 'cadetblue']
+
+for i in range_oil:
+    barplot.bar([b*rho + (i*offset) for b in bar_l],
+                blend_values[i], width=bar_width, color=colors[i], label=oil_names[i])
+
+plt.xticks(tick_pos, gas_names)
+barplot.set_xlabel("gasolines")
+barplot.set_ylabel("blend")
+plt.legend(loc="upper right")
+plt.title('Blend Repartition\n')
+
+
+# Set a buffer around the edge
+plt.xlim([0, max(tick_pos)+mbar_w +0.5])
+
+plt.show()
+
+
+_images/oil_blending_46_0.png +

Notice the missing bar for (crude2, diesel) which is expected since +blend[crude2, diesel] is zero in the solution.

+

We can check the solution value of blends for crude2 and diesel, +remembering that crude2 has offset 1 and diesel has offset 2. Note how +the decision variable is automatically converted to a float here. This +would raise an exception if called before submitting a solve, as no +solution value would be present.

+
print("* value of blend[crude2, diesel] is %g" % blends[1,2])
+
+
+
* value of blend[crude2, diesel] is 0
+
+
+
+
+
+
+
+

Summary

+

You learned how to set up and use IBM Decision Optimization CPLEX +Modeling for Python to formulate a Mathematical Programming model and +solve it with CPLEX.

+
+
+

References

+ +

Copyright � 2017-2019 IBM. IPLA licensed Sample Materials.

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/production.html b/docs/2.29.245/docs/mp/production.html new file mode 100644 index 0000000..4614ae8 --- /dev/null +++ b/docs/2.29.245/docs/mp/production.html @@ -0,0 +1,231 @@ + + + + + + + + + + production.py — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

production.py

+

To meet the demands of its customers, a company manufactures its products in its own factories (inside production) or buys them from other companies (outside production). +The inside production is subject to some resource constraints: each product consumes a certain amount of each resource. +In contrast, outside production is theoretically unlimited. The problem is to determine how much of each product should be +produced inside and outside the company while minimizing the overall production cost, meeting the demand, and satisfying the resource constraints.

+

The model aims at minimizing the production cost for a number of products while satisfying customer demand. +Each product can be produced either inside the company or outside, at a higher cost. +The inside production is constrained by the company’s resources, while outside production is considered unlimited. +The model first declares the products and the resources. The data consists of the description of the products +(the demand, the inside and outside costs, and the resource consumption) and the capacity of the various resources.

+

The variables for this problem are the inside and outside production for each product.

+
  1# --------------------------------------------------------------------------
+  2# Source file provided under Apache License, Version 2.0, January 2004,
+  3# http://www.apache.org/licenses/
+  4# (c) Copyright IBM Corp. 2015, 2018
+  5# --------------------------------------------------------------------------
+  6
+  7"""The model aims at minimizing the production cost for a number of products
+  8while satisfying customer demand. Each product can be produced either inside
+  9the company or outside, at a higher cost.
+ 10
+ 11The inside production is constrained by the company's resources, while outside
+ 12production is considered unlimited.
+ 13
+ 14The model first declares the products and the resources.
+ 15The data consists of the description of the products (the demand, the inside
+ 16and outside costs, and the resource consumption) and the capacity of the
+ 17various resources.
+ 18
+ 19The variables for this problem are the inside and outside production for each
+ 20product.
+ 21"""
+ 22
+ 23from docplex.mp.model import Model
+ 24from docplex.util.environment import get_environment
+ 25
+ 26
+ 27# ----------------------------------------------------------------------------
+ 28# Initialize the problem data
+ 29# ----------------------------------------------------------------------------
+ 30PRODUCTS = [("kluski", 100, 0.6, 0.8),
+ 31            ("capellini", 200, 0.8, 0.9),
+ 32            ("fettucine", 300, 0.3, 0.4)]
+ 33
+ 34# resources are a list of simple tuples (name, capacity)
+ 35RESOURCES = [("flour", 20),
+ 36             ("eggs", 40)]
+ 37
+ 38CONSUMPTIONS = {("kluski", "flour"): 0.5,
+ 39                ("kluski", "eggs"): 0.2,
+ 40                ("capellini", "flour"): 0.4,
+ 41                ("capellini", "eggs"): 0.4,
+ 42                ("fettucine", "flour"): 0.3,
+ 43                ("fettucine", "eggs"): 0.6}
+ 44
+ 45
+ 46# ----------------------------------------------------------------------------
+ 47# Build the model
+ 48# ----------------------------------------------------------------------------
+ 49def build_production_problem(mdl, products, resources, consumptions, **kwargs):
+ 50    """ Takes as input:
+ 51        - a list of product tuples (name, demand, inside, outside)
+ 52        - a list of resource tuples (name, capacity)
+ 53        - a list of consumption tuples (product_name, resource_named, consumed)
+ 54    """
+ 55      # --- decision variables ---
+ 56    mdl.inside_vars  = mdl.continuous_var_dict(products, name=lambda p: 'inside_%s' % p[0])
+ 57    mdl.outside_vars = mdl.continuous_var_dict(products, name=lambda p: 'outside_%s' % p[0])
+ 58
+ 59    # --- constraints ---
+ 60    # demand satisfaction
+ 61    mdl.add_constraints((mdl.inside_vars[prod] + mdl.outside_vars[prod] >= prod[1], 'ct_demand_%s' % prod[0]) for prod in products)
+ 62
+ 63    # --- resource capacity ---
+ 64    mdl.add_constraints((mdl.sum(mdl.inside_vars[p] * consumptions[p[0], res[0]] for p in products) <= res[1],
+ 65                         'ct_res_%s' % res[0]) for res in resources)
+ 66
+ 67    # --- objective ---
+ 68    mdl.total_inside_cost = mdl.sum(mdl.inside_vars[p] * p[2] for p in products)
+ 69    mdl.add_kpi(mdl.total_inside_cost, "inside cost")
+ 70    mdl.total_outside_cost = mdl.sum(mdl.outside_vars[p] * p[3] for p in products)
+ 71    mdl.add_kpi(mdl.total_outside_cost, "outside cost")
+ 72    mdl.minimize(mdl.total_inside_cost + mdl.total_outside_cost)
+ 73    return mdl
+ 74
+ 75
+ 76def print_production_solution(mdl, products):
+ 77    obj = mdl.objective_value
+ 78    print("* Production model solved with objective: {:g}".format(obj))
+ 79    print("* Total inside cost=%g" % mdl.total_inside_cost.solution_value)
+ 80    for p in products:
+ 81        print("Inside production of {product}: {ins_var}".format
+ 82              (product=p[0], ins_var=mdl.inside_vars[p].solution_value))
+ 83    print("* Total outside cost=%g" % mdl.total_outside_cost.solution_value)
+ 84    for p in products:
+ 85        print("Outside production of {product}: {out_var}".format
+ 86              (product=p[0], out_var=mdl.outside_vars[p].solution_value))
+ 87
+ 88def build_default_production_problem(**kwargs):
+ 89    mdl = Model( **kwargs)
+ 90    return build_production_problem(mdl, PRODUCTS, RESOURCES, CONSUMPTIONS)
+ 91# ----------------------------------------------------------------------------
+ 92# Solve the model and display the result
+ 93# ----------------------------------------------------------------------------
+ 94if __name__ == '__main__':
+ 95    # Build the model
+ 96    with Model(name='production') as model:
+ 97        model = build_production_problem(model, PRODUCTS, RESOURCES, CONSUMPTIONS)
+ 98        model.print_information()
+ 99        # Solve the model.
+100        if model.solve():
+101            print_production_solution(model, PRODUCTS)
+102            # Save the CPLEX solution as "solution.json" program output
+103            with get_environment().get_output_stream("solution.json") as fp:
+104                model.solution.export(fp, "json")
+105        else:
+106            print("Problem has no solution")
+107
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/py-modindex.html b/docs/2.29.245/docs/mp/py-modindex.html new file mode 100644 index 0000000..41e4f55 --- /dev/null +++ b/docs/2.29.245/docs/mp/py-modindex.html @@ -0,0 +1,253 @@ + + + + + + + + + Python Module Index — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + + +
+
+
+
+ + +

Python Module Index

+ +
+ d +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ d
+ docplex +
    + docplex.mp.basic +
    + docplex.mp.callbacks.cb_mixin +
    + docplex.mp.conflict_refiner +
    + docplex.mp.constants +
    + docplex.mp.constr +
    + docplex.mp.context +
    + docplex.mp.dvar +
    + docplex.mp.environment +
    + docplex.mp.error_handler +
    + docplex.mp.kpi +
    + docplex.mp.linear +
    + docplex.mp.model +
    + docplex.mp.model_reader +
    + docplex.mp.model_stats +
    + docplex.mp.params.parameters +
    + docplex.mp.priority +
    + docplex.mp.progress +
    + docplex.mp.publish +
    + docplex.mp.pwl +
    + docplex.mp.quad +
    + docplex.mp.relax_linear +
    + docplex.mp.relaxer +
    + docplex.mp.sdetails +
    + docplex.mp.solution +
    + docplex.mp.sosvarset +
    + docplex.mp.vartype +
    + docplex.mp.with_funcs +
    + docplex.util.cli +
    + docplex.util.csv_utils +
    + docplex.util.environment +
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/refman.html b/docs/2.29.245/docs/mp/refman.html new file mode 100644 index 0000000..71f7ddf --- /dev/null +++ b/docs/2.29.245/docs/mp/refman.html @@ -0,0 +1,357 @@ + + + + + + + + + + docplex.mp reference manual — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

docplex.mp reference manual

+
+ +
+
+

Indices and tables

+ +
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/samples.html b/docs/2.29.245/docs/mp/samples.html new file mode 100644 index 0000000..85ac068 --- /dev/null +++ b/docs/2.29.245/docs/mp/samples.html @@ -0,0 +1,236 @@ + + + + + + + + + + Examples of mathematical programming — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Examples of mathematical programming

+
+

Downloading the examples

+ + + +The examples can be downloaded from GitHub: + + +docplex examples + + +
+
+
+
+

Examples content and source

+

The sample archive docplex_examples.zip contains +subdirectories for different sample categories:

+
    +

  • examples/mp/modeling contains examples that target modeling.

    +
    +
      +

    • diet: This example solves a simple variation of the well-known +diet problem that was posed by George Stigler and George Dantzig. How does a planner +choose foods that satisfy nutritional requirements while minimizing costs or +maximizing satiety?

      • +

    • production: This example solves a production planning problem. +How does a company decide what proportion of its products to produce +inside the company and what to buy from outside the company?

      • +

    • sport_scheduling: How can a sports league schedule matches between +teams in different divisions such that the teams play each other the +appropriate number of times and maximize the objective of scheduling +intradivision matches as late as possible in the season?

      • +

    • nurses: This example solves the problem of finding an optimal +assignment of nurses to shifts.

      • +

    • nurses with multiobjective: This example solves the problem of finding an optimal +assignment of nurses to shifts using multi objective.

      • +
    +
    +
    • +

  • examples/mp/workflow contains examples that target optimization workflow.

    +
    +
      +

    • cutstock: The cutting stock problem in this example is sometimes known in math programming terms as a knapsack problem with reduced +cost in the objective function. Generally, a cutting stock problem begins with a supply of rolls of material of fixed length (the stock). +Strips are cut from these rolls. All the strips that are cut from one roll are known together as a pattern. +The point of this example is to use as few rolls of stock as possible to satisfy some specified demand of strips.

      • +

    • lagrangian_relaxation: This example solves the generalized +assignment problem, with or without Lagrangian relaxation.

      • +

    • load_balancing: This example looks at cloud load balancing to keep a service running +in the cloud at reasonable cost by reducing the expense of running cloud servers while +minimizing risk and human time due to rebalancing and doing balance sleeping models +across servers.

      • +
    • +
      populate.py: This sample shows how to run the populate algorithm,

      either on a model file or a model instance.

      +
      +
      +
      • +
    +
    +
    • +

  • examples/mp/jupyter contains Jupyter Notebooks, working on http://datascience.ibm.com.

    +
    +
      +

    • boxes : This example illustrates assigning objects to boxes in a manner that +minimizes the total distance between each object and its assigned box.

      • +

    • chicago_coffee_shops : A K-Median model is used to determine where N +coffee shops should be located to minimize the distance from local libraries.

      • +

    • marketing_campaign : A marketing department wants to achieve more profitable results in future +campaigns by matching the right offer of financial services to each customer.

      • +

    • mining_pandas : This mining operations optimization problem is an +implementation of Problem 7 from “Model Building in Mathematical Programming” by H.P. Williams. The operational decisions that need +to be made are which mines should be operated each year and how much each mine should produce.

      • +

    • nurses_pandas : This is the same example as the nurses example, but describes how to use pandas in the model.

      • +

    • nurses_scheduling : This example solves the problem of finding an optimal assignment of nurses to shifts.

      • +

    • oil_blending : The oil-blending problem consists of calculating different blends of gasoline according to specific quality criteria. +Blending problems are a typical industry application on Linear Programming.

      • +

    • sports_scheduling : How can a sports league schedule matches between +teams in different divisions such that the teams play each other the +appropriate number of times and maximize the objective of scheduling +intradivision matches as late as possible in the season?

      • +

    • ucp_pandas : The Unit Commitment Problem answers the question, “Which power generators should I run at which times and at what level +in order to satisfy the demand for electricity?”

      • +
    +
    +
    • +
+
+
+

Running the examples

+

Examples files are Python scripts that contain problem data. +Debug traces and warnings are included in the examples to help you diagnose the cloud or local solve and +to give a brief overview of your installation (Is CPLEX® in the path?, Is matplotlib installed?…). +Running a sample submits the problem to the optimization engine and displays the result.

+

For instance, to run diet, type the following command at a command prompt:

+
c:\docplex\examples\mp\modeling> python diet.py
+* model solved as function with objective: 2.69041
+1> Servings of ({Spaghetti W/ Sauce}) = 2.155
+2> Servings of ({Chocolate Chip Cookies}) = 10.000
+3> Servings of ({2% Lowfat Milk}) = 1.831
+4> Servings of ({Hotdog}) = 0.930
+* KPI: Total Calories=2000.000
+* KPI: Total Calcium=800.000
+* KPI: Total Iron=11.278
+* KPI: Total Vit_A=8518.433
+* KPI: Total Dietary_Fiber=25.000
+* KPI: Total Carbohydrates=256.806
+* KPI: Total Protein=51.174
+
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/search.html b/docs/2.29.245/docs/mp/search.html new file mode 100644 index 0000000..ead5156 --- /dev/null +++ b/docs/2.29.245/docs/mp/search.html @@ -0,0 +1,107 @@ + + + + + + + + + Search — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + + +
+ +
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/searchindex.js b/docs/2.29.245/docs/mp/searchindex.js new file mode 100644 index 0000000..6f9f08d --- /dev/null +++ b/docs/2.29.245/docs/mp/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["README.md", "boxes", "chicago_coffee_shops", "creating_model", "cutstock", "diet", "docplex.mp.basic", "docplex.mp.callbacks.cb_mixin", "docplex.mp.conflict_refiner", "docplex.mp.constants", "docplex.mp.constr", "docplex.mp.context", "docplex.mp.dvar", "docplex.mp.environment", "docplex.mp.error_handler", "docplex.mp.kpi", "docplex.mp.linear", "docplex.mp.model", "docplex.mp.model_reader", "docplex.mp.model_stats", "docplex.mp.params.parameters", "docplex.mp.priority", "docplex.mp.progress", "docplex.mp.publish", "docplex.mp.pwl", "docplex.mp.quad", "docplex.mp.relax_linear", "docplex.mp.relaxer", "docplex.mp.sdetails", "docplex.mp.solution", "docplex.mp.sosvarset", "docplex.mp.vartype", "docplex.mp.with_funcs", "docplex.util.cli", "docplex.util.csv_utils", "docplex.util.environment", "getting_started", "getting_started_python", "index", "lagrangian_relaxation", "load_balancing", "marketing_campaign", "mining_pandas", "nurses", "nurses_multiobj", "nurses_pandas", "nurses_scheduling", "oil_blending", "production", "refman", "samples", "sport_scheduling", "sports_scheduling", "support", "troubleshooting", "ucp_pandas", "warehouse"], "filenames": ["README.md.rst", "boxes.rst", "chicago_coffee_shops.rst", "creating_model.rst", "cutstock.rst", "diet.rst", "docplex.mp.basic.rst", "docplex.mp.callbacks.cb_mixin.rst", "docplex.mp.conflict_refiner.rst", "docplex.mp.constants.rst", "docplex.mp.constr.rst", "docplex.mp.context.rst", "docplex.mp.dvar.rst", "docplex.mp.environment.rst", "docplex.mp.error_handler.rst", "docplex.mp.kpi.rst", "docplex.mp.linear.rst", "docplex.mp.model.rst", "docplex.mp.model_reader.rst", "docplex.mp.model_stats.rst", "docplex.mp.params.parameters.rst", "docplex.mp.priority.rst", "docplex.mp.progress.rst", "docplex.mp.publish.rst", "docplex.mp.pwl.rst", "docplex.mp.quad.rst", "docplex.mp.relax_linear.rst", "docplex.mp.relaxer.rst", "docplex.mp.sdetails.rst", "docplex.mp.solution.rst", "docplex.mp.sosvarset.rst", "docplex.mp.vartype.rst", "docplex.mp.with_funcs.rst", "docplex.util.cli.rst", "docplex.util.csv_utils.rst", "docplex.util.environment.rst", "getting_started.rst", "getting_started_python.rst", "index.rst", "lagrangian_relaxation.rst", "load_balancing.rst", "marketing_campaign.rst", "mining_pandas.rst", "nurses.rst", "nurses_multiobj.rst", "nurses_pandas.rst", "nurses_scheduling.rst", "oil_blending.rst", "production.rst", "refman.rst", "samples.rst", "sport_scheduling.rst", "sports_scheduling.rst", "support.rst", "troubleshooting.rst", "ucp_pandas.rst", "warehouse.rst"], "titles": ["README.md", "Objects in boxes", "Finding optimal locations of new stores", "Creating a mathematical programming model", "cutstock.py", "diet.py", "docplex.mp.basic module", "docplex.mp.callbacks.cb_mixin module", "docplex.mp.conflict_refiner module", "docplex.mp.constants module", "docplex.mp.constr module", "docplex.mp.context module", "docplex.mp.dvar module", "docplex.mp.environment module", "docplex.mp.error_handler module", "docplex.mp.kpi module", "docplex.mp.linear module", "docplex.mp.model module", "docplex.mp.model_reader module", "docplex.mp.model_stats module", "docplex.mp.params.parameters module", "docplex.mp.priority module", "docplex.mp.progress module", "docplex.mp.publish module", "docplex.mp.pwl module", "docplex.mp.quad module", "docplex.mp.relax_linear module", "docplex.mp.relaxer module", "docplex.mp.sdetails module", "docplex.mp.solution module", "docplex.mp.sosvarset module", "docplex.mp.vartype module", "docplex.mp.with_funcs module", "docplex.util.cli module", "docplex.util.csv_utils module", "docplex.util.environment module", "Setting up an optimization engine", "Setting up a Python environment", "Mathematical Programming Modeling for Python (DOcplex.MP)", "lagrangian_relaxation.py", "load_balancing.py", "How to make targeted offers to customers?", "Optimizing mining operations", "nurses.py", "nurses_multiobj.py", "The Nurse Assignment Problem", "The Nurses Model", "Maximizing the profit of an oil company", "production.py", "docplex.mp reference manual", "Examples of mathematical programming", "sport_scheduling.py", "Use decision optimization to help a sports league schedule its games", "IBM\u00ae Elite Support for DOcplex", "Troubleshooting", "The Unit Commitment Problem (UCP)", "The Warehouse Problem"], "terms": {"ibm": [0, 1, 2, 4, 5, 9, 28, 29, 37, 38, 39, 40, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 54, 55], "reg": [0, 36, 37, 38], "decis": [0, 4, 5, 6, 12, 15, 16, 17, 19, 25, 29, 30, 31, 35, 36, 37, 39, 40, 48, 50, 51, 53], "optim": [0, 3, 5, 8, 9, 17, 28, 35, 37, 39, 40, 43, 44, 50, 51, 53, 54, 56], "model": [0, 4, 5, 6, 7, 8, 9, 10, 11, 12, 15, 16, 18, 19, 20, 22, 24, 25, 26, 27, 28, 29, 30, 31, 32, 35, 36, 39, 40, 43, 44, 48, 49, 50, 51, 53], "python": [0, 1, 2, 3, 7, 12, 13, 17, 35, 36, 42, 45, 46, 47, 50, 52, 53, 54, 55, 56], "docplex": [0, 3, 4, 5, 36, 39, 40, 41, 43, 44, 48, 50, 51, 54], "welcom": [0, 38], "licens": [0, 1, 2, 4, 5, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55], "under": [0, 4, 5, 17, 29, 35, 38, 39, 40, 43, 44, 45, 48, 51], "apach": [0, 4, 5, 38, 39, 40, 43, 44, 48, 51], "v2": [0, 25], "0": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 12, 13, 16, 17, 20, 22, 25, 27, 28, 29, 32, 35, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 54, 55, 56], "With": [0, 1, 2, 17, 38, 42, 45, 46, 52, 55], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 55, 56], "librari": [0, 13, 28, 38, 50, 54], "you": [0, 1, 2, 11, 12, 13, 16, 17, 22, 26, 28, 35, 36, 37, 38, 41, 42, 45, 46, 47, 50, 52, 53, 54, 55], "can": [0, 3, 5, 8, 9, 11, 12, 13, 15, 16, 17, 18, 20, 22, 23, 24, 27, 29, 32, 35, 36, 37, 38, 39, 43, 44, 48, 50, 51, 53, 56], "quickli": [0, 38], "easili": [0, 2, 38, 42, 45], "add": [0, 1, 4, 5, 10, 16, 17, 24, 29, 35, 38, 42, 44, 45, 55], "power": [0, 38, 50, 55], "your": [0, 1, 2, 11, 13, 22, 35, 37, 38, 41, 42, 45, 46, 47, 50, 52, 53, 54, 55], "applic": [0, 2, 24, 38, 41, 47, 50, 53], "need": [0, 1, 2, 17, 22, 36, 37, 38, 41, 42, 45, 46, 47, 50, 51, 52, 53, 54, 55, 56], "ilog": [0, 1, 2, 9, 28, 29, 38, 41, 42, 45, 46, 47, 51, 55], "cplex": [0, 1, 2, 3, 5, 7, 8, 9, 11, 13, 17, 18, 20, 22, 28, 29, 31, 35, 38, 40, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 54, 55], "studio": [0, 1, 2, 35, 37, 38, 41, 42, 45, 46, 47, 51, 52, 55], "solv": [0, 4, 5, 8, 10, 11, 12, 15, 16, 17, 18, 22, 23, 27, 28, 29, 32, 35, 36, 38, 39, 40, 43, 44, 48, 50, 51], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 39, 40, 41, 43, 44, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56], "compos": [0, 2], "2": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 17, 22, 25, 27, 29, 32, 35, 36, 37, 38, 39, 40, 43, 44, 48, 50, 51, 54, 56], "modul": [0, 38, 42, 49, 52, 56], "namespac": 0, "mp": [0, 1, 2, 3, 4, 5, 35, 36, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 55, 56], "cp": [0, 2, 36, 41, 45, 47, 52, 55], "requir": [0, 1, 2, 3, 5, 15, 17, 18, 41, 43, 44, 47, 50, 52, 56], "v12": [0, 36, 54], "10": [0, 1, 3, 4, 5, 9, 10, 17, 22, 29, 39, 41, 42, 43, 44, 45, 46, 47, 50, 52, 55, 56], "later": [0, 36, 55, 56], "instal": [0, 1, 2, 13, 17, 22, 35, 41, 42, 45, 46, 47, 50, 52, 55, 56], "machin": [0, 35, 36], "numpi": [0, 13, 17, 37, 38, 47, 52], "friendli": [0, 38, 42], "pip": [0, 2, 42, 45, 46, 54, 55, 56], "get": [0, 1, 2, 4, 6, 7, 10, 12, 16, 17, 20, 22, 25, 28, 29, 30, 35, 41, 42, 45, 46, 47, 52, 54, 55, 56], "document": [0, 1, 2, 9, 17, 28, 36, 37, 41, 42, 45, 46, 47, 52, 55], "exampl": [0, 3, 5, 7, 9, 10, 12, 14, 16, 17, 18, 20, 22, 23, 25, 26, 27, 28, 29, 32, 36, 38, 39, 40, 41, 43, 44, 51, 54, 56], "latest": [0, 17, 22, 36], "http": [0, 1, 2, 4, 5, 9, 28, 29, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 55], "ibmdecisionoptim": [0, 36, 37, 45, 46], "github": [0, 37, 45, 46, 50], "io": [0, 45, 46], "doc": [0, 17], "archiv": [0, 50], "23": [0, 5, 17, 41, 42, 43, 44, 45, 46, 55], "222": [0, 55], "22": [0, 17, 32, 41, 43, 44, 45, 46, 55, 56], "213": 0, "21": [0, 5, 17, 32, 41, 43, 44, 45, 46, 55], "207": 0, "20": [0, 4, 17, 28, 29, 41, 42, 43, 44, 45, 46, 48, 55, 56], "204": 0, "19": [0, 1, 17, 35, 41, 43, 44, 45, 46, 55], "202": 0, "18": [0, 1, 5, 41, 42, 43, 44, 45, 46, 55], "200": [0, 41, 48, 55], "16": [0, 5, 17, 36, 41, 43, 44, 45, 46, 47, 55], "195": [0, 37], "com": [0, 1, 2, 9, 28, 29, 38, 40, 41, 42, 45, 46, 47, 50, 52, 53, 55], "edit": [0, 1, 4, 36, 37, 38, 41, 42, 45, 47, 51, 52, 55], "free": [0, 1, 2, 17, 36, 37, 38, 41, 42, 45, 46, 47, 52, 55], "commun": [0, 1, 36, 38, 41, 42, 47, 51, 52, 55], "www": [0, 2, 4, 5, 9, 28, 29, 39, 40, 43, 44, 48, 51], "account": [0, 1, 2, 12, 36, 37, 41, 42, 45, 46, 47, 52, 55], "u": [0, 1, 2, 4, 5, 19, 38, 40, 41, 42, 45, 46, 47, 52, 53, 55], "en": 0, "signup": 0, "formid": 0, "urx": 0, "20028": 0, "limit": [0, 1, 2, 3, 5, 17, 28, 35, 36, 41, 43, 44, 45, 46, 47, 51, 52, 55, 56], "capabl": [0, 36], "term": [0, 16, 17, 25, 42, 43, 44, 45, 46, 47, 50, 56], "problem": [0, 3, 4, 5, 9, 10, 12, 17, 28, 29, 32, 35, 37, 38, 39, 40, 43, 44, 48, 50, 51], "size": [0, 4, 7, 17, 28, 29, 36, 41, 47, 55], "faculti": [0, 36], "member": [0, 5, 8, 11, 17, 36, 45], "research": [0, 36], "profession": [0, 36], "accredit": [0, 36], "institut": [0, 36], "access": [0, 3, 15, 17, 22, 27, 29, 35, 36, 37, 53], "an": [0, 3, 5, 7, 8, 9, 10, 11, 12, 15, 16, 17, 18, 20, 21, 22, 24, 25, 26, 27, 28, 29, 30, 31, 32, 35, 37, 38, 39, 41, 43, 44, 50, 51, 53, 54, 56], "unlimit": [0, 48, 51], "version": [0, 1, 2, 4, 5, 8, 9, 10, 11, 13, 17, 18, 22, 28, 29, 32, 35, 36, 37, 38, 39, 40, 42, 43, 44, 45, 46, 48, 51, 52, 54, 55, 56], "through": [0, 1, 2, 12, 16, 22, 27, 41, 42, 45, 46, 47, 52, 53, 55], "academ": [0, 36], "initi": [0, 4, 5, 17, 26, 32, 36, 39, 40, 42, 43, 44, 45, 47, 48, 51], "biz": 0, "student": 0, "depend": [0, 12, 17, 20, 28, 34, 35, 36, 37, 41, 45, 46, 47, 51, 52, 55], "These": [0, 20, 41, 42, 45, 54], "third": [0, 2, 35, 45, 52, 56], "parti": 0, "ar": [0, 1, 2, 3, 7, 8, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 22, 24, 25, 26, 27, 28, 29, 31, 32, 35, 36, 37, 40, 41, 42, 43, 44, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56], "automat": [0, 9, 11, 17, 35, 36, 37, 42, 47, 56], "futur": [0, 1, 2, 41, 42, 45, 46, 47, 50, 52, 55], "pypi": [0, 1, 2, 36, 37, 41, 42, 45, 46, 47, 52, 55], "org": [0, 1, 2, 4, 5, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55], "request": [0, 2, 35], "six": [0, 2, 56], "certifi": 0, "deliv": [0, 53, 54], "januari": [0, 4, 5, 39, 40, 43, 44, 48, 51, 52], "2004": [0, 4, 5, 39, 40, 43, 44, 48, 51], "see": [0, 1, 2, 7, 9, 11, 12, 17, 20, 22, 28, 29, 35, 36, 37, 41, 42, 45, 46, 47, 52, 55, 56], "txt": [0, 35], "tutori": [1, 2, 41, 42, 45, 46, 47, 52, 55], "includ": [1, 2, 8, 10, 11, 17, 20, 34, 35, 36, 37, 41, 42, 45, 46, 47, 50, 52, 55, 56], "everyth": [1, 2, 17, 41, 42, 45, 46, 47, 52, 55], "build": [1, 2, 4, 5, 7, 8, 17, 18, 29, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 55], "mathemat": [1, 2, 11, 36, 37, 41, 42, 45, 46, 47, 52, 55], "program": [1, 2, 4, 5, 8, 11, 29, 35, 36, 37, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55], "its": [1, 2, 8, 9, 10, 12, 16, 17, 18, 20, 21, 22, 29, 35, 38, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 55, 56], "cloud": [1, 2, 18, 36, 37, 39, 40, 41, 42, 45, 46, 47, 50, 51, 52, 55], "when": [1, 2, 7, 8, 11, 12, 17, 18, 20, 22, 24, 26, 27, 28, 29, 32, 35, 36, 37, 41, 42, 45, 46, 47, 52, 55, 56], "finish": [1, 2, 17, 22, 35, 41, 42, 45, 46, 47, 52, 55], "ll": [1, 2, 36, 41, 42, 45, 46, 47, 52, 55, 56], "have": [1, 2, 7, 9, 10, 11, 12, 15, 16, 17, 18, 22, 24, 26, 29, 32, 36, 37, 41, 42, 43, 44, 45, 46, 47, 52, 54, 55, 56], "foundat": [1, 2, 41, 42, 45, 46, 47, 52, 55], "knowledg": [1, 2, 41, 42, 45, 46, 47, 52, 55], "analyt": [1, 2, 41, 42, 45, 46, 47, 52, 55], "notebook": [1, 2, 36, 37, 41, 42, 45, 46, 47, 50, 52, 55], "part": [1, 2, 4, 7, 8, 9, 10, 12, 16, 25, 35, 37, 41, 42, 43, 44, 45, 46, 47, 52, 55], "It": [1, 2, 7, 8, 11, 17, 22, 27, 29, 35, 41, 42, 45, 46, 47, 52, 55], "either": [1, 2, 8, 9, 15, 16, 17, 20, 22, 24, 25, 27, 29, 32, 41, 42, 45, 46, 47, 48, 50, 52, 55], "watson": [1, 2, 35, 36, 37, 38, 41, 42, 45, 46, 47, 52, 55], "sign": [1, 2, 36, 41, 42, 45, 46, 47, 52, 55], "start": [1, 2, 3, 8, 9, 17, 22, 29, 34, 36, 37, 39, 41, 43, 44, 46, 47, 52, 55], "right": [1, 2, 7, 10, 41, 42, 45, 46, 47, 50, 52, 55], "awai": [1, 2, 41, 42, 45, 46, 47, 52, 55], "tabl": [1, 2, 3, 11, 34, 35, 41, 42, 45, 46, 47, 52, 55], "content": [1, 2, 5, 35, 41, 42, 45, 46, 47, 52, 55], "we": [1, 2, 17, 24, 37, 41, 42, 43, 44, 45, 46, 47, 51, 52, 55, 56], "wish": [1, 42, 45, 46], "put": [1, 35], "n": [1, 2, 3, 4, 5, 17, 31, 39, 40, 43, 44, 46, 47, 50, 52], "which": [1, 2, 3, 6, 7, 8, 10, 12, 15, 16, 17, 18, 20, 22, 24, 27, 29, 32, 34, 35, 37, 41, 42, 45, 46, 47, 50, 52, 55, 56], "scatter": [1, 55, 56], "plane": [1, 56], "row": [1, 2, 5, 42, 45, 52, 55], "align": [1, 41, 45, 46, 47, 52], "from": [1, 2, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 22, 24, 28, 29, 32, 35, 36, 37, 39, 40, 41, 42, 43, 44, 47, 48, 50, 51, 52, 53, 56], "left": [1, 7, 10, 17, 29, 35, 41, 42, 45, 46, 47, 52], "x": [1, 2, 3, 4, 7, 10, 12, 16, 17, 24, 25, 32, 35, 37, 46, 55], "axi": [1, 24, 41, 45, 46, 47, 52, 55, 56], "locat": [1, 3, 13, 20, 42, 45, 46, 50, 52, 54, 55, 56], "point": [1, 3, 7, 8, 16, 17, 20, 22, 24, 28, 50, 52, 55, 56], "b_i": 1, "y": [1, 2, 3, 10, 17, 24, 25, 32, 35, 42, 46, 55], "j": [1, 3, 39, 41], "o_j": 1, "want": [1, 17, 23, 24, 26, 37, 41, 42, 45, 46, 50, 55], "find": [1, 9, 17, 22, 36, 42, 43, 44, 45, 46, 50, 55], "arrang": 1, "each": [1, 2, 3, 4, 7, 8, 15, 16, 17, 22, 27, 28, 29, 31, 35, 39, 40, 41, 43, 44, 46, 47, 48, 50, 51, 55, 56], "contain": [1, 2, 3, 4, 7, 8, 11, 13, 16, 17, 19, 22, 26, 28, 29, 31, 35, 41, 42, 45, 46, 47, 50, 52, 55], "exactli": [1, 2, 17, 51, 56], "one": [1, 2, 3, 4, 7, 9, 10, 11, 17, 20, 22, 23, 25, 26, 28, 29, 31, 35, 37, 41, 42, 43, 44, 45, 46, 50, 51, 52, 55, 56], "store": [1, 4, 6, 11, 17, 22, 29, 35, 41, 42, 45, 46, 47, 51, 52, 55, 56], "total": [1, 2, 4, 5, 17, 19, 20, 39, 40, 41, 43, 44, 45, 46, 48, 50, 51, 52, 55, 56], "distanc": [1, 50], "storag": [1, 35], "minim": [1, 2, 4, 5, 8, 9, 17, 40, 43, 44, 47, 48, 50, 55, 56], "first": [1, 2, 7, 9, 17, 24, 25, 29, 35, 36, 37, 41, 42, 43, 44, 45, 47, 48, 51, 55, 56], "two": [1, 2, 4, 7, 9, 10, 12, 16, 17, 29, 35, 41, 42, 43, 44, 45, 46, 47, 51, 52, 55, 56], "new": [1, 3, 4, 7, 8, 9, 10, 11, 16, 17, 20, 22, 24, 26, 29, 32, 35, 37, 39, 42, 51, 52, 55], "examin": [1, 8], "cost": [1, 4, 5, 12, 17, 29, 40, 41, 43, 44, 46, 47, 48, 50, 53, 56], "chang": [1, 2, 4, 9, 11, 16, 17, 20, 22, 24, 32, 36, 41, 42, 45, 46, 47, 52, 55], "impos": [1, 47], "assign": [1, 2, 8, 17, 27, 39, 40, 43, 44, 50, 51, 52, 56], "immedi": 1, "Then": [1, 17, 41, 42, 45, 55], "next": [1, 2, 4, 41, 42, 45, 46, 47, 52, 55, 56], "6": [1, 3, 4, 5, 7, 13, 29, 36, 37, 39, 41, 42, 43, 44, 45, 46, 47, 48, 52, 54, 55, 56], "technologi": [1, 2, 5, 41, 42, 45, 46, 47, 52], "recommend": [1, 2, 41, 42, 45, 46, 47, 52, 55], "action": [1, 2, 41, 42, 45, 46, 47, 52, 55], "base": [1, 2, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 35, 37, 41, 42, 45, 46, 47, 52, 55], "desir": [1, 2, 41, 42, 45, 46, 47, 52, 55], "outcom": [1, 2, 41, 42, 45, 46, 47, 52, 55], "take": [1, 2, 5, 7, 9, 11, 12, 15, 16, 17, 20, 27, 41, 42, 43, 44, 45, 46, 47, 48, 52, 55, 56], "specif": [1, 2, 4, 17, 20, 22, 29, 35, 41, 42, 45, 46, 47, 50, 52, 55], "scenario": [1, 2, 41, 42, 45, 46, 47, 52, 55], "resourc": [1, 2, 17, 41, 42, 45, 46, 47, 48, 52, 55], "past": [1, 2, 41, 42, 45, 46, 47, 52, 55], "current": [1, 2, 11, 17, 20, 22, 35, 37, 40, 41, 42, 45, 46, 47, 52, 55], "event": [1, 2, 22, 41, 42, 45, 46, 47, 52, 55], "insight": [1, 2, 41, 42, 45, 46, 47, 52, 55], "organ": [1, 2, 36, 41, 42, 45, 46, 47, 52, 55], "make": [1, 2, 4, 9, 17, 25, 42, 45, 46, 47, 52, 55, 56], "better": [1, 2, 9, 41, 42, 45, 46, 47, 52, 55], "greater": [1, 2, 17, 41, 42, 45, 46, 47, 52, 55, 56], "control": [1, 2, 9, 11, 17, 22, 23, 29, 41, 42, 45, 46, 47, 52, 55], "path": [1, 2, 13, 17, 18, 29, 41, 42, 45, 46, 47, 50, 52, 55], "valu": [1, 2, 3, 4, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 20, 21, 22, 24, 27, 28, 29, 30, 31, 32, 35, 41, 42, 43, 44, 45, 46, 47, 52, 55, 56], "synergi": [1, 2, 41, 42, 45, 46, 47, 52, 55], "predict": [1, 2, 41, 42, 45, 46, 47, 52, 55], "analyz": [1, 2, 4, 8, 37, 42, 46, 47, 52, 55], "level": [1, 2, 9, 11, 14, 17, 29, 35, 41, 42, 46, 50, 52, 55], "suggest": [1, 2, 41, 42, 45, 46, 47, 52, 55], "wai": [1, 2, 10, 11, 17, 18, 21, 35, 36, 37, 41, 42, 45, 46, 47, 52, 55, 56], "handl": [1, 2, 17, 22, 35, 41, 42, 45, 46, 47, 52, 55], "situat": [1, 2, 41, 42, 45, 46, 47, 52, 55], "act": [1, 2, 17, 27, 41, 42, 45, 46, 47, 52, 55], "fast": [1, 2, 41, 42, 45, 46, 47, 52, 55], "dynam": [1, 2, 4, 41, 42, 45, 46, 47, 52, 55], "condit": [1, 2, 41, 42, 45, 46, 47, 52, 55], "superior": [1, 2, 41, 42, 45, 46, 47, 52, 55], "uncertain": [1, 2, 41, 42, 45, 46, 47, 52, 55], "environ": [1, 2, 4, 5, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 52, 53, 55, 56], "gain": [1, 2, 41, 42, 45, 46, 47, 52, 53, 55], "strong": [1, 2, 41, 42, 45, 46, 47, 52, 55], "competit": [1, 2, 41, 42, 45, 46, 47, 52, 55], "advantag": [1, 2, 41, 42, 45, 46, 47, 52, 53, 55], "autom": [1, 2, 41, 42, 45, 46, 47, 52, 55], "complex": [1, 2, 41, 42, 45, 46, 47, 52, 55], "trade": [1, 2, 41, 42, 45, 46, 47, 52, 55], "off": [1, 2, 17, 35, 41, 42, 45, 46, 47, 52], "manag": [1, 2, 4, 17, 41, 42, 45, 46, 47, 52, 53, 55], "opportun": [1, 2, 41, 42, 45, 46, 47, 52, 55], "mitig": [1, 2, 41, 42, 45, 46, 47, 52, 55], "risk": [1, 2, 40, 41, 42, 45, 46, 47, 50, 52, 55], "proactiv": [1, 2, 41, 42, 45, 46, 47, 52, 55], "updat": [1, 2, 4, 11, 29, 35, 36, 37, 39, 41, 42, 45, 46, 47, 52, 55], "meet": [1, 2, 37, 41, 42, 45, 46, 47, 48, 51, 52, 55], "oper": [1, 2, 3, 8, 9, 10, 11, 12, 16, 17, 18, 20, 25, 27, 29, 35, 37, 41, 45, 46, 47, 50, 52, 55, 56], "goal": [1, 2, 5, 17, 41, 42, 46, 47, 52, 55, 56], "increas": [1, 2, 14, 41, 42, 45, 46, 47, 51, 52, 55], "custom": [1, 2, 3, 7, 17, 22, 23, 42, 45, 46, 47, 48, 50, 52, 55], "loyalti": [1, 2, 41, 42, 45, 46, 47, 52, 55], "prevent": [1, 2, 10, 22, 41, 42, 45, 46, 47, 52, 55, 56], "threat": [1, 2, 41, 42, 45, 46, 47, 52, 55], "fraud": [1, 2, 41, 42, 45, 46, 47, 52, 55], "process": [1, 2, 4, 17, 28, 35, 40, 41, 42, 45, 46, 47, 52, 53, 55], "follow": [1, 2, 3, 4, 10, 11, 13, 17, 28, 35, 36, 37, 41, 42, 45, 46, 47, 50, 52, 55, 56], "code": [1, 2, 3, 7, 11, 17, 20, 22, 28, 31, 35, 41, 42, 45, 46, 47, 52, 54, 55, 56], "The": [1, 2, 3, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 27, 28, 29, 30, 32, 34, 35, 36, 37, 39, 40, 41, 43, 44, 47, 48, 50, 51, 54], "packag": [1, 2, 13, 22, 24, 35, 41, 42, 45, 46, 47, 52, 53, 54, 55], "earlier": [1, 2, 42], "sy": [1, 2, 3, 11, 29, 41, 42, 45, 46, 47, 52, 55], "try": [1, 2, 13, 17, 41, 42, 45, 46, 47, 52, 55, 56], "except": [1, 2, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 22, 24, 28, 29, 32, 35, 41, 42, 45, 46, 47, 52, 55, 56], "rais": [1, 2, 7, 10, 11, 12, 15, 16, 17, 18, 20, 21, 24, 27, 29, 32, 35, 41, 42, 45, 46, 47, 52, 54, 55, 56], "pleas": [1, 2, 38, 41, 42, 45, 46, 47, 52, 53, 55], "project": [1, 2, 37, 41, 42, 45, 46, 47, 52, 55], "If": [1, 6, 8, 10, 11, 13, 15, 16, 17, 18, 20, 22, 23, 25, 26, 27, 28, 29, 35, 36, 37, 39, 41, 42, 46, 47, 51, 52, 54, 55], "input": [1, 17, 35, 45, 46, 47, 48, 55], "number": [1, 3, 5, 6, 7, 8, 9, 10, 12, 16, 17, 19, 20, 22, 24, 25, 27, 28, 29, 35, 40, 41, 43, 44, 45, 46, 47, 48, 50, 51, 56], "posit": [1, 7, 10, 12, 17, 30, 35, 42, 45, 47, 52, 56], "euclidean": 1, "comput": [1, 8, 9, 15, 16, 17, 20, 22, 24, 27, 29, 37, 38, 41, 42, 43, 44, 47, 55, 56], "between": [1, 3, 7, 9, 10, 16, 17, 22, 24, 35, 42, 45, 46, 50, 51, 56], "math": [1, 17, 37, 50], "sqrt": 1, "15": [1, 5, 17, 29, 39, 41, 43, 44, 45, 46, 52, 55], "box_rang": 1, "rang": [1, 3, 4, 5, 10, 17, 19, 20, 39, 41, 42, 43, 44, 45, 46, 47, 51, 52, 55, 56], "obj_rang": 1, "random": 1, "o_xmax": 1, "o_ymax": 1, "box_coord": 1, "b": [1, 2, 4, 12, 17, 23, 31, 39, 41, 42, 45, 46, 47, 55, 56], "obj_coord": 1, "140": [1, 45, 55, 56], "146": [1, 45, 55], "8": [1, 2, 3, 4, 5, 9, 11, 35, 36, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55, 56], "132": [1, 45], "14": [1, 17, 39, 41, 43, 44, 45, 46, 47, 52, 55], "53": [1, 42, 55], "28": [1, 43, 44, 45, 46, 55, 56], "137": 1, "13": [1, 17, 29, 41, 43, 44, 45, 46, 47, 52, 55, 56], "7": [1, 2, 3, 5, 7, 16, 17, 35, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 50, 52, 54, 55, 56], "95": [1, 41, 42, 45, 55, 56], "12": [1, 5, 13, 17, 39, 41, 42, 43, 44, 45, 46, 47, 52, 54, 55], "68": [1, 45], "9": [1, 3, 4, 5, 13, 17, 36, 39, 41, 42, 43, 44, 45, 46, 48, 52, 54, 55, 56], "102": [1, 17], "116": [1, 55], "11": [1, 2, 5, 8, 17, 41, 42, 43, 44, 45, 46, 50, 52, 55, 56], "29": [1, 42, 43, 44, 45, 46, 55, 56], "89": [1, 45], "141": 1, "matrix": [1, 3, 17, 28, 47], "actual": [1, 2, 29, 32, 35, 45, 47, 56], "squar": [1, 3, 9, 17, 25, 51, 52], "keep": [1, 2, 9, 17, 29, 32, 37, 40, 42, 43, 44, 45, 46, 50, 55, 56], "integ": [1, 2, 3, 6, 7, 9, 10, 12, 16, 17, 19, 20, 22, 28, 29, 30, 31, 35, 41, 42, 43, 44, 45, 46, 47, 52, 55, 56], "doe": [1, 16, 17, 20, 21, 23, 24, 29, 35, 37, 40, 42, 45, 46, 50, 55, 56], "essenc": 1, "o": [1, 35, 41, 45, 46, 47, 55, 56], "dx": 1, "dy": 1, "d2": 1, "env": [1, 2, 7, 34, 35, 42, 45, 46, 52, 55, 56], "print_inform": [1, 2, 3, 5, 8, 13, 17, 19, 39, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55, 56], "system": [1, 2, 13, 17, 36, 42, 45, 46, 52, 55, 56], "window": [1, 2, 36, 37, 42, 45, 46, 52, 55, 56], "64bit": [1, 2, 13, 42, 45, 46, 52, 55, 56], "c": [1, 2, 4, 5, 10, 12, 17, 18, 23, 29, 31, 36, 37, 39, 40, 41, 42, 43, 44, 45, 46, 48, 50, 51, 52, 54, 55], "local": [1, 2, 8, 11, 13, 17, 18, 22, 29, 35, 36, 42, 45, 46, 50, 52, 54, 55], "python373": [1, 2, 42, 45, 46, 52, 55], "ex": [1, 2, 42, 45, 46, 52, 55], "present": [1, 2, 3, 6, 13, 16, 17, 20, 22, 25, 29, 35, 42, 45, 46, 47, 52, 54, 55, 56], "panda": [1, 2, 13, 17, 23, 29, 35, 37, 38, 41, 42, 47, 50, 52], "25": [1, 2, 4, 5, 41, 42, 43, 44, 45, 46, 47, 50, 52, 55, 56], "all": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 14, 16, 17, 18, 19, 20, 22, 24, 25, 27, 29, 31, 32, 35, 40, 42, 43, 44, 45, 46, 47, 50, 51, 52, 55, 56], "mdl": [1, 2, 3, 5, 8, 17, 26, 27, 29, 32, 39, 40, 41, 43, 44, 45, 46, 47, 48, 51, 52, 55], "For": [1, 2, 3, 7, 8, 10, 12, 17, 22, 25, 27, 28, 29, 35, 36, 37, 41, 42, 45, 46, 47, 50, 52, 54, 55, 56], "binari": [1, 2, 3, 8, 9, 10, 12, 17, 19, 29, 31, 35, 41, 42, 43, 44, 45, 46, 47, 52, 55, 56], "x_": [1, 52], "equal": [1, 3, 10, 12, 16, 17, 20, 35, 42, 43, 44, 45, 46, 47, 55, 56], "onli": [1, 3, 5, 11, 12, 16, 17, 20, 22, 29, 35, 41, 43, 44, 45, 46, 51, 55, 56], "2d": 1, "binary_var_matrix": [1, 2, 3, 17, 40, 42, 43, 44, 45, 46, 51, 52, 55, 56], "lambda": [1, 4, 5, 17, 42, 45, 46, 48, 51, 52, 55], "ij": [1, 17, 52], "d_": [1, 51], "d": [1, 2, 4, 11, 22, 39, 42, 43, 44, 46, 51, 52, 55, 56], "sum": [1, 2, 3, 4, 5, 9, 16, 17, 35, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55, 56], "over": [1, 3, 5, 10, 16, 17, 20, 25, 29, 30, 37, 42, 43, 44, 45, 52, 55, 56], "both": [1, 7, 10, 17, 25, 37, 42, 43, 44, 45, 46, 55, 56], "column": [1, 2, 4, 23, 28, 29, 41, 42, 45, 46, 47, 52, 55], "must": [1, 2, 3, 4, 7, 10, 12, 15, 17, 18, 22, 24, 29, 30, 31, 35, 36, 37, 42, 45, 46, 47, 51, 55, 56], "result": [1, 4, 5, 8, 17, 23, 29, 35, 39, 40, 41, 43, 44, 46, 48, 50, 51, 52, 55], "time": [1, 2, 4, 5, 7, 9, 16, 17, 20, 22, 28, 35, 40, 42, 43, 44, 47, 50, 51, 52, 55, 56], "per": [1, 4, 5, 8, 35, 39, 41, 42, 43, 44, 46, 47, 52, 56], "add_constraint": [1, 2, 3, 4, 17, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55, 56], "225": 1, "continu": [1, 2, 3, 12, 17, 19, 26, 31, 39, 41, 42, 45, 46, 47, 52, 55, 56], "30": [1, 5, 32, 41, 45, 46, 55, 56], "linear": [1, 2, 3, 5, 7, 9, 10, 12, 15, 17, 19, 24, 25, 26, 28, 29, 41, 42, 45, 46, 47, 49, 50, 51, 52, 55, 56], "paramet": [1, 2, 7, 8, 9, 11, 12, 16, 17, 18, 22, 24, 25, 26, 27, 29, 32, 34, 35, 41, 42, 43, 44, 45, 46, 47, 49, 52, 55, 56], "default": [1, 2, 3, 4, 8, 10, 11, 12, 14, 17, 18, 20, 22, 24, 26, 27, 29, 31, 32, 35, 36, 41, 42, 45, 46, 47, 52, 55, 56], "type": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 22, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 41, 42, 45, 46, 47, 50, 52, 54, 55], "milp": [1, 2, 17, 41, 42, 45, 46, 52, 55], "displac": 1, "assert": [1, 2, 4, 12, 39, 41, 42, 43, 44, 45, 46, 47, 51, 52, 55, 56], "fail": [1, 2, 4, 10, 12, 17, 28, 39, 41, 42, 45, 46, 47, 52, 55], "report": [1, 2, 11, 17, 22, 38, 40, 41, 42, 45, 46, 47, 51, 52, 53, 55], "d1": 1, "objective_valu": [1, 2, 4, 17, 29, 39, 43, 44, 48, 55, 56], "print_solut": [1, 17, 43, 44], "def": [1, 2, 4, 5, 7, 17, 23, 39, 40, 42, 43, 44, 45, 46, 47, 48, 51, 55, 56], "make_solution_vector": 1, "x_var": [1, 39], "sol": [1, 7, 17, 22, 29, 43, 44, 52], "solution_valu": [1, 2, 4, 5, 12, 16, 39, 40, 41, 43, 44, 45, 46, 47, 48, 52, 55, 56], "break": [1, 4, 39, 45], "return": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 39, 40, 42, 43, 44, 45, 46, 48, 51, 55, 56], "make_obj_box_dir": 1, "sol_vec": 1, "arrai": [1, 4, 17, 47, 52, 55], "order": [1, 7, 9, 12, 13, 14, 17, 22, 24, 29, 30, 35, 36, 42, 45, 46, 47, 50, 51, 55], "slot": 1, "obj": [1, 4, 29, 39, 48, 56], "sol1": 1, "print": [1, 2, 3, 4, 5, 7, 11, 14, 17, 18, 19, 20, 22, 26, 29, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55, 56], "": [1, 2, 3, 4, 5, 15, 17, 20, 21, 22, 29, 31, 32, 35, 37, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55, 56], "format": [1, 2, 4, 5, 7, 8, 9, 17, 18, 19, 20, 22, 29, 35, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55], "8858": 1, "As": [1, 3, 7, 22, 32, 35, 37, 39, 42, 45, 55, 56], "consequ": 1, "cannot": [1, 10, 12, 16, 17, 29, 30, 35, 42, 43, 44, 45, 51, 55], "so": [1, 2, 3, 6, 9, 17, 26, 27, 29, 30, 35, 36, 43, 44, 45, 46, 47, 52, 55], "linearconstraint": [1, 10, 17, 46, 49], "x_1_2": 1, "eq": [1, 9, 10, 17, 46, 56], "now": [1, 41, 42, 45, 46, 47, 52, 55, 56], "state": [1, 10, 17, 42, 43, 44, 45, 46, 54, 56], "k": [1, 2, 3, 17, 24, 25, 37, 39, 46, 50, 55, 56], "geq": 1, "logic": [1, 9, 10, 17, 20, 26, 27, 45, 52, 55, 56], "implic": [1, 56], "relat": [1, 17, 19, 29, 42, 43, 44, 46, 56], "45": [1, 4, 45, 46, 47, 52, 55], "let": [1, 2, 17, 35, 41, 42, 45, 46, 47, 55, 56], "again": [1, 17, 39, 42, 45, 55], "check": [1, 6, 8, 10, 12, 16, 17, 20, 25, 27, 28, 29, 31, 36, 37, 47, 54, 56], "our": [1, 2, 42, 45, 52, 56], "satisfi": [1, 3, 5, 7, 10, 17, 29, 42, 46, 47, 48, 50, 55, 56], "ok2": 1, "sol2": [1, 45], "8878": 1, "inde": [1, 56], "higher": [1, 8, 17, 36, 45, 48, 55], "expect": [1, 7, 17, 29, 41, 43, 44, 45, 46, 47, 55, 56], "second": [1, 2, 9, 17, 25, 28, 35, 45, 52, 56], "In": [1, 8, 9, 10, 12, 15, 17, 20, 22, 28, 29, 42, 45, 46, 47, 48, 52, 55, 56], "other": [1, 8, 12, 13, 16, 17, 20, 27, 29, 35, 42, 43, 44, 45, 46, 48, 50, 51, 52, 56], "word": [1, 8, 20, 29, 45, 46], "OR": [1, 17, 45], "side": [1, 4, 7, 20, 29], "case": [1, 10, 12, 15, 17, 22, 27, 28, 29, 35, 42, 45, 47, 56], "extrem": [1, 17, 55], "care": [1, 45, 56], "foral": 1, "hand": [1, 5, 7], "last": [1, 17, 24, 46, 52], "befor": [1, 3, 7, 17, 22, 24, 28, 29, 35, 36, 42, 45, 46, 47, 55], "ok3": 1, "d3": 1, "sol3": 1, "9078": 1, "vector": 1, "indic": [1, 2, 7, 8, 10, 15, 17, 19, 21, 22, 28, 29, 41, 42, 45, 51, 54], "sort": [1, 14, 40, 41, 43, 44, 45, 51, 52], "maptplotlib": [1, 56], "displai": [1, 4, 5, 8, 10, 13, 17, 24, 39, 40, 41, 42, 43, 44, 45, 46, 48, 50, 51, 52, 55], "matplotlib": [1, 13, 24, 42, 45, 46, 47, 50, 55, 56], "pyplot": [1, 42, 45, 46, 47, 55, 56], "plt": [1, 42, 45, 46, 47, 55, 56], "pylab": [1, 55], "rcparam": [1, 55], "inlin": [1, 42, 45, 46, 47, 55, 56], "figur": [1, 45, 46, 55], "figsiz": [1, 42, 46, 47, 55], "display_solut": 1, "obj_box": 1, "box_x": 1, "box_i": 1, "obj_x": 1, "obj_i": 1, "text": [1, 2, 21, 28, 34, 41, 45, 46, 47, 52, 55], "str": [1, 2, 3, 4, 17, 35, 39, 43, 44, 45, 46, 52, 56], "bbox": [1, 55], "dict": [1, 11, 17, 18, 29, 35, 43, 44, 45, 46, 52], "facecolor": [1, 55], "red": [1, 2, 5], "alpha": 1, "plot": [1, 24, 42, 45, 46, 47, 55, 56], "show": [1, 5, 8, 24, 41, 42, 46, 47, 50, 52, 55, 56], "segment": [1, 17], "cross": [1, 2], "enforc": [1, 42, 45, 55], "introduc": [1, 37], "mydict": 1, "titl": [1, 42, 46, 47, 55], "true": [1, 4, 5, 6, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 20, 21, 23, 25, 26, 27, 28, 29, 31, 35, 39, 40, 42, 43, 44, 45, 46, 55, 56], "has_matplotlib": [1, 13, 56], "len": [1, 2, 4, 5, 17, 29, 39, 40, 41, 42, 43, 44, 45, 46, 47, 51, 55, 56], "label": [1, 42, 46, 47, 52, 56], "kei": [1, 4, 11, 12, 15, 17, 20, 27, 29, 35, 39, 42, 43, 44, 46, 51, 55, 56], "ind": 1, "xrang": [1, 41], "group": [1, 8, 17, 18, 20, 52, 55], "width": [1, 4, 46, 47, 55], "bar": [1, 17, 42, 46, 47], "fig": [1, 46], "ax": [1, 45, 46, 55], "subplot": [1, 46, 47], "rects1": 1, "color": [1, 2, 41, 45, 46, 47, 52, 56], "g": [1, 2, 4, 7, 17, 18, 39, 42, 45, 46, 47, 48, 55, 56], "set_titl": [1, 46], "set_xtick": 1, "set_xticklabel": 1, "legend": [1, 47, 56], "els": [1, 2, 3, 4, 5, 6, 12, 15, 16, 17, 18, 20, 22, 25, 26, 27, 29, 39, 40, 43, 44, 45, 46, 48, 51, 52, 55, 56], "warn": [1, 14, 17, 35, 46, 50, 54, 56], "collect": [1, 2, 3, 4, 5, 17, 22, 40, 42, 43, 44, 45, 46, 51, 52, 55, 56], "ordereddict": 1, "dist": 1, "8000": 1, "evolut": [1, 55], "858": 1, "878": [1, 2], "1078": 1, "learn": [1, 2, 35, 36, 37, 41, 42, 45, 46, 47, 52, 55], "formul": [1, 2, 41, 42, 45, 46, 47, 52, 55], "bug": [1, 2, 38, 41, 42, 45, 46, 47, 52, 53, 55], "go": [1, 2, 38, 41, 42, 45, 46, 47, 52, 53, 55], "here": [1, 2, 3, 17, 23, 29, 35, 36, 37, 38, 39, 41, 42, 43, 44, 45, 46, 47, 52, 53, 54, 55, 56], "contact": [1, 2, 41, 42, 45, 46, 47, 52, 55], "dofeedback": [1, 2, 38, 41, 42, 45, 46, 47, 52, 53, 55], "wwpdl": [1, 2, 38, 41, 42, 45, 46, 47, 52, 53, 55], "vnet": [1, 2, 38, 41, 42, 45, 46, 47, 52, 53, 55], "copyright": [1, 2, 4, 5, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55], "2017": [1, 2, 41, 42, 45, 46, 47, 52, 55], "2019": [1, 2, 41, 42, 45, 46, 47, 52, 55], "ipla": [1, 2, 41, 42, 45, 46, 47, 52, 55], "sampl": [1, 2, 37, 41, 42, 44, 45, 46, 47, 50, 52, 55], "materi": [1, 2, 41, 42, 45, 46, 47, 50, 52, 55], "A": [2, 3, 6, 7, 8, 9, 10, 11, 12, 15, 16, 17, 18, 20, 21, 22, 23, 24, 25, 27, 29, 30, 31, 35, 37, 39, 41, 42, 45, 46, 47, 50, 51, 52, 56], "fiction": [2, 41], "coffe": [2, 50], "compani": [2, 41, 48, 50, 55], "plan": [2, 41, 42, 45, 46, 50, 55], "determin": [2, 4, 7, 9, 17, 22, 41, 48, 50, 52, 55], "where": [2, 3, 7, 9, 10, 11, 13, 17, 22, 25, 27, 36, 50, 52, 55, 56], "thei": [2, 9, 11, 16, 17, 22, 24, 29, 35, 36, 41, 45, 46], "should": [2, 7, 8, 11, 17, 20, 22, 28, 29, 35, 42, 43, 44, 45, 46, 47, 48, 50, 51, 55], "know": [2, 55, 56], "most": [2, 9, 37, 41, 45, 47, 55, 56], "brewer": 2, "enjoi": 2, "read": [2, 11, 17, 18, 29, 35, 38, 45, 46], "borrow": 2, "book": [2, 37], "those": [2, 17, 20, 22, 32, 42, 56], "citi": [2, 51, 52], "public": 2, "within": [2, 8, 17, 22, 27, 29, 37, 41, 51, 52, 55], "walk": 2, "chicago": [2, 51, 52], "implement": [2, 3, 22, 27, 35, 42, 45, 50, 52, 55], "median": [2, 29, 50], "note": [2, 10, 12, 16, 17, 22, 24, 26, 28, 29, 30, 35, 40, 42, 45, 47, 55, 56], "more": [2, 3, 4, 5, 8, 17, 20, 35, 36, 38, 41, 42, 43, 44, 45, 50, 52, 53, 55, 56], "global": [2, 3, 18, 36, 37, 43, 44, 45, 46, 47, 55], "anoth": [2, 6, 17, 45, 46, 47], "subpackag": 2, "dedic": [2, 18], "branch": [2, 42, 45, 46], "quit": 2, "simpl": [2, 3, 5, 22, 35, 37, 48, 50, 52, 56], "geograph": 2, "acquir": 2, "json": [2, 4, 5, 11, 29, 35, 39, 40, 43, 44, 48, 51], "file": [2, 4, 5, 9, 11, 17, 18, 20, 29, 34, 35, 39, 40, 43, 44, 45, 46, 48, 50, 51], "13bfa4c7": 2, "78ce": 2, "4d83": 2, "b53d": 2, "b57c60b701cf": 2, "1441918880": 2, "885709": 2, "null": [2, 17, 35], "albani": 2, "park": 2, "m": [2, 4, 10, 12, 13, 16, 17, 18, 37, 39, 40, 41, 42, 46, 51, 52], "w": [2, 5, 46, 50, 51, 52, 56], "10am": 2, "6pm": 2, "tu": 2, "th": [2, 12, 15, 17, 29, 41, 45, 46, 47, 52, 56], "12pm": 2, "8pm": 2, "f": [2, 4, 5, 47], "sa": 2, "9am": 2, "5pm": 2, "su": 2, "close": [2, 5, 35], "ye": [2, 40, 42, 56], "3401": 2, "foster": 2, "avenu": 2, "il": 2, "60625": 2, "773": 2, "539": 2, "5450": 2, "chipublib": 2, "41": [2, 42, 45, 55], "975456": 2, "87": [2, 55], "71409": 2, "fals": [2, 5, 6, 8, 10, 11, 12, 16, 17, 18, 20, 23, 25, 26, 27, 29, 31, 39, 42, 43, 44, 45, 46, 55], "snippet": 2, "repres": [2, 3, 7, 8, 10, 17, 35, 41, 45, 46, 47, 53, 55, 56], "disclaim": 2, "site": [2, 37], "provid": [2, 4, 5, 8, 13, 17, 22, 24, 35, 36, 37, 39, 40, 42, 43, 44, 45, 46, 47, 48, 51, 54, 55, 56], "ha": [2, 3, 5, 6, 7, 10, 12, 15, 16, 17, 20, 22, 27, 28, 29, 30, 32, 35, 39, 41, 45, 46, 47, 48, 51, 56], "been": [2, 3, 6, 7, 10, 12, 15, 16, 17, 22, 24, 27, 28, 29, 32, 35, 39, 45, 51], "modifi": [2, 7, 16, 17, 22, 24, 32, 41, 42, 45], "origin": [2, 6, 8, 17, 29, 35, 45, 55], "sourc": [2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 34, 35, 39, 40, 43, 44, 48, 51, 52, 53], "cityofchicago": 2, "offici": 2, "websit": 2, "claim": 2, "accuraci": 2, "timeli": 2, "complet": [2, 29, 43, 44, 46, 56], "ani": [2, 10, 12, 16, 17, 18, 20, 22, 25, 29, 42, 45, 46, 52, 55, 56], "subject": [2, 48, 52], "understood": 2, "being": [2, 8, 11, 16, 17, 22, 35, 41, 52, 56], "own": [2, 20, 21, 22, 35, 48], "name": [2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 15, 17, 18, 20, 22, 23, 24, 27, 29, 30, 31, 32, 34, 35, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 51, 52, 55, 56], "latitud": 2, "longitud": 2, "street": 2, "class": [2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 35, 40, 43, 44, 45, 46, 52, 56], "xpoint": 2, "__init__": [2, 4, 7, 23, 43, 44, 46], "self": [2, 4, 7, 10, 16, 23, 24, 25, 35, 40, 41, 43, 44, 46, 52, 56], "__str__": [2, 4, 20, 30, 40, 43, 44, 46, 56], "p": [2, 4, 39, 41, 42, 44, 48, 50, 55, 56], "g_": 2, "namedpoint": 2, "To": [2, 3, 7, 8, 10, 12, 17, 22, 29, 30, 37, 42, 45, 47, 48, 51, 52, 55, 56], "geopi": 2, "hasattr": [2, 45, 46], "real_prefix": [2, 45, 46], "virtual": [2, 37, 45, 46], "user": [2, 6, 7, 10, 17, 18, 20, 23, 27, 29, 35, 40, 42, 45, 46, 55], "great_circl": 2, "get_dist": 2, "p1": 2, "p2": 2, "mile": 2, "pars": [2, 9, 21, 45, 46], "element": [2, 3, 7, 8, 17, 35, 55, 56], "build_libraries_from_url": 2, "url": 2, "iteritem": [2, 46], "r": [2, 3, 45, 46, 52, 55, 56], "myjson": 2, "load": [2, 40, 50], "parse_const": 2, "utf": [2, 4, 39, 40], "meta": 2, "view": [2, 3], "name_col": 2, "location_col": 2, "col": 2, "enumer": [2, 4, 8, 9, 10, 12, 14, 17, 21, 22, 27, 29, 30, 32, 39, 43, 44, 46, 56], "strip": [2, 45, 50], "lower": [2, 8, 9, 10, 12, 17, 29, 31, 43, 44, 45, 46, 55], "runtimeerror": 2, "could": [2, 13, 17, 45, 46, 51, 55, 56], "mayb": 2, "unam": 2, "float": [2, 3, 4, 7, 8, 12, 15, 16, 17, 20, 22, 28, 29, 39, 42, 45, 46, 47, 55], "typeerror": 2, "none": [2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15, 17, 18, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 34, 35, 39, 41, 43, 44, 45, 46, 47, 52, 55, 56], "p_": 2, "s_": [2, 5, 45, 46, 52], "append": [2, 4, 17, 22, 29, 35, 40, 42, 46, 52, 55, 56], "api": [2, 7, 29, 38], "x8fc": 2, "8rcq": 2, "accesstyp": 2, "download": [2, 36, 37], "There": [2, 3, 9, 17, 47, 52, 56], "81": [2, 5, 42], "constant": [2, 8, 10, 12, 16, 17, 25, 27, 29, 30, 32, 42, 44, 49], "mani": [2, 3, 8, 24, 36, 45, 55, 56], "would": [2, 47, 56], "like": [2, 8, 17, 27, 29, 35, 41, 56], "nb_shop": 2, "folium": 2, "map": [2, 4, 17, 35, 43, 44, 46], "marker": [2, 56], "map_osm": 2, "629": 2, "zoom_start": 2, "lt": 2, "lg": 2, "add_to": 2, "after": [2, 17, 24, 29, 35, 37, 47, 52], "abov": [2, 14, 39, 42, 45, 46, 47, 51, 55], "imposs": 2, "ideal": [2, 45], "just": [2, 17, 45, 47], "look": [2, 7, 9, 17, 27, 29, 36, 37, 40, 42, 50, 52], "write": [2, 3, 4, 17, 20, 22, 29, 34, 35, 39, 40], "bignum": 2, "999999999": 2, "ensur": [2, 45, 55, 56], "uniqu": [2, 15, 17, 20, 56], "simplic": 2, "consid": [2, 8, 10, 11, 16, 17, 35, 48], "candid": [2, 20, 56], "same": [2, 9, 12, 16, 17, 20, 22, 24, 29, 32, 35, 42, 43, 44, 45, 46, 50, 51, 55], "That": [2, 55], "also": [2, 3, 7, 9, 12, 17, 19, 20, 22, 29, 35, 37, 38, 42, 45, 47, 52, 55, 56], "select": [2, 5, 18, 36, 41], "coffeeshop_loc": 2, "var": [2, 3, 4, 6, 7, 9, 12, 16, 17, 25, 29, 40, 49, 56], "coffeeshop_var": 2, "binary_var_dict": [2, 3, 17, 40, 56], "is_coffeeshop": 2, "link_var": 2, "link": [2, 4, 10, 17], "suspect": 2, "exclud": [2, 8, 17], "c_loc": 2, "ct_forbid_": 2, "_": [2, 17, 35, 36, 37, 38, 40, 43, 44, 46, 50, 53, 54, 55], "6642": 2, "6561": [2, 42], "fourth": 2, "fix": [2, 32, 47, 50, 53, 55, 56], "nb": [2, 4, 5, 45, 51, 55], "inform": [2, 3, 8, 9, 10, 12, 13, 17, 18, 20, 22, 29, 36, 37, 42, 45, 46, 52, 55, 56], "6643": 2, "reader": [2, 35], "alwai": [2, 8, 17, 20, 22, 27, 45, 46], "hub": 2, "total_dist": 2, "open_coffeeshop": 2, "not_coffeeshop": 2, "edg": [2, 47], "int": [2, 5, 35, 47, 52], "210": [2, 55], "894": 2, "p_austin": 2, "irving_76": 2, "p_woodson": 2, "region": 2, "library_77": 2, "p_manning_13": 2, "p_back": 2, "yards_20": 2, "p_sulzer": 2, "library_27": 2, "highlight": 2, "coffeeshop": 2, "icon": 2, "info": [2, 14, 35], "coordin": [2, 17, 24], "add_child": 2, "polylin": 2, "ff0000": 2, "weight": [2, 17, 30, 41, 42, 45, 46, 47, 51, 52, 55], "scope": [3, 11, 45, 46], "what": [3, 9, 22, 42, 47, 50, 54, 55, 56], "possibl": [3, 7, 9, 10, 12, 14, 17, 21, 22, 23, 26, 28, 29, 31, 35, 42, 45, 46, 47, 50, 51, 52, 55], "interact": [3, 8, 35, 37], "busi": [3, 17], "ad": [3, 10, 16, 17, 22, 24, 45, 46, 52, 55, 56], "object": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 31, 32, 35, 39, 40, 43, 44, 48, 50, 51], "numer": [3, 7, 8, 9, 15, 17, 20, 22, 27, 56], "criterion": 3, "us": [3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 15, 16, 17, 18, 20, 22, 23, 24, 25, 27, 29, 30, 32, 34, 35, 37, 38, 40, 44, 50, 51, 53, 54, 56], "rank": 3, "solut": [3, 4, 5, 7, 9, 11, 12, 15, 16, 17, 22, 27, 28, 32, 35, 39, 40, 43, 44, 48, 49, 51, 56], "algorithm": [3, 5, 8, 9, 22, 27, 28, 45, 50], "aim": [3, 48], "best": [3, 4, 22, 28, 39, 41, 45, 47, 52, 56], "step": [3, 17, 56], "option": [3, 7, 15, 17, 18, 29, 32, 35, 37, 42, 45, 46, 47], "feasibl": [3, 9, 17, 28, 29, 42, 45, 55], "folder": 3, "set": [3, 5, 6, 8, 10, 11, 12, 14, 16, 17, 18, 20, 23, 24, 25, 26, 29, 30, 32, 35, 38, 40, 43, 44, 56], "factori": [3, 10, 17, 47, 48], "manipul": 3, "describ": [3, 9, 17, 20, 28, 50], "refer": [3, 20, 29, 36, 37, 38], "manual": [3, 20, 38], "method": [3, 5, 7, 8, 10, 12, 13, 15, 16, 17, 18, 19, 20, 22, 23, 24, 25, 26, 27, 28, 29, 30, 35, 40, 42, 43, 44, 45, 46, 47, 55, 56], "singl": [3, 17, 29, 55], "list": [3, 4, 7, 8, 9, 11, 12, 17, 22, 24, 29, 30, 35, 36, 37, 42, 45, 46, 47, 48, 51, 52, 55, 56], "dictionari": [3, 4, 8, 12, 17, 20, 27, 29, 32, 35, 42, 46, 55, 56], "index": [3, 6, 7, 17, 29, 35, 38, 41, 42, 43, 44, 45, 46, 47, 49, 51, 52, 55], "standard": [3, 5, 17, 29, 36, 37, 45, 54], "function": [3, 4, 5, 7, 10, 13, 16, 17, 18, 20, 22, 24, 30, 32, 35, 40, 42, 45, 47, 50, 52, 56], "binary_var": [3, 10, 17], "binary_var_list": [3, 17, 39], "integer_var": [3, 17, 40, 41], "integer_var_list": [3, 4, 17], "integer_var_dict": [3, 17, 29], "integer_var_matrix": [3, 17], "continuous_var": [3, 4, 17, 41, 43, 44, 45, 46, 55], "continuous_var_list": [3, 17, 39, 42, 47], "continuous_var_dict": [3, 4, 12, 17, 43, 44, 46, 48], "continuous_var_matrix": [3, 17, 42, 47, 55], "three": [3, 9, 10, 17, 47, 56], "accord": [3, 9, 35, 45, 46, 47, 50], "1": [3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 16, 17, 22, 24, 25, 27, 28, 29, 35, 37, 39, 40, 43, 44, 48, 50, 51, 53, 54, 56], "detail": [3, 4, 11, 17, 28, 29, 35, 36, 37, 41, 53, 54], "attribut": [3, 6, 11, 17], "found": [3, 5, 9, 13, 17, 24, 27, 29, 36, 39, 45, 52, 56], "py": [3, 11, 35, 50], "built": [3, 15, 16, 17, 18, 25, 27, 52], "combin": [3, 17, 47, 56], "elementari": 3, "form": [3, 10, 17, 19, 20, 25, 27, 29], "arithmet": [3, 17, 52], "overload": [3, 12, 16, 20, 29, 56], "manner": [3, 17, 22, 50, 51, 56], "z": [3, 10, 17, 29, 37], "3": [3, 4, 5, 7, 9, 10, 13, 16, 17, 22, 25, 29, 36, 37, 39, 40, 43, 44, 48, 50, 51, 54, 56], "5": [3, 4, 5, 8, 17, 25, 29, 37, 39, 40, 41, 43, 44, 48, 54, 56], "allow": [3, 17, 20, 29, 35, 36], "creation": [3, 45], "larg": [3, 5, 10, 12, 17, 36, 45], "though": [3, 45, 56], "much": [3, 4, 12, 35, 42, 45, 47, 48, 50, 51], "faster": [3, 12, 17], "larger": 3, "simplifi": [3, 42, 56], "comparison": 3, "compar": 3, "forc": [3, 5, 11, 20, 45, 52], "explicit": [3, 17], "avail": [3, 10, 12, 13, 17, 22, 29, 35, 36, 37, 42, 45, 53, 54], "eas": [3, 18], "eq_constraint": [3, 17], "le_constraint": [3, 17], "itself": [3, 9, 16, 17], "call": [3, 7, 12, 17, 20, 22, 25, 27, 28, 29, 35, 41, 45, 47], "possibli": [3, 12, 17, 20], "string": [3, 7, 8, 9, 10, 11, 13, 17, 18, 20, 21, 23, 27, 28, 29, 30, 31, 32, 34, 35, 42, 43, 44, 45, 46, 56], "argument": [3, 5, 7, 8, 9, 12, 15, 17, 18, 20, 21, 22, 24, 26, 27, 29, 35, 42, 45, 56], "activ": [3, 10, 17, 40, 43, 44, 46], "condens": 3, "sudoku": 3, "polici": 3, "comment": 3, "directori": [3, 17, 29, 35, 37], "myinput": 3, "4": [3, 4, 5, 8, 9, 10, 17, 29, 32, 35, 39, 40, 41, 43, 44, 48, 50, 54, 56], "idx": [3, 17, 41, 56], "solvesolut": [3, 7, 15, 17, 22, 27, 29, 49], "section": [3, 37, 42, 53, 56], "statu": [3, 8, 9, 10, 12, 17, 22, 28, 29], "accessor": [3, 17], "output": [3, 4, 5, 10, 11, 14, 17, 20, 23, 29, 35, 42, 43, 44, 45, 46, 48, 51, 52, 56], "adjust": 3, "hierarch": [3, 20], "tree": [3, 20, 22, 45], "reflect": [3, 20], "hierarchi": [3, 17, 20], "mip": [3, 9, 11, 17, 20, 22, 26, 28, 29, 32, 42, 44, 45, 46, 52], "toler": [3, 7, 17, 20, 29, 44, 45, 46], "mip_gap": [3, 22], "05": [3, 17, 27, 41, 45, 46], "gap": [3, 17, 22, 28, 39, 45], "data": [3, 4, 5, 7, 17, 18, 22, 23, 29, 34, 35, 37, 38, 39, 40, 43, 44, 48, 50, 51], "structur": [3, 46, 47, 52], "search": [3, 9, 11, 13, 17, 22, 36, 38, 45, 49, 56], "shortcut": 3, "simpler": 3, "test": [3, 12, 16, 17, 40, 45, 56], "directli": [3, 6, 7, 17, 28, 29, 30, 45], "bracket": 3, "msol": 3, "vname": 3, "nqueen": 3, "stdout": [3, 11, 17, 22], "v": [3, 43, 44, 45, 55, 56], "get_solve_statu": [3, 17], "correspond": [3, 8, 17, 28, 29, 35, 42, 45, 46, 55], "made": [3, 22, 41, 42, 44, 47, 50, 56], "export_as_lp": [3, 17], "demonstr": [3, 5, 55], "construct": [3, 17, 26, 32, 42], "gener": [4, 6, 17, 20, 22, 39, 45, 50, 52, 55, 56], "begin": [4, 22, 45, 50, 56], "small": [4, 10, 29, 56], "few": [4, 37, 45, 47, 50, 55], "variabl": [4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 19, 22, 25, 26, 29, 30, 31, 35, 36, 39, 43, 44, 48, 51], "partial": [4, 17, 26], "enlarg": 4, "repeat": 4, "until": [4, 42], "satisfactori": 4, "whole": 4, "achiev": [4, 40, 41, 50, 56], "corp": [4, 5, 39, 40, 43, 44, 48, 51], "2015": [4, 5, 39, 40, 43, 44, 48, 51, 52], "2022": 4, "import": [4, 5, 13, 17, 24, 35, 39, 40, 43, 44, 48, 51, 56], "namedtupl": [4, 5, 8, 23, 40, 43, 44, 46, 51, 52, 56], "util": [4, 5, 13, 17, 39, 40, 43, 44, 45, 46, 48, 49, 51], "get_environ": [4, 5, 35, 39, 40, 43, 44, 48, 49, 51], "default_roll_width": 4, "110": [4, 55], "default_item": 4, "48": [4, 45, 55], "35": [4, 45, 46, 47, 55, 56], "50": [4, 5, 40, 42, 44, 45, 47, 55, 56], "24": [4, 5, 41, 43, 44, 45, 46, 55, 56], "55": [4, 45, 46, 56], "75": [4, 42, 55], "default_pattern": 4, "etc": [4, 42], "default_pattern_item_fil": 4, "pattern1": 4, "item1": 4, "pattern2": 4, "item2": 4, "first_generation_du": 4, "titem": 4, "item_id": 4, "item_s": 4, "demand": [4, 48, 50], "id": [4, 17, 18, 22, 40, 41, 55, 56], "dual_valu": [4, 10, 17], "classmethod": [4, 8, 18, 21, 29], "cl": 4, "arg": [4, 9, 11, 17, 18, 21, 24, 29], "arg_id": 4, "arg_siz": 4, "arg_demand": 4, "item": [4, 7, 11, 17, 26, 46, 52, 55], "tpattern": 4, "pattern": [4, 5, 17, 50], "make_cutstock_pattern_generation_model": 4, "roll_width": 4, "kwarg": [4, 5, 8, 11, 17, 18, 24, 26, 27, 29, 35, 39, 40, 43, 44, 48, 51], "gen_model": 4, "cutstock_generate_pattern": 4, "dual": [4, 10, 17, 29, 55], "creat": [4, 5, 7, 8, 10, 11, 12, 16, 17, 18, 22, 24, 29, 30, 35, 36, 37, 38, 56], "use_var": 4, "ub": [4, 5, 9, 10, 12, 17, 45, 55], "999999": 4, "setup": [4, 40], "constraint": [4, 5, 6, 7, 8, 9, 10, 12, 17, 19, 21, 26, 27, 29, 36, 39, 40, 43, 44, 48], "usag": [4, 17, 23, 43, 44], "less": [4, 17, 42, 43, 44, 46, 56], "than": [4, 9, 17, 35, 41, 42, 43, 44, 45, 46, 55, 56], "roll": [4, 50], "dot": [4, 17, 42, 45], "express": [4, 6, 7, 9, 10, 12, 15, 16, 17, 19, 24, 25, 26, 29, 32, 56], "use_dual_expr": 4, "cutstock_update_du": 4, "gmodel": 4, "new_dual": 4, "propag": 4, "updated_us": 4, "modif": 4, "notifi": 4, "set_coeffici": 4, "make_custstock_master_model": 4, "item_t": 4, "pattern_t": 4, "fill_tabl": 4, "custock_mast": 4, "properti": [4, 6, 7, 8, 9, 10, 12, 13, 16, 17, 19, 20, 22, 25, 27, 28, 29, 30, 31, 35, 43, 44, 45, 46, 55], "it_row": 4, "items_by_id": 4, "pattern_row": 4, "patterns_by_id": 4, "pat": 4, "max_pattern_id": 4, "max": [4, 9, 17, 20, 32, 39, 40, 42, 46, 47, 55], "pt": [4, 56], "how": [4, 5, 8, 17, 29, 40, 48, 50, 51, 54, 56], "fill": [4, 17], "pattern_item_fil": 4, "cut": [4, 7, 17, 29, 42, 45, 46, 50], "max_cut": 4, "9999": 4, "cut_var": 4, "lb": [4, 5, 9, 10, 12, 17, 26, 40, 41, 43, 44, 45, 46, 47, 55], "all_pattern": 4, "all_item": 4, "item_fill_ct": 4, "ct_fill_": 4, "stock": [4, 50], "total_cutting_cost": 4, "add_pattern_to_master_model": 4, "master_model": 4, "item_usag": 4, "master": [4, 45, 46], "perform": [4, 15, 17, 29, 37, 42, 45, 55], "instanc": [4, 7, 8, 9, 12, 15, 16, 17, 18, 19, 20, 22, 24, 25, 27, 28, 29, 31, 32, 35, 36, 37, 46, 50, 51, 56], "taken": [4, 7, 41, 56], "sub": [4, 17, 20, 22, 31, 46], "new_pattern_id": 4, "new_pattern": 4, "zip": [4, 39, 42, 45, 46, 47, 50, 55], "new_pattern_cut_var": 4, "cut_": 4, "ct": [4, 7, 8, 17, 27, 29, 43, 44, 46], "lh": [4, 7, 10, 17], "ctlh": 4, "effect": [4, 20, 22, 29], "expr": [4, 6, 10, 16, 17, 25, 45, 49], "cost_expr": 4, "performw": 4, "cutstock_print_solut": 4, "cutstock_model": 4, "cut_var_valu": 4, "70": [4, 42, 44, 45, 47, 55, 56], "1e": [4, 5, 7, 12, 17, 27, 28, 29, 39, 45, 46, 55], "pattern_detail": 4, "10g": 4, "cutstock_save_as_json": 4, "json_fil": [4, 40], "dump": [4, 35, 39, 40], "indent": [4, 40], "encod": [4, 17, 34, 39, 40], "cutstock_solv": 4, "verbos": [4, 18, 27, 43, 46], "pop": [4, 5, 44], "field": [4, 5, 8, 11, 17, 27, 29, 35, 47, 56], "tupl": [4, 5, 7, 8, 17, 22, 27, 28, 29, 42, 43, 44, 46, 48, 51, 52, 56], "rc_ep": 4, "obj_ep": 4, "loop_count": [4, 39], "curr": 4, "while": [4, 5, 9, 11, 17, 18, 39, 42, 46, 47, 48, 50, 52, 54], "100": [4, 5, 10, 12, 17, 18, 41, 45, 48, 55], "ab": [4, 17, 45], "stop": [4, 9, 17, 22, 35, 39], "iter": [4, 7, 8, 10, 12, 16, 17, 20, 22, 25, 27, 28, 29, 30, 39, 42, 45, 51, 55], "move": [4, 24, 45], "2f": [4, 55], "slave": 4, "rc_cost": 4, "run": [4, 8, 9, 13, 17, 27, 35, 36, 39, 40, 41, 54], "use_valu": 4, "get_valu": [4, 7, 29, 42], "termin": [4, 17], "ret": 4, "loop": [4, 27, 39], "end": [4, 8, 17, 28, 34, 40, 42, 43, 44, 46, 51], "cutstock_solve_default": 4, "__name__": [4, 5, 39, 40, 43, 44, 48, 51], "__main__": [4, 5, 39, 40, 43, 44, 48, 51], "46": [4, 55, 56], "save": [4, 5, 11, 35, 39, 40, 41, 43, 44, 48, 51, 55], "get_output_stream": [4, 5, 35, 39, 40, 43, 44, 48, 49, 51], "fp": [4, 5, 39, 40, 43, 44, 48, 51], "monei": 5, "food": [5, 50], "budget": [5, 41], "armi": 5, "without": [5, 16, 17, 39, 50, 55], "damag": 5, "nutrit": [5, 50], "health": 5, "arm": 5, "variat": [5, 50, 55], "well": [5, 22, 45, 46, 47, 50, 55, 56], "known": [5, 17, 27, 50], "wa": [5, 17, 27, 29, 36, 42, 45, 50, 55], "pose": [5, 50], "georg": [5, 41, 50], "stigler": [5, 50], "dantzig": [5, 50], "choos": [5, 37, 50], "maxim": [5, 9, 17, 39, 41, 42, 50, 51, 52, 56], "satieti": [5, 50], "hi": 5, "becaus": [5, 12, 16, 28, 29, 31, 42, 56], "did": [5, 17, 42, 45], "yet": [5, 17, 56], "support": [5, 9, 11, 28, 29, 35, 37], "sophist": 5, "howev": [5, 17, 43, 44, 45, 46], "1947": 5, "jack": 5, "laderman": 5, "nation": 5, "bureau": 5, "appli": [5, 17, 27, 42, 45, 55, 56], "simplex": 5, "recent": 5, "propos": 5, "team": [5, 45, 46, 50, 51, 53], "nine": 5, "programm": 5, "work": [5, 9, 22, 35, 43, 44, 50, 51, 52, 55], "desk": 5, "calcul": [5, 24, 42, 45, 46, 47, 50, 51, 52, 55], "heurist": 5, "approxim": 5, "veri": [5, 12, 35, 42, 56], "cent": 5, "year": [5, 50, 52], "optimum": 5, "thu": [5, 22, 45, 46, 47], "practic": [5, 37, 45], "scale": [5, 24], "real": [5, 22, 42, 45, 46, 47, 55], "world": 5, "certain": [5, 20, 28, 35, 42, 45, 46, 48], "2018": [5, 39, 40, 43, 44, 48, 51], "daili": 5, "neo": 5, "guid": [5, 37], "solver": [5, 11, 17, 22, 23, 35, 36, 49], "roast": 5, "chicken": 5, "84": [5, 41, 45, 55], "spaghetti": [5, 50], "sauc": [5, 50], "78": [5, 55], "tomato": 5, "ripe": 5, "raw": [5, 45, 46, 47, 55], "27": [5, 42, 45, 46, 55, 56], "appl": 5, "skin": 5, "grape": 5, "32": [5, 43, 44, 45, 46, 55, 56], "chocol": [5, 50], "chip": [5, 50], "cooki": [5, 50], "03": [5, 32, 45, 46], "lowfat": [5, 50], "milk": [5, 50], "raisin": 5, "brn": 5, "34": [5, 41, 45, 55, 56], "hotdog": [5, 50], "31": [5, 43, 44, 45, 46, 55], "nutrient": 5, "calori": [5, 50], "2000": [5, 47, 50], "2500": [5, 45], "calcium": [5, 50], "800": [5, 50], "1600": 5, "iron": [5, 50], "vit_a": [5, 50], "5000": [5, 42, 47, 55], "50000": 5, "dietary_fib": [5, 50], "carbohydr": [5, 50], "300": [5, 41, 48, 55], "protein": [5, 50], "food_nutri": 5, "277": 5, "77": [5, 42, 55], "42": [5, 45, 55, 56], "358": 5, "80": [5, 17, 45], "3055": 5, "58": [5, 45, 55], "766": 5, "73": [5, 45, 56], "101": [5, 17, 39, 55], "121": 5, "296": 5, "500": [5, 41, 55], "115": [5, 55], "1250": 5, "242": 5, "unit_cost": 5, "qmin": 5, "qmax": 5, "build_diet_model": 5, "fn": [5, 15, 27], "ftype": 5, "integer_vartyp": [5, 17], "continuous_vartyp": [5, 17], "qty": 5, "var_dict": [5, 17, 29], "q_": 5, "mark": [5, 17, 37, 51], "them": [5, 17, 26, 29, 35, 45, 46, 47, 48, 55], "kpi": [5, 11, 17, 22, 29, 40, 44, 46, 47, 49, 50, 55], "amount": [5, 24, 27, 42, 47, 48], "add_rang": [5, 10, 17], "add_kpi": [5, 17, 39, 40, 42, 43, 44, 45, 46, 47, 48, 55], "publish_nam": [5, 17], "total_cost": [5, 55], "count": [5, 17, 25, 42, 45, 56], "nb_product": 5, "mdl_": 5, "qv": 5, "find_matching_var": [5, 17], "log_output": [5, 11, 17, 40, 42, 43, 44, 45, 46, 49], "float_precis": [5, 17], "qty_var": 5, "fv": 5, "food_nam": 5, "bui": [5, 41, 47, 48, 50], "6g": 5, "report_kpi": [5, 17, 43, 44], "export": [5, 17, 18, 20, 29, 43, 44, 48, 51], "modelobject": [6, 49], "operand": [6, 16, 17], "_abstractvalu": [6, 12, 15], "parent": [6, 20, 31], "contains_var": [6, 16, 25], "dvar": [6, 7, 8, 16, 17, 25, 29, 49], "whether": [6, 7, 8, 10, 12, 13, 16, 17, 20, 22, 25, 29, 41, 45, 51, 52, 54, 56], "param": [6, 11, 16, 17, 25, 32, 43, 44, 46, 49], "boolean": [6, 8, 12, 16, 17, 20, 21, 22, 25, 28, 29, 31], "is_quad_expr": [6, 25], "quadrat": [6, 10, 17, 19, 25, 29], "number_of_vari": [6, 16, 17, 19], "indexableobject": [6, 10, 12, 30, 49], "modelingobjectbas": [6, 24, 49], "is_gener": 6, "_origin": 6, "belong": [6, 9, 20], "_abstractmodelobject": 6, "_abstractnam": [6, 15], "intend": [6, 7, 16, 24, 25, 32], "instanti": [6, 7, 10, 12, 16, 20, 24, 25, 28, 29, 30, 31], "has_nam": 6, "has_user_nam": 6, "valid": [6, 7, 13, 15, 17, 20, 22, 29], "given": [6, 7, 8, 12, 16, 17, 24, 29, 35, 42, 45, 46, 52, 55, 56], "constraintcallbackmixin": [7, 49], "modelcallbackmixin": [7, 49], "get_cpx_unsatisfied_ct": 7, "06": [7, 12, 17, 29, 45], "subset": [7, 45], "unsatisfi": 7, "lazi": [7, 17], "among": [7, 17, 41, 45], "amn": 7, "defaut": [7, 8], "sens": [7, 9, 10, 17, 27, 32, 56], "rh": [7, 10, 17, 55], "rith": 7, "make_solution_from_watch": 7, "watch": 7, "incumb": [7, 22], "intermedi": [7, 22], "mention": [7, 10, 16, 17, 29], "regist": 7, "soluton": 7, "make_complete_solut": 7, "register_watched_var": 7, "mixin": [7, 23], "bridg": 7, "inherit": 7, "jointli": 7, "defin": [7, 8, 9, 10, 11, 15, 17, 21, 22, 23, 24, 29, 31, 43, 44], "branchcallback": 7, "legaci": 7, "constructor": [7, 18], "compli": 7, "mybranch": 7, "register_callback": 7, "assum": [7, 12, 17, 25, 29, 42, 47, 51, 52], "setter": 7, "connect": [7, 24], "index_to_var": 7, "var_index": 7, "convert": [7, 9, 12, 17, 20, 21, 29, 30, 35, 42, 43, 44, 45, 46, 47, 56], "associ": [7, 8, 10, 12, 16, 17, 29, 35, 42, 43, 44], "withth": 7, "otherwis": [7, 10, 12, 13, 15, 17, 18, 20, 22, 23, 27], "error": [7, 11, 14, 17, 18, 21, 29, 35, 54], "static": [7, 8, 9, 11, 17], "linear_ct_to_cplex": 7, "linear_ct": [7, 10, 17], "converst": 7, "coeffici": [7, 10, 12, 16, 17, 25, 42, 45], "letter": [7, 31], "l": [7, 19, 41], "e": [7, 16, 17, 18, 42, 45, 46, 55], "2x": [7, 16, 17, 25], "linear_ct_cplex": 7, "make_solut": 7, "make_solution_from_var": 7, "print_cal": [7, 49], "prompt_msg": 7, "decor": 7, "__call__": 7, "deriv": [7, 22, 55], "mycallback": 7, "lazyconstraintcallback": 7, "my": [7, 17, 54], "messag": [7, 14, 17, 18, 22, 26, 28, 54], "execut": [7, 35, 37, 42], "__call_": 7, "inplac": 7, "conflictrefin": [8, 49], "output_process": 8, "publishresultasdf": [8, 23, 27, 49], "abstract": [8, 15, 17, 22, 27, 31], "interfac": [8, 18, 27], "conflict": [8, 9], "mutual": 8, "contradictori": [8, 45, 46], "bound": [8, 9, 10, 12, 17, 22, 28, 29, 31, 43, 44, 45, 46, 55], "infeas": [8, 10, 17, 27, 43, 44, 46], "refin": [8, 9, 22, 43, 44, 46], "identifi": [8, 17, 41, 45, 46], "remov": [8, 16, 17, 21, 35, 45], "arriv": [8, 52], "display_conflict": 8, "represent": [8, 10, 11, 17, 20, 30, 31, 35, 52, 56], "conflictrefinerresult": [8, 49], "refine_conflict": 8, "prefer": [8, 9, 18, 45, 51, 52], "relax": [8, 9, 10, 26, 39, 43, 44, 45, 46, 49, 50], "constraintsgroup": [8, 49], "flag": [8, 17, 18, 20, 21, 29, 42], "accept": [8, 9, 12, 17, 18, 20, 21, 22, 27, 29, 32, 35, 41, 42], "similar": [8, 17, 22, 27, 52, 55], "conflictrefinerresut": 8, "hold": [8, 10, 12, 17, 22, 29], "about": [8, 13, 17, 22, 29, 36, 37, 38, 54], "var_bound": 8, "pref": 8, "include_infinity_bound": 8, "singleton": [8, 29], "constraintgroup": 8, "variabel": 8, "replic": 8, "sthe": 8, "behavior": [8, 11, 17, 22], "non": [8, 9, 10, 12, 17, 20, 26, 28, 29, 46, 51, 55], "differ": [8, 9, 16, 17, 20, 22, 29, 35, 40, 42, 43, 44, 45, 46, 47, 50, 51, 52, 55], "upper": [8, 9, 10, 12, 17, 31, 43, 44, 45, 46, 47, 55], "unless": [8, 17, 23], "precis": [8, 12, 17, 27, 29, 45, 46, 56], "infi": 8, "refined_bi": 8, "tconflictconstraint": [8, 49], "conflictstatu": [8, 9, 49], "possible_memb": 8, "involv": [8, 37], "wrapper": [8, 54], "display_stat": 8, "statist": [8, 17, 19, 29], "iter_conflict": 8, "number_of_conflict": 8, "were": [8, 17, 41], "produc": [8, 17, 29, 42, 47, 48, 50, 55], "cplex_loc": [8, 13, 29], "docplexcloud": [8, 29, 35], "cplex_cloud": [8, 29], "definit": [8, 17, 45, 46], "mai": [8, 10, 12, 17, 22, 24, 28, 35, 37, 41, 47, 52, 55], "neg": [8, 17, 45], "specifi": [8, 11, 13, 17, 20, 23, 24, 34, 35, 36, 37, 39, 44, 46, 50, 51], "zero": [8, 9, 10, 12, 17, 26, 28, 29, 42, 43, 44, 45, 46, 47, 56], "from_var": 8, "bound_typ": 8, "fromon": 8, "whose": [8, 17, 24, 35, 45, 56], "varboundtyp": [8, 9, 49], "alia": [8, 27], "_tconflictconstraint": 8, "varlbconstraintwrapp": [8, 49], "varboundwrapp": 8, "referenc": 8, "caus": [8, 29, 47, 54], "wrap": 8, "varubconstraintwrapp": [8, 49], "basisstatu": [9, 10, 12, 17, 49], "enum": [9, 11, 14, 21, 22, 46], "basi": [9, 10, 12, 17], "queri": [9, 16, 17], "lp": [9, 10, 12, 17, 18, 29, 32, 47], "notabasisstatu": 9, "invalid": [9, 10, 29, 35, 45, 54], "unknown": 9, "basic": [9, 17, 22, 46, 47, 49, 52], "mean": [9, 17, 24, 29, 42, 45, 52], "atlow": 9, "atupp": 9, "freenonbas": 9, "nonbas": 9, "knowledgecent": [9, 28, 29], "sssa5p_20": [9, 28, 29], "odm": [9, 28, 29], "help": [9, 22, 28, 29, 37, 38, 50, 53], "refcallablelibrari": [9, 28], "cpxapi": [9, 28], "getbas": 9, "html": [9, 28, 29, 40, 41, 45, 46, 47, 52, 55], "comparisontyp": [9, 10, 17, 49], "variou": [9, 17, 19, 27, 35, 45, 46, 48], "le": [9, 10, 17, 56], "e1": [9, 10, 17], "e2": [9, 10, 17], "ge": [9, 10, 17, 56], "denot": [9, 10, 17], "operator_symbol": 9, "cplexscop": [9, 49], "effortlevel": [9, 17, 49], "effort": 9, "ident": [9, 17, 22, 29, 47], "refcppcplex": 9, "ilocplex_mipstarteffort": 9, "objectivesens": [9, 17, 32, 44, 49], "is_maxim": [9, 17], "is_minim": [9, 17], "logger": [9, 11, 13, 21], "long": 9, "short": [9, 17, 31], "convent": 9, "short_nam": [9, 20, 31], "min": [9, 17, 20, 32, 35, 42, 46, 55], "verb": 9, "lowercas": [9, 20, 45], "qualitymetr": [9, 49], "relaxationmod": [9, 27, 49], "strategi": 9, "minsum": 9, "optsum": 9, "mininf": 9, "optinf": 9, "minquad": 9, "optquad": 9, "phase": [9, 28, 56], "metric": [9, 17], "pair": [9, 16, 17, 25, 27, 29, 35, 42, 43, 44, 45, 46, 51, 56], "minxxx": 9, "optxxx": 9, "soluion": 9, "do": [9, 17, 22, 23, 36, 40, 41, 42, 45, 46, 47, 50, 54, 55, 56], "longer": 9, "evalu": [9, 11, 15, 17, 24, 29, 46, 56], "qualiti": [9, 17, 47, 50], "xxx": [9, 17, 26, 36], "inf": 9, "even": [9, 17, 45], "huge": 9, "slack": [9, 10, 17, 27, 29], "instead": [9, 11, 17, 35, 44, 45], "quand": 9, "expens": [9, 40, 50], "avoid": [9, 45, 46, 55], "discrep": 9, "sostyp": [9, 17, 30, 49], "sos1": [9, 17, 30], "solveattribut": [9, 49], "updateev": [9, 49], "uupper": 9, "writelevel": [9, 17, 29, 49], "written": [9, 17, 20, 23, 29, 35, 36, 42], "mst": [9, 17, 29], "decreas": [9, 17, 22, 42], "quantiti": [9, 45, 47], "allvar": [9, 17, 29], "discretevar": [9, 29], "discret": [9, 12, 16, 17, 29, 31, 32, 52], "semi": [9, 17, 19, 26, 31], "nonzerovar": [9, 29], "regardless": [9, 17, 55], "discretenonzerovar": 9, "auto": [9, 17, 29], "abstractconstraint": [10, 49], "_abstractbendersannot": [10, 12, 30], "is_ad": 10, "c2": [10, 17], "set_mandatori": 10, "mandatori": [10, 21, 27], "revert": 10, "prioriti": [10, 17, 27, 29, 46, 49], "binaryconstraint": [10, 49], "left_expr": 10, "ctsens": [10, 17], "right_expr": 10, "get_left_expr": 10, "get_right_expr": 10, "iter_vari": [10, 16, 17, 29, 30], "although": 10, "to_str": [10, 20, 30, 31], "use_spac": 10, "usual": [10, 17, 55], "equivalenceconstraint": [10, 19, 49], "truth_valu": 10, "logicalconstraint": [10, 49], "equival": [10, 12, 16, 17, 19, 25, 35], "satisfact": [10, 17, 29, 48], "truth": 10, "convers": [10, 17, 43, 44, 46, 55, 56], "meant": [10, 20, 30, 31], "ifthenconstraint": [10, 17, 49], "if_ct": [10, 17], "then_ct": [10, 17], "negat": [10, 16, 17], "indicatorconstraint": [10, 19, 49], "shorten": 10, "style": [10, 29, 41, 45, 46, 47, 52, 55], "active_valu": [10, 17], "add_ind": [10, 17], "opposit": [10, 16, 17, 55], "typic": [10, 17, 20, 21, 42, 47, 50], "trivial": 10, "linearoperand": [10, 12, 16], "expr1": [10, 17], "op": [10, 17, 18, 56], "expr2": [10, 17], "basis_statu": [10, 12], "some": [10, 12, 16, 17, 20, 26, 29, 34, 35, 42, 45, 46, 47, 48, 50, 51, 54, 55, 56], "still": [10, 12, 17], "has_basi": [10, 12, 17], "benders_annot": [10, 12, 30], "bender": [10, 12, 30], "annot": [10, 12, 30], "successfulli": [10, 12, 17, 29, 32, 42, 45, 56], "ok": [10, 39, 56], "sequenc": [10, 12, 17, 29, 30, 42, 55], "func": [10, 29, 45], "slack_valu": [10, 17, 29], "notequalconstraint": [10, 49], "negated_eqct": 10, "pwlconstraint": [10, 49], "pwl_expr": 10, "piecewis": [10, 17, 24, 26, 29], "pwl_func": 10, "quadraticconstraint": [10, 19, 49], "qexpr1": 10, "qexpr2": 10, "least": [10, 17, 22, 25, 26, 29, 46], "rangeconstraint": [10, 17, 19, 49], "stai": [10, 17, 41], "configur": [11, 36, 55], "engin": [11, 17, 18, 35, 37, 38, 47, 50, 52], "behaviour": [11, 36, 42], "advis": 11, "instanci": 11, "obtain": [11, 17, 28, 47, 55, 56], "make_default_context": [11, 17], "cplex_config": 11, "cplex_config_": 11, "hostnam": 11, "pythonpath": [11, 17, 45, 46], "cplex_paramet": [11, 17], "emphasi": [11, 32, 45], "memori": 11, "basecontext": [11, 49], "rootparametergroup": [11, 17, 18, 20, 49], "auto_publish": [11, 23, 35, 49], "publish": [11, 17, 22, 35, 49], "solve_detail": [11, 17, 28, 29, 44, 51], "result_output": 11, "kpis_output": 11, "filenam": [11, 18, 20, 23, 29, 35], "multipl": [11, 16, 17, 35, 42, 47], "csv": [11, 23, 34, 35], "kpis_output_field_nam": [11, 49], "kpis_output_field_valu": [11, 49], "log": [11, 17, 22, 35, 42, 45], "out": [11, 20, 29], "kpi_report": [11, 49], "filter_level": [11, 49], "filter": [11, 17, 22, 29, 35], "done": [11, 17, 45, 56], "progress": [11, 17, 49], "kpifilterlevel": 11, "unfilt": 11, "filterobjectiveandbound": 11, "filterobject": 11, "copi": [11, 16, 17, 20, 22, 24, 25, 26, 35], "shallow": 11, "file_list": 11, "config": [11, 35], "exist": [11, 13, 17, 35, 36, 37], "overrid": [11, 27, 32, 35, 36], "read_set": [11, 17], "invalidsettingsfileerror": [11, 49], "occur": [11, 17, 18, 22, 28, 29, 45, 52], "sinc": [11, 17, 22, 35, 42, 43, 44, 46, 47, 54, 55], "create_missing_nod": 11, "child": [11, 41, 45, 46, 47, 52], "recogn": [11, 21], "agent": 11, "nativ": 11, "stream": [11, 17, 20, 29, 35], "overwrit": [11, 17], "keyword": [11, 17, 18, 26], "alreadi": [11, 35, 36, 37, 55], "contextoverrid": [11, 49], "initial_context": 11, "mesg": 11, "solvercontext": [11, 49], "redefinit": [12, 15, 16, 22], "__eq__": [12, 16], "eth": 12, "consist": [12, 16, 17, 22, 29, 45, 46, 47, 48, 50, 51, 56], "pass": [12, 15, 16, 17, 18, 20, 22, 24, 25, 26, 28, 29, 35, 42, 56], "get_kei": 12, "xa": 12, "is_binari": 12, "is_continu": 12, "is_discret": [12, 16, 31], "is_integ": 12, "iter_constraint": [12, 17], "travers": [12, 20], "ceil": 12, "reduced_cost": [12, 17], "reduc": [12, 17, 29, 40, 45, 50], "docplexexcept": [12, 16, 18, 24, 27], "succesfulli": 12, "sv": 12, "shorter": 12, "to_bool": [12, 51], "nonzero": [12, 16, 28, 45, 55], "floor": [12, 52], "reset": [12, 17, 20, 45], "infin": [12, 17], "vartyp": [12, 17, 49], "runtim": [13, 17, 18, 22, 36, 41, 47, 55], "invok": [13, 24, 42, 45], "shell": 13, "command": [13, 36, 37, 50, 52], "line": [13, 17, 55], "linux": [13, 36, 37], "usr": 13, "bin": 13, "cplex_studio129": 13, "x86": [13, 36], "64_linux": 13, "start_auto_configur": 13, "detect": [13, 17, 45, 54], "regard": [13, 42], "interest": [13, 22, 29, 42, 56], "get_cplex_modul": 13, "default_loc": 13, "sucess": 13, "cplex_studio_dir20101": 13, "cplex_studio_dir201": 13, "cplex_studio_dir1210": 13, "cplex_studio_dir129": 13, "cplex_studio_dir128": 13, "python_vers": 13, "platform": [13, 35, 36, 37], "has_cplex": 13, "has_numpi": 13, "has_panda": 13, "is_64bit": 13, "64": [13, 36, 37, 45], "bit": [13, 35, 37], "unsupportedplatformerror": [13, 49], "defaulterrorhandl": [14, 49], "output_level": [14, 18], "infolevel": [14, 49], "abstracterrorhandl": 14, "handler": [14, 35], "sever": [14, 22, 35, 45, 46, 53], "fatal": 14, "enabl": [14, 17, 41], "suppress": 14, "decisionkpi": [15, 17, 45, 49], "kpi_op": 15, "special": [15, 17, 22, 29, 30, 31, 43, 44, 46], "subclass": [15, 17, 18, 20, 22, 43, 44, 46], "emodel": 15, "latter": 15, "explicitli": [15, 17], "underli": [15, 35], "get_model": 15, "is_decision_express": 15, "functionalkpi": [15, 49], "attach": [15, 17, 22, 34, 35, 40], "attempt": [15, 56], "abstractlinearexpr": [16, 49], "get_coef": 16, "constantexpr": [16, 49], "cst": 16, "_subscriptionmixin": [16, 25], "docplexquadraticarithexcept": [16, 49], "linearexpr": [16, 17, 25, 49], "linear_expr": [16, 17], "plu": [16, 45, 46, 47], "add_term": 16, "coeff": 16, "clone": [16, 17, 20, 24, 25], "divid": [16, 24, 42, 45, 55], "permit": 16, "linear_express": 16, "equals_const": 16, "scalar": [16, 17], "is_const": 16, "5x": 16, "iter_term": [16, 25], "multipli": [16, 17, 24, 39, 42], "replac": [16, 17, 35, 43, 44], "snot": 16, "quotient": 16, "divis": [16, 42, 50, 51, 52], "remove_term": 16, "subtract": [16, 24, 47], "minu": [16, 17, 47, 52, 55], "monomialexpr": [16, 49], "safe": [16, 17], "zeroexpr": [16, 49], "context": [17, 23, 35, 43, 44, 49], "main": 17, "emb": 17, "statement": 17, "block": [17, 32], "alloc": [17, 43, 44, 46], "destroi": 17, "thread": [17, 35, 42, 43, 44, 45, 46], "altern": [17, 37], "checker": 17, "disabl": [17, 20], "everywher": 17, "turn": [17, 37, 42], "improv": [17, 22, 45], "caution": 17, "std": [17, 42], "nan": [17, 28], "neither": 17, "nor": 17, "trust": 17, "full": [17, 20, 29, 36], "union": 17, "typecheck": 17, "thoroughli": 17, "cts_by_nam": 17, "absolut": [17, 22, 43, 44, 46, 55, 56], "transform": [17, 42, 45, 47], "auxiliari": [17, 42, 45], "natur": [17, 28, 43, 44, 46], "ctname": [17, 43, 44, 46, 55], "newli": [17, 18, 45], "add_constraint_": 17, "batch": 17, "c1": 17, "comprehens": 17, "yield": [17, 20, 45], "consttraint": 17, "add_quadratic_constraint": 17, "add_constraints_": 17, "anyth": [17, 37], "add_equival": 17, "true_valu": 17, "trigger": [17, 35], "add_equivalence_constraint": 17, "eqct": 17, "equivalence_constraint": 17, "add_equivalence_constraints_": 17, "length": [17, 24, 35, 42, 50, 52, 56], "add_if_then": 17, "govern": 17, "becom": [17, 43, 44, 46], "soon": 17, "reli": [17, 29], "On": [17, 35, 51], "extra": [17, 42, 45, 55, 56], "bvar": 17, "plain": [17, 29], "syntax": [17, 20], "add_indicator_constraint": 17, "indct": 17, "indicator_constraint": 17, "add_indicator_constraints_": 17, "kpi_arg": 17, "seper": 17, "profit": [17, 39, 41, 42, 50], "resp": 17, "add_lazy_constraint": 17, "lazy_ct": 17, "add_mip_start": [17, 42], "mip_start_sol": 17, "effort_level": 17, "write_level": [17, 29], "complete_var": 17, "eps_zero": 17, "featur": [17, 35, 37, 38, 42, 45, 55], "warm": [17, 29], "ore": [17, 42], "witelevel": 17, "nonzerodiscretevar": [17, 29], "By": [17, 18, 26, 43, 44, 52, 55], "optin": 17, "doplex": 17, "succe": [17, 18, 27, 39], "winclud": 17, "ones": 17, "add_progress_listen": [17, 22], "listen": [17, 22], "progresslisten": [17, 22, 49], "qc": 17, "contraint": 17, "rng_name": 17, "interv": [17, 24, 35, 55], "smaller": [17, 42, 55], "constr": [17, 19, 49], "add_so": [17, 30], "sos_arg": 17, "sos2": [17, 30], "seri": [17, 37, 41, 42, 45, 52, 55], "unord": 17, "add_sos1": [17, 30], "add_sos2": [17, 30], "add_user_cut_constraint": 17, "cut_ct": 17, "binaryvartyp": [17, 31, 49], "binary_var_cub": [17, 41], "keys1": [17, 42, 45, 47, 51, 55], "keys2": [17, 42, 45, 47, 51, 55], "keys3": 17, "key_format": 17, "triplet": [17, 25], "k1": [17, 29], "k2": [17, 29], "k3": 17, "retriev": [17, 35, 55], "empti": [17, 21, 29, 30, 41, 42, 45, 46, 47, 52], "interpret": [17, 29, 35, 37], "contribut": [17, 42], "x_k1": 17, "x_k2": 17, "surround": 17, "z_0": 17, "z_1": 17, "z_2": 17, "cartesian": 17, "product": [17, 25, 36, 41, 42, 45, 50], "coupl": [17, 42, 43, 44, 45, 46, 47, 56], "binary_vartyp": 17, "blended_objective_valu": 17, "blend": [17, 29, 47, 50], "build_multiobj_paramset": [17, 44], "timelimit": [17, 32, 43, 44], "mipgap": [17, 20, 32, 44, 45, 46], "pre": 17, "parameterset": 17, "multi": [17, 28, 29, 44, 50], "lex_timelimit": 17, "lex_mipgap": 17, "change_var_lower_bound": 17, "check_bound": 17, "ivar": 17, "change_var_typ": 17, "vartype_arg": 17, "discard_incompatible_solut": 17, "incompat": [17, 43, 44], "discard": [17, 18], "change_var_upper_bound": 17, "103": 17, "01": [17, 45], "clear": [17, 22, 29, 56], "clear_constraint": 17, "clear_kpi": 17, "clear_lazy_constraint": 17, "clear_mip_start": 17, "via": [17, 35, 36, 37, 41], "interb": 17, "previou": [17, 32, 41, 42, 45, 55], "fresh": 17, "nd": 17, "forget": 17, "clean_before_solv": [17, 44], "clear_multi_object": 17, "had": 17, "previous": [17, 45], "noth": [17, 22, 23, 29, 35], "clear_progress_listen": 17, "clear_so": 17, "clear_user_cut_constraint": 17, "new_nam": 17, "clone_kwarg": 17, "deep": [17, 20], "continuousvartyp": [17, 31, 49], "continuous_var_cub": 17, "share": [17, 22, 46, 52], "vari": 17, "create_parameter_set": [17, 44], "coef": 17, "synonym": [17, 18], "scal_prod": [17, 39], "dotf": 17, "coef_fn": 17, "assume_alldiffer": 17, "variant": 17, "asrgument": 17, "xxx_var_dict": 17, "xx_var_var_matrix": 17, "dimension": [17, 52], "xxx_var_matrix": 17, "var_cub": 17, "anumb": 17, "One": [17, 45, 46], "dimens": [17, 45, 47], "whichi": 17, "ndicat": 17, "dicitonari": [17, 22, 29], "xxx_var": 17, "si": 17, "wrong": 17, "incorrect": 17, "dictionai": [17, 22], "m1": [17, 42, 45], "b_1_1": 17, "b_1_2": 17, "b_2_1": 17, "b_2_2": 17, "pure": [17, 29], "dump_as_sav": 17, "basenam": [17, 18, 29], "sav": [17, 18], "place": [17, 29, 52], "tempfil": [17, 29], "gettempdir": [17, 29], "pathnam": 17, "don": [17, 54], "t": [17, 39, 41, 42, 43, 44, 51, 52, 54, 55], "anymor": 17, "hide_user_nam": 17, "x1": 17, "x2": 17, "mymodel": [17, 18], "foo": [17, 18], "home": [17, 29, 36, 37, 38], "docplex_": 17, "docplex_mymodel": 17, "export_as_lp_str": 17, "export_as_mp": 17, "export_as_mps_str": 17, "export_as_sav": 17, "export_as_sav_str": 17, "byte": [17, 35], "export_as_savgz": 17, "compress": 17, "export_priority_order_fil": 17, "success": [17, 27, 29, 51, 55], "export_to_stream": 17, "format_spec": 17, "stringio": [17, 45, 46], "sent": 17, "find_matching_linear_constraint": 17, "match_cas": [17, 29], "anonym": [17, 45], "match": [17, 21, 27, 29, 37, 41, 45, 46, 50, 51, 52, 55], "find_matching_quadratic_constraint": 17, "find_re_matching_var": 17, "regexpr": 17, "regular": [17, 47], "din": 17, "re": [17, 41, 42, 45, 47, 48, 55, 56], "digit": 17, "decim": 17, "ge_constraint": 17, "get_constraint_by_index": 17, "rememb": [17, 47, 56], "separ": [17, 20, 25, 42, 45, 46, 55], "space": [17, 35], "get_constraint_by_nam": 17, "fly": 17, "duplic": 17, "my_model": 17, "get_cplex": [17, 44], "do_rais": [17, 21], "get_cut": [17, 29], "get_num_cut": [17, 29], "cut_typ": [17, 29], "get_objective_expr": 17, "get_parameter_from_id": 17, "parameter_cpx_id": 17, "2009": [17, 52], "get_quadratic_constraint_by_index": 17, "therefor": 17, "constrait": 17, "jobsolvestatu": 17, "solvedetail": [17, 28, 29, 49], "eg": 17, "status_cod": [17, 28], "get_time_limit": 17, "get_var_by_nam": 17, "has_multi_object": 17, "if_then": 17, "ct1": 17, "ct2": 17, "ignore_nam": [17, 18], "ignor": [17, 18, 29, 35, 45], "lead": [17, 35], "onc": [17, 35, 51], "restor": [17, 22, 32], "import_solut": 17, "source_solut": 17, "target": [17, 50], "simplest": 17, "oth": 17, "rmodel": 17, "predefin": [17, 27], "eimag": 17, "init_numpi": 17, "awar": 17, "repr": 17, "restore_numpi": 17, "integervartyp": [17, 31, 49], "integer_var_cub": 17, "ij_0": 17, "ij_1": 17, "ij_2": 17, "concaten": 17, "arbitrari": [17, 46], "__name_": 17, "__": 17, "__name_0__": 17, "__name_1__": 17, "_name__2__": 17, "q": [17, 25], "q_0": 17, "q_1": 17, "q_3": 17, "q2": [17, 25], "q3": 17, "is_optim": 17, "happen": [17, 22, 35, 55, 56], "remove_object": 17, "iter_binary_constraint": 17, "iter_binary_var": 17, "iter_continuous_var": 17, "iter_equivalence_constraint": 17, "iter_indicator_constraint": 17, "iter_integer_var": 17, "iter_kpi": [17, 47], "iter_lazy_constraint": 17, "iter_linear_constraint": 17, "iter_mip_start": 17, "iter_progress_listen": 17, "iter_pwl_constraint": 17, "pwl": [17, 49], "iter_pwl_funct": 17, "iter_quadratic_constraint": 17, "iter_range_constraint": 17, "iter_semicontinuous_var": 17, "iter_semiinteger_var": 17, "iter_so": 17, "iter_sos1": 17, "iter_sos2": 17, "iter_user_cut_constraint": 17, "kpi_by_nam": [17, 29, 40, 55], "try_match": 17, "fetch": 17, "exact": [17, 29], "substr": 17, "co2": 17, "dummi": [17, 29], "kpi_value_by_nam": [17, 29], "bool": 17, "new_solut": [17, 42], "kpis_as_dict": 17, "kpi_filt": 17, "objective_kei": 17, "use_nam": 17, "predic": [17, 29], "eobject": 17, "linear_constraint": 17, "linear_constraint_basis_status": 17, "lct": [17, 29], "detailt": 17, "logical_and": 17, "AND": 17, "logical_or": 17, "logical_not": 17, "xor": 17, "logxor": 17, "b1": 17, "b2": 17, "lp_line_length": 17, "maximum": [17, 20, 29, 35, 41, 42, 43, 44, 45, 55, 56], "lp_string": 17, "e3": 17, "x3": 17, "maximize_static_lex": 17, "abstol": 17, "reltol": 17, "objnam": 17, "lexicograph": [17, 56], "rel": [17, 22, 28, 56], "minimum": [17, 20, 22, 29, 47, 56], "minimize_static_lex": [17, 40, 44], "mip_start": 17, "multi_objective_valu": [17, 29], "number_of_binary_vari": [17, 19], "number_of_constraint": 17, "number_of_continuous_vari": [17, 19], "number_of_equivalence_constraint": [17, 19], "number_of_indicator_constraint": [17, 19], "number_of_integer_vari": [17, 19], "number_of_lazy_constraint": 17, "number_of_linear_constraint": [17, 19], "number_of_range_constraint": [17, 19], "number_of_mip_start": 17, "number_of_progress_listen": 17, "number_of_pwl_constraint": 17, "number_of_quadratic_constraint": [17, 19], "number_of_semicontinuous_vari": [17, 19], "number_of_semiinteger_vari": [17, 19], "number_of_so": 17, "number_of_sos1": 17, "number_of_sos2": 17, "number_of_user_constraint": 17, "toth": 17, "number_of_user_cut_constraint": 17, "objective_coef": 17, "objective_expr": [17, 55], "objective_sens": 17, "direct": [17, 35, 55], "root": [17, 20, 42, 45, 46], "0001": [17, 20], "02": [17, 45], "parametergroup": [17, 20, 49], "preslop": [17, 24], "breaksxi": 17, "postslop": [17, 24], "breakpoint": [17, 24], "half": [17, 45, 51], "slope": [17, 24], "x_valu": 17, "discontinu": [17, 24], "piecewise_as_slop": [17, 24], "slopebreaksx": 17, "lastslop": 17, "anchor": 17, "breakx": 17, "consecut": [17, 52, 55], "purpos": [17, 29, 45, 52], "ground": 17, "illustr": [17, 42, 46, 50, 52], "popul": [17, 29, 50], "pool": [17, 29], "solutiion": 17, "solutionpool": [17, 29, 49], "populate_solution_pool": 17, "breakdown": [17, 45, 47, 56], "print_zero": 17, "solution_header_fmt": 17, "var_value_fmt": 17, "header": [17, 45], "problem_typ": [17, 28], "requyir": 17, "qp": 17, "miqp": 17, "qcp": 17, "miqcp": 17, "quad_expr": [17, 25], "quad": [17, 49], "quadexpr": [17, 25, 49], "quadratic_dual_slack": 17, "quality_metr": 17, "range_constraint": 17, "read_basis_fil": 17, "bas_path": 17, "extens": [17, 34, 35], "ba": 17, "read_mip_start": 17, "mst_path": 17, "read_priority_order_fil": 17, "ord_path": 17, "ord": 17, "accapt": 17, "remove_constraint": 17, "ct_arg": 17, "remove_kpi": 17, "subsequ": [17, 42, 45], "has_object": [17, 29], "remove_progress_listen": 17, "selected_kpi": 17, "kpi_format": [17, 22], "companion": 17, "undo": 17, "round_solut": 17, "round": [17, 45, 47], "99999": 17, "cal_prod": 17, "unexpect": 17, "scal_prod_f": [17, 43], "scal_prod_vars_all_differ": 17, "fastli": 17, "semicontinuous_var": 17, "strictli": 17, "semicontinuousvartyp": [17, 31, 49], "semicontinuous_var_dict": 17, "semiintegervartyp": [17, 31, 49], "semicontinuous_var_list": 17, "semicontinuous_var_matrix": 17, "semicontinu": [17, 19, 31], "semiinteger_var_dict": 17, "semicontinuous_vartyp": 17, "semiinteger_var": 17, "semiinteger_var_list": 17, "semiinteger_var_matrix": 17, "semiinteg": [17, 31], "semiinteger_vartyp": 17, "semiintegertyp": 17, "set_lex_multi_object": 17, "fashion": 17, "set_lp_start_basi": 17, "dvar_stat": 17, "lct_stat": 17, "set_multi_object": 17, "togeth": [17, 46, 47, 50], "allexpress": 17, "set_multi_objective_abstol": 17, "set_multi_objective_expr": 17, "set_multi_objective_reltol": 17, "set_object": 17, "set_time_limit": 17, "time_limit": 17, "might": [17, 22, 29, 35, 37, 54, 56], "normal": [17, 28, 41, 45, 46, 47, 52, 55], "pick": 17, "up": [17, 38], "parameter_set": [17, 44], "reason": [17, 40, 50, 56], "why": [17, 56], "proper": [17, 20], "infeasibilti": 17, "unbounded": 17, "sdetail": [17, 29, 49], "elaps": [17, 22, 45], "node": [17, 20, 22, 28, 41, 42, 45, 46], "final": [17, 43, 44, 45, 46, 47, 56], "solve_statu": 17, "solve_with_go": 17, "goal_nam": 17, "write_pass_fil": 17, "solution_callbackfn": 17, "ither": 17, "asingl": 17, "wors": 17, "98": [17, 45], "revers": [17, 56], "model_stat": [17, 49], "modelstatist": [17, 19, 49], "str_use_spac": 17, "especi": 17, "3y": 17, "5z": 17, "compact": [17, 42, 56], "quadray": 17, "sum_squar": 17, "sum_var": 17, "sum_vars_all_differ": 17, "summat": [17, 45], "due": [17, 40, 50, 52], "fact": [17, 42], "sumsq": 17, "concret": [17, 22], "domain": 17, "var_basis_status": 17, "var_hypercub": 17, "vartype_spec": 17, "seq_of_kei": 17, "analog": 17, "specifics": 17, "translat": [17, 24, 27, 35, 49], "cube": 17, "xx_var_matrix": 17, "famili": [17, 41, 45, 46, 47, 52], "hc": 17, "2x2x4": 17, "four": [17, 47], "hypercub": 17, "modelread": [18, 49], "read_model": [18, 49], "model_nam": 18, "model_class": 18, "modelpass": 18, "temp": [18, 29], "docplex_foo": 18, "odel": 18, "compat": [18, 29, 45], "read_ops_fil": 18, "opl": 18, "cpo": [18, 36], "pak": 18, "experi": [18, 36, 37, 38], "read_prm": 18, "prm": [18, 20], "modelreadererror": [18, 49], "msg": [18, 35], "gz": 18, "contructor": 18, "exceot": 18, "solver_ag": 18, "gather": [19, 37], "get_statist": 19, "counter": 19, "number_of_eq_constraint": 19, "number_of_ge_constraint": 19, "number_of_le_constraint": 19, "compris": [19, 52], "readabl": [19, 20, 52], "boolparamet": [20, 49], "cpx_name": 20, "param_kei": 20, "descript": [20, 29, 48], "default_valu": 20, "accept_valu": 20, "new_valu": 20, "intparamet": [20, 49], "min_valu": 20, "max_valu": 20, "sync": [20, 42, 45, 46], "numparamet": [20, 49], "cpx_id": 20, "cpx_param_epgap": 20, "workdir": 20, "optimalitytarget": 20, "is_default": 20, "is_nondefault": 20, "qualified_nam": [20, 32], "qualifi": [20, 32, 36], "guarante": [20, 35], "often": [20, 24], "parent_group": 20, "come": [20, 47], "generate_nondefault_param": 20, "subgroup": 20, "generate_param": 20, "recurs": 20, "is_root": 20, "iter_param": 20, "directparamet": 20, "number_of_param": 20, "number_of_subgroup": 20, "sep": 20, "include_root": 20, "mip_cut": 20, "cover": [20, 45], "total_number_of_param": 20, "insid": [20, 27, 35, 42, 48, 50, 55], "positiveintparamet": [20, 49], "cplex_vers": 20, "export_prm": 20, "overload_param": 20, "addit": [20, 22, 24, 29, 35, 45, 46, 47, 53, 54], "kept": [20, 35], "export_prm_to_str": 20, "merg": [20, 45, 55], "temporari": [20, 29, 32], "print_info_to_stream": 20, "print_default": 20, "indent_level": 20, "human": [20, 37, 40, 50], "print_info_to_str": 20, "strparamet": [20, 49], "very_low": 21, "low": [21, 46], "medium": [21, 27, 46], "high": [21, 27, 37, 46], "very_high": 21, "accept_non": 21, "default_prior": [21, 27], "set_prior": 21, "monitor": 22, "protocol": 22, "mipinfocallback": 22, "cplexcloud": 22, "At": [22, 56], "receiv": [22, 52], "notify_progress": 22, "progressdata": [22, 49], "suit": 22, "dure": [22, 28], "textprogresslisten": [22, 49], "solutionlisten": [22, 49], "notify_solut": 22, "frequenc": 22, "chose": [22, 56], "kind": [22, 42, 45, 55], "realli": 22, "summar": [22, 45, 56], "clock": 22, "chosen": [22, 56], "solutionrecord": [22, 49], "functionalsolutionlisten": [22, 49], "solution_fn": 22, "progressclock": [22, 49], "absdiff": 22, "reldiff": 22, "No": [22, 41, 45], "caught": 22, "redefin": [22, 29, 43, 44, 46, 56], "kpilisten": [22, 49], "defaul": 22, "ti": 22, "kpi_dict": 22, "kpiprint": [22, 49], "itcnt": [22, 45], "bestbound": 22, "necessarili": 22, "impriv": 22, "descend": 22, "has_incumb": 22, "current_object": 22, "best_bound": [22, 28], "current_nb_iter": 22, "current_nb_nod": 22, "remaining_nb_nod": 22, "det_tim": 22, "_tprogressdata": 22, "reeiv": 22, "moment": 22, "remain": 22, "determinist": [22, 28, 45], "progressdatarecord": [22, 49], "iter_record": 22, "progress_data": 22, "notify_start": 22, "intern": [22, 35, 43, 44], "superclass": 22, "record": [22, 35, 51], "clock_arg": 22, "_abstractprogresslisten": 22, "abort": [22, 35], "tell": [22, 45], "criteria": [22, 47, 50], "below": [22, 45, 46, 47], "threshold": 22, "current_progress_data": 22, "notify_end": 22, "callback": [22, 35, 49], "priogress": 22, "iter_solut": 22, "redefint": 22, "number_of_solut": 22, "gap_fmt": 22, "obj_fmt": 22, "frame": [23, 35, 45, 52, 55], "write_output_t": 23, "df": [23, 35], "output_property_nam": 23, "output_nam": 23, "output_propert_nam": 23, "somesolv": 23, "output_custom": 23, "someth": 23, "autopublish": 23, "somesolver_output": 23, "output_table_property_nam": 23, "default_output_table_nam": 23, "output_table_custom": 23, "datafram": [23, 29, 34, 35, 41, 42, 45, 46, 47, 52], "output_table_using_df": 23, "pwlfunction": [24, 49], "pwl_def": 24, "give": [24, 42, 45, 46, 50, 53, 55], "linearli": 24, "along": [24, 45, 46], "x_val": 24, "lx": 24, "rx": 24, "factor": [24, 41], "horizont": 24, "get_quadratic_coeffici": 25, "var1": 25, "var2": 25, "has_quadratic_term": 25, "is_separ": 25, "iter_quad_triplet": 25, "v1": 25, "linear_part": 25, "number_of_quadratic_term": 25, "q1": 25, "linearrelax": [26, 49], "linear_relax": 26, "return_parti": 26, "copy_paramet": 26, "anywai": 26, "unrelax": 26, "encount": 26, "functionalpriorit": [27, 49], "priorit": [27, 46, 49], "mappingpriorit": [27, 49], "priority_map": 27, "matchnamepriorit": [27, 49], "priority_for_unnam": 27, "priority_for_non_match": 27, "case_sensit": 27, "get_prior": 27, "namedpriorit": [27, 49], "functor": 27, "constraintpriorit": 27, "conveni": [27, 42, 45, 55, 56], "unnam": 27, "get_relax": 27, "is_relax": 27, "iter_relax": 27, "violat": 27, "number_of_relax": 27, "relax_mod": 27, "mode": [27, 35, 45], "relaxed_objective_valu": 27, "toutputt": [27, 49], "uniformpriorit": [27, 49], "dettim": 28, "status_str": 28, "ncolumn": 28, "miprelgap": 28, "n_iter": 28, "n_nodes_process": 28, "never": [28, 31, 43, 44], "deterministic_tim": 28, "tick": [28, 42, 45, 46], "percentag": 28, "has_hit_limit": 28, "hit": 28, "mip_relative_gap": 28, "nb_iter": [28, 55], "usd": 28, "nb_linear_nonzero": 28, "nb_nodes_process": 28, "callabl": 28, "cpxxgetstatstr": 28, "getstatstr": 28, "proven": 28, "mip_time_limit_feas": 28, "promot": [28, 41], "exceed": 28, "1016": 28, "macro": 28, "solution_status_cod": 28, "fulli": [29, 35, 45], "describe_object": 29, "poolobject": 29, "stat": 29, "export_as_sol": 29, "mean_objective_valu": 29, "deviat": [29, 45, 46], "var_value_map": 29, "blended_obj_by_prior": 29, "solved_bi": 29, "keep_zero": 29, "add_var_valu": [29, 42], "var_kei": 29, "as_df": 29, "name_kei": 29, "value_kei": 29, "cilumn": 29, "check_as_mip_start": 29, "strong_check": 29, "unchang": [29, 32], "__contains_": 29, "file_or_filenam": 29, "xml": 29, "export_as_json_str": 29, "export_as_mst": 29, "prob": 29, "myprob1": 29, "my_": 29, "s_mipstart": 29, "my_prob_mipstart": 29, "fileformat": 29, "topic": [29, 37], "from_fil": 29, "get_blended_objective_value_by_prior": 29, "no_solut": 29, "get_dual_valu": 29, "get_objective_valu": 29, "get_reduced_cost": 29, "get_sensit": 29, "sensit": 29, "lower_bound": 29, "upper_bound": 29, "get_slack": 29, "get_statu": [29, 51], "particularli": [29, 45, 46], "__getitem__": [29, 35], "get_value_df": 29, "value_column_nam": 29, "key_column_nam": 29, "xx_var_dict": 29, "ekei": 29, "get_value_dict": 29, "get_value_list": 29, "var_seq": 29, "is_empti": 29, "is_feasible_solut": 29, "silent": 29, "is_valid_solut": 29, "iter_var_valu": 29, "compon": [29, 56], "distinguish": 29, "number_of_var_valu": 29, "print_mst": 29, "set_objective_valu": 29, "var_values_iter": 29, "sosvariableset": [30, 49], "variable_sequ": 30, "sos_typ": 30, "default_lb": 31, "cplex_typecod": 31, "default_ub": 31, "model_object": [32, 49], "temp_obj": 32, "temp_sens": 32, "contextu": 32, "temporarili": [32, 35], "mdl2": 32, "exit": 32, "overridden": 32, "model_paramet": [32, 49], "temp_paramet": 32, "empahsi": 32, "tolernac": 32, "model_solvefix": [32, 49], "solvefix": 32, "solvefixex": 32, "mfunction": 32, "encode_csv_str": [34, 49], "doubl": 34, "quot": 34, "write_table_as_csv": [34, 49], "field_nam": 34, "transact": [34, 35, 43, 44], "independ": 35, "premis": 35, "worker": [35, 40], "adapt": 35, "open": [35, 52, 53, 56], "get_input_stream": [35, 49], "split": [35, 51, 52], "fragment": 35, "38": [35, 43, 44, 45, 46, 55], "default_environ": 35, "read_df": [35, 49], "write_df": [35, 49], "get_available_core_count": [35, 49], "get_paramet": [35, 49], "update_solve_detail": [35, 49], "add_abort_callback": [35, 49], "remove_abort_callback": [35, 49], "abstractlocalenviron": [35, 49], "core": [35, 41, 45, 46, 47, 52, 55], "job": 35, "set_output_attach": [35, 49], "entri": [35, 39, 56], "26": [35, 41, 43, 44, 45, 46, 55], "appropri": [35, 41, 50, 51], "correct": 35, "abort_callback": 35, "script": [35, 50], "your_cb": 35, "solution_storage_handl": 35, "default_solution_storage_handl": [35, 49], "record_history_field": 35, "histori": 35, "record_history_s": 35, "record_interv": 35, "create_transact": 35, "outputattachmenttransact": [35, 49], "get_engine_log_level": 35, "oaa": 35, "engineloglevel": 35, "fine": 35, "finer": 35, "finest": 35, "debug": [35, 50], "get_stop_callback": 35, "stop_callback": 35, "deprec": 35, "is_debug_mod": 35, "publish_solve_detail": 35, "read_csv": 35, "read_msgpack": 35, "notavailableerror": [35, 49], "set_stop_callback": 35, "cb": 35, "store_solut": 35, "serial": 35, "send": [35, 52], "servic": [35, 36, 37, 40, 41, 47, 50, 53], "rate": [35, 41, 45, 46, 47], "de": 35, "writer": 35, "localenviron": [35, 49], "commit": [35, 50], "wait": [35, 42, 45, 46], "publush": 35, "overrideenviron": [35, 49], "new_env": 35, "solvedetailsfilt": [35, 49], "respons": [35, 41], "make_attachment_nam": [35, 49], "restrict": [35, 52], "255": 35, "charact": [35, 43, 44, 46], "ascii": 35, "unauthor": 35, "conform": 35, "valueerror": 35, "maketran": [35, 49], "usabl": 35, "unicod": 35, "ordin": 35, "lookup": 35, "lookuperror": 35, "untouch": 35, "delet": 35, "to_csv": 35, "to_msgpack": 35, "\u00bd": [36, 37, 38, 50, 53, 54], "\u00bc": [36, 37, 38, 50, 53, 54], "\u215b": [36, 37, 38, 50, 53, 54], "\u00be": [36, 37, 38, 50, 53, 54], "\u215c": [36, 37, 38, 50, 53, 54], "\u215d": [36, 37, 38, 50, 53, 54], "\u215e": [36, 37, 38, 50, 53, 54], "\u00b5": [36, 37, 38, 50, 53, 54], "\u03c9": [36, 37, 38, 50, 53, 54], "\u00aa": [36, 37, 38, 50, 53, 54], "\u00ba": [36, 37, 38, 50, 53, 54], "\u00b9": [36, 37, 38, 50, 53, 54], "\u00b2": [36, 37, 38, 50, 53, 54], "\u00b3": [36, 37, 38, 50, 53, 54], "addition": 36, "develop": [36, 53], "deploy": 36, "anacondacloud": 36, "ai": 36, "join": [36, 42, 45, 55], "softwar": [36, 53], "charg": 36, "deploi": 36, "host": [36, 37], "ultim": 36, "inspect": 36, "cplex_studio_dirxxx": 36, "1000": [36, 42, 47], "tool": [36, 47, 52, 53], "easi": [36, 37, 45, 56], "upgrad": [36, 37], "uninstal": [36, 37], "readm": [36, 37], "md": [36, 37], "distribut": [36, 37], "osx": 36, "anaconda": [36, 37], "continuum": [36, 37], "channel": [36, 37, 41], "ppc64le": [36, 37], "verifi": 37, "lifespan": 37, "matcht": 37, "mac": 37, "aix": 37, "plinux": 37, "diagnos": [37, 50], "editor": 37, "debugg": 37, "pycharm": 37, "pydev": 37, "good": [37, 42, 52, 55], "popular": 37, "scienc": [37, 38], "analysi": [37, 41], "visual": [37, 46], "microsoft": 37, "easiest": 37, "browser": [37, 55], "minut": 37, "clean": [37, 42], "extract": [37, 55], "onlin": [37, 53], "train": 37, "cours": [37, 42, 45, 56], "everybodi": 37, "michigan": 37, "univers": 37, "introduct": 37, "rice": 37, "big": 37, "hard": 37, "modern": 37, "bill": [37, 51, 52], "lubanov": 37, "5th": 37, "lutz": 37, "micha": 37, "gorelick": 37, "doug": 37, "hellmann": 37, "cookbook": 37, "david": [37, 43, 44, 45, 46], "beazlei": 37, "brian": 37, "jone": 37, "essenti": 37, "nutshel": 37, "alex": 37, "martelli": 37, "scientif": [37, 47], "scratch": 37, "principl": 37, "joel": 37, "gru": 37, "wrangl": 37, "ipython": [37, 41, 45, 46, 47, 52, 55], "mckinnei": 37, "scipi": 37, "overview": [37, 38, 50], "eli": 37, "bressert": 37, "beginn": 37, "ivan": 37, "idri": 37, "confer": 37, "social": 38, "media": 38, "page": [38, 49], "inspir": 39, "adventur": 39, "blog": [39, 40], "articl": 39, "lagrangian": [39, 50], "builtin": 39, "run_gap_model": 39, "wolsei": 39, "number_of_c": 39, "xv": 39, "ii": 39, "total_profit": 39, "x_i": 39, "c_i": 39, "run_gap_model_with_lagrangian_relax": 39, "max_it": 39, "c_rang": 39, "p_var": 39, "pv": 39, "ep": [39, 55], "initial_multipli": 39, "rebuilt": 39, "total_penalti": 39, "penalti": 39, "do_stop": 39, "justifi": 39, "penalized_viol": 39, "scale_factor": 39, "run_default_gap_model_with_lagrangian_relax": 39, "gap_best_obj": 39, "relaxed_best": 39, "objectivevalu": 39, "balanc": [40, 41, 45, 46, 50], "server": [40, 50, 56], "rebalanc": [40, 50], "sleep": [40, 50], "across": [40, 45, 50, 56], "multiobject": [40, 44, 50], "yhathq": 40, "post": [40, 42, 43, 44, 46, 55], "yhat": 40, "tuser": 40, "current_serv": 40, "server002": 40, "server003": 40, "server001": 40, "server006": 40, "server007": 40, "server004": 40, "server005": 40, "user013": 40, "user014": 40, "user015": 40, "user016": 40, "user017": 40, "user018": 40, "user019": 40, "user020": 40, "user021": 40, "user022": 40, "user023": 40, "user024": 40, "user025": 40, "user026": 40, "user027": 40, "user028": 40, "user029": 40, "user030": 40, "user031": 40, "user032": 40, "user033": 40, "user034": 40, "user035": 40, "user036": 40, "user037": 40, "user038": 40, "user039": 40, "user040": 40, "user001": 40, "user002": 40, "user003": 40, "user004": 40, "user005": 40, "user006": 40, "user007": 40, "user008": 40, "user009": 40, "user010": 40, "user011": 40, "user012": 40, "user062": 40, "user063": 40, "user064": 40, "user065": 40, "user066": 40, "user067": 40, "user068": 40, "user069": 40, "user070": 40, "user071": 40, "user072": 40, "user073": 40, "user074": 40, "user075": 40, "user076": 40, "user077": 40, "user078": 40, "user079": 40, "user080": 40, "user081": 40, "user082": 40, "user041": 40, "user042": 40, "user043": 40, "user044": 40, "user045": 40, "user046": 40, "user047": 40, "user048": 40, "user049": 40, "user050": 40, "user051": 40, "user052": 40, "user053": 40, "user054": 40, "user055": 40, "user056": 40, "user057": 40, "user058": 40, "user059": 40, "user060": 40, "user061": 40, "prepar": [40, 43, 44], "default_max_processes_per_serv": 40, "_is_migr": 40, "build_load_balancing_model": 40, "users_": 40, "max_process_per_serv": 40, "user_row": 40, "active_var_by_serv": 40, "isact": 40, "user_server_pair_nam": 40, "u_": 40, "s_to_": 40, "assign_user_to_server_var": 40, "active_serv": 40, "ct_name": 40, "ct_assign_to_active_": 40, "ct_unique_server_": 40, "number_of_active_serv": 40, "svr": 40, "number_of_migr": 40, "migrat": 40, "max_sleeping_workload": 40, "max_sleeping_process": 40, "ct_define_max_sleeping_": 40, "workload": 40, "artefact": [40, 56], "lb_report": 40, "make_default_load_balancing_model": 40, "lb_save_solution_as_json": 40, "solution_dict": 40, "sleeping_process": 40, "user_assign": 40, "lbm": 40, "slrm": 41, "Such": 41, "assist": 41, "probabl": 41, "benefici": 41, "relationship": 41, "market": [41, 50], "center": 41, "bank": 41, "depart": [41, 43, 44, 45, 46, 50], "campaign": [41, 50], "financi": [41, 50], "datasci": [41, 50], "characterist": 41, "who": [41, 45, 46, 52], "respond": 41, "favor": [41, 55], "offerig": 41, "respect": [41, 45, 47, 56], "gift": 41, "newslett": 41, "seminar": 41, "confid": 41, "139987": 41, "pension": 41, "13221": 41, "mortgag": 41, "10675": 41, "certainli": 41, "wherea": 41, "140030": 41, "95678": 41, "84446": 41, "spss": 41, "declar": [41, 45, 48], "pd": [41, 42, 45, 46, 47, 52, 55], "guadalup": 41, "martinez": 41, "michel": 41, "lopez": 41, "140089": 41, "terri": 41, "ridglei": 41, "140097": 41, "miranda": 41, "roush": 41, "139068": 41, "sandra": 41, "wynkoop": 41, "139154": 41, "roland": 41, "gu": 41, "rett": 41, "139158": 41, "fabien": 41, "mailhot": 41, "139169": 41, "christian": 41, "austerlitz": 41, "139220": 41, "steffen": 41, "meister": 41, "139261": 41, "wolfgang": 41, "sanger": 41, "139416": 41, "lee": 41, "tsou": 41, "139422": 41, "sanaa": 41, "hikmah": 41, "hakimi": 41, "139532": 41, "miroslav": 41, "skaroupka": 41, "139549": 41, "blomqvist": 41, "139560": 41, "Will": 41, "henderson": 41, "139577": 41, "yuina": 41, "ohira": 41, "139580": 41, "vlad": 41, "alekseeva": 41, "139636": 41, "cassio": 41, "lombardo": 41, "139647": 41, "triniti": 41, "zelaya": 41, "miramont": 41, "139649": 41, "eldar": 41, "muravyov": 41, "139665": 41, "shu": 41, "139667": 41, "jameel": 41, "abdul": 41, "ghani": 41, "gerg": 41, "139696": 41, "zeeb": 41, "longoria": 41, "marrero": 41, "139752": 41, "matheu": 41, "azevedo": 41, "melo": 41, "139832": 41, "earl": 41, "wood": 41, "139859": 41, "gabrielli": 41, "sousa": 41, "martin": 41, "139881": 41, "franca": 41, "palermo": 41, "80233": 41, "80506": 41, "28391": 41, "95676": 41, "82269": 41, "16428": 41, "86779": 41, "13225": 41, "28934": 41, "95675": 41, "27248": 41, "16188": 41, "83426": 41, "75925": 41, "car": 41, "loan": 41, "productvalu": 41, "400": [41, 55], "budgetshar": 41, "availablebudget": 41, "customerid": 41, "product1": 41, "confidence1": 41, "product2": 41, "confidence2": 41, "insert": 41, "forecast": 41, "css": [41, 45, 46, 47, 52], "bodi": [41, 45, 46, 47, 52], "margin": [41, 45, 46, 47, 52], "font": [41, 45, 46, 47, 52], "helvetica": [41, 45, 46, 47, 52], "border": [41, 45, 46, 47, 52], "collaps": [41, 45, 46, 47, 52], "tr": [41, 45, 46, 47, 52], "td": [41, 45, 46, 47, 52], "1px": [41, 45, 46, 47, 52], "solid": [41, 45, 46, 47, 52], "white": [41, 45, 46, 47, 52], "pad": [41, 45, 46, 47, 52, 55], "25em": [41, 45, 46, 47, 52], "background": [41, 45, 46, 47, 52], "fec": [41, 45, 46, 47, 52], "nth": [41, 45, 46, 47, 52], "dash": [41, 45, 46, 47, 52], "888": [41, 45, 46, 47, 52], "2px": [41, 45, 46, 47, 52], "ccf": [41, 45, 46, 47, 52], "f4f4ff": [41, 45, 46, 47, 52], "thead": [41, 45, 46, 47, 52], "tbodi": [41, 45, 46, 47, 52], "drop": 41, "sort_valu": [41, 45, 52], "17": [41, 42, 43, 44, 45, 46, 52, 55], "marketing_campaign": [41, 50], "channelvar": 41, "particular": [41, 46], "totaloff": 41, "budgetsp": 41, "offersr": 41, "productsr": 41, "channelsr": 41, "exce": [41, 47, 51], "326": 41, "324": 41, "revenu": [41, 47], "idx2": 41, "iterrow": 41, "stage": [41, 47, 55], "pai": [41, 42, 45, 46, 47, 55], "subscript": [41, 47, 55], "report_bd": 41, "364": 41, "focu": 41, "h": [42, 45, 50], "william": [42, 50], "horizon": 42, "price": [42, 47, 55], "aggreg": [42, 45, 55], "900": 42, "810": 42, "net": [42, 47], "required_minimum_pandas_vers": [42, 45, 55], "__version__": [42, 45, 55], "prior": 42, "cell": [42, 45, 46], "df_mine": 42, "ore_qu": 42, "max_extract": 42, "nb_mine": 42, "range_min": 42, "blend_qual": 42, "nb_year": 42, "000000": 42, "900000": 42, "223607": 42, "600000": 42, "800000": 42, "200000": 42, "dtype": [42, 45], "float64": 42, "supposedli": 42, "flat": 42, "blend_pric": 42, "max_worked_min": 42, "discount_r": 42, "cleans": 42, "mm": 42, "mining_panda": [42, 50], "range_year": 42, "work_var": 42, "open_var": [42, 56], "ore_var": 42, "60": [42, 44, 45, 47, 55], "40": [42, 43, 44, 45, 46, 48, 55], "df_decision_var": [42, 55], "work_0_0": 42, "open_0_0": 42, "ore_0_0": 42, "work_0_1": 42, "open_0_1": 42, "ore_0_1": 42, "work_0_2": 42, "open_0_2": 42, "ore_0_2": 42, "work_0_3": 42, "open_0_3": 42, "ore_0_3": 42, "work_0_4": 42, "open_0_4": 42, "ore_0_4": 42, "itertupl": [42, 45, 46, 55], "effici": [42, 45, 46, 53, 55], "littl": [42, 45, 56], "groupbi": [42, 45, 55], "postopencloseconstraint": 42, "open_next": 42, "open_curr": 42, "sure": [42, 45, 46], "work_1_0": 42, "work_2_0": 42, "work_3_0": 42, "work_1_1": 42, "work_2_1": 42, "work_3_1": 42, "work_1_2": 42, "work_2_2": 42, "work_3_2": 42, "work_1_3": 42, "work_2_3": 42, "work_3_3": 42, "work_1_4": 42, "work_2_4": 42, "work_3_4": 42, "thing": 42, "open_1_0": 42, "ore_1_0": 42, "open_1_1": 42, "ore_1_1": 42, "open_1_2": 42, "ore_1_2": 42, "open_1_3": 42, "ore_1_3": 42, "open_1_4": 42, "ore_1_4": 42, "61": [42, 55, 56], "blend_var": 42, "ores": 42, "65": [42, 45, 56], "66": [42, 45, 56], "inequ": [42, 56], "71": [42, 55, 56], "s_discount": 42, "0000": [42, 45], "9000": 42, "8100": 42, "7290": 42, "yearli": 42, "expected_revenu": 42, "twice": [42, 45, 56], "relev": [42, 45, 55], "common": [42, 55], "df_royalties_data": 42, "roylati": 42, "disc_royalti": 42, "0500": 42, "6450": 42, "2805": 42, "total_royalti": 42, "print_cplex_log": 42, "s1": [42, 43, 44, 46], "161": 42, "438": 42, "214": 42, "674": 42, "236": 42, "leverag": [42, 45, 56], "Of": [42, 45], "pivot": [42, 45, 55], "unstack": [42, 45, 55], "mine_label": 42, "ylabel": [42, 45, 46, 55, 56], "ore_valu": 42, "df_re": [42, 45], "mine1": 42, "mine2": 42, "mine3": 42, "mine4": 42, "y1": 42, "00": [42, 43, 44, 45, 46, 55], "500000": 42, "y2": 42, "y3": 42, "y4": 42, "y5": 42, "166667": 42, "graphic": [42, 56], "xlabel": [42, 45, 46, 55, 56], "forbid": [42, 45], "impact": [42, 56], "forced_stop": 42, "stop_m": 42, "stop_i": 42, "whenev": [42, 55, 56], "full_min": 42, "s2": [42, 43, 44, 46], "cpxparam_read_datacheck": [42, 45, 46], "108": [42, 45], "9605": 42, "tri": [42, 45], "presolv": [42, 45, 46], "elimin": [42, 45, 56], "36": [42, 45, 55], "substitut": [42, 45], "sec": [42, 45, 46], "parallel": [42, 45, 46], "157": 42, "936": 42, "228": 42, "367": 42, "431": 42, "9355": 42, "ore_values2": 42, "df_res2": [42, 45], "blue": 42, "shift": [43, 44, 50], "weekdai": [43, 44, 46], "_all_dai": [43, 44, 46], "mondai": [43, 44, 45, 46], "tuesdai": [43, 44, 45, 46], "wednesdai": [43, 44, 45, 46], "thursdai": [43, 44, 45, 46], "fridai": [43, 44, 45, 46], "saturdai": [43, 44, 45, 46], "sundai": [43, 44, 45, 46], "day_to_day_week": [43, 44, 46], "dai": [43, 44, 45, 46, 47], "day_map": [43, 44, 46], "tworkrul": [43, 44, 46], "work_time_max": [43, 44, 46], "tvacat": [43, 44, 46], "tnursepair": [43, 44, 46], "firstnurs": [43, 44, 46], "secondnurs": [43, 44, 46], "tskillrequir": [43, 44, 46], "skill": [43, 44, 45], "ann": [43, 44, 45, 46], "bethani": [43, 44, 45, 46], "betsi": [43, 44, 45, 46], "cathi": [43, 44, 45, 46], "cecilia": [43, 44, 45, 46], "chri": [43, 44, 45, 46], "cindi": [43, 44, 45, 46], "debbi": [43, 44, 45, 46], "dee": [43, 44, 45, 46], "gloria": [43, 44, 45, 46], "isabel": [43, 44, 45, 46], "jane": [43, 44, 45, 46], "janel": [43, 44, 45, 46], "janic": [43, 44, 45, 46], "jemma": [43, 44, 45, 46], "joan": [43, 44, 45, 46], "joyc": [43, 44, 45, 46], "jude": [43, 44, 45, 46], "juli": [43, 44, 45, 46, 52], "juliet": [43, 44, 45, 46], "kate": [43, 44, 45, 46], "nanci": [43, 44, 45, 46], "nathali": [43, 44, 45, 46], "nicol": [43, 44, 45, 46], "patricia": [43, 44, 45, 46], "patrick": [43, 44, 45, 46], "roberta": [43, 44, 45, 46], "suzann": [43, 44, 45, 46], "vicki": [43, 44, 45, 46], "wendi": [43, 44, 45, 46], "zoe": [43, 44, 45, 46], "emerg": [43, 44, 45], "consult": [43, 44, 45], "cardiac_car": [43, 44], "geriatr": [43, 44, 45], "nurse_skil": [43, 44, 46], "anaesthesiologi": [43, 44], "oncologi": [43, 44], "pediatr": [43, 44], "vacat": [43, 44], "nurse_associ": [43, 44, 46], "nurse_incompat": [43, 44, 46], "skill_requir": [43, 44, 46], "default_work_rul": [43, 44], "tnurs": [43, 44, 46], "tnurse1": [43, 44, 46], "senior": [43, 44, 45, 46], "qualif": [43, 44, 45, 46], "pay_rat": [43, 44, 45, 46], "tshift": [43, 44, 46], "start_tim": [43, 44, 45, 46], "end_tim": [43, 44, 45, 46], "min_requir": [43, 44, 46], "max_requir": [43, 44, 46], "uppercas": [43, 44, 46], "dept2": [43, 44, 46], "daynam": [43, 44, 46], "02d": [43, 44, 46], "shiftact": [43, 44, 46], "staticmethod": [43, 44, 46], "to_abstim": [43, 44, 46], "day_index": [43, 44, 46], "time_of_dai": [43, 44, 46], "hour": [43, 44, 45, 46], "start_time_of_dai": [43, 44, 46], "end_time_of_dai": [43, 44, 46], "_weekdai": [43, 44, 46], "_start_time_of_dai": [43, 44, 46], "_end_time_of_dai": [43, 44, 46], "start_day_index": [43, 44, 46], "end_day_index": [43, 44, 46], "durat": [43, 44, 46], "overlap": [43, 44], "other_shift": [43, 44, 46], "isinst": [43, 44, 46], "2min": [43, 44], "120": [43, 44, 55, 56], "load_data": [43, 44], "shifts_": [43, 44], "nurses_": [43, 44], "vacations_": [43, 44], "nurse_associations_": [43, 44], "nurse_imcompatibilities_": [43, 44], "number_of_overlap": [43, 44, 46], "work_rul": [43, 44, 46], "shift_row": [43, 44, 46], "nurse_row": [43, 44], "vacation_row": [43, 44, 46], "npr": [43, 44], "sh": [43, 44], "setup_data": [43, 44], "stor": [43, 44], "ethem": [43, 44], "shift_act": [43, 44, 46], "nurses_by_id": [43, 44, 46], "setup_vari": [43, 44], "all_nurs": [43, 44, 45], "all_shift": [43, 44, 45], "iff": [43, 44, 55], "nurse_assignment_var": [43, 44, 46], "nurseassign": [43, 44, 46], "nurse_work_time_var": [43, 44, 46], "nurseworktim": [43, 44, 46], "over_averag": [43, 44, 46], "averag": [43, 44, 45], "nurse_over_average_time_var": [43, 44, 46], "nurseoveraverageworktim": [43, 44, 46], "nurse_under_average_time_var": [43, 44, 46], "nurseunderaverageworktim": [43, 44, 46], "average_nurse_work_tim": [43, 44, 46], "averageworktim": [43, 44, 46], "setup_constraint": [43, 44], "nurse_assign": [43, 44, 45], "nurse_work_tim": [43, 44], "max_work_tim": [43, 44, 45], "work_time_var": [43, 44, 46], "work_time_": [43, 44, 46], "worktim": [43, 44, 46], "trick": [43, 44, 46, 56], "thse": [43, 44], "wil": [43, 44], "average_work_time_": [43, 44, 46], "max_time_": [43, 44, 46], "vac_nurse_id": [43, 44, 46], "vac_dai": [43, 44, 46], "vac_n": [43, 44, 46], "medium_vacations_": [43, 44, 46], "nb_shift": [43, 44, 46], "i1": [43, 44, 46], "i2": [43, 44, 46], "high_overlapping_": [43, 44, 46], "demand_min": [43, 44, 46], "demand_max": [43, 44, 46], "total_assign": [43, 44, 46], "high_req_min_": [43, 44, 46], "medium_req_max_": [43, 44, 46], "mandatory_presence_": 43, "dept": [43, 44, 46], "dsh": [43, 44, 46], "skilled_nurs": [43, 44, 46], "high_required_": [43, 44, 46], "nurse_id1": [43, 44, 46], "nurse_id2": [43, 44, 46], "nurse1": [43, 44, 45, 46], "nurse2": [43, 44, 45, 46], "medium_ct_nurse_assoc_": [43, 44, 46], "medium_ct_nurse_incompat_": [43, 44, 46], "total_number_of_assign": [43, 44, 46], "nurse_cost": [43, 44, 46], "assignment_cost_f": 43, "total_salary_cost": [43, 44, 45, 46], "setup_object": [43, 44], "salari": [43, 44, 46], "total_over_average_worktim": [43, 44, 46], "total_under_average_worktim": [43, 44, 46], "total_fair": [43, 44, 46], "fair": [43, 44, 46], "total_hour": [43, 44], "nurs": [44, 50], "overal": [44, 45, 46, 48, 55], "co": 44, "000001": 44, "paramset": 44, "000003": 44, "000002": 44, "hospit": [45, 46], "staf": [45, 46], "fairli": [45, 46], "week": [45, 46, 51], "nurseskil": [45, 46], "skillrequir": [45, 46], "person": [45, 46], "nursevac": [45, 46], "nurseassoci": [45, 46], "nurseincompat": [45, 46], "sheet": [45, 46, 55], "importerror": [45, 46], "xlrd": [45, 46], "tab": 45, "data_url": [45, 46], "blob": [45, 46], "jupyt": [45, 46, 50], "nurses_data": [45, 46], "xl": [45, 46], "nurse_xls_fil": [45, 46], "excelfil": [45, 46], "df_skill": 45, "df_dept": 45, "df_shift": 45, "renam": 45, "shiftid": 45, "df_nurs": 45, "index_col": 45, "df_nurse_skil": 45, "df_vacat": 45, "df_associ": 45, "df_incompat": 45, "59": [45, 56], "max_nb_shift": 45, "min_req": 45, "max_req": 45, "cardiac": 45, "33": [45, 55], "37": [45, 46, 55, 56], "39": [45, 55], "precomput": 45, "8am": 45, "dow": 45, "day_of_week": 45, "day_to_day_of_week": 45, "whitespac": 45, "wstart": 45, "complic": 45, "span": 45, "midnight": 45, "am": 45, "rule": [45, 46], "abs_end_tim": 45, "wend": 45, "significantli": [45, 55], "calculate_absolute_endtim": 45, "straightforward": [45, 56], "min_demand": 45, "56": [45, 56], "74": [45, 56], "90": [45, 55], "104": 45, "114": 45, "122": 45, "72": 45, "156": 45, "164": 45, "170": 45, "152": [45, 56], "154": 45, "mix": [45, 46], "upon": 45, "assign_": 45, "df_assign": 45, "df_assigned_pivot": 45, "reset_index": 45, "head": [45, 55], "assign_anne_0": 45, "assign_anne_1": 45, "assign_anne_2": 45, "assign_anne_3": 45, "assign_anne_4": 45, "assign_anne_5": 45, "assign_anne_6": 45, "assign_anne_7": 45, "assign_anne_8": 45, "assign_anne_9": 45, "assign_anne_31": 45, "assign_anne_32": 45, "assign_anne_33": 45, "assign_anne_34": 45, "assign_anne_35": 45, "assign_anne_36": 45, "assign_anne_37": 45, "assign_anne_38": 45, "assign_anne_39": 45, "assign_anne_40": 45, "assign_bethanie_0": 45, "assign_bethanie_1": 45, "assign_bethanie_2": 45, "assign_bethanie_3": 45, "assign_bethanie_4": 45, "assign_bethanie_5": 45, "assign_bethanie_6": 45, "assign_bethanie_7": 45, "assign_bethanie_8": 45, "assign_bethanie_9": 45, "assign_bethanie_31": 45, "assign_bethanie_32": 45, "assign_bethanie_33": 45, "assign_bethanie_34": 45, "assign_bethanie_35": 45, "assign_bethanie_36": 45, "assign_bethanie_37": 45, "assign_bethanie_38": 45, "assign_bethanie_39": 45, "assign_bethanie_40": 45, "assign_betsy_0": 45, "assign_betsy_1": 45, "assign_betsy_2": 45, "assign_betsy_3": 45, "assign_betsy_4": 45, "assign_betsy_5": 45, "assign_betsy_6": 45, "assign_betsy_7": 45, "assign_betsy_8": 45, "assign_betsy_9": 45, "assign_betsy_31": 45, "assign_betsy_32": 45, "assign_betsy_33": 45, "assign_betsy_34": 45, "assign_betsy_35": 45, "assign_betsy_36": 45, "assign_betsy_37": 45, "assign_betsy_38": 45, "assign_betsy_39": 45, "assign_betsy_40": 45, "assign_cathy_0": 45, "assign_cathy_1": 45, "assign_cathy_2": 45, "assign_cathy_3": 45, "assign_cathy_4": 45, "assign_cathy_5": 45, "assign_cathy_6": 45, "assign_cathy_7": 45, "assign_cathy_8": 45, "assign_cathy_9": 45, "assign_cathy_31": 45, "assign_cathy_32": 45, "assign_cathy_33": 45, "assign_cathy_34": 45, "assign_cathy_35": 45, "assign_cathy_36": 45, "assign_cathy_37": 45, "assign_cathy_38": 45, "assign_cathy_39": 45, "assign_cathy_40": 45, "assign_cecilia_0": 45, "assign_cecilia_1": 45, "assign_cecilia_2": 45, "assign_cecilia_3": 45, "assign_cecilia_4": 45, "assign_cecilia_5": 45, "assign_cecilia_6": 45, "assign_cecilia_7": 45, "assign_cecilia_8": 45, "assign_cecilia_9": 45, "assign_cecilia_31": 45, "assign_cecilia_32": 45, "assign_cecilia_33": 45, "assign_cecilia_34": 45, "assign_cecilia_35": 45, "assign_cecilia_36": 45, "assign_cecilia_37": 45, "assign_cecilia_38": 45, "assign_cecilia_39": 45, "assign_cecilia_40": 45, "unsort": 45, "df_sorted_shift": 45, "number_of_incompatible_shift_constraint": 45, "shift_2": 45, "iloc": 45, "640": 45, "he": [45, 46], "forbidden": 45, "assig": 45, "df_assigned_reindex": 45, "df_vacation_forbidden_assign": 45, "left_on": [45, 55], "right_on": 45, "assign_anne_28": 45, "assign_anne_29": 45, "assign_anne_30": 45, "forbidden_assign": 45, "342": 45, "everi": [45, 46, 47, 51, 52], "suffix": [45, 56], "df_preferred_assign": 45, "_1": 45, "_2": 45, "all_nurses_1": 45, "assigned_1": 45, "all_nurses_2": 45, "assigned_2": 45, "assign_isabelle_0": 45, "assign_dee_0": 45, "assign_isabelle_1": 45, "assign_dee_1": 45, "assign_isabelle_2": 45, "assign_dee_2": 45, "assign_isabelle_3": 45, "assign_dee_3": 45, "assign_isabelle_4": 45, "assign_dee_4": 45, "preferred_assign": 45, "similarli": [45, 46], "sift": 45, "df_incompatible_assign": 45, "assign_patricia_0": 45, "assign_patrick_0": 45, "assign_patricia_1": 45, "assign_patrick_1": 45, "assign_patricia_2": 45, "assign_patrick_2": 45, "assign_patricia_3": 45, "assign_patrick_3": 45, "assign_patricia_4": 45, "assign_patrick_4": 45, "incompatible_assign": 45, "regul": 45, "unnecessari": 45, "perspect": 45, "make_var": 45, "varname_fmt": 45, "worktime_": 45, "worktime_ann": 45, "worktime_bethani": 45, "worktime_betsi": 45, "worktime_cathi": 45, "worktime_cecilia": 45, "worktime_chri": 45, "worktime_cindi": 45, "worktime_david": 45, "worktime_debbi": 45, "worktime_de": 45, "worktime_gloria": 45, "worktime_isabel": 45, "worktime_jan": 45, "worktime_janel": 45, "worktime_janic": 45, "worktime_jemma": 45, "worktime_joan": 45, "worktime_joyc": 45, "worktime_jud": 45, "worktime_juli": 45, "worktime_juliet": 45, "worktime_k": 45, "worktime_n": 45, "worktime_nathali": 45, "worktime_nicol": 45, "worktime_patricia": 45, "worktime_patrick": 45, "worktime_roberta": 45, "worktime_suzann": 45, "worktime_vicki": 45, "worktime_wendi": 45, "worktime_zo": 45, "constrain": [45, 47, 48, 55], "1344": 45, "1312": 45, "1547": 45, "set_max_work_tim": 45, "fanci": 45, "convert_dtyp": 45, "shift_nurs": 45, "total_salary_seri": 45, "25worktime_ann": 45, "28worktime_bethani": 45, "17worktime_betsi": 45, "17worktime_": 45, "preliminari": 45, "accomplish": [45, 46], "1588": 45, "unit": [45, 46, 50], "magnitud": [45, 46], "cpxparam_mip_tolerances_mipgap": [45, 46], "0000000000000001e": [45, 46], "997": 45, "379": 45, "550": 45, "922": 45, "2862": 45, "892": 45, "soss": 45, "probe": 45, "cliqu": 45, "479": 45, "iinf": 45, "28824": 45, "473": 45, "62": 45, "649": 45, "44": [45, 55], "716": 45, "795": 45, "29100": 45, "29068": 45, "139": [45, 55], "mb": 45, "29014": 45, "29010": 45, "28982": 45, "28944": 45, "47": [45, 55, 56], "28936": 45, "1611": 45, "1392": [45, 55], "28888": 45, "4006": 45, "3397": 45, "28842": 45, "4152": 45, "3293": 45, "4253": 45, "3414": 45, "73849": 45, "gub": 45, "76": [45, 55, 56], "flow": 45, "lift": 45, "270": 45, "08": 45, "410": 45, "07": 45, "000": [45, 46, 47, 50, 55, 56], "s_assign": 45, "s_demand": 45, "total_demand": [45, 55], "avg_worktim": 45, "theoret": [45, 48], "s_worktim": 45, "s_to_mean": 45, "s_abs_to_mean": 45, "total_to_mean": 45, "histogram": 45, "hist": 45, "lightblu": [45, 56], "amongst": 45, "df_work": 45, "gold": [45, 56], "xlim": [45, 46, 47], "fewer": 45, "fraction": 45, "nonetheless": 45, "quantifi": 45, "avg_work": 45, "avg": 45, "worked_to_avg": 45, "875": 45, "diagram": [45, 47], "overwork": 45, "overw_": 45, "underwork": 45, "underw_": 45, "total_overw": 45, "total_underw": 45, "underw_ann": 45, "underw_bethani": 45, "underw_betsi": 45, "underw_cathi": 45, "underw_cec": 45, "over_work": 45, "under_work": 45, "suffici": 45, "unambigu": 45, "incorpor": 45, "readi": 45, "28840": 45, "582": 45, "986": 45, "3859": 45, "580": 45, "982": 45, "3814": 45, "28827": 45, "9167": 45, "885": 45, "04": 45, "28829": 45, "51": [45, 50], "1053": 45, "9063": 45, "107": 45, "1359": [45, 55], "28831": 45, "1530": 45, "1649": 45, "1715": 45, "1783": 45, "69": [45, 55, 56], "gomori": 45, "211": 45, "92": 45, "250": [45, 55], "625": 45, "recomput": 45, "s_assigned2": 45, "new_total_to_mean": 45, "down": [45, 56], "_subplot": [45, 55], "axessubplot": [45, 55], "0x279df51e710": 45, "closer": 45, "simpli": 45, "unrealist": 45, "far": [45, 47], "29606": 45, "28884": 45, "s_assigned_fair": 45, "df_res_fair": 45, "solution_value_fair": 45, "plum": 45, "0x279e05915f8": 45, "deal": 46, "schedul": [46, 50, 51], "conevrt": 46, "tnurseskil": 46, "tshift1": 46, "day_start_tim": 46, "skilltabl": 46, "depttabl": 46, "shifttabl": 46, "skillrequirementt": 46, "nurset": 46, "nurseskillt": 46, "nursevacationt": 46, "nurseassociationt": 46, "nurseincompatibilityt": 46, "nurses_panda": [46, 50], "benefit": 46, "nsk": 46, "nskt": 46, "setdefault": 46, "skill_requirement_row": 46, "na": 46, "And": 46, "18averageworktim": 46, "nurseworktime_betsi": 46, "nurseworktime_cathi": 46, "nurseworktime_cindi": 46, "nurseworktime_debbi": 46, "nurseworktime_de": 46, "nurseworktime_isabel": 46, "nurseworktime_jan": 46, "nurseworktime_janel": 46, "nurseworktime_janic": 46, "nurseworktime_jemma": 46, "nurseworktime_joan": 46, "nurseworktime_jud": 46, "nurseworktime_juli": 46, "nurseworktime_k": 46, "nurseworktime_patrick": 46, "nurseworktime_suzann": 46, "nurseworktime_vicki": 46, "nurseworktime_wendi": 46, "she": 46, "lesser": 46, "associt": 46, "measur": 46, "793": 46, "738": 46, "961": 46, "revis": 46, "emphas": 46, "enable_trac": 46, "relaxed_sol": 46, "relaxed_ok": 46, "high_req_min_emer_mon_18_3": 46, "high_req_min_cons_mon_08_10": 46, "high_req_min_cons_mon_12_8": 46, "high_req_min_card_mon_08_10": 46, "high_req_min_card_mon_12_8": 46, "high_req_min_emer_tue_08_4": 46, "high_req_min_emer_tue_18_3": 46, "high_req_min_cons_tue_08_10": 46, "high_req_min_cons_tue_12_8": 46, "high_req_min_card_tue_08_4": 46, "high_req_min_card_tue_18_3": 46, "high_req_min_emer_wed_18_3": 46, "high_req_min_emer_thu_02_3": 46, "high_req_min_emer_thu_18_3": 46, "high_req_min_cons_thu_08_10": 46, "high_req_min_cons_thu_12_8": 46, "high_req_min_emer_fri_18_3": 46, "high_req_min_cons_fri_08_10": 46, "high_req_min_cons_fri_12_8": 46, "high_req_min_emer_sat_02_5": 46, "high_req_min_emer_sat_12_7": 46, "high_req_min_emer_sat_20_12": 46, "high_req_min_emer_sun_02_5": 46, "high_req_min_emer_sun_12_7": 46, "high_required_emergency_cardiac": 46, "care_1_emer_mon_02": 46, "care_1_emer_mon_18": 46, "care_1_emer_tue_18": 46, "care_1_emer_wed_12": 46, "care_1_emer_wed_18": 46, "care_1_emer_thu_18": 46, "care_1_emer_fri_18": 46, "care_1_emer_sat_02": 46, "care_1_emer_sat_12": 46, "care_1_emer_sun_02": 46, "care_1_emer_sun_12": 46, "97": [46, 56], "14097": 46, "333": 46, "13940": 46, "134": 46, "667": 46, "chart": [46, 47, 55, 56], "gantt": 46, "gridspec": 46, "colorbydepart": 46, "nbassignmentsbyshift": 46, "shiftsbydepart": 46, "createlabel": 46, "shiftinfobydai": 46, "xtick": [46, 47], "set_xlabel": [46, 47], "set_ylabel": [46, 47], "grid": 46, "displaynursesassignmentsgantt": 46, "tickloc": 46, "bottom": 46, "ylim": [46, 55], "ytick": 46, "OF": 46, "displaydepartmentsassign": 46, "maxnbassign": 46, "vertic": 46, "height_ratio": 46, "manufactur": [47, 48], "gasolin": [47, 50], "diesel": [47, 55], "crude": 47, "purchas": 47, "decid": [47, 50, 56], "industri": [47, 50], "life": 47, "super": [47, 52], "crude1": 47, "crude2": 47, "crude3": 47, "barrel": 47, "advertis": 47, "ten": 47, "dollar": 47, "spent": 47, "bought": 47, "sell": 47, "inventori": 47, "proport": [47, 50], "magin": 47, "fundament": 47, "np": [47, 52], "gas_nam": 47, "gas_data": 47, "3000": 47, "oil_nam": 47, "oil_data": 47, "nb_ga": 47, "nb_oil": 47, "range_ga": 47, "range_oil": 47, "production_cost": 47, "production_max": 47, "14000": 47, "advert_return": 47, "languag": 47, "gaspd": 47, "oilpd": 47, "stylesheet": [47, 52], "ga": [47, 55], "submit": [47, 50], "oil_blend": [47, 50], "advert": 47, "sale": [47, 53], "total_advert_cost": 47, "total_oil_cost": 47, "total_production_cost": 47, "total_revenu": 47, "287750": 47, "750": [47, 55], "487500": 47, "54000": 47, "830000": 47, "all_kpi": 47, "kp": 47, "kpis_bd": 47, "blend_valu": 47, "total_gas_prod": 47, "prod": [47, 48], "prods_bd": 47, "pie": [47, 55, 56], "display_pi": 47, "pie_valu": 47, "pie_label": 47, "autopct": [47, 55, 56], "1f": [47, 56], "kpnv": 47, "green": [47, 51, 52], "goldenrod": 47, "lightgreen": 47, "sblend": 47, "blends_bd": 47, "barplot": 47, "bar_width": 47, "offset": 47, "rho": 47, "boundari": 47, "bar_l": 47, "mbar_w": 47, "tick_po": 47, "oliv": 47, "cadetblu": 47, "loc": [47, 56], "repartit": 47, "buffer": 47, "around": 47, "notic": 47, "miss": 47, "outsid": [48, 50, 52], "consum": 48, "contrast": 48, "consumpt": 48, "capac": [48, 56], "kluski": 48, "capellini": 48, "fettucin": 48, "flour": 48, "egg": 48, "build_production_problem": 48, "product_nam": 48, "resource_nam": 48, "inside_var": 48, "inside_": 48, "outside_var": 48, "outside_": 48, "ct_demand_": 48, "ct_res_": 48, "total_inside_cost": 48, "total_outside_cost": 48, "print_production_solut": 48, "ins_var": 48, "out_var": 48, "build_default_production_problem": 48, "cb_mixin": 49, "conflict_refin": 49, "error_handl": 49, "model_read": 49, "relax_linear": 49, "sosvarset": 49, "with_func": 49, "cli": 49, "csv_util": 49, "docplex_exampl": 50, "subdirectori": 50, "categori": 50, "diet": 50, "planner": 50, "sport_schedul": 50, "sport": [50, 51], "leagu": [50, 51], "plai": [50, 51], "intradivis": [50, 51], "late": [50, 51, 52], "season": [50, 51, 52], "workflow": 50, "cutstock": 50, "sometim": 50, "knapsack": 50, "suppli": [50, 56], "lagrangian_relax": 50, "load_balanc": 50, "box": 50, "chicago_coffee_shop": 50, "shop": 50, "offer": [50, 53], "mine": 50, "nurses_schedul": 50, "oil": 50, "sports_schedul": 50, "ucp_panda": 50, "answer": [50, 55], "question": [50, 54, 55], "electr": [50, 55], "trace": 50, "brief": 50, "prompt": 50, "69041": 50, "serv": 50, "155": [50, 55], "831": 50, "930": 50, "278": 50, "8518": 50, "433": [50, 55, 56], "256": 50, "806": 50, "174": [50, 55], "game": 51, "intradivision": 51, "held": [51, 52], "incent": [51, 52], "oppon": [51, 52], "team_div1": [51, 52], "baltimor": [51, 52], "raven": [51, 52], "cincinnati": [51, 52], "bengal": [51, 52], "cleveland": [51, 52], "brown": [51, 52], "pittsburgh": [51, 52], "steeler": [51, 52], "houston": [51, 52], "texan": [51, 52], "indianapoli": [51, 52], "colt": [51, 52], "jacksonvil": [51, 52], "jaguar": [51, 52], "tennesse": [51, 52], "titan": [51, 52], "buffalo": [51, 52], "miami": [51, 52], "dolphin": [51, 52], "england": [51, 52], "patriot": [51, 52], "york": [51, 52], "jet": [51, 52], "denver": [51, 52], "bronco": [51, 52], "kansa": [51, 52], "chief": [51, 52], "oakland": [51, 52], "raider": [51, 52], "san": [51, 52], "diego": [51, 52], "charger": [51, 52], "team_div2": [51, 52], "bear": [51, 52], "detroit": [51, 52], "lion": [51, 52], "bai": [51, 52], "packer": [51, 52], "minnesota": [51, 52], "vike": [51, 52], "atlanta": [51, 52], "falcon": [51, 52], "carolina": [51, 52], "panther": [51, 52], "orlean": [51, 52], "saint": [51, 52], "tampa": [51, 52], "buccan": [51, 52], "dalla": [51, 52], "cowboi": [51, 52], "giant": [51, 52], "philadelphia": [51, 52], "eagl": [51, 52], "washington": [51, 52], "redskin": [51, 52], "arizona": [51, 52], "cardin": [51, 52], "francisco": [51, 52], "49er": [51, 52], "seattl": [51, 52], "seahawk": [51, 52], "st": [51, 52], "loui": [51, 52], "ram": [51, 52], "team1": [51, 52], "team2": [51, 52], "is_division": [51, 52], "build_sport": 51, "sportschedcplex": 51, "nb_teams_in_divis": [51, 52], "nb_intra_division": 51, "nb_inter_division": 51, "2n": 51, "team_rang": 51, "necessari": [51, 52, 56], "nb_week": [51, 52], "interdivision": [51, 52], "halv": [51, 52], "first_half_week": [51, 52], "nb_first_half_gam": [51, 52], "t1": [51, 52], "t2": [51, 52], "nb_plai": [51, 52], "mw": 51, "play_": 51, "d_w": 51, "correct_nb_games_": 51, "max_teams_in_divis": [51, 52], "plays_exactly_once_": 51, "in_division_first_half_": 51, "postpon": 51, "division": 51, "tsolut": 51, "print_sports_solut": 51, "currweek": 51, "ip": 52, "eight": 52, "1st": 52, "2nd": 52, "number_of_matches_to_plai": 52, "number_of_matches_inside_divis": 52, "number_of_matches_outside_divis": 52, "top": 52, "tabular": 52, "spreadsheet": 52, "databas": 52, "think": 52, "afc": 52, "nfc": 52, "concat": 52, "issu": [52, 53, 54, 56], "nb_team": 52, "nb_inside_div": 52, "nb_outside_div": 52, "405": 52, "135": 52, "495": 52, "505": 52, "design": 52, "260": 52, "replai": 52, "bowl": 52, "team_leagu": 52, "nfl_final": 52, "2016": 52, "2014": 52, "2013": 52, "2012": 52, "2011": 52, "2010": 52, "2008": 52, "2007": 52, "nfl_meet": 52, "winners_bd": 52, "month": 52, "februari": 52, "march": 52, "april": 52, "june": 52, "august": 52, "septemb": 52, "octob": 52, "novemb": 52, "decemb": 52, "matches_bd": 52, "technic": [53, 56], "reliabl": 53, "expert": 53, "mission": 53, "critic": 53, "phone": 53, "24x7": 53, "defect": 53, "submiss": 53, "triag": 53, "ssl": 54, "unsupport": 54, "cplex_studio1263": 54, "lack": 54, "ask": 54, "forum": 54, "estim": [55, 56], "standalon": 55, "excel": 55, "appear": 55, "df_energi": 55, "coal": 55, "wind": 55, "co2_cost": 55, "df_unit": 55, "all_unit": 55, "coal1": 55, "coal2": 55, "gas1": 55, "gas2": 55, "gas3": 55, "gas4": 55, "diesel1": 55, "diesel2": 55, "diesel3": 55, "diesel4": 55, "ucp_raw_unit_data": 55, "350": 55, "205": 55, "52": 55, "150": [55, 56], "min_gen": 55, "54": [55, 56], "max_gen": 55, "425": 55, "365": 55, "220": 55, "165": 55, "158": 55, "operating_max_gen": 55, "197": 55, "min_uptim": 55, "min_downtim": 55, "ramp_up": 55, "212": 55, "94": 55, "ramp_down": 55, "183": 55, "198": 55, "start_cost": 55, "4550": 55, "1320": 55, "1291": 55, "1280": 55, "1105": 55, "560": 55, "554": 55, "fixed_cost": [55, 56], "208": 55, "117": 55, "172": 55, "353": 55, "144": 55, "417": 55, "551": 55, "79": 55, "638": 55, "259": 55, "variable_cost": 55, "536": 55, "985": 55, "522": 55, "642": 55, "610": 55, "370": 55, "520": 55, "840": 55, "330": 55, "inner": 55, "intersect": 55, "df_up": 55, "right_index": 55, "raw_demand": 55, "1259": 55, "1439": 55, "1289": 55, "1211": 55, "1433": 55, "1287": 55, "1285": 55, "1227": 55, "1269": 55, "1158": 55, "1277": 55, "1417": 55, "1294": 55, "1396": 55, "1414": 55, "1386": 55, "1302": 55, "1215": 55, "1354": 55, "1436": 55, "1332": 55, "1172": 55, "1446": 55, "1367": 55, "1243": 55, "1275": 55, "1363": 55, "1208": 55, "1394": 55, "1345": 55, "1217": 55, "1432": 55, "1431": 55, "1356": 55, "1360": 55, "1364": 55, "1286": 55, "1440": 55, "1313": 55, "1389": 55, "1385": 55, "1265": 55, "1442": 55, "1435": 55, "1411": 55, "1258": 55, "1333": 55, "1293": 55, "1193": 55, "1306": 55, "1264": 55, "1244": 55, "1368": 55, "1437": 55, "1236": 55, "1383": 55, "1350": 55, "1329": 55, "1427": 55, "1163": 55, "1339": 55, "1351": 55, "1174": 55, "1235": 55, "1245": 55, "1262": 55, "1362": 55, "1184": 55, "1207": 55, "1443": 55, "1205": 55, "1192": 55, "1233": 55, "1281": 55, "1295": 55, "1357": 55, "1191": 55, "1334": 55, "1365": 55, "1199": 55, "1256": 55, "1257": 55, "1224": 55, "1246": 55, "1194": 55, "1366": 55, "1282": 55, "1221": 55, "1255": 55, "1358": 55, "1254": 55, "1276": 55, "1335": 55, "1355": 55, "1337": 55, "1197": 55, "1423": 55, "1310": 55, "1300": 55, "1388": 55, "1434": 55, "1232": 55, "1402": 55, "1160": 55, "1422": 55, "1219": 55, "1410": 55, "1361": 55, "1407": 55, "1164": 55, "1408": 55, "1196": 55, "1430": 55, "1216": 55, "1340": 55, "1327": 55, "1230": 55, "1448": 55, "1220": 55, "1425": 55, "1413": 55, "1279": 55, "1162": 55, "1441": 55, "1307": 55, "1308": 55, "1420": 55, "1338": 55, "1311": 55, "1328": 55, "1336": 55, "1231": 55, "nb_period": 55, "192": 55, "0x23fbad3d588": 55, "ucpm": 55, "in_us": 55, "turn_on": 55, "turn_off": 55, "switch": 55, "7680": 55, "3840": 55, "in_use_coal1_1": 55, "turn_on_coal1_1": 55, "turn_off_coal1_1": 55, "p_coal1_1": 55, "in_use_coal1_2": 55, "turn_on_coal1_2": 55, "turn_off_coal1_2": 55, "p_coal1_2": 55, "in_use_coal1_3": 55, "turn_on_coal1_3": 55, "turn_off_coal1_3": 55, "p_coal1_3": 55, "in_use_coal1_4": 55, "turn_on_coal1_4": 55, "turn_off_coal1_4": 55, "p_coal1_4": 55, "in_use_coal1_5": 55, "turn_on_coal1_5": 55, "turn_off_coal1_5": 55, "p_coal1_5": 55, "ie": 55, "df_join_decision_vars_up": 55, "pb": 55, "turnoff": 55, "3860": 55, "u_ramp_up": 55, "u_ramp_down": 55, "u_initi": 55, "p_curr": 55, "p_next": 55, "7700": 55, "in_use_curr": 55, "in_use_next": 55, "turn_on_next": 55, "turn_off_next": 55, "11520": 55, "min_up_": 55, "min_down_": 55, "robust": [55, 56], "ct_meet_demand_": 55, "incur": [55, 56], "startup": 55, "df_join_obj": 55, "total_fixed_cost": 55, "total_variable_cost": 55, "total_startup_cost": 55, "total_co2_cost": 55, "total_economic_cost": 55, "total_nb_us": 55, "total_nb_start": 55, "15455": 55, "14213082": 55, "064": 55, "161025": 55, "131": 55, "8865900": 55, "2832": 55, "9029757": 55, "564": 55, "5183324": 55, "df_prod": 55, "df_use": 55, "df_start": 55, "215": 55, "109": 55, "312": 55, "234": 55, "143": 55, "reserv": 55, "df_spin": 55, "to_dict": 55, "142": 55, "67": [55, 56], "0x23fd903bf60": 55, "spin": 55, "global_spin": 55, "0x23fda312710": 55, "0x23fda37f9b0": 55, "all_cost": 55, "df_cost": 55, "running_cost": 55, "startup_cost": 55, "logi": 55, "0x23fda3c7e80": 55, "cost_by_unit": 55, "unit_energi": 55, "gb": 55, "fontsiz": [55, 56], "push": 55, "discuss": 55, "But": [55, 56], "co2_kpi": 55, "eco_kpi": 55, "eco": 55, "prev_co2_cost": 55, "prev_eco_cost": 55, "old_object": 55, "as_express": 55, "56390015": 55, "min_co2_cost": 55, "min_co2_eco_cost": 55, "3399032": 55, "12434227": 55, "620000225": 55, "alon": 55, "min_eco_cost": 55, "min_eco_co2_cost": 55, "8887433": 55, "859000005": 55, "5375417": 55, "pareto": 55, "co2_limit": 55, "max_co2_ctnam": 55, "ct_max_co2": 55, "co2_ct": 55, "co2min": 55, "co2max": 55, "explore_ucp": 55, "co2_ub": 55, "all_co2": 55, "all_eco": 55, "cur_co2": 55, "cur_eco": 55, "explor": 55, "frontier": 55, "3438559": 55, "3478087": 55, "3517615": 55, "3557142": 55, "3596670": 55, "3636198": 55, "3675725": 55, "3715253": 55, "3754781": 55, "3794309": 55, "3833836": 55, "3873364": 55, "3912892": 55, "3952419": 55, "3991947": 55, "4031475": 55, "4071002": 55, "4110530": 55, "4150058": 55, "4189586": 55, "4229113": 55, "4268641": 55, "4308169": 55, "4347696": 55, "4387224": 55, "4426752": 55, "4466279": 55, "4505807": 55, "4545335": 55, "4584863": 55, "4624390": 55, "4663918": 55, "4703446": 55, "4742973": 55, "4782501": 55, "4822029": 55, "4861556": 55, "4901084": 55, "4940612": 55, "4980140": 55, "5019667": 55, "5059195": 55, "43": [55, 56], "5098723": 55, "5138250": 55, "5177778": 55, "5217306": 55, "5256833": 55, "5296361": 55, "49": 55, "5335889": 55, "eco_max": 55, "nx": 55, "ny": 55, "markers": 55, "clearli": [55, 56], "textbook": 56, "supply_cost": 56, "unic": 56, "dataset": 56, "bonn": 56, "93": 56, "bordeaux": 56, "96": 56, "london": 56, "82": 56, "63": 56, "pari": 56, "83": 56, "85": 56, "rome": 56, "brussel": 56, "twarehous": 56, "twarehouse1": 56, "tstore": 56, "tstore1": 56, "store_": 56, "itervalu": 56, "portabl": 56, "python3": 56, "nb_store": 56, "wrow": 56, "nstore": 56, "113": 56, "warehouse_model": 56, "scheme": 56, "supply_london_store_1": 56, "supply_var": 56, "docplex_model1": 56, "rng": 56, "total_opening_cost": 56, "_get_supply_cost": 56, "nest": 56, "total_supply_cost": 56, "293": 56, "opening_cost_obj": 56, "supply_cost_obj": 56, "toolkit": 56, "draw": 56, "display_cost": 56, "supply_cost_by_warehous": 56, "wh_label": 56, "383": 56, "263": 56, "wonder": 56, "solve_lexicograph": 56, "hat": 56, "opening_first_then_suppli": 56, "opening1": 56, "supply1": 56, "352": 56, "472": 56, "supersed": 56, "supply_first_then_open": 56, "opening2": 56, "supply2": 56, "288": 56, "440": 56, "grater": 56, "display_pareto": 56, "cla": 56, "nb_re": 56, "opening_first": 56, "supply_first": 56, "scatterpoint": 56, "ncol": 56}, "objects": {"docplex.mp": [[6, 0, 0, "-", "basic"], [8, 0, 0, "-", "conflict_refiner"], [9, 0, 0, "-", "constants"], [10, 0, 0, "-", "constr"], [11, 0, 0, "-", "context"], [12, 0, 0, "-", "dvar"], [13, 0, 0, "-", "environment"], [14, 0, 0, "-", "error_handler"], [15, 0, 0, "-", "kpi"], [16, 0, 0, "-", "linear"], [17, 0, 0, "-", "model"], [18, 0, 0, "-", "model_reader"], [19, 0, 0, "-", "model_stats"], [21, 0, 0, "-", "priority"], [22, 0, 0, "-", "progress"], [23, 0, 0, "-", "publish"], [24, 0, 0, "-", "pwl"], [25, 0, 0, "-", "quad"], [26, 0, 0, "-", "relax_linear"], [27, 0, 0, "-", "relaxer"], [28, 0, 0, "-", "sdetails"], [29, 0, 0, "-", "solution"], [30, 0, 0, "-", "sosvarset"], [31, 0, 0, "-", "vartype"], [32, 0, 0, "-", "with_funcs"]], "docplex.mp.basic": [[6, 1, 1, "", "Expr"], [6, 1, 1, "", "IndexableObject"], [6, 1, 1, "", "ModelObject"], [6, 1, 1, "", "ModelingObjectBase"]], "docplex.mp.basic.Expr": [[6, 2, 1, "", "contains_var"], [6, 2, 1, "", "is_quad_expr"], [6, 2, 1, "", "number_of_variables"]], "docplex.mp.basic.IndexableObject": [[6, 2, 1, "", "is_generated"], [6, 3, 1, "", "model"]], "docplex.mp.basic.ModelingObjectBase": [[6, 2, 1, "", "has_name"], [6, 2, 1, "", "has_user_name"], [6, 3, 1, "", "model"], [6, 3, 1, "", "name"]], "docplex.mp.callbacks": [[7, 0, 0, "-", "cb_mixin"]], "docplex.mp.callbacks.cb_mixin": [[7, 1, 1, "", "ConstraintCallbackMixin"], [7, 1, 1, "", "ModelCallbackMixin"], [7, 4, 1, "", "print_called"]], "docplex.mp.callbacks.cb_mixin.ConstraintCallbackMixin": [[7, 2, 1, "", "get_cpx_unsatisfied_cts"], [7, 2, 1, "", "make_solution_from_watched"], [7, 2, 1, "", "register_watched_var"], [7, 2, 1, "", "register_watched_vars"]], "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin": [[7, 2, 1, "", "index_to_var"], [7, 2, 1, "", "linear_ct_to_cplex"], [7, 2, 1, "", "make_complete_solution"], [7, 2, 1, "", "make_solution"], [7, 2, 1, "", "make_solution_from_vars"], [7, 3, 1, "", "model"]], "docplex.mp.conflict_refiner": [[8, 1, 1, "", "ConflictRefiner"], [8, 1, 1, "", "ConflictRefinerResult"], [8, 1, 1, "", "ConstraintsGroup"], [8, 5, 1, "", "TConflictConstraint"], [8, 1, 1, "", "VarLbConstraintWrapper"], [8, 1, 1, "", "VarUbConstraintWrapper"]], "docplex.mp.conflict_refiner.ConflictRefiner": [[8, 2, 1, "", "display_conflicts"], [8, 2, 1, "", "refine_conflict"], [8, 2, 1, "", "var_bounds"]], "docplex.mp.conflict_refiner.ConflictRefinerResult": [[8, 2, 1, "", "display"], [8, 2, 1, "", "display_stats"], [8, 2, 1, "", "iter_conflicts"], [8, 3, 1, "", "number_of_conflicts"], [8, 2, 1, "", "print_information"], [8, 3, 1, "", "refined_by"]], "docplex.mp.conflict_refiner.ConstraintsGroup": [[8, 2, 1, "", "from_var"]], "docplex.mp.constants": [[9, 1, 1, "", "BasisStatus"], [9, 1, 1, "", "ComparisonType"], [9, 1, 1, "", "ConflictStatus"], [9, 1, 1, "", "CplexScope"], [9, 1, 1, "", "EffortLevel"], [9, 1, 1, "", "ObjectiveSense"], [9, 1, 1, "", "QualityMetric"], [9, 1, 1, "", "RelaxationMode"], [9, 1, 1, "", "SOSType"], [9, 1, 1, "", "SolveAttribute"], [9, 1, 1, "", "UpdateEvent"], [9, 1, 1, "", "VarBoundType"], [9, 1, 1, "", "WriteLevel"]], "docplex.mp.constants.ComparisonType": [[9, 3, 1, "", "operator_symbol"]], "docplex.mp.constants.ObjectiveSense": [[9, 2, 1, "", "is_maximize"], [9, 2, 1, "", "is_minimize"], [9, 2, 1, "", "parse"], [9, 3, 1, "", "short_name"], [9, 3, 1, "", "verb"]], "docplex.mp.constr": [[10, 1, 1, "", "AbstractConstraint"], [10, 1, 1, "", "BinaryConstraint"], [10, 1, 1, "", "EquivalenceConstraint"], [10, 1, 1, "", "IfThenConstraint"], [10, 1, 1, "", "IndicatorConstraint"], [10, 1, 1, "", "LinearConstraint"], [10, 1, 1, "", "LogicalConstraint"], [10, 1, 1, "", "NotEqualConstraint"], [10, 1, 1, "", "PwlConstraint"], [10, 1, 1, "", "QuadraticConstraint"], [10, 1, 1, "", "RangeConstraint"]], "docplex.mp.constr.AbstractConstraint": [[10, 2, 1, "", "is_added"], [10, 2, 1, "", "set_mandatory"]], "docplex.mp.constr.BinaryConstraint": [[10, 2, 1, "", "get_left_expr"], [10, 2, 1, "", "get_right_expr"], [10, 2, 1, "", "iter_variables"], [10, 2, 1, "", "to_string"], [10, 3, 1, "", "type"]], "docplex.mp.constr.IfThenConstraint": [[10, 2, 1, "", "to_string"]], "docplex.mp.constr.IndicatorConstraint": [[10, 2, 1, "", "invalidate"]], "docplex.mp.constr.LinearConstraint": [[10, 3, 1, "", "basis_status"], [10, 3, 1, "", "benders_annotation"], [10, 3, 1, "", "dual_value"], [10, 2, 1, "", "eq"], [10, 2, 1, "", "ge"], [10, 2, 1, "", "le"], [10, 3, 1, "", "left_expr"], [10, 3, 1, "", "lhs"], [10, 3, 1, "", "rhs"], [10, 3, 1, "", "right_expr"], [10, 3, 1, "", "sense"], [10, 3, 1, "", "slack_value"], [10, 2, 1, "", "to_string"], [10, 3, 1, "", "type"]], "docplex.mp.constr.LogicalConstraint": [[10, 3, 1, "", "benders_annotation"], [10, 2, 1, "", "to_string"]], "docplex.mp.constr.NotEqualConstraint": [[10, 2, 1, "", "to_string"]], "docplex.mp.constr.PwlConstraint": [[10, 3, 1, "", "expr"], [10, 2, 1, "", "iter_variables"], [10, 3, 1, "", "pwl_func"], [10, 3, 1, "", "y"]], "docplex.mp.constr.QuadraticConstraint": [[10, 3, 1, "", "benders_annotation"], [10, 3, 1, "", "sense"], [10, 3, 1, "", "slack_value"], [10, 3, 1, "", "type"]], "docplex.mp.constr.RangeConstraint": [[10, 3, 1, "", "basis_status"], [10, 3, 1, "", "benders_annotation"], [10, 3, 1, "", "bounds"], [10, 3, 1, "", "dual_value"], [10, 3, 1, "", "expr"], [10, 2, 1, "", "iter_variables"], [10, 3, 1, "", "lb"], [10, 3, 1, "", "slack_value"], [10, 3, 1, "", "ub"]], "docplex.mp.context": [[11, 1, 1, "", "BaseContext"], [11, 1, 1, "", "Context"], [11, 1, 1, "", "ContextOverride"], [11, 6, 1, "", "InvalidSettingsFileError"], [11, 1, 1, "", "SolverContext"]], "docplex.mp.context.Context.context.solver.auto_publish": [[11, 5, 1, "", "kpis_output_field_name"], [11, 5, 1, "", "kpis_output_field_value"]], "docplex.mp.context.Context": [[11, 2, 1, "", "copy"], [11, 5, 1, "", "cplex_parameters"], [11, 2, 1, "", "make_default_context"], [11, 2, 1, "", "read_settings"], [11, 2, 1, "", "update"]], "docplex.mp.context.Context.solver": [[11, 5, 1, "", "auto_publish"], [11, 5, 1, "", "log_output"]], "docplex.mp.context.Context.solver.auto_publish": [[11, 5, 1, "", "kpis_output"], [11, 5, 1, "", "result_output"], [11, 5, 1, "", "solve_details"]], "docplex.mp.context.Context.solver.kpi_reporting": [[11, 5, 1, "", "filter_level"]], "docplex.mp.dvar": [[12, 1, 1, "", "Var"]], "docplex.mp.dvar.Var": [[12, 3, 1, "", "basis_status"], [12, 3, 1, "", "benders_annotation"], [12, 2, 1, "", "equals"], [12, 2, 1, "", "get_key"], [12, 2, 1, "", "is_binary"], [12, 2, 1, "", "is_continuous"], [12, 2, 1, "", "is_discrete"], [12, 2, 1, "", "is_integer"], [12, 2, 1, "", "iter_constraints"], [12, 3, 1, "", "lb"], [12, 3, 1, "", "name"], [12, 3, 1, "", "reduced_cost"], [12, 3, 1, "", "solution_value"], [12, 3, 1, "", "sv"], [12, 2, 1, "", "to_bool"], [12, 3, 1, "", "ub"], [12, 3, 1, "", "vartype"]], "docplex.mp.environment": [[13, 1, 1, "", "Environment"], [13, 6, 1, "", "UnsupportedPlatformError"]], "docplex.mp.environment.Environment": [[13, 3, 1, "", "cplex_location"], [13, 2, 1, "", "get_cplex_module"], [13, 3, 1, "", "has_cplex"], [13, 3, 1, "", "has_matplotlib"], [13, 3, 1, "", "has_numpy"], [13, 3, 1, "", "has_pandas"], [13, 2, 1, "", "is_64bit"], [13, 3, 1, "", "python_version"]], "docplex.mp.error_handler": [[14, 1, 1, "", "DefaultErrorHandler"], [14, 1, 1, "", "InfoLevel"]], "docplex.mp.kpi": [[15, 1, 1, "", "DecisionKPI"], [15, 1, 1, "", "FunctionalKPI"], [15, 1, 1, "", "KPI"]], "docplex.mp.kpi.DecisionKPI": [[15, 2, 1, "", "compute"], [15, 2, 1, "", "get_model"], [15, 2, 1, "", "is_decision_expression"]], "docplex.mp.kpi.FunctionalKPI": [[15, 2, 1, "", "get_model"], [15, 2, 1, "", "is_decision_expression"]], "docplex.mp.kpi.KPI": [[15, 2, 1, "", "get_model"], [15, 2, 1, "", "is_decision_expression"]], "docplex.mp.linear": [[16, 1, 1, "", "AbstractLinearExpr"], [16, 1, 1, "", "ConstantExpr"], [16, 6, 1, "", "DOCplexQuadraticArithException"], [16, 1, 1, "", "LinearExpr"], [16, 1, 1, "", "MonomialExpr"], [16, 1, 1, "", "ZeroExpr"]], "docplex.mp.linear.AbstractLinearExpr": [[16, 2, 1, "", "get_coef"]], "docplex.mp.linear.ConstantExpr": [[16, 2, 1, "", "contains_var"], [16, 2, 1, "", "iter_variables"], [16, 2, 1, "", "number_of_variables"]], "docplex.mp.linear.LinearExpr": [[16, 2, 1, "", "add"], [16, 2, 1, "", "add_term"], [16, 2, 1, "", "clone"], [16, 3, 1, "", "constant"], [16, 2, 1, "", "contains_var"], [16, 2, 1, "", "divide"], [16, 2, 1, "", "equals"], [16, 2, 1, "", "equals_constant"], [16, 2, 1, "", "is_constant"], [16, 2, 1, "", "is_discrete"], [16, 2, 1, "", "iter_terms"], [16, 2, 1, "", "multiply"], [16, 2, 1, "", "negate"], [16, 2, 1, "", "number_of_variables"], [16, 2, 1, "", "plus"], [16, 2, 1, "", "quotient"], [16, 2, 1, "", "remove_term"], [16, 3, 1, "", "solution_value"], [16, 2, 1, "", "subtract"], [16, 2, 1, "", "times"]], "docplex.mp.linear.MonomialExpr": [[16, 2, 1, "", "contains_var"], [16, 2, 1, "", "number_of_variables"]], "docplex.mp.linear.ZeroExpr": [[16, 2, 1, "", "contains_var"], [16, 2, 1, "", "number_of_variables"]], "docplex.mp.model": [[17, 1, 1, "", "Model"]], "docplex.mp.model.Model": [[17, 2, 1, "", "abs"], [17, 2, 1, "", "add_constraint"], [17, 2, 1, "", "add_constraint_"], [17, 2, 1, "", "add_constraints"], [17, 2, 1, "", "add_constraints_"], [17, 2, 1, "", "add_equivalence"], [17, 2, 1, "", "add_equivalence_constraints"], [17, 2, 1, "", "add_equivalence_constraints_"], [17, 2, 1, "", "add_equivalences"], [17, 2, 1, "", "add_if_then"], [17, 2, 1, "", "add_indicator"], [17, 2, 1, "", "add_indicator_constraints"], [17, 2, 1, "", "add_indicator_constraints_"], [17, 2, 1, "", "add_indicators"], [17, 2, 1, "", "add_kpi"], [17, 2, 1, "", "add_lazy_constraint"], [17, 2, 1, "", "add_lazy_constraints"], [17, 2, 1, "", "add_mip_start"], [17, 2, 1, "", "add_progress_listener"], [17, 2, 1, "", "add_quadratic_constraints"], [17, 2, 1, "", "add_range"], [17, 2, 1, "", "add_sos"], [17, 2, 1, "", "add_sos1"], [17, 2, 1, "", "add_sos2"], [17, 2, 1, "", "add_user_cut_constraint"], [17, 2, 1, "", "add_user_cut_constraints"], [17, 2, 1, "", "binary_var"], [17, 2, 1, "", "binary_var_cube"], [17, 2, 1, "", "binary_var_dict"], [17, 2, 1, "", "binary_var_list"], [17, 2, 1, "", "binary_var_matrix"], [17, 3, 1, "", "binary_vartype"], [17, 3, 1, "", "blended_objective_values"], [17, 2, 1, "", "build_multiobj_paramsets"], [17, 2, 1, "", "change_var_lower_bounds"], [17, 2, 1, "", "change_var_types"], [17, 2, 1, "", "change_var_upper_bounds"], [17, 2, 1, "", "clear"], [17, 2, 1, "", "clear_constraints"], [17, 2, 1, "", "clear_kpis"], [17, 2, 1, "", "clear_lazy_constraints"], [17, 2, 1, "", "clear_mip_starts"], [17, 2, 1, "", "clear_multi_objective"], [17, 2, 1, "", "clear_progress_listeners"], [17, 2, 1, "", "clear_sos"], [17, 2, 1, "", "clear_user_cut_constraints"], [17, 2, 1, "", "clone"], [17, 2, 1, "", "continuous_var"], [17, 2, 1, "", "continuous_var_cube"], [17, 2, 1, "", "continuous_var_dict"], [17, 2, 1, "", "continuous_var_list"], [17, 2, 1, "", "continuous_var_matrix"], [17, 3, 1, "", "continuous_vartype"], [17, 3, 1, "", "cplex"], [17, 2, 1, "", "create_parameter_sets"], [17, 2, 1, "", "dot"], [17, 2, 1, "", "dotf"], [17, 2, 1, "", "dual_values"], [17, 2, 1, "", "dump_as_sav"], [17, 2, 1, "", "end"], [17, 2, 1, "", "eq_constraint"], [17, 2, 1, "", "equivalence_constraint"], [17, 2, 1, "", "export_as_lp"], [17, 2, 1, "", "export_as_lp_string"], [17, 2, 1, "", "export_as_mps"], [17, 2, 1, "", "export_as_mps_string"], [17, 2, 1, "", "export_as_sav"], [17, 2, 1, "", "export_as_sav_string"], [17, 2, 1, "", "export_as_savgz"], [17, 2, 1, "", "export_priority_order_file"], [17, 2, 1, "", "export_to_stream"], [17, 2, 1, "", "find_matching_linear_constraints"], [17, 2, 1, "", "find_matching_quadratic_constraints"], [17, 2, 1, "", "find_matching_vars"], [17, 2, 1, "", "find_re_matching_vars"], [17, 3, 1, "", "float_precision"], [17, 2, 1, "", "ge_constraint"], [17, 2, 1, "", "get_constraint_by_index"], [17, 2, 1, "", "get_constraint_by_name"], [17, 2, 1, "", "get_cplex"], [17, 2, 1, "", "get_cuts"], [17, 2, 1, "", "get_num_cuts"], [17, 2, 1, "", "get_objective_expr"], [17, 2, 1, "", "get_parameter_from_id"], [17, 2, 1, "", "get_quadratic_constraint_by_index"], [17, 2, 1, "", "get_solve_status"], [17, 2, 1, "", "get_time_limit"], [17, 2, 1, "", "get_var_by_name"], [17, 2, 1, "", "has_basis"], [17, 2, 1, "", "has_multi_objective"], [17, 2, 1, "", "if_then"], [17, 3, 1, "", "ignore_names"], [17, 2, 1, "", "import_solution"], [17, 2, 1, "", "indicator_constraint"], [17, 3, 1, "", "infinity"], [17, 2, 1, "", "init_numpy"], [17, 2, 1, "", "integer_var"], [17, 2, 1, "", "integer_var_cube"], [17, 2, 1, "", "integer_var_dict"], [17, 2, 1, "", "integer_var_list"], [17, 2, 1, "", "integer_var_matrix"], [17, 3, 1, "", "integer_vartype"], [17, 2, 1, "", "is_maximized"], [17, 2, 1, "", "is_minimized"], [17, 2, 1, "", "is_optimized"], [17, 2, 1, "", "iter_binary_constraints"], [17, 2, 1, "", "iter_binary_vars"], [17, 2, 1, "", "iter_constraints"], [17, 2, 1, "", "iter_continuous_vars"], [17, 2, 1, "", "iter_equivalence_constraints"], [17, 2, 1, "", "iter_indicator_constraints"], [17, 2, 1, "", "iter_integer_vars"], [17, 2, 1, "", "iter_kpis"], [17, 2, 1, "", "iter_lazy_constraints"], [17, 2, 1, "", "iter_linear_constraints"], [17, 2, 1, "", "iter_mip_starts"], [17, 2, 1, "", "iter_progress_listeners"], [17, 2, 1, "", "iter_pwl_constraints"], [17, 2, 1, "", "iter_pwl_functions"], [17, 2, 1, "", "iter_quadratic_constraints"], [17, 2, 1, "", "iter_range_constraints"], [17, 2, 1, "", "iter_semicontinuous_vars"], [17, 2, 1, "", "iter_semiinteger_vars"], [17, 2, 1, "", "iter_sos"], [17, 2, 1, "", "iter_sos1"], [17, 2, 1, "", "iter_sos2"], [17, 2, 1, "", "iter_user_cut_constraints"], [17, 2, 1, "", "iter_variables"], [17, 2, 1, "", "kpi_by_name"], [17, 2, 1, "", "kpi_value_by_name"], [17, 2, 1, "", "kpis_as_dict"], [17, 2, 1, "", "le_constraint"], [17, 2, 1, "", "linear_constraint"], [17, 2, 1, "", "linear_constraint_basis_statuses"], [17, 2, 1, "", "linear_expr"], [17, 2, 1, "", "logical_and"], [17, 2, 1, "", "logical_not"], [17, 2, 1, "", "logical_or"], [17, 3, 1, "", "lp_line_length"], [17, 3, 1, "", "lp_string"], [17, 2, 1, "", "max"], [17, 2, 1, "", "maximize"], [17, 2, 1, "", "maximize_static_lex"], [17, 2, 1, "", "min"], [17, 2, 1, "", "minimize"], [17, 2, 1, "", "minimize_static_lex"], [17, 3, 1, "", "mip_starts"], [17, 3, 1, "", "multi_objective_values"], [17, 3, 1, "", "name"], [17, 3, 1, "", "number_of_binary_variables"], [17, 3, 1, "", "number_of_constraints"], [17, 3, 1, "", "number_of_continuous_variables"], [17, 3, 1, "", "number_of_equivalence_constraints"], [17, 3, 1, "", "number_of_indicator_constraints"], [17, 3, 1, "", "number_of_integer_variables"], [17, 3, 1, "", "number_of_lazy_constraints"], [17, 3, 1, "", "number_of_linear_constraints"], [17, 3, 1, "", "number_of_mip_starts"], [17, 3, 1, "", "number_of_progress_listeners"], [17, 3, 1, "", "number_of_pwl_constraints"], [17, 3, 1, "", "number_of_quadratic_constraints"], [17, 3, 1, "", "number_of_range_constraints"], [17, 3, 1, "", "number_of_semicontinuous_variables"], [17, 3, 1, "", "number_of_semiinteger_variables"], [17, 3, 1, "", "number_of_sos"], [17, 3, 1, "", "number_of_sos1"], [17, 3, 1, "", "number_of_sos2"], [17, 3, 1, "", "number_of_user_constraints"], [17, 3, 1, "", "number_of_user_cut_constraints"], [17, 3, 1, "", "number_of_variables"], [17, 2, 1, "", "objective_coef"], [17, 3, 1, "", "objective_expr"], [17, 3, 1, "", "objective_sense"], [17, 3, 1, "", "objective_value"], [17, 3, 1, "", "parameters"], [17, 2, 1, "", "piecewise"], [17, 2, 1, "", "piecewise_as_slopes"], [17, 2, 1, "", "populate"], [17, 2, 1, "", "populate_solution_pool"], [17, 2, 1, "", "print_information"], [17, 2, 1, "", "print_solution"], [17, 3, 1, "", "problem_type"], [17, 2, 1, "", "quad_expr"], [17, 2, 1, "", "quadratic_dual_slacks"], [17, 3, 1, "", "quality_metrics"], [17, 2, 1, "", "range_constraint"], [17, 2, 1, "", "read_basis_file"], [17, 2, 1, "", "read_mip_starts"], [17, 2, 1, "", "read_priority_order_file"], [17, 2, 1, "", "reduced_costs"], [17, 2, 1, "", "remove"], [17, 2, 1, "", "remove_constraint"], [17, 2, 1, "", "remove_constraints"], [17, 2, 1, "", "remove_kpi"], [17, 2, 1, "", "remove_objective"], [17, 2, 1, "", "remove_progress_listener"], [17, 2, 1, "", "report"], [17, 2, 1, "", "report_kpis"], [17, 2, 1, "", "restore_numpy"], [17, 3, 1, "", "round_solution"], [17, 2, 1, "", "scal_prod"], [17, 2, 1, "", "scal_prod_f"], [17, 2, 1, "", "scal_prod_vars_all_different"], [17, 2, 1, "", "semicontinuous_var"], [17, 2, 1, "", "semicontinuous_var_dict"], [17, 2, 1, "", "semicontinuous_var_list"], [17, 2, 1, "", "semicontinuous_var_matrix"], [17, 3, 1, "", "semicontinuous_vartype"], [17, 2, 1, "", "semiinteger_var"], [17, 2, 1, "", "semiinteger_var_dict"], [17, 2, 1, "", "semiinteger_var_list"], [17, 2, 1, "", "semiinteger_var_matrix"], [17, 3, 1, "", "semiinteger_vartype"], [17, 2, 1, "", "set_lex_multi_objective"], [17, 2, 1, "", "set_lp_start_basis"], [17, 2, 1, "", "set_multi_objective"], [17, 2, 1, "", "set_multi_objective_abstols"], [17, 2, 1, "", "set_multi_objective_exprs"], [17, 2, 1, "", "set_multi_objective_reltols"], [17, 2, 1, "", "set_objective"], [17, 2, 1, "", "set_time_limit"], [17, 2, 1, "", "slack_values"], [17, 3, 1, "", "solution"], [17, 2, 1, "", "solve"], [17, 3, 1, "", "solve_details"], [17, 3, 1, "", "solve_status"], [17, 2, 1, "", "solve_with_goals"], [17, 3, 1, "", "statistics"], [17, 3, 1, "", "str_use_space"], [17, 2, 1, "", "sum"], [17, 2, 1, "", "sum_squares"], [17, 2, 1, "", "sum_vars"], [17, 2, 1, "", "sum_vars_all_different"], [17, 2, 1, "", "sums"], [17, 2, 1, "", "sumsq"], [17, 3, 1, "", "time_limit"], [17, 2, 1, "", "var"], [17, 2, 1, "", "var_basis_statuses"], [17, 2, 1, "", "var_hypercube"]], "docplex.mp.model_reader": [[18, 1, 1, "", "ModelReader"], [18, 6, 1, "", "ModelReaderError"], [18, 4, 1, "", "read_model"]], "docplex.mp.model_reader.ModelReader": [[18, 2, 1, "", "read"], [18, 2, 1, "", "read_model"], [18, 2, 1, "", "read_ops_file"], [18, 2, 1, "", "read_prm"]], "docplex.mp.model_stats": [[19, 1, 1, "", "ModelStatistics"]], "docplex.mp.model_stats.ModelStatistics": [[19, 3, 1, "", "number_of_binary_variables"], [19, 3, 1, "", "number_of_continuous_variables"], [19, 3, 1, "", "number_of_eq_constraints"], [19, 3, 1, "", "number_of_equivalence_constraints"], [19, 3, 1, "", "number_of_ge_constraints"], [19, 3, 1, "", "number_of_indicator_constraints"], [19, 3, 1, "", "number_of_integer_variables"], [19, 3, 1, "", "number_of_le_constraints"], [19, 3, 1, "", "number_of_linear_constraints"], [19, 3, 1, "", "number_of_quadratic_constraints"], [19, 3, 1, "", "number_of_range_constraints"], [19, 3, 1, "", "number_of_semicontinuous_variables"], [19, 3, 1, "", "number_of_semiinteger_variables"], [19, 3, 1, "", "number_of_variables"], [19, 2, 1, "", "print_information"]], "docplex.mp.params": [[20, 0, 0, "-", "parameters"]], "docplex.mp.params.parameters": [[20, 1, 1, "", "BoolParameter"], [20, 1, 1, "", "IntParameter"], [20, 1, 1, "", "NumParameter"], [20, 1, 1, "", "Parameter"], [20, 1, 1, "", "ParameterGroup"], [20, 1, 1, "", "PositiveIntParameter"], [20, 1, 1, "", "RootParameterGroup"], [20, 1, 1, "", "StrParameter"]], "docplex.mp.params.parameters.BoolParameter": [[20, 2, 1, "", "accept_value"]], "docplex.mp.params.parameters.IntParameter": [[20, 2, 1, "", "accept_value"]], "docplex.mp.params.parameters.NumParameter": [[20, 2, 1, "", "accept_value"]], "docplex.mp.params.parameters.Parameter": [[20, 2, 1, "", "accept_value"], [20, 3, 1, "", "cpx_id"], [20, 3, 1, "", "cpx_name"], [20, 3, 1, "", "default_value"], [20, 3, 1, "", "description"], [20, 2, 1, "", "get"], [20, 2, 1, "", "is_default"], [20, 2, 1, "", "is_nondefault"], [20, 3, 1, "", "qualified_name"], [20, 2, 1, "", "reset"], [20, 2, 1, "", "set"], [20, 2, 1, "", "to_string"]], "docplex.mp.params.parameters.ParameterGroup": [[20, 2, 1, "", "clone"], [20, 2, 1, "", "generate_nondefault_params"], [20, 2, 1, "", "generate_params"], [20, 2, 1, "", "is_root"], [20, 2, 1, "", "iter_params"], [20, 3, 1, "", "name"], [20, 3, 1, "", "number_of_params"], [20, 3, 1, "", "number_of_subgroups"], [20, 3, 1, "", "parent_group"], [20, 2, 1, "", "qualified_name"], [20, 2, 1, "", "reset"], [20, 2, 1, "", "total_number_of_params"]], "docplex.mp.params.parameters.RootParameterGroup": [[20, 2, 1, "", "export_prm"], [20, 2, 1, "", "export_prm_to_string"], [20, 2, 1, "", "is_root"], [20, 2, 1, "", "print_info_to_stream"], [20, 2, 1, "", "print_info_to_string"], [20, 2, 1, "", "qualified_name"]], "docplex.mp.params.parameters.StrParameter": [[20, 2, 1, "", "accept_value"], [20, 2, 1, "", "to_string"]], "docplex.mp.priority": [[21, 1, 1, "", "Priority"]], "docplex.mp.priority.Priority": [[21, 2, 1, "", "parse"]], "docplex.mp.progress": [[22, 1, 1, "", "FunctionalSolutionListener"], [22, 1, 1, "", "KpiListener"], [22, 1, 1, "", "KpiPrinter"], [22, 1, 1, "", "ProgressClock"], [22, 1, 1, "", "ProgressData"], [22, 1, 1, "", "ProgressDataRecorder"], [22, 1, 1, "", "ProgressListener"], [22, 1, 1, "", "SolutionListener"], [22, 1, 1, "", "SolutionRecorder"], [22, 1, 1, "", "TextProgressListener"]], "docplex.mp.progress.FunctionalSolutionListener": [[22, 2, 1, "", "notify_solution"]], "docplex.mp.progress.KpiListener": [[22, 2, 1, "", "notify_solution"], [22, 2, 1, "", "publish"]], "docplex.mp.progress.KpiPrinter": [[22, 2, 1, "", "publish"]], "docplex.mp.progress.ProgressData": [[22, 5, 1, "", "best_bound"], [22, 5, 1, "", "current_nb_iterations"], [22, 5, 1, "", "current_nb_nodes"], [22, 5, 1, "", "current_objective"], [22, 5, 1, "", "det_time"], [22, 5, 1, "", "has_incumbent"], [22, 5, 1, "", "mip_gap"], [22, 5, 1, "", "remaining_nb_nodes"], [22, 5, 1, "", "time"]], "docplex.mp.progress.ProgressDataRecorder": [[22, 3, 1, "", "iter_recorded"], [22, 2, 1, "", "notify_progress"], [22, 2, 1, "", "notify_start"], [22, 3, 1, "", "recorded"]], "docplex.mp.progress.ProgressListener": [[22, 2, 1, "", "abort"], [22, 3, 1, "", "clock"], [22, 3, 1, "", "current_progress_data"], [22, 2, 1, "", "notify_end"], [22, 2, 1, "", "notify_progress"], [22, 2, 1, "", "notify_solution"], [22, 2, 1, "", "notify_start"]], "docplex.mp.progress.SolutionListener": [[22, 2, 1, "", "notify_solution"], [22, 2, 1, "", "notify_start"]], "docplex.mp.progress.SolutionRecorder": [[22, 2, 1, "", "iter_solutions"], [22, 2, 1, "", "notify_solution"], [22, 2, 1, "", "notify_start"], [22, 3, 1, "", "number_of_solutions"]], "docplex.mp.progress.TextProgressListener": [[22, 2, 1, "", "notify_progress"], [22, 2, 1, "", "notify_start"]], "docplex.mp.publish": [[23, 1, 1, "", "PublishResultAsDf"]], "docplex.mp.publish.PublishResultAsDf": [[23, 2, 1, "", "write_output_table"]], "docplex.mp.pwl": [[24, 1, 1, "", "PwlFunction"]], "docplex.mp.pwl.PwlFunction": [[24, 2, 1, "", "add"], [24, 2, 1, "", "clone"], [24, 2, 1, "", "divide"], [24, 2, 1, "", "evaluate"], [24, 2, 1, "", "multiply"], [24, 2, 1, "", "plot"], [24, 2, 1, "", "subtract"], [24, 2, 1, "", "translate"]], "docplex.mp.quad": [[25, 1, 1, "", "QuadExpr"]], "docplex.mp.quad.QuadExpr": [[25, 2, 1, "", "clone"], [25, 3, 1, "", "constant"], [25, 2, 1, "", "contains_var"], [25, 2, 1, "", "get_quadratic_coefficient"], [25, 2, 1, "", "has_quadratic_term"], [25, 2, 1, "", "is_quad_expr"], [25, 2, 1, "", "is_separable"], [25, 2, 1, "", "iter_quad_triplets"], [25, 2, 1, "", "iter_terms"], [25, 3, 1, "", "linear_part"], [25, 3, 1, "", "number_of_quadratic_terms"]], "docplex.mp.relax_linear": [[26, 1, 1, "", "LinearRelaxer"]], "docplex.mp.relax_linear.LinearRelaxer": [[26, 2, 1, "", "linear_relaxation"]], "docplex.mp.relaxer": [[27, 1, 1, "", "FunctionalPrioritizer"], [27, 1, 1, "", "MappingPrioritizer"], [27, 1, 1, "", "MatchNamePrioritizer"], [27, 1, 1, "", "NamedPrioritizer"], [27, 1, 1, "", "Prioritizer"], [27, 1, 1, "", "Relaxer"], [27, 1, 1, "", "TOutputTables"], [27, 1, 1, "", "UniformPrioritizer"]], "docplex.mp.relaxer.MatchNamePrioritizer": [[27, 2, 1, "", "get_priority"]], "docplex.mp.relaxer.Relaxer": [[27, 2, 1, "", "get_relaxation"], [27, 2, 1, "", "is_relaxed"], [27, 2, 1, "", "iter_relaxations"], [27, 3, 1, "", "number_of_relaxations"], [27, 2, 1, "", "relax"], [27, 2, 1, "", "relaxations"], [27, 3, 1, "", "relaxed_objective_value"]], "docplex.mp.relaxer.TOutputTables": [[27, 5, 1, "", "Amount"], [27, 5, 1, "", "Constraint"], [27, 5, 1, "", "Priority"]], "docplex.mp.sdetails": [[28, 1, 1, "", "SolveDetails"]], "docplex.mp.sdetails.SolveDetails": [[28, 3, 1, "", "best_bound"], [28, 3, 1, "", "columns"], [28, 3, 1, "", "deterministic_time"], [28, 3, 1, "", "dettime"], [28, 3, 1, "", "gap"], [28, 2, 1, "", "has_hit_limit"], [28, 3, 1, "", "mip_relative_gap"], [28, 3, 1, "", "nb_iterations"], [28, 3, 1, "", "nb_linear_nonzeros"], [28, 3, 1, "", "nb_nodes_processed"], [28, 3, 1, "", "problem_type"], [28, 3, 1, "", "status"], [28, 3, 1, "", "status_code"], [28, 3, 1, "", "time"]], "docplex.mp.solution": [[29, 1, 1, "", "SolutionPool"], [29, 1, 1, "", "SolveSolution"]], "docplex.mp.solution.SolutionPool": [[29, 2, 1, "", "describe_objectives"], [29, 2, 1, "", "export_as_sol"], [29, 3, 1, "", "mean_objective_value"], [29, 3, 1, "", "size"], [29, 3, 1, "", "stats"]], "docplex.mp.solution.SolveSolution": [[29, 2, 1, "", "add_var_value"], [29, 2, 1, "", "as_df"], [29, 2, 1, "", "check_as_mip_start"], [29, 2, 1, "", "clear"], [29, 2, 1, "", "contains"], [29, 2, 1, "", "export"], [29, 2, 1, "", "export_as_json_string"], [29, 2, 1, "", "export_as_mst"], [29, 2, 1, "", "export_as_sol"], [29, 2, 1, "", "from_file"], [29, 2, 1, "", "get_blended_objective_value_by_priority"], [29, 2, 1, "", "get_cuts"], [29, 2, 1, "", "get_dual_values"], [29, 2, 1, "", "get_num_cuts"], [29, 2, 1, "", "get_objective_value"], [29, 2, 1, "", "get_reduced_costs"], [29, 2, 1, "", "get_sensitivity"], [29, 2, 1, "", "get_slacks"], [29, 2, 1, "", "get_status"], [29, 2, 1, "", "get_value"], [29, 2, 1, "", "get_value_df"], [29, 2, 1, "", "get_value_dict"], [29, 2, 1, "", "get_value_list"], [29, 2, 1, "", "get_values"], [29, 2, 1, "", "has_objective"], [29, 2, 1, "", "is_empty"], [29, 2, 1, "", "is_feasible_solution"], [29, 2, 1, "", "is_valid_solution"], [29, 2, 1, "", "iter_var_values"], [29, 2, 1, "", "iter_variables"], [29, 2, 1, "", "kpi_value_by_name"], [29, 3, 1, "", "model"], [29, 3, 1, "", "multi_objective_values"], [29, 3, 1, "", "name"], [29, 3, 1, "", "number_of_var_values"], [29, 3, 1, "", "objective_value"], [29, 2, 1, "", "print_mst"], [29, 2, 1, "", "set_objective_value"], [29, 3, 1, "", "size"], [29, 2, 1, "", "slack_value"], [29, 3, 1, "", "solve_details"], [29, 3, 1, "", "solved_by"], [29, 2, 1, "", "update"]], "docplex.mp.sosvarset": [[30, 1, 1, "", "SOSVariableSet"]], "docplex.mp.sosvarset.SOSVariableSet": [[30, 3, 1, "", "benders_annotation"], [30, 2, 1, "", "iter_variables"], [30, 3, 1, "", "sos_type"], [30, 2, 1, "", "to_string"]], "docplex.mp.vartype": [[31, 1, 1, "", "BinaryVarType"], [31, 1, 1, "", "ContinuousVarType"], [31, 1, 1, "", "IntegerVarType"], [31, 1, 1, "", "SemiContinuousVarType"], [31, 1, 1, "", "SemiIntegerVarType"], [31, 1, 1, "", "VarType"]], "docplex.mp.vartype.BinaryVarType": [[31, 2, 1, "", "is_discrete"]], "docplex.mp.vartype.ContinuousVarType": [[31, 2, 1, "", "is_discrete"]], "docplex.mp.vartype.IntegerVarType": [[31, 2, 1, "", "is_discrete"]], "docplex.mp.vartype.SemiContinuousVarType": [[31, 3, 1, "", "default_lb"], [31, 2, 1, "", "is_discrete"]], "docplex.mp.vartype.SemiIntegerVarType": [[31, 3, 1, "", "default_lb"], [31, 2, 1, "", "is_discrete"]], "docplex.mp.vartype.VarType": [[31, 3, 1, "", "cplex_typecode"], [31, 3, 1, "", "default_lb"], [31, 3, 1, "", "default_ub"], [31, 2, 1, "", "is_discrete"], [31, 3, 1, "", "short_name"], [31, 2, 1, "", "to_string"]], "docplex.mp.with_funcs": [[32, 4, 1, "", "model_objective"], [32, 4, 1, "", "model_parameters"], [32, 4, 1, "", "model_solvefixed"]], "docplex.util": [[33, 0, 0, "-", "cli"], [34, 0, 0, "-", "csv_utils"], [35, 0, 0, "-", "environment"]], "docplex.util.csv_utils": [[34, 4, 1, "", "encode_csv_string"], [34, 4, 1, "", "write_table_as_csv"]], "docplex.util.environment": [[35, 1, 1, "", "AbstractLocalEnvironment"], [35, 1, 1, "", "Environment"], [35, 1, 1, "", "LocalEnvironment"], [35, 6, 1, "", "NotAvailableError"], [35, 1, 1, "", "OutputAttachmentTransaction"], [35, 1, 1, "", "OverrideEnvironment"], [35, 1, 1, "", "SolveDetailsFilter"], [35, 4, 1, "", "add_abort_callback"], [35, 4, 1, "", "default_solution_storage_handler"], [35, 4, 1, "", "get_available_core_count"], [35, 4, 1, "", "get_environment"], [35, 4, 1, "", "get_input_stream"], [35, 4, 1, "", "get_output_stream"], [35, 4, 1, "", "get_parameter"], [35, 4, 1, "", "make_attachment_name"], [35, 4, 1, "", "maketrans"], [35, 4, 1, "", "read_df"], [35, 4, 1, "", "remove_abort_callback"], [35, 4, 1, "", "set_output_attachment"], [35, 4, 1, "", "set_output_attachments"], [35, 4, 1, "", "translate"], [35, 4, 1, "", "update_solve_details"], [35, 4, 1, "", "write_df"]], "docplex.util.environment.AbstractLocalEnvironment": [[35, 2, 1, "", "get_available_core_count"], [35, 2, 1, "", "get_input_stream"], [35, 2, 1, "", "get_output_stream"], [35, 2, 1, "", "get_parameter"], [35, 2, 1, "", "get_parameters"], [35, 2, 1, "", "set_output_attachment"], [35, 2, 1, "", "set_output_attachments"]], "docplex.util.environment.Environment": [[35, 5, 1, "", "abort_callbacks"], [35, 2, 1, "", "create_transaction"], [35, 2, 1, "", "get_available_core_count"], [35, 2, 1, "", "get_engine_log_level"], [35, 2, 1, "", "get_input_stream"], [35, 2, 1, "", "get_output_stream"], [35, 2, 1, "", "get_parameter"], [35, 2, 1, "", "get_parameters"], [35, 2, 1, "", "get_stop_callback"], [35, 2, 1, "", "is_debug_mode"], [35, 2, 1, "", "publish_solve_details"], [35, 2, 1, "", "read_df"], [35, 5, 1, "", "record_history_fields"], [35, 5, 1, "", "record_history_size"], [35, 5, 1, "", "record_interval"], [35, 2, 1, "", "set_output_attachment"], [35, 2, 1, "", "set_output_attachments"], [35, 2, 1, "", "set_stop_callback"], [35, 5, 1, "", "solution_storage_handler"], [35, 3, 1, "", "stop_callback"], [35, 2, 1, "", "store_solution"], [35, 2, 1, "", "update_solve_details"], [35, 2, 1, "", "write_df"]], "docplex.util.environment.OutputAttachmentTransaction": [[35, 2, 1, "", "close"], [35, 2, 1, "", "commit"], [35, 2, 1, "", "set_output_attachments"]], "docplex.util.environment.SolveDetailsFilter": [[35, 2, 1, "", "filter"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:function", "5": "py:attribute", "6": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "function", "Python function"], "5": ["py", "attribute", "Python attribute"], "6": ["py", "exception", "Python exception"]}, "titleterms": {"readm": 0, "md": 0, "object": [1, 2, 41, 42, 45, 46, 47, 52, 55, 56], "box": 1, "describ": [1, 2, 41, 42, 45, 46, 47, 55], "busi": [1, 2, 41, 42, 45, 46, 47, 52, 55, 56], "problem": [1, 2, 41, 42, 45, 46, 47, 52, 55, 56], "how": [1, 2, 41, 42, 45, 46, 47, 52, 55], "decis": [1, 2, 3, 38, 41, 42, 45, 46, 47, 52, 55, 56], "optim": [1, 2, 36, 38, 41, 42, 45, 46, 47, 52, 55], "can": [1, 2, 41, 42, 45, 46, 47, 52, 55], "help": [1, 2, 41, 42, 45, 46, 47, 52, 55], "us": [1, 2, 36, 41, 42, 45, 46, 47, 52, 55], "step": [1, 2, 41, 42, 45, 46, 47, 52, 55], "1": [1, 2, 41, 42, 45, 46, 47, 52, 55], "import": [1, 2, 3, 41, 42, 45, 46, 47, 52, 55], "librari": [1, 2, 36, 37, 41, 42, 45, 46, 47, 52, 55], "2": [1, 2, 41, 42, 45, 46, 47, 52, 55], "model": [1, 2, 3, 17, 37, 38, 41, 42, 45, 46, 47, 52, 55, 56], "data": [1, 2, 41, 42, 45, 46, 47, 52, 55, 56], "3": [1, 2, 41, 42, 45, 46, 47, 52, 55], "prepar": [1, 2, 41, 42, 45, 46, 47, 52, 55], "4": [1, 2, 42, 45, 46, 47, 52, 55], "set": [1, 2, 36, 37, 41, 42, 45, 46, 47, 52, 55], "up": [1, 2, 36, 37, 41, 42, 45, 46, 47, 52, 55], "prescript": [1, 2, 41, 42, 45, 46, 47, 52, 55], "creat": [1, 2, 3, 41, 42, 45, 46, 47, 52, 55], "docplex": [1, 2, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 42, 45, 46, 47, 49, 52, 53, 55, 56], "defin": [1, 2, 3, 41, 42, 45, 46, 47, 52, 55, 56], "variabl": [1, 2, 3, 41, 42, 45, 46, 47, 52, 55, 56], "express": [1, 2, 3, 41, 42, 45, 46, 47, 52, 55], "constraint": [1, 2, 3, 41, 42, 45, 46, 47, 52, 55, 56], "solv": [1, 2, 3, 41, 42, 45, 46, 47, 52, 55, 56], "addit": [1, 42], "5": [1, 2, 42, 45, 46, 47, 52, 55], "investig": [1, 2, 42, 45, 46, 47, 52, 55], "solut": [1, 2, 29, 41, 42, 45, 46, 47, 52, 55], "run": [1, 2, 42, 45, 46, 47, 50, 52, 55], "an": [1, 2, 36, 42, 45, 46, 47, 52, 55], "exampl": [1, 2, 37, 42, 45, 46, 47, 50, 52, 55], "analysi": [1, 2, 42, 45, 46, 47, 52, 55], "summari": [1, 2, 41, 42, 45, 46, 47, 52, 55], "refer": [1, 2, 41, 42, 45, 46, 47, 49], "find": 2, "locat": 2, "new": [2, 45], "store": 2, "comput": [2, 36, 45, 46], "earth": 2, "distanc": 2, "between": [2, 52, 55], "point": 2, "declar": 2, "list": 2, "number": [2, 42, 52, 55], "shop": 2, "open": [2, 42], "valid": 2, "displai": [2, 47, 56], "them": 2, "mathemat": [3, 38, 50], "program": [3, 38, 50], "build": 3, "aggreg": 3, "necessari": 3, "modul": [3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35], "paramet": [3, 20], "retriev": 3, "result": [3, 42, 45, 56], "gener": 3, "lp": 3, "file": 3, "cutstock": 4, "py": [4, 5, 39, 40, 43, 44, 48, 51], "diet": 5, "mp": [6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 38, 49], "basic": 6, "callback": 7, "cb_mixin": 7, "conflict_refin": 8, "constant": 9, "constr": 10, "context": 11, "dvar": 12, "environ": [13, 35, 37], "error_handl": 14, "kpi": [15, 42, 45], "linear": 16, "model_read": 18, "model_stat": 19, "param": 20, "prioriti": 21, "progress": 22, "publish": 23, "pwl": 24, "quad": 25, "relax_linear": 26, "relax": 27, "sdetail": 28, "sosvarset": 30, "vartyp": 31, "with_func": 32, "util": [33, 34, 35], "cli": 33, "csv_util": 34, "engin": 36, "get": [36, 37], "ibm": [36, 41, 53], "setup": 36, "ilog": 36, "cplex": [36, 37, 41], "studio": 36, "your": 36, "instal": [36, 37], "ce": 36, "pip": [36, 37], "conda": [36, 37], "packag": [36, 37], "python": [37, 38, 41], "system": 37, "requir": [37, 42, 45, 46, 55], "develop": 37, "tool": 37, "try": 37, "out": 37, "local": 37, "manag": 37, "more": 37, "resourc": 37, "troubleshoot": [37, 54], "what": [38, 45], "i": [38, 42, 45], "contact": [38, 53], "follow": 38, "indic": [38, 49], "tabl": [38, 49], "lagrangian_relax": 39, "load_balanc": 40, "make": 41, "target": 41, "offer": 41, "custom": 41, "analyz": [41, 45], "mine": 42, "oper": 42, "total": [42, 47], "actual": 42, "revenu": 42, "expect": 42, "royalti": 42, "check": [42, 45, 55], "minimum": [42, 45, 46, 55], "blend": 42, "qualiti": 42, "global": 42, "onli": 42, "work": [42, 45, 46], "onc": [42, 52], "close": 42, "stai": 42, "The": [42, 45, 46, 52, 55, 56], "each": [42, 45, 52], "year": 42, "limit": 42, "quantiti": 42, "extract": 42, "averag": [42, 46], "discount": 42, "rate": 42, "arrai": 42, "cost": [42, 45, 55], "visual": 42, "ad": 42, "heurist": 42, "start": [42, 45], "nurs": [43, 45, 46], "nurses_multiobj": 44, "assign": [45, 46], "load": [45, 46, 55], "from": [45, 46, 55], "excel": [45, 46], "panda": [45, 46, 55], "sub": 45, "absolut": 45, "time": [45, 46], "shift": [45, 46], "end": 45, "durat": 45, "demand": [45, 47, 55], "overlap": [45, 46], "vacat": [45, 46], "associ": [45, 46], "incompat": [45, 46], "minim": [45, 46], "salari": 45, "worktim": 45, "distribut": 45, "ar": 45, "introduc": 45, "fair": 45, "goal": 45, "three": 45, "per": 45, "post": 45, "link": [45, 55], "togeth": 45, "measur": 45, "after": 45, "But": 45, "would": 45, "level": [45, 47], "first": [46, 52], "second": 46, "under": 46, "over": 46, "third": 46, "fourth": 46, "cannot": [46, 52], "fifth": 46, "enforc": 46, "maximum": [46, 47], "sixth": 46, "skill": 46, "select": 46, "seventh": 46, "eighth": 46, "maxim": 47, "profit": 47, "oil": 47, "compani": 47, "capac": 47, "octan": 47, "lead": 47, "product": [47, 48, 55], "manual": 49, "download": 50, "content": 50, "sourc": 50, "sport_schedul": 51, "sport": 52, "leagu": 52, "schedul": 52, "its": 52, "game": 52, "nation": 52, "footbal": 52, "pair": 52, "team": 52, "must": 52, "plai": 52, "correct": 52, "exactli": 52, "week": 52, "same": 52, "success": 52, "some": 52, "intradivision": 52, "should": 52, "half": 52, "elit": 53, "support": 53, "comprehens": 53, "eclips": 53, "platform": 53, "provid": 53, "portal": 53, "unit": 55, "commit": 55, "ucp": 55, "datafram": 55, "avail": 55, "energi": 55, "technologi": 55, "statu": 55, "initi": 55, "state": 55, "ramp": 55, "down": 55, "turn": 55, "off": 55, "uptim": 55, "downtim": 55, "plant": 55, "onlin": 55, "period": 55, "breakdown": 55, "arbitr": 55, "co2": 55, "econom": 55, "warehous": 56, "input": 56, "math": 56, "explor": 56, "pareto": 56, "frontier": 56, "diagram": 56}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 58}, "alltitles": {"README.md": [[0, "readme-md"]], "Objects in boxes": [[1, "objects-in-boxes"]], "Describe the business problem": [[1, "describe-the-business-problem"], [2, "describe-the-business-problem"], [41, "describe-the-business-problem"], [42, "describe-the-business-problem"], [45, "describe-the-business-problem"], [46, "describe-the-business-problem"], [47, "describe-the-business-problem"], [55, "describe-the-business-problem"]], "How decision optimization can help": [[1, "how-decision-optimization-can-help"], [2, "how-decision-optimization-can-help"], [41, "how-decision-optimization-can-help"], [42, "how-decision-optimization-can-help"], [45, "how-decision-optimization-can-help"], [46, "how-decision-optimization-can-help"], [47, "how-decision-optimization-can-help"], [52, "how-decision-optimization-can-help"], [55, "how-decision-optimization-can-help"]], "Use decision optimization": [[1, "use-decision-optimization"], [2, "use-decision-optimization"], [42, "use-decision-optimization"], [45, "use-decision-optimization"], [46, "use-decision-optimization"], [47, "use-decision-optimization"], [52, "use-decision-optimization"], [55, "use-decision-optimization"]], "Step 1: Import the library": [[1, "step-1-import-the-library"], [2, "step-1-import-the-library"], [41, "step-1-import-the-library"], [42, "step-1-import-the-library"], [45, "step-1-import-the-library"], [46, "step-1-import-the-library"], [47, "step-1-import-the-library"], [52, "step-1-import-the-library"], [55, "step-1-import-the-library"]], "Step 2: Model the data": [[1, "step-2-model-the-data"], [2, "step-2-model-the-data"], [42, "step-2-model-the-data"], [45, "step-2-model-the-data"], [46, "step-2-model-the-data"], [47, "step-2-model-the-data"], [52, "step-2-model-the-data"], [55, "step-2-model-the-data"]], "Step 3: Prepare the data": [[1, "step-3-prepare-the-data"], [2, "step-3-prepare-the-data"], [42, "step-3-prepare-the-data"], [45, "step-3-prepare-the-data"], [46, "step-3-prepare-the-data"], [47, "step-3-prepare-the-data"], [52, "step-3-prepare-the-data"], [55, "step-3-prepare-the-data"]], "Step 4: Set up the prescriptive model": [[1, "step-4-set-up-the-prescriptive-model"], [2, "step-4-set-up-the-prescriptive-model"], [42, "step-4-set-up-the-prescriptive-model"], [45, "step-4-set-up-the-prescriptive-model"], [46, "step-4-set-up-the-prescriptive-model"], [47, "step-4-set-up-the-prescriptive-model"], [52, "step-4-set-up-the-prescriptive-model"], [55, "step-4-set-up-the-prescriptive-model"]], "Create the DOcplex model": [[1, "create-the-docplex-model"], [2, "create-the-docplex-model"], [45, "create-the-docplex-model"], [46, "create-the-docplex-model"], [47, "create-the-docplex-model"], [52, "create-the-docplex-model"], [55, "create-the-docplex-model"]], "Define the decision variables": [[1, "define-the-decision-variables"], [2, "define-the-decision-variables"], [41, "define-the-decision-variables"], [42, "define-the-decision-variables"], [45, "define-the-decision-variables"], [46, "define-the-decision-variables"], [47, "define-the-decision-variables"], [52, "define-the-decision-variables"], [55, "define-the-decision-variables"]], "Express the business constraints": [[1, "express-the-business-constraints"], [2, "express-the-business-constraints"], [42, "express-the-business-constraints"], [45, "express-the-business-constraints"], [46, "express-the-business-constraints"], [47, "express-the-business-constraints"], [52, "express-the-business-constraints"], [55, "express-the-business-constraints"]], "Express the objective": [[1, "express-the-objective"], [2, "express-the-objective"], [41, "express-the-objective"], [42, "express-the-objective"], [45, "express-the-objective"], [46, "express-the-objective"], [47, "express-the-objective"], [52, "express-the-objective"], [55, "express-the-objective"]], "Solve the model": [[1, "solve-the-model"], [41, "solve-the-model"]], "Additional constraint #1": [[1, "additional-constraint-1"]], "Additional constraint #2": [[1, "additional-constraint-2"]], "Step 5: Investigate the solution and then run an example analysis": [[1, "step-5-investigate-the-solution-and-then-run-an-example-analysis"], [2, "step-5-investigate-the-solution-and-then-run-an-example-analysis"], [42, "step-5-investigate-the-solution-and-then-run-an-example-analysis"], [45, "step-5-investigate-the-solution-and-then-run-an-example-analysis"], [46, "step-5-investigate-the-solution-and-then-run-an-example-analysis"], [47, "step-5-investigate-the-solution-and-then-run-an-example-analysis"], [52, "step-5-investigate-the-solution-and-then-run-an-example-analysis"], [55, "step-5-investigate-the-solution-and-then-run-an-example-analysis"]], "Summary": [[1, "summary"], [2, "summary"], [41, "summary"], [42, "summary"], [45, "summary"], [46, "summary"], [47, "summary"], [52, "summary"], [55, "summary"]], "References": [[1, "references"], [2, "references"], [41, "references"], [42, "references"], [45, "references"], [46, "references"], [47, "references"]], "Finding optimal locations of new stores": [[2, "finding-optimal-locations-of-new-stores"]], "Define how to compute the earth distance between 2 points": [[2, "define-how-to-compute-the-earth-distance-between-2-points"]], "Declare the list of libraries": [[2, "declare-the-list-of-libraries"]], "Define number of shops to open": [[2, "define-number-of-shops-to-open"]], "Validate the data by displaying them": [[2, "validate-the-data-by-displaying-them"]], "Solve with Decision Optimization": [[2, "solve-with-decision-optimization"], [42, "solve-with-decision-optimization"], [45, "solve-with-decision-optimization"], [46, "solve-with-decision-optimization"], [47, "solve-with-decision-optimization"], [52, "solve-with-decision-optimization"], [55, "solve-with-decision-optimization"]], "Displaying the solution": [[2, "displaying-the-solution"], [47, "displaying-the-solution"]], "Creating a mathematical programming model": [[3, "creating-a-mathematical-programming-model"]], "Define model decision variables": [[3, "define-model-decision-variables"]], "Build model expressions": [[3, "build-model-expressions"]], "Aggregated expressions": [[3, "aggregated-expressions"]], "Building constraints": [[3, "building-constraints"]], "Build a model": [[3, "build-a-model"]], "Import necessary modules": [[3, "import-necessary-modules"]], "Solving parameters": [[3, "solving-parameters"]], "Retrieve results": [[3, "retrieve-results"]], "Generate LP file": [[3, "generate-lp-file"]], "cutstock.py": [[4, "cutstock-py"]], "diet.py": [[5, "diet-py"]], "docplex.mp.basic module": [[6, "docplex-mp-basic-module"]], "docplex.mp.callbacks.cb_mixin module": [[7, "docplex-mp-callbacks-cb-mixin-module"]], "docplex.mp.conflict_refiner module": [[8, "docplex-mp-conflict-refiner-module"]], "docplex.mp.constants module": [[9, "docplex-mp-constants-module"]], "docplex.mp.constr module": [[10, "docplex-mp-constr-module"]], "docplex.mp.context module": [[11, "docplex-mp-context-module"]], "docplex.mp.dvar module": [[12, "docplex-mp-dvar-module"]], "docplex.mp.environment module": [[13, "docplex-mp-environment-module"]], "docplex.mp.error_handler module": [[14, "docplex-mp-error-handler-module"]], "docplex.mp.kpi module": [[15, "docplex-mp-kpi-module"]], "docplex.mp.linear module": [[16, "docplex-mp-linear-module"]], "docplex.mp.model module": [[17, "docplex-mp-model-module"]], "docplex.mp.model_reader module": [[18, "docplex-mp-model-reader-module"]], "docplex.mp.model_stats module": [[19, "docplex-mp-model-stats-module"]], "docplex.mp.params.parameters module": [[20, "docplex-mp-params-parameters-module"]], "docplex.mp.priority module": [[21, "docplex-mp-priority-module"]], "docplex.mp.progress module": [[22, "docplex-mp-progress-module"]], "docplex.mp.publish module": [[23, "docplex-mp-publish-module"]], "docplex.mp.pwl module": [[24, "docplex-mp-pwl-module"]], "docplex.mp.quad module": [[25, "docplex-mp-quad-module"]], "docplex.mp.relax_linear module": [[26, "docplex-mp-relax-linear-module"]], "docplex.mp.relaxer module": [[27, "docplex-mp-relaxer-module"]], "docplex.mp.sdetails module": [[28, "docplex-mp-sdetails-module"]], "docplex.mp.solution module": [[29, "docplex-mp-solution-module"]], "docplex.mp.sosvarset module": [[30, "docplex-mp-sosvarset-module"]], "docplex.mp.vartype module": [[31, "docplex-mp-vartype-module"]], "docplex.mp.with_funcs module": [[32, "docplex-mp-with-funcs-module"]], "docplex.util.cli module": [[33, "docplex-util-cli-module"]], "docplex.util.csv_utils module": [[34, "docplex-util-csv-utils-module"]], "docplex.util.environment module": [[35, "docplex-util-environment-module"]], "Setting up an optimization engine": [[36, "setting-up-an-optimization-engine"]], "Get IBM\u00ae optimizers": [[36, "get-ibmreg-optimizers"]], "Engine setup": [[36, "engine-setup"]], "Using IBM ILOG CPLEX Optimization Studio on your computer": [[36, "using-ibm-ilog-cplex-optimization-studio-on-your-computer"]], "Installing IBM ILOG CPLEX Optimization CE": [[36, "installing-ibm-ilog-cplex-optimization-ce"]], "Installing IBM ILOG CPLEX Optimization library with pip": [[36, "installing-ibm-ilog-cplex-optimization-library-with-pip"]], "Installing the IBM ILOG CPLEX Optimization library with conda install packager": [[36, "installing-the-ibm-ilog-cplex-optimization-library-with-conda-install-packager"]], "Setting up a Python environment": [[37, "setting-up-a-python-environment"]], "System requirements": [[37, "system-requirements"]], "Get Python development tools": [[37, "get-python-development-tools"]], "Installing the CPLEX modeling library with pip": [[37, "installing-the-cplex-modeling-library-with-pip"]], "Installing the CPLEX modeling library with conda install packager": [[37, "installing-the-cplex-modeling-library-with-conda-install-packager"]], "Try out DOcplex, no local installation required!": [[37, "try-out-docplex-no-local-installation-required"]], "Managing environments": [[37, "managing-environments"]], "Installing examples": [[37, "installing-examples"]], "More resources on Python": [[37, "more-resources-on-python"]], "Troubleshooting": [[37, "troubleshooting"], [54, "troubleshooting"]], "Mathematical Programming Modeling for Python (DOcplex.MP)": [[38, "mathematical-programming-modeling-for-python-docplex-mp"], [38, "id1"]], "What is Decision Optimization?": [[38, "what-is-decision-optimization"]], "Contacts": [[38, "contacts"], [53, "contacts"]], "Follow Decision Optimization": [[38, "follow-decision-optimization"]], "Indices and tables": [[38, "indices-and-tables"], [49, "indices-and-tables"]], "lagrangian_relaxation.py": [[39, "lagrangian-relaxation-py"]], "load_balancing.py": [[40, "load-balancing-py"]], "How to make targeted offers to customers?": [[41, "how-to-make-targeted-offers-to-customers"]], "Prepare the data": [[41, "prepare-the-data"]], "Use IBM Decision Optimization CPLEX Modeling for Python": [[41, "use-ibm-decision-optimization-cplex-modeling-for-python"]], "Step 2: Set up the prescriptive model": [[41, "step-2-set-up-the-prescriptive-model"]], "Create the model": [[41, "create-the-model"]], "Set up the constraints": [[41, "set-up-the-constraints"]], "Step 3: Analyze the solution": [[41, "step-3-analyze-the-solution"]], "Optimizing mining operations": [[42, "optimizing-mining-operations"]], "Business constraints": [[42, "business-constraints"]], "Objective and KPIs": [[42, "objective-and-kpis"]], "Total actualized revenue": [[42, "total-actualized-revenue"], [42, "id1"]], "Total expected royalties": [[42, "total-expected-royalties"]], "Business objective": [[42, "business-objective"]], "Checking minimum requirements": [[42, "checking-minimum-requirements"], [45, "checking-minimum-requirements"], [55, "checking-minimum-requirements"]], "Mining Data": [[42, "mining-data"]], "Blend quality data": [[42, "blend-quality-data"]], "Additional (global) data": [[42, "additional-global-data"]], "Create DOcplex model": [[42, "create-docplex-model"]], "Constraint 1: Only open mines can be worked.": [[42, "constraint-1-only-open-mines-can-be-worked"]], "Constraint 2: Once closed, a mine stays closed.": [[42, "constraint-2-once-closed-a-mine-stays-closed"]], "Constraint 3: The number of worked mines each year is limited.": [[42, "constraint-3-the-number-of-worked-mines-each-year-is-limited"]], "Constraint 4: The quantity extracted is limited.": [[42, "constraint-4-the-quantity-extracted-is-limited"]], "Blend constraints": [[42, "blend-constraints"]], "Minimum average blend quality constraint": [[42, "minimum-average-blend-quality-constraint"]], "KPIs and objective": [[42, "kpis-and-objective"]], "The discount rate array": [[42, "the-discount-rate-array"]], "Total actualized royalty cost": [[42, "total-actualized-royalty-cost"]], "Visualize results": [[42, "visualize-results"]], "Adding operational constraints.": [[42, "adding-operational-constraints"]], "Using an heuristic start solution": [[42, "using-an-heuristic-start-solution"]], "nurses.py": [[43, "nurses-py"]], "nurses_multiobj.py": [[44, "nurses-multiobj-py"]], "The Nurse Assignment Problem": [[45, "the-nurse-assignment-problem"]], "Loading data from Excel with pandas": [[45, "loading-data-from-excel-with-pandas"], [46, "loading-data-from-excel-with-pandas"]], "Sub-step #1": [[45, "sub-step-1"]], "Sub-step #2 : Compute the absolute start time of each shift.": [[45, "sub-step-2-compute-the-absolute-start-time-of-each-shift"]], "Sub-Step #3 : Compute the absolute end time of each shift.": [[45, "sub-step-3-compute-the-absolute-end-time-of-each-shift"]], "Sub-step #4 : Compute the duration of each shift.": [[45, "sub-step-4-compute-the-duration-of-each-shift"]], "Sub-step #5 : Compute the minimum demand for each shift.": [[45, "sub-step-5-compute-the-minimum-demand-for-each-shift"]], "Overlapping shifts": [[45, "overlapping-shifts"]], "Vacations": [[45, "vacations"]], "Associations": [[45, "associations"]], "Incompatibilities": [[45, "incompatibilities"]], "Constraints on work time": [[45, "constraints-on-work-time"]], "Minimum requirement for shifts": [[45, "minimum-requirement-for-shifts"]], "Minimizing salary cost": [[45, "minimizing-salary-cost"]], "Analyzing how worktime is distributed": [[45, "analyzing-how-worktime-is-distributed"]], "How shifts are distributed": [[45, "how-shifts-are-distributed"]], "Introducing a fairness goal": [[45, "introducing-a-fairness-goal"]], "Step #1 : Introduce three new variables per nurse to model the": [[45, "step-1-introduce-three-new-variables-per-nurse-to-model-the"]], "Step #2 : Post the constraint that links these variables together.": [[45, "step-2-post-the-constraint-that-links-these-variables-together"]], "Step #3 : Define KPIs to measure the result after solve.": [[45, "step-3-define-kpis-to-measure-the-result-after-solve"]], "Analyzing new results": [[45, "analyzing-new-results"]], "But what would be the minimal fairness level?": [[45, "but-what-would-be-the-minimal-fairness-level"]], "The Nurses Model": [[46, "the-nurses-model"]], "First constraint: define average work time": [[46, "first-constraint-define-average-work-time"]], "Second constraint: compute nurse work time, average and under/over time": [[46, "second-constraint-compute-nurse-work-time-average-and-under-over-time"]], "Third constraint: vacations": [[46, "third-constraint-vacations"]], "Fourth constraint: a nurse cannot be assigned overlapping shifts": [[46, "fourth-constraint-a-nurse-cannot-be-assigned-overlapping-shifts"]], "Fifth constraint: enforce minimum and maximum requirements for shifts": [[46, "fifth-constraint-enforce-minimum-and-maximum-requirements-for-shifts"]], "Sixth constraint: enforce skill requirements for selected shifts": [[46, "sixth-constraint-enforce-skill-requirements-for-selected-shifts"]], "Seventh constraint: associations": [[46, "seventh-constraint-associations"]], "Eighth constraint: incompatibilities": [[46, "eighth-constraint-incompatibilities"]], "Minimizing objective": [[46, "minimizing-objective"]], "Maximizing the profit of an oil company": [[47, "maximizing-the-profit-of-an-oil-company"]], "Demand": [[47, "demand"]], "Maximum capacity": [[47, "maximum-capacity"]], "Octane and Lead levels": [[47, "octane-and-lead-levels"]], "Maximum total production": [[47, "maximum-total-production"]], "Production": [[47, "production"]], "production.py": [[48, "production-py"]], "docplex.mp reference manual": [[49, "docplex-mp-reference-manual"]], "Examples of mathematical programming": [[50, "examples-of-mathematical-programming"]], "Downloading the examples": [[50, "downloading-the-examples"]], "Examples content and source": [[50, "examples-content-and-source"]], "Running the examples": [[50, "running-the-examples"]], "sport_scheduling.py": [[51, "sport-scheduling-py"]], "Use decision optimization to help a sports league schedule its games": [[52, "use-decision-optimization-to-help-a-sports-league-schedule-its-games"]], "The business problem: Games Scheduling in the National Football League": [[52, "the-business-problem-games-scheduling-in-the-national-football-league"]], "Each pair of teams must play the correct number of games.": [[52, "each-pair-of-teams-must-play-the-correct-number-of-games"]], "Each team must play exactly once in a week.": [[52, "each-team-must-play-exactly-once-in-a-week"]], "Games between the same teams cannot be on successive weeks.": [[52, "games-between-the-same-teams-cannot-be-on-successive-weeks"]], "Some intradivisional games should be in the first half.": [[52, "some-intradivisional-games-should-be-in-the-first-half"]], "IBM\u00ae Elite Support for DOcplex": [[53, "ibmreg-elite-support-for-docplex"]], "Comprehensive support for the Eclipse platform provided by IBM": [[53, "comprehensive-support-for-the-eclipse-platform-provided-by-ibm"]], "Support portal": [[53, "support-portal"]], "The Unit Commitment Problem (UCP)": [[55, "the-unit-commitment-problem-ucp"]], "Load data from a pandas DataFrame": [[55, "load-data-from-a-pandas-dataframe"]], "Available energy technologies": [[55, "available-energy-technologies"]], "Linking in-use status to production": [[55, "linking-in-use-status-to-production"]], "Initial state": [[55, "initial-state"]], "Ramp-up / ramp-down constraint": [[55, "ramp-up-ramp-down-constraint"]], "Turn on / turn off": [[55, "turn-on-turn-off"]], "Minimum uptime and downtime": [[55, "minimum-uptime-and-downtime"]], "Demand constraint": [[55, "demand-constraint"]], "Number of plants online by period": [[55, "number-of-plants-online-by-period"]], "Costs by period": [[55, "costs-by-period"]], "Cost breakdown by unit and by energy": [[55, "cost-breakdown-by-unit-and-by-energy"]], "Arbitration between CO2 cost and economic cost": [[55, "arbitration-between-co2-cost-and-economic-cost"]], "The Warehouse Problem": [[56, "the-warehouse-problem"]], "Input Data": [[56, "input-data"]], "Business Decisions": [[56, "business-decisions"]], "Business Constraints": [[56, "business-constraints"]], "Business Objective": [[56, "business-objective"]], "The math model": [[56, "the-math-model"]], "Solving with DOcplex": [[56, "solving-with-docplex"]], "The model": [[56, "the-model"]], "Defining decision variables": [[56, "defining-decision-variables"]], "Defining constraints": [[56, "defining-constraints"]], "Defining the Objective": [[56, "defining-the-objective"]], "Solving the model": [[56, "solving-the-model"]], "Displaying results": [[56, "displaying-results"]], "Exploring the Pareto frontier": [[56, "exploring-the-pareto-frontier"]], "Pareto Diagram": [[56, "pareto-diagram"]]}, "indexentries": {"expr (class in docplex.mp.basic)": [[6, "docplex.mp.basic.Expr"]], "indexableobject (class in docplex.mp.basic)": [[6, "docplex.mp.basic.IndexableObject"]], "modelobject (class in docplex.mp.basic)": [[6, "docplex.mp.basic.ModelObject"]], "modelingobjectbase (class in docplex.mp.basic)": [[6, "docplex.mp.basic.ModelingObjectBase"]], "contains_var() (docplex.mp.basic.expr method)": [[6, "docplex.mp.basic.Expr.contains_var"]], "docplex.mp.basic": [[6, "module-docplex.mp.basic"]], "has_name() (docplex.mp.basic.modelingobjectbase method)": [[6, "docplex.mp.basic.ModelingObjectBase.has_name"]], "has_user_name() (docplex.mp.basic.modelingobjectbase method)": [[6, "docplex.mp.basic.ModelingObjectBase.has_user_name"]], "is_generated() (docplex.mp.basic.indexableobject method)": [[6, "docplex.mp.basic.IndexableObject.is_generated"]], "is_quad_expr() (docplex.mp.basic.expr method)": [[6, "docplex.mp.basic.Expr.is_quad_expr"]], "model (docplex.mp.basic.indexableobject property)": [[6, "docplex.mp.basic.IndexableObject.model"]], "model (docplex.mp.basic.modelingobjectbase property)": [[6, "docplex.mp.basic.ModelingObjectBase.model"]], "module": [[6, "module-docplex.mp.basic"], [7, "module-docplex.mp.callbacks.cb_mixin"], [8, "module-docplex.mp.conflict_refiner"], [9, "module-docplex.mp.constants"], [10, "module-docplex.mp.constr"], [11, "module-docplex.mp.context"], [12, "module-docplex.mp.dvar"], [13, "module-docplex.mp.environment"], [14, "module-docplex.mp.error_handler"], [15, "module-docplex.mp.kpi"], [16, "module-docplex.mp.linear"], [17, "module-docplex.mp.model"], [18, "module-docplex.mp.model_reader"], [19, "module-docplex.mp.model_stats"], [20, "module-docplex.mp.params.parameters"], [21, "module-docplex.mp.priority"], [22, "module-docplex.mp.progress"], [23, "module-docplex.mp.publish"], [24, "module-docplex.mp.pwl"], [25, "module-docplex.mp.quad"], [26, "module-docplex.mp.relax_linear"], [27, "module-docplex.mp.relaxer"], [28, "module-docplex.mp.sdetails"], [29, "module-docplex.mp.solution"], [30, "module-docplex.mp.sosvarset"], [31, "module-docplex.mp.vartype"], [32, "module-docplex.mp.with_funcs"], [33, "module-docplex.util.cli"], [34, "module-docplex.util.csv_utils"], [35, "module-docplex.util.environment"]], "name (docplex.mp.basic.modelingobjectbase property)": [[6, "docplex.mp.basic.ModelingObjectBase.name"]], "number_of_variables() (docplex.mp.basic.expr method)": [[6, "docplex.mp.basic.Expr.number_of_variables"]], "constraintcallbackmixin (class in docplex.mp.callbacks.cb_mixin)": [[7, "docplex.mp.callbacks.cb_mixin.ConstraintCallbackMixin"]], "modelcallbackmixin (class in docplex.mp.callbacks.cb_mixin)": [[7, "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin"]], "docplex.mp.callbacks.cb_mixin": [[7, "module-docplex.mp.callbacks.cb_mixin"]], "get_cpx_unsatisfied_cts() (docplex.mp.callbacks.cb_mixin.constraintcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ConstraintCallbackMixin.get_cpx_unsatisfied_cts"]], "index_to_var() (docplex.mp.callbacks.cb_mixin.modelcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin.index_to_var"]], "linear_ct_to_cplex() (docplex.mp.callbacks.cb_mixin.modelcallbackmixin static method)": [[7, "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin.linear_ct_to_cplex"]], "make_complete_solution() (docplex.mp.callbacks.cb_mixin.modelcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin.make_complete_solution"]], "make_solution() (docplex.mp.callbacks.cb_mixin.modelcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin.make_solution"]], "make_solution_from_vars() (docplex.mp.callbacks.cb_mixin.modelcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin.make_solution_from_vars"]], "make_solution_from_watched() (docplex.mp.callbacks.cb_mixin.constraintcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ConstraintCallbackMixin.make_solution_from_watched"]], "model (docplex.mp.callbacks.cb_mixin.modelcallbackmixin property)": [[7, "docplex.mp.callbacks.cb_mixin.ModelCallbackMixin.model"]], "print_called() (in module docplex.mp.callbacks.cb_mixin)": [[7, "docplex.mp.callbacks.cb_mixin.print_called"]], "register_watched_var() (docplex.mp.callbacks.cb_mixin.constraintcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ConstraintCallbackMixin.register_watched_var"]], "register_watched_vars() (docplex.mp.callbacks.cb_mixin.constraintcallbackmixin method)": [[7, "docplex.mp.callbacks.cb_mixin.ConstraintCallbackMixin.register_watched_vars"]], "conflictrefiner (class in docplex.mp.conflict_refiner)": [[8, "docplex.mp.conflict_refiner.ConflictRefiner"]], "conflictrefinerresult (class in docplex.mp.conflict_refiner)": [[8, "docplex.mp.conflict_refiner.ConflictRefinerResult"]], "constraintsgroup (class in docplex.mp.conflict_refiner)": [[8, "docplex.mp.conflict_refiner.ConstraintsGroup"]], "tconflictconstraint (in module docplex.mp.conflict_refiner)": [[8, "docplex.mp.conflict_refiner.TConflictConstraint"]], "varlbconstraintwrapper (class in docplex.mp.conflict_refiner)": [[8, "docplex.mp.conflict_refiner.VarLbConstraintWrapper"]], "varubconstraintwrapper (class in docplex.mp.conflict_refiner)": [[8, "docplex.mp.conflict_refiner.VarUbConstraintWrapper"]], "display() (docplex.mp.conflict_refiner.conflictrefinerresult method)": [[8, "docplex.mp.conflict_refiner.ConflictRefinerResult.display"]], "display_conflicts() (docplex.mp.conflict_refiner.conflictrefiner static method)": [[8, "docplex.mp.conflict_refiner.ConflictRefiner.display_conflicts"]], "display_stats() (docplex.mp.conflict_refiner.conflictrefinerresult method)": [[8, "docplex.mp.conflict_refiner.ConflictRefinerResult.display_stats"]], "docplex.mp.conflict_refiner": [[8, "module-docplex.mp.conflict_refiner"]], "from_var() (docplex.mp.conflict_refiner.constraintsgroup class method)": [[8, "docplex.mp.conflict_refiner.ConstraintsGroup.from_var"]], "iter_conflicts() (docplex.mp.conflict_refiner.conflictrefinerresult method)": [[8, "docplex.mp.conflict_refiner.ConflictRefinerResult.iter_conflicts"]], "number_of_conflicts (docplex.mp.conflict_refiner.conflictrefinerresult property)": [[8, "docplex.mp.conflict_refiner.ConflictRefinerResult.number_of_conflicts"]], "print_information() (docplex.mp.conflict_refiner.conflictrefinerresult method)": [[8, "docplex.mp.conflict_refiner.ConflictRefinerResult.print_information"]], "refine_conflict() (docplex.mp.conflict_refiner.conflictrefiner method)": [[8, "docplex.mp.conflict_refiner.ConflictRefiner.refine_conflict"]], "refined_by (docplex.mp.conflict_refiner.conflictrefinerresult property)": [[8, "docplex.mp.conflict_refiner.ConflictRefinerResult.refined_by"]], "var_bounds() (docplex.mp.conflict_refiner.conflictrefiner class method)": [[8, "docplex.mp.conflict_refiner.ConflictRefiner.var_bounds"]], "basisstatus (class in docplex.mp.constants)": [[9, "docplex.mp.constants.BasisStatus"]], "comparisontype (class in docplex.mp.constants)": [[9, "docplex.mp.constants.ComparisonType"]], "conflictstatus (class in docplex.mp.constants)": [[9, "docplex.mp.constants.ConflictStatus"]], "cplexscope (class in docplex.mp.constants)": [[9, "docplex.mp.constants.CplexScope"]], "effortlevel (class in docplex.mp.constants)": [[9, "docplex.mp.constants.EffortLevel"]], "objectivesense (class in docplex.mp.constants)": [[9, "docplex.mp.constants.ObjectiveSense"]], "qualitymetric (class in docplex.mp.constants)": [[9, "docplex.mp.constants.QualityMetric"]], "relaxationmode (class in docplex.mp.constants)": [[9, "docplex.mp.constants.RelaxationMode"]], "sostype (class in docplex.mp.constants)": [[9, "docplex.mp.constants.SOSType"]], "solveattribute (class in docplex.mp.constants)": [[9, "docplex.mp.constants.SolveAttribute"]], "updateevent (class in docplex.mp.constants)": [[9, "docplex.mp.constants.UpdateEvent"]], "varboundtype (class in docplex.mp.constants)": [[9, "docplex.mp.constants.VarBoundType"]], "writelevel (class in docplex.mp.constants)": [[9, "docplex.mp.constants.WriteLevel"]], "docplex.mp.constants": [[9, "module-docplex.mp.constants"]], "is_maximize() (docplex.mp.constants.objectivesense method)": [[9, "docplex.mp.constants.ObjectiveSense.is_maximize"]], "is_minimize() (docplex.mp.constants.objectivesense method)": [[9, "docplex.mp.constants.ObjectiveSense.is_minimize"]], "operator_symbol (docplex.mp.constants.comparisontype property)": [[9, "docplex.mp.constants.ComparisonType.operator_symbol"]], "parse() (docplex.mp.constants.objectivesense static method)": [[9, "docplex.mp.constants.ObjectiveSense.parse"]], "short_name (docplex.mp.constants.objectivesense property)": [[9, "docplex.mp.constants.ObjectiveSense.short_name"]], "verb (docplex.mp.constants.objectivesense property)": [[9, "docplex.mp.constants.ObjectiveSense.verb"]], "abstractconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.AbstractConstraint"]], "binaryconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.BinaryConstraint"]], "equivalenceconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.EquivalenceConstraint"]], "ifthenconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.IfThenConstraint"]], "indicatorconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.IndicatorConstraint"]], "linearconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.LinearConstraint"]], "logicalconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.LogicalConstraint"]], "notequalconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.NotEqualConstraint"]], "pwlconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.PwlConstraint"]], "quadraticconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.QuadraticConstraint"]], "rangeconstraint (class in docplex.mp.constr)": [[10, "docplex.mp.constr.RangeConstraint"]], "basis_status (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.basis_status"]], "basis_status (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.basis_status"]], "benders_annotation (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.benders_annotation"]], "benders_annotation (docplex.mp.constr.logicalconstraint property)": [[10, "docplex.mp.constr.LogicalConstraint.benders_annotation"]], "benders_annotation (docplex.mp.constr.quadraticconstraint property)": [[10, "docplex.mp.constr.QuadraticConstraint.benders_annotation"]], "benders_annotation (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.benders_annotation"]], "bounds (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.bounds"]], "docplex.mp.constr": [[10, "module-docplex.mp.constr"]], "dual_value (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.dual_value"]], "dual_value (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.dual_value"]], "eq() (docplex.mp.constr.linearconstraint method)": [[10, "docplex.mp.constr.LinearConstraint.eq"]], "expr (docplex.mp.constr.pwlconstraint property)": [[10, "docplex.mp.constr.PwlConstraint.expr"]], "expr (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.expr"]], "ge() (docplex.mp.constr.linearconstraint method)": [[10, "docplex.mp.constr.LinearConstraint.ge"]], "get_left_expr() (docplex.mp.constr.binaryconstraint method)": [[10, "docplex.mp.constr.BinaryConstraint.get_left_expr"]], "get_right_expr() (docplex.mp.constr.binaryconstraint method)": [[10, "docplex.mp.constr.BinaryConstraint.get_right_expr"]], "invalidate() (docplex.mp.constr.indicatorconstraint method)": [[10, "docplex.mp.constr.IndicatorConstraint.invalidate"]], "is_added() (docplex.mp.constr.abstractconstraint method)": [[10, "docplex.mp.constr.AbstractConstraint.is_added"]], "iter_variables() (docplex.mp.constr.binaryconstraint method)": [[10, "docplex.mp.constr.BinaryConstraint.iter_variables"]], "iter_variables() (docplex.mp.constr.pwlconstraint method)": [[10, "docplex.mp.constr.PwlConstraint.iter_variables"]], "iter_variables() (docplex.mp.constr.rangeconstraint method)": [[10, "docplex.mp.constr.RangeConstraint.iter_variables"]], "lb (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.lb"]], "le() (docplex.mp.constr.linearconstraint method)": [[10, "docplex.mp.constr.LinearConstraint.le"]], "left_expr (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.left_expr"]], "lhs (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.lhs"]], "pwl_func (docplex.mp.constr.pwlconstraint property)": [[10, "docplex.mp.constr.PwlConstraint.pwl_func"]], "rhs (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.rhs"]], "right_expr (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.right_expr"]], "sense (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.sense"]], "sense (docplex.mp.constr.quadraticconstraint property)": [[10, "docplex.mp.constr.QuadraticConstraint.sense"]], "set_mandatory() (docplex.mp.constr.abstractconstraint method)": [[10, "docplex.mp.constr.AbstractConstraint.set_mandatory"]], "slack_value (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.slack_value"]], "slack_value (docplex.mp.constr.quadraticconstraint property)": [[10, "docplex.mp.constr.QuadraticConstraint.slack_value"]], "slack_value (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.slack_value"]], "to_string() (docplex.mp.constr.binaryconstraint method)": [[10, "docplex.mp.constr.BinaryConstraint.to_string"]], "to_string() (docplex.mp.constr.ifthenconstraint method)": [[10, "docplex.mp.constr.IfThenConstraint.to_string"]], "to_string() (docplex.mp.constr.linearconstraint method)": [[10, "docplex.mp.constr.LinearConstraint.to_string"]], "to_string() (docplex.mp.constr.logicalconstraint method)": [[10, "docplex.mp.constr.LogicalConstraint.to_string"]], "to_string() (docplex.mp.constr.notequalconstraint method)": [[10, "docplex.mp.constr.NotEqualConstraint.to_string"]], "type (docplex.mp.constr.binaryconstraint property)": [[10, "docplex.mp.constr.BinaryConstraint.type"]], "type (docplex.mp.constr.linearconstraint property)": [[10, "docplex.mp.constr.LinearConstraint.type"]], "type (docplex.mp.constr.quadraticconstraint property)": [[10, "docplex.mp.constr.QuadraticConstraint.type"]], "ub (docplex.mp.constr.rangeconstraint property)": [[10, "docplex.mp.constr.RangeConstraint.ub"]], "y (docplex.mp.constr.pwlconstraint property)": [[10, "docplex.mp.constr.PwlConstraint.y"]], "basecontext (class in docplex.mp.context)": [[11, "docplex.mp.context.BaseContext"]], "context (class in docplex.mp.context)": [[11, "docplex.mp.context.Context"]], "contextoverride (class in docplex.mp.context)": [[11, "docplex.mp.context.ContextOverride"]], "invalidsettingsfileerror": [[11, "docplex.mp.context.InvalidSettingsFileError"]], "solvercontext (class in docplex.mp.context)": [[11, "docplex.mp.context.SolverContext"]], "auto_publish (docplex.mp.context.context.solver attribute)": [[11, "docplex.mp.context.Context.solver.auto_publish"]], "copy() (docplex.mp.context.context method)": [[11, "docplex.mp.context.Context.copy"]], "cplex_parameters (docplex.mp.context.context attribute)": [[11, "docplex.mp.context.Context.cplex_parameters"]], "docplex.mp.context": [[11, "module-docplex.mp.context"]], "filter_level (docplex.mp.context.context.solver.kpi_reporting attribute)": [[11, "docplex.mp.context.Context.solver.kpi_reporting.filter_level"]], "kpis_output (docplex.mp.context.context.solver.auto_publish attribute)": [[11, "docplex.mp.context.Context.solver.auto_publish.kpis_output"]], "kpis_output_field_name (docplex.mp.context.context.context.solver.auto_publish attribute)": [[11, "docplex.mp.context.Context.context.solver.auto_publish.kpis_output_field_name"]], "kpis_output_field_value (docplex.mp.context.context.context.solver.auto_publish attribute)": [[11, "docplex.mp.context.Context.context.solver.auto_publish.kpis_output_field_value"]], "log_output (docplex.mp.context.context.solver attribute)": [[11, "docplex.mp.context.Context.solver.log_output"]], "make_default_context() (docplex.mp.context.context static method)": [[11, "docplex.mp.context.Context.make_default_context"]], "read_settings() (docplex.mp.context.context method)": [[11, "docplex.mp.context.Context.read_settings"]], "result_output (docplex.mp.context.context.solver.auto_publish attribute)": [[11, "docplex.mp.context.Context.solver.auto_publish.result_output"]], "solve_details (docplex.mp.context.context.solver.auto_publish attribute)": [[11, "docplex.mp.context.Context.solver.auto_publish.solve_details"]], "update() (docplex.mp.context.context method)": [[11, "docplex.mp.context.Context.update"]], "var (class in docplex.mp.dvar)": [[12, "docplex.mp.dvar.Var"]], "basis_status (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.basis_status"]], "benders_annotation (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.benders_annotation"]], "docplex.mp.dvar": [[12, "module-docplex.mp.dvar"]], "equals() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.equals"]], "get_key() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.get_key"]], "is_binary() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.is_binary"]], "is_continuous() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.is_continuous"]], "is_discrete() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.is_discrete"]], "is_integer() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.is_integer"]], "iter_constraints() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.iter_constraints"]], "lb (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.lb"]], "name (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.name"]], "reduced_cost (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.reduced_cost"]], "solution_value (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.solution_value"]], "sv (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.sv"]], "to_bool() (docplex.mp.dvar.var method)": [[12, "docplex.mp.dvar.Var.to_bool"]], "ub (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.ub"]], "vartype (docplex.mp.dvar.var property)": [[12, "docplex.mp.dvar.Var.vartype"]], "environment (class in docplex.mp.environment)": [[13, "docplex.mp.environment.Environment"]], "unsupportedplatformerror": [[13, "docplex.mp.environment.UnsupportedPlatformError"]], "cplex_location (docplex.mp.environment.environment property)": [[13, "docplex.mp.environment.Environment.cplex_location"]], "docplex.mp.environment": [[13, "module-docplex.mp.environment"]], "get_cplex_module() (docplex.mp.environment.environment method)": [[13, "docplex.mp.environment.Environment.get_cplex_module"]], "has_cplex (docplex.mp.environment.environment property)": [[13, "docplex.mp.environment.Environment.has_cplex"]], "has_matplotlib (docplex.mp.environment.environment property)": [[13, "docplex.mp.environment.Environment.has_matplotlib"]], "has_numpy (docplex.mp.environment.environment property)": [[13, "docplex.mp.environment.Environment.has_numpy"]], "has_pandas (docplex.mp.environment.environment property)": [[13, "docplex.mp.environment.Environment.has_pandas"]], "is_64bit() (docplex.mp.environment.environment method)": [[13, "docplex.mp.environment.Environment.is_64bit"]], "python_version (docplex.mp.environment.environment property)": [[13, "docplex.mp.environment.Environment.python_version"]], "defaulterrorhandler (class in docplex.mp.error_handler)": [[14, "docplex.mp.error_handler.DefaultErrorHandler"]], "infolevel (class in docplex.mp.error_handler)": [[14, "docplex.mp.error_handler.InfoLevel"]], "docplex.mp.error_handler": [[14, "module-docplex.mp.error_handler"]], "decisionkpi (class in docplex.mp.kpi)": [[15, "docplex.mp.kpi.DecisionKPI"]], "functionalkpi (class in docplex.mp.kpi)": [[15, "docplex.mp.kpi.FunctionalKPI"]], "kpi (class in docplex.mp.kpi)": [[15, "docplex.mp.kpi.KPI"]], "compute() (docplex.mp.kpi.decisionkpi method)": [[15, "docplex.mp.kpi.DecisionKPI.compute"]], "docplex.mp.kpi": [[15, "module-docplex.mp.kpi"]], "get_model() (docplex.mp.kpi.decisionkpi method)": [[15, "docplex.mp.kpi.DecisionKPI.get_model"]], "get_model() (docplex.mp.kpi.functionalkpi method)": [[15, "docplex.mp.kpi.FunctionalKPI.get_model"]], "get_model() (docplex.mp.kpi.kpi method)": [[15, "docplex.mp.kpi.KPI.get_model"]], "is_decision_expression() (docplex.mp.kpi.decisionkpi method)": [[15, "docplex.mp.kpi.DecisionKPI.is_decision_expression"]], "is_decision_expression() (docplex.mp.kpi.functionalkpi method)": [[15, "docplex.mp.kpi.FunctionalKPI.is_decision_expression"]], "is_decision_expression() (docplex.mp.kpi.kpi method)": [[15, "docplex.mp.kpi.KPI.is_decision_expression"]], "abstractlinearexpr (class in docplex.mp.linear)": [[16, "docplex.mp.linear.AbstractLinearExpr"]], "constantexpr (class in docplex.mp.linear)": [[16, "docplex.mp.linear.ConstantExpr"]], "docplexquadraticarithexception": [[16, "docplex.mp.linear.DOCplexQuadraticArithException"]], "linearexpr (class in docplex.mp.linear)": [[16, "docplex.mp.linear.LinearExpr"]], "monomialexpr (class in docplex.mp.linear)": [[16, "docplex.mp.linear.MonomialExpr"]], "zeroexpr (class in docplex.mp.linear)": [[16, "docplex.mp.linear.ZeroExpr"]], "add() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.add"]], "add_term() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.add_term"]], "clone() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.clone"]], "constant (docplex.mp.linear.linearexpr property)": [[16, "docplex.mp.linear.LinearExpr.constant"]], "contains_var() (docplex.mp.linear.constantexpr method)": [[16, "docplex.mp.linear.ConstantExpr.contains_var"]], "contains_var() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.contains_var"]], "contains_var() (docplex.mp.linear.monomialexpr method)": [[16, "docplex.mp.linear.MonomialExpr.contains_var"]], "contains_var() (docplex.mp.linear.zeroexpr method)": [[16, "docplex.mp.linear.ZeroExpr.contains_var"]], "divide() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.divide"]], "docplex.mp.linear": [[16, "module-docplex.mp.linear"]], "equals() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.equals"]], "equals_constant() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.equals_constant"]], "get_coef() (docplex.mp.linear.abstractlinearexpr method)": [[16, "docplex.mp.linear.AbstractLinearExpr.get_coef"]], "is_constant() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.is_constant"]], "is_discrete() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.is_discrete"]], "iter_terms() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.iter_terms"]], "iter_variables() (docplex.mp.linear.constantexpr method)": [[16, "docplex.mp.linear.ConstantExpr.iter_variables"]], "multiply() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.multiply"]], "negate() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.negate"]], "number_of_variables() (docplex.mp.linear.constantexpr method)": [[16, "docplex.mp.linear.ConstantExpr.number_of_variables"]], "number_of_variables() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.number_of_variables"]], "number_of_variables() (docplex.mp.linear.monomialexpr method)": [[16, "docplex.mp.linear.MonomialExpr.number_of_variables"]], "number_of_variables() (docplex.mp.linear.zeroexpr method)": [[16, "docplex.mp.linear.ZeroExpr.number_of_variables"]], "plus() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.plus"]], "quotient() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.quotient"]], "remove_term() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.remove_term"]], "solution_value (docplex.mp.linear.linearexpr property)": [[16, "docplex.mp.linear.LinearExpr.solution_value"]], "subtract() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.subtract"]], "times() (docplex.mp.linear.linearexpr method)": [[16, "docplex.mp.linear.LinearExpr.times"]], "model (class in docplex.mp.model)": [[17, "docplex.mp.model.Model"]], "abs() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.abs"]], "add_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_constraint"]], "add_constraint_() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_constraint_"]], "add_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_constraints"]], "add_constraints_() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_constraints_"]], "add_equivalence() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_equivalence"]], "add_equivalence_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_equivalence_constraints"]], "add_equivalence_constraints_() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_equivalence_constraints_"]], "add_equivalences() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_equivalences"]], "add_if_then() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_if_then"]], "add_indicator() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_indicator"]], "add_indicator_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_indicator_constraints"]], "add_indicator_constraints_() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_indicator_constraints_"]], "add_indicators() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_indicators"]], "add_kpi() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_kpi"]], "add_lazy_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_lazy_constraint"]], "add_lazy_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_lazy_constraints"]], "add_mip_start() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_mip_start"]], "add_progress_listener() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_progress_listener"]], "add_quadratic_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_quadratic_constraints"]], "add_range() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_range"]], "add_sos() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_sos"]], "add_sos1() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_sos1"]], "add_sos2() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_sos2"]], "add_user_cut_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_user_cut_constraint"]], "add_user_cut_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.add_user_cut_constraints"]], "binary_var() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.binary_var"]], "binary_var_cube() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.binary_var_cube"]], "binary_var_dict() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.binary_var_dict"]], "binary_var_list() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.binary_var_list"]], "binary_var_matrix() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.binary_var_matrix"]], "binary_vartype (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.binary_vartype"]], "blended_objective_values (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.blended_objective_values"]], "build_multiobj_paramsets() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.build_multiobj_paramsets"]], "change_var_lower_bounds() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.change_var_lower_bounds"]], "change_var_types() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.change_var_types"]], "change_var_upper_bounds() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.change_var_upper_bounds"]], "clear() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear"]], "clear_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_constraints"]], "clear_kpis() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_kpis"]], "clear_lazy_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_lazy_constraints"]], "clear_mip_starts() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_mip_starts"]], "clear_multi_objective() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_multi_objective"]], "clear_progress_listeners() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_progress_listeners"]], "clear_sos() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_sos"]], "clear_user_cut_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clear_user_cut_constraints"]], "clone() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.clone"]], "continuous_var() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.continuous_var"]], "continuous_var_cube() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.continuous_var_cube"]], "continuous_var_dict() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.continuous_var_dict"]], "continuous_var_list() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.continuous_var_list"]], "continuous_var_matrix() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.continuous_var_matrix"]], "continuous_vartype (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.continuous_vartype"]], "cplex (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.cplex"]], "create_parameter_sets() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.create_parameter_sets"]], "docplex.mp.model": [[17, "module-docplex.mp.model"]], "dot() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.dot"]], "dotf() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.dotf"]], "dual_values() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.dual_values"]], "dump_as_sav() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.dump_as_sav"]], "end() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.end"]], "eq_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.eq_constraint"]], "equivalence_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.equivalence_constraint"]], "export_as_lp() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_as_lp"]], "export_as_lp_string() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_as_lp_string"]], "export_as_mps() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_as_mps"]], "export_as_mps_string() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_as_mps_string"]], "export_as_sav() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_as_sav"]], "export_as_sav_string() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_as_sav_string"]], "export_as_savgz() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_as_savgz"]], "export_priority_order_file() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_priority_order_file"]], "export_to_stream() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.export_to_stream"]], "find_matching_linear_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.find_matching_linear_constraints"]], "find_matching_quadratic_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.find_matching_quadratic_constraints"]], "find_matching_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.find_matching_vars"]], "find_re_matching_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.find_re_matching_vars"]], "float_precision (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.float_precision"]], "ge_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.ge_constraint"]], "get_constraint_by_index() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_constraint_by_index"]], "get_constraint_by_name() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_constraint_by_name"]], "get_cplex() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_cplex"]], "get_cuts() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_cuts"]], "get_num_cuts() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_num_cuts"]], "get_objective_expr() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_objective_expr"]], "get_parameter_from_id() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_parameter_from_id"]], "get_quadratic_constraint_by_index() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_quadratic_constraint_by_index"]], "get_solve_status() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_solve_status"]], "get_time_limit() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_time_limit"]], "get_var_by_name() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.get_var_by_name"]], "has_basis() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.has_basis"]], "has_multi_objective() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.has_multi_objective"]], "if_then() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.if_then"]], "ignore_names (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.ignore_names"]], "import_solution() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.import_solution"]], "indicator_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.indicator_constraint"]], "infinity (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.infinity"]], "init_numpy() (docplex.mp.model.model static method)": [[17, "docplex.mp.model.Model.init_numpy"]], "integer_var() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.integer_var"]], "integer_var_cube() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.integer_var_cube"]], "integer_var_dict() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.integer_var_dict"]], "integer_var_list() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.integer_var_list"]], "integer_var_matrix() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.integer_var_matrix"]], "integer_vartype (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.integer_vartype"]], "is_maximized() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.is_maximized"]], "is_minimized() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.is_minimized"]], "is_optimized() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.is_optimized"]], "iter_binary_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_binary_constraints"]], "iter_binary_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_binary_vars"]], "iter_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_constraints"]], "iter_continuous_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_continuous_vars"]], "iter_equivalence_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_equivalence_constraints"]], "iter_indicator_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_indicator_constraints"]], "iter_integer_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_integer_vars"]], "iter_kpis() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_kpis"]], "iter_lazy_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_lazy_constraints"]], "iter_linear_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_linear_constraints"]], "iter_mip_starts() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_mip_starts"]], "iter_progress_listeners() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_progress_listeners"]], "iter_pwl_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_pwl_constraints"]], "iter_pwl_functions() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_pwl_functions"]], "iter_quadratic_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_quadratic_constraints"]], "iter_range_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_range_constraints"]], "iter_semicontinuous_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_semicontinuous_vars"]], "iter_semiinteger_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_semiinteger_vars"]], "iter_sos() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_sos"]], "iter_sos1() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_sos1"]], "iter_sos2() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_sos2"]], "iter_user_cut_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_user_cut_constraints"]], "iter_variables() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.iter_variables"]], "kpi_by_name() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.kpi_by_name"]], "kpi_value_by_name() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.kpi_value_by_name"]], "kpis_as_dict() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.kpis_as_dict"]], "le_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.le_constraint"]], "linear_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.linear_constraint"]], "linear_constraint_basis_statuses() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.linear_constraint_basis_statuses"]], "linear_expr() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.linear_expr"]], "logical_and() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.logical_and"]], "logical_not() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.logical_not"]], "logical_or() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.logical_or"]], "lp_line_length (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.lp_line_length"]], "lp_string (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.lp_string"]], "max() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.max"]], "maximize() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.maximize"]], "maximize_static_lex() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.maximize_static_lex"]], "min() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.min"]], "minimize() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.minimize"]], "minimize_static_lex() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.minimize_static_lex"]], "mip_starts (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.mip_starts"]], "multi_objective_values (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.multi_objective_values"]], "name (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.name"]], "number_of_binary_variables (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_binary_variables"]], "number_of_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_constraints"]], "number_of_continuous_variables (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_continuous_variables"]], "number_of_equivalence_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_equivalence_constraints"]], "number_of_indicator_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_indicator_constraints"]], "number_of_integer_variables (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_integer_variables"]], "number_of_lazy_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_lazy_constraints"]], "number_of_linear_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_linear_constraints"]], "number_of_mip_starts (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_mip_starts"]], "number_of_progress_listeners (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_progress_listeners"]], "number_of_pwl_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_pwl_constraints"]], "number_of_quadratic_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_quadratic_constraints"]], "number_of_range_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_range_constraints"]], "number_of_semicontinuous_variables (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_semicontinuous_variables"]], "number_of_semiinteger_variables (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_semiinteger_variables"]], "number_of_sos (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_sos"]], "number_of_sos1 (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_sos1"]], "number_of_sos2 (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_sos2"]], "number_of_user_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_user_constraints"]], "number_of_user_cut_constraints (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_user_cut_constraints"]], "number_of_variables (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.number_of_variables"]], "objective_coef() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.objective_coef"]], "objective_expr (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.objective_expr"]], "objective_sense (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.objective_sense"]], "objective_value (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.objective_value"]], "parameters (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.parameters"]], "piecewise() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.piecewise"]], "piecewise_as_slopes() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.piecewise_as_slopes"]], "populate() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.populate"]], "populate_solution_pool() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.populate_solution_pool"]], "print_information() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.print_information"]], "print_solution() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.print_solution"]], "problem_type (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.problem_type"]], "quad_expr() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.quad_expr"]], "quadratic_dual_slacks() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.quadratic_dual_slacks"]], "quality_metrics (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.quality_metrics"]], "range_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.range_constraint"]], "read_basis_file() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.read_basis_file"]], "read_mip_starts() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.read_mip_starts"]], "read_priority_order_file() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.read_priority_order_file"]], "reduced_costs() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.reduced_costs"]], "remove() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.remove"]], "remove_constraint() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.remove_constraint"]], "remove_constraints() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.remove_constraints"]], "remove_kpi() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.remove_kpi"]], "remove_objective() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.remove_objective"]], "remove_progress_listener() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.remove_progress_listener"]], "report() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.report"]], "report_kpis() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.report_kpis"]], "restore_numpy() (docplex.mp.model.model static method)": [[17, "docplex.mp.model.Model.restore_numpy"]], "round_solution (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.round_solution"]], "scal_prod() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.scal_prod"]], "scal_prod_f() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.scal_prod_f"]], "scal_prod_vars_all_different() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.scal_prod_vars_all_different"]], "semicontinuous_var() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semicontinuous_var"]], "semicontinuous_var_dict() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semicontinuous_var_dict"]], "semicontinuous_var_list() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semicontinuous_var_list"]], "semicontinuous_var_matrix() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semicontinuous_var_matrix"]], "semicontinuous_vartype (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.semicontinuous_vartype"]], "semiinteger_var() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semiinteger_var"]], "semiinteger_var_dict() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semiinteger_var_dict"]], "semiinteger_var_list() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semiinteger_var_list"]], "semiinteger_var_matrix() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.semiinteger_var_matrix"]], "semiinteger_vartype (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.semiinteger_vartype"]], "set_lex_multi_objective() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_lex_multi_objective"]], "set_lp_start_basis() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_lp_start_basis"]], "set_multi_objective() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_multi_objective"]], "set_multi_objective_abstols() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_multi_objective_abstols"]], "set_multi_objective_exprs() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_multi_objective_exprs"]], "set_multi_objective_reltols() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_multi_objective_reltols"]], "set_objective() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_objective"]], "set_time_limit() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.set_time_limit"]], "slack_values() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.slack_values"]], "solution (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.solution"]], "solve() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.solve"]], "solve_details (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.solve_details"]], "solve_status (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.solve_status"]], "solve_with_goals() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.solve_with_goals"]], "statistics (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.statistics"]], "str_use_space (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.str_use_space"]], "sum() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.sum"]], "sum_squares() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.sum_squares"]], "sum_vars() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.sum_vars"]], "sum_vars_all_different() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.sum_vars_all_different"]], "sums() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.sums"]], "sumsq() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.sumsq"]], "time_limit (docplex.mp.model.model property)": [[17, "docplex.mp.model.Model.time_limit"]], "var() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.var"]], "var_basis_statuses() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.var_basis_statuses"]], "var_hypercube() (docplex.mp.model.model method)": [[17, "docplex.mp.model.Model.var_hypercube"]], "modelreader (class in docplex.mp.model_reader)": [[18, "docplex.mp.model_reader.ModelReader"]], "modelreadererror": [[18, "docplex.mp.model_reader.ModelReaderError"]], "docplex.mp.model_reader": [[18, "module-docplex.mp.model_reader"]], "read() (docplex.mp.model_reader.modelreader class method)": [[18, "docplex.mp.model_reader.ModelReader.read"]], "read_model() (docplex.mp.model_reader.modelreader class method)": [[18, "docplex.mp.model_reader.ModelReader.read_model"]], "read_model() (in module docplex.mp.model_reader)": [[18, "docplex.mp.model_reader.read_model"]], "read_ops_file() (docplex.mp.model_reader.modelreader class method)": [[18, "docplex.mp.model_reader.ModelReader.read_ops_file"]], "read_prm() (docplex.mp.model_reader.modelreader class method)": [[18, "docplex.mp.model_reader.ModelReader.read_prm"]], "modelstatistics (class in docplex.mp.model_stats)": [[19, "docplex.mp.model_stats.ModelStatistics"]], "docplex.mp.model_stats": [[19, "module-docplex.mp.model_stats"]], "number_of_binary_variables (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_binary_variables"]], "number_of_continuous_variables (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_continuous_variables"]], "number_of_eq_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_eq_constraints"]], "number_of_equivalence_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_equivalence_constraints"]], "number_of_ge_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_ge_constraints"]], "number_of_indicator_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_indicator_constraints"]], "number_of_integer_variables (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_integer_variables"]], "number_of_le_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_le_constraints"]], "number_of_linear_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_linear_constraints"]], "number_of_quadratic_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_quadratic_constraints"]], "number_of_range_constraints (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_range_constraints"]], "number_of_semicontinuous_variables (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_semicontinuous_variables"]], "number_of_semiinteger_variables (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_semiinteger_variables"]], "number_of_variables (docplex.mp.model_stats.modelstatistics property)": [[19, "docplex.mp.model_stats.ModelStatistics.number_of_variables"]], "print_information() (docplex.mp.model_stats.modelstatistics method)": [[19, "docplex.mp.model_stats.ModelStatistics.print_information"]], "boolparameter (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.BoolParameter"]], "intparameter (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.IntParameter"]], "numparameter (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.NumParameter"]], "parameter (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.Parameter"]], "parametergroup (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.ParameterGroup"]], "positiveintparameter (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.PositiveIntParameter"]], "rootparametergroup (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.RootParameterGroup"]], "strparameter (class in docplex.mp.params.parameters)": [[20, "docplex.mp.params.parameters.StrParameter"]], "accept_value() (docplex.mp.params.parameters.boolparameter method)": [[20, "docplex.mp.params.parameters.BoolParameter.accept_value"]], "accept_value() (docplex.mp.params.parameters.intparameter method)": [[20, "docplex.mp.params.parameters.IntParameter.accept_value"]], "accept_value() (docplex.mp.params.parameters.numparameter method)": [[20, "docplex.mp.params.parameters.NumParameter.accept_value"]], "accept_value() (docplex.mp.params.parameters.parameter method)": [[20, "docplex.mp.params.parameters.Parameter.accept_value"]], "accept_value() (docplex.mp.params.parameters.strparameter method)": [[20, "docplex.mp.params.parameters.StrParameter.accept_value"]], "clone() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.clone"]], "cpx_id (docplex.mp.params.parameters.parameter property)": [[20, "docplex.mp.params.parameters.Parameter.cpx_id"]], "cpx_name (docplex.mp.params.parameters.parameter property)": [[20, "docplex.mp.params.parameters.Parameter.cpx_name"]], "default_value (docplex.mp.params.parameters.parameter property)": [[20, "docplex.mp.params.parameters.Parameter.default_value"]], "description (docplex.mp.params.parameters.parameter property)": [[20, "docplex.mp.params.parameters.Parameter.description"]], "docplex.mp.params.parameters": [[20, "module-docplex.mp.params.parameters"]], "export_prm() (docplex.mp.params.parameters.rootparametergroup method)": [[20, "docplex.mp.params.parameters.RootParameterGroup.export_prm"]], "export_prm_to_string() (docplex.mp.params.parameters.rootparametergroup method)": [[20, "docplex.mp.params.parameters.RootParameterGroup.export_prm_to_string"]], "generate_nondefault_params() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.generate_nondefault_params"]], "generate_params() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.generate_params"]], "get() (docplex.mp.params.parameters.parameter method)": [[20, "docplex.mp.params.parameters.Parameter.get"]], "is_default() (docplex.mp.params.parameters.parameter method)": [[20, "docplex.mp.params.parameters.Parameter.is_default"]], "is_nondefault() (docplex.mp.params.parameters.parameter method)": [[20, "docplex.mp.params.parameters.Parameter.is_nondefault"]], "is_root() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.is_root"]], "is_root() (docplex.mp.params.parameters.rootparametergroup method)": [[20, "docplex.mp.params.parameters.RootParameterGroup.is_root"]], "iter_params() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.iter_params"]], "name (docplex.mp.params.parameters.parametergroup property)": [[20, "docplex.mp.params.parameters.ParameterGroup.name"]], "number_of_params (docplex.mp.params.parameters.parametergroup property)": [[20, "docplex.mp.params.parameters.ParameterGroup.number_of_params"]], "number_of_subgroups (docplex.mp.params.parameters.parametergroup property)": [[20, "docplex.mp.params.parameters.ParameterGroup.number_of_subgroups"]], "parent_group (docplex.mp.params.parameters.parametergroup property)": [[20, "docplex.mp.params.parameters.ParameterGroup.parent_group"]], "print_info_to_stream() (docplex.mp.params.parameters.rootparametergroup method)": [[20, "docplex.mp.params.parameters.RootParameterGroup.print_info_to_stream"]], "print_info_to_string() (docplex.mp.params.parameters.rootparametergroup method)": [[20, "docplex.mp.params.parameters.RootParameterGroup.print_info_to_string"]], "qualified_name (docplex.mp.params.parameters.parameter property)": [[20, "docplex.mp.params.parameters.Parameter.qualified_name"]], "qualified_name() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.qualified_name"]], "qualified_name() (docplex.mp.params.parameters.rootparametergroup method)": [[20, "docplex.mp.params.parameters.RootParameterGroup.qualified_name"]], "reset() (docplex.mp.params.parameters.parameter method)": [[20, "docplex.mp.params.parameters.Parameter.reset"]], "reset() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.reset"]], "set() (docplex.mp.params.parameters.parameter method)": [[20, "docplex.mp.params.parameters.Parameter.set"]], "to_string() (docplex.mp.params.parameters.parameter method)": [[20, "docplex.mp.params.parameters.Parameter.to_string"]], "to_string() (docplex.mp.params.parameters.strparameter method)": [[20, "docplex.mp.params.parameters.StrParameter.to_string"]], "total_number_of_params() (docplex.mp.params.parameters.parametergroup method)": [[20, "docplex.mp.params.parameters.ParameterGroup.total_number_of_params"]], "priority (class in docplex.mp.priority)": [[21, "docplex.mp.priority.Priority"]], "docplex.mp.priority": [[21, "module-docplex.mp.priority"]], "parse() (docplex.mp.priority.priority class method)": [[21, "docplex.mp.priority.Priority.parse"]], "functionalsolutionlistener (class in docplex.mp.progress)": [[22, "docplex.mp.progress.FunctionalSolutionListener"]], "kpilistener (class in docplex.mp.progress)": [[22, "docplex.mp.progress.KpiListener"]], "kpiprinter (class in docplex.mp.progress)": [[22, "docplex.mp.progress.KpiPrinter"]], "progressclock (class in docplex.mp.progress)": [[22, "docplex.mp.progress.ProgressClock"]], "progressdata (class in docplex.mp.progress)": [[22, "docplex.mp.progress.ProgressData"]], "progressdatarecorder (class in docplex.mp.progress)": [[22, "docplex.mp.progress.ProgressDataRecorder"]], "progresslistener (class in docplex.mp.progress)": [[22, "docplex.mp.progress.ProgressListener"]], "solutionlistener (class in docplex.mp.progress)": [[22, "docplex.mp.progress.SolutionListener"]], "solutionrecorder (class in docplex.mp.progress)": [[22, "docplex.mp.progress.SolutionRecorder"]], "textprogresslistener (class in docplex.mp.progress)": [[22, "docplex.mp.progress.TextProgressListener"]], "abort() (docplex.mp.progress.progresslistener method)": [[22, "docplex.mp.progress.ProgressListener.abort"]], "best_bound (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.best_bound"]], "clock (docplex.mp.progress.progresslistener property)": [[22, "docplex.mp.progress.ProgressListener.clock"]], "current_nb_iterations (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.current_nb_iterations"]], "current_nb_nodes (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.current_nb_nodes"]], "current_objective (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.current_objective"]], "current_progress_data (docplex.mp.progress.progresslistener property)": [[22, "docplex.mp.progress.ProgressListener.current_progress_data"]], "det_time (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.det_time"]], "docplex.mp.progress": [[22, "module-docplex.mp.progress"]], "has_incumbent (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.has_incumbent"]], "iter_recorded (docplex.mp.progress.progressdatarecorder property)": [[22, "docplex.mp.progress.ProgressDataRecorder.iter_recorded"]], "iter_solutions() (docplex.mp.progress.solutionrecorder method)": [[22, "docplex.mp.progress.SolutionRecorder.iter_solutions"]], "mip_gap (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.mip_gap"]], "notify_end() (docplex.mp.progress.progresslistener method)": [[22, "docplex.mp.progress.ProgressListener.notify_end"]], "notify_progress() (docplex.mp.progress.progressdatarecorder method)": [[22, "docplex.mp.progress.ProgressDataRecorder.notify_progress"]], "notify_progress() (docplex.mp.progress.progresslistener method)": [[22, "docplex.mp.progress.ProgressListener.notify_progress"]], "notify_progress() (docplex.mp.progress.textprogresslistener method)": [[22, "docplex.mp.progress.TextProgressListener.notify_progress"]], "notify_solution() (docplex.mp.progress.functionalsolutionlistener method)": [[22, "docplex.mp.progress.FunctionalSolutionListener.notify_solution"]], "notify_solution() (docplex.mp.progress.kpilistener method)": [[22, "docplex.mp.progress.KpiListener.notify_solution"]], "notify_solution() (docplex.mp.progress.progresslistener method)": [[22, "docplex.mp.progress.ProgressListener.notify_solution"]], "notify_solution() (docplex.mp.progress.solutionlistener method)": [[22, "docplex.mp.progress.SolutionListener.notify_solution"]], "notify_solution() (docplex.mp.progress.solutionrecorder method)": [[22, "docplex.mp.progress.SolutionRecorder.notify_solution"]], "notify_start() (docplex.mp.progress.progressdatarecorder method)": [[22, "docplex.mp.progress.ProgressDataRecorder.notify_start"]], "notify_start() (docplex.mp.progress.progresslistener method)": [[22, "docplex.mp.progress.ProgressListener.notify_start"]], "notify_start() (docplex.mp.progress.solutionlistener method)": [[22, "docplex.mp.progress.SolutionListener.notify_start"]], "notify_start() (docplex.mp.progress.solutionrecorder method)": [[22, "docplex.mp.progress.SolutionRecorder.notify_start"]], "notify_start() (docplex.mp.progress.textprogresslistener method)": [[22, "docplex.mp.progress.TextProgressListener.notify_start"]], "number_of_solutions (docplex.mp.progress.solutionrecorder property)": [[22, "docplex.mp.progress.SolutionRecorder.number_of_solutions"]], "publish() (docplex.mp.progress.kpilistener method)": [[22, "docplex.mp.progress.KpiListener.publish"]], "publish() (docplex.mp.progress.kpiprinter method)": [[22, "docplex.mp.progress.KpiPrinter.publish"]], "recorded (docplex.mp.progress.progressdatarecorder property)": [[22, "docplex.mp.progress.ProgressDataRecorder.recorded"]], "remaining_nb_nodes (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.remaining_nb_nodes"]], "time (docplex.mp.progress.progressdata attribute)": [[22, "docplex.mp.progress.ProgressData.time"]], "publishresultasdf (class in docplex.mp.publish)": [[23, "docplex.mp.publish.PublishResultAsDf"]], "docplex.mp.publish": [[23, "module-docplex.mp.publish"]], "write_output_table() (docplex.mp.publish.publishresultasdf method)": [[23, "docplex.mp.publish.PublishResultAsDf.write_output_table"]], "pwlfunction (class in docplex.mp.pwl)": [[24, "docplex.mp.pwl.PwlFunction"]], "add() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.add"]], "clone() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.clone"]], "divide() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.divide"]], "docplex.mp.pwl": [[24, "module-docplex.mp.pwl"]], "evaluate() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.evaluate"]], "multiply() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.multiply"]], "plot() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.plot"]], "subtract() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.subtract"]], "translate() (docplex.mp.pwl.pwlfunction method)": [[24, "docplex.mp.pwl.PwlFunction.translate"]], "quadexpr (class in docplex.mp.quad)": [[25, "docplex.mp.quad.QuadExpr"]], "clone() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.clone"]], "constant (docplex.mp.quad.quadexpr property)": [[25, "docplex.mp.quad.QuadExpr.constant"]], "contains_var() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.contains_var"]], "docplex.mp.quad": [[25, "module-docplex.mp.quad"]], "get_quadratic_coefficient() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.get_quadratic_coefficient"]], "has_quadratic_term() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.has_quadratic_term"]], "is_quad_expr() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.is_quad_expr"]], "is_separable() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.is_separable"]], "iter_quad_triplets() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.iter_quad_triplets"]], "iter_terms() (docplex.mp.quad.quadexpr method)": [[25, "docplex.mp.quad.QuadExpr.iter_terms"]], "linear_part (docplex.mp.quad.quadexpr property)": [[25, "docplex.mp.quad.QuadExpr.linear_part"]], "number_of_quadratic_terms (docplex.mp.quad.quadexpr property)": [[25, "docplex.mp.quad.QuadExpr.number_of_quadratic_terms"]], "linearrelaxer (class in docplex.mp.relax_linear)": [[26, "docplex.mp.relax_linear.LinearRelaxer"]], "docplex.mp.relax_linear": [[26, "module-docplex.mp.relax_linear"]], "linear_relaxation() (docplex.mp.relax_linear.linearrelaxer method)": [[26, "docplex.mp.relax_linear.LinearRelaxer.linear_relaxation"]], "amount (docplex.mp.relaxer.toutputtables attribute)": [[27, "docplex.mp.relaxer.TOutputTables.Amount"]], "constraint (docplex.mp.relaxer.toutputtables attribute)": [[27, "docplex.mp.relaxer.TOutputTables.Constraint"]], "functionalprioritizer (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.FunctionalPrioritizer"]], "mappingprioritizer (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.MappingPrioritizer"]], "matchnameprioritizer (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.MatchNamePrioritizer"]], "namedprioritizer (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.NamedPrioritizer"]], "prioritizer (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.Prioritizer"]], "priority (docplex.mp.relaxer.toutputtables attribute)": [[27, "docplex.mp.relaxer.TOutputTables.Priority"]], "relaxer (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.Relaxer"]], "toutputtables (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.TOutputTables"]], "uniformprioritizer (class in docplex.mp.relaxer)": [[27, "docplex.mp.relaxer.UniformPrioritizer"]], "docplex.mp.relaxer": [[27, "module-docplex.mp.relaxer"]], "get_priority() (docplex.mp.relaxer.matchnameprioritizer method)": [[27, "docplex.mp.relaxer.MatchNamePrioritizer.get_priority"]], "get_relaxation() (docplex.mp.relaxer.relaxer method)": [[27, "docplex.mp.relaxer.Relaxer.get_relaxation"]], "is_relaxed() (docplex.mp.relaxer.relaxer method)": [[27, "docplex.mp.relaxer.Relaxer.is_relaxed"]], "iter_relaxations() (docplex.mp.relaxer.relaxer method)": [[27, "docplex.mp.relaxer.Relaxer.iter_relaxations"]], "number_of_relaxations (docplex.mp.relaxer.relaxer property)": [[27, "docplex.mp.relaxer.Relaxer.number_of_relaxations"]], "relax() (docplex.mp.relaxer.relaxer method)": [[27, "docplex.mp.relaxer.Relaxer.relax"]], "relaxations() (docplex.mp.relaxer.relaxer method)": [[27, "docplex.mp.relaxer.Relaxer.relaxations"]], "relaxed_objective_value (docplex.mp.relaxer.relaxer property)": [[27, "docplex.mp.relaxer.Relaxer.relaxed_objective_value"]], "solvedetails (class in docplex.mp.sdetails)": [[28, "docplex.mp.sdetails.SolveDetails"]], "best_bound (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.best_bound"]], "columns (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.columns"]], "deterministic_time (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.deterministic_time"]], "dettime (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.dettime"]], "docplex.mp.sdetails": [[28, "module-docplex.mp.sdetails"]], "gap (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.gap"]], "has_hit_limit() (docplex.mp.sdetails.solvedetails method)": [[28, "docplex.mp.sdetails.SolveDetails.has_hit_limit"]], "mip_relative_gap (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.mip_relative_gap"]], "nb_iterations (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.nb_iterations"]], "nb_linear_nonzeros (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.nb_linear_nonzeros"]], "nb_nodes_processed (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.nb_nodes_processed"]], "problem_type (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.problem_type"]], "status (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.status"]], "status_code (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.status_code"]], "time (docplex.mp.sdetails.solvedetails property)": [[28, "docplex.mp.sdetails.SolveDetails.time"]], "solutionpool (class in docplex.mp.solution)": [[29, "docplex.mp.solution.SolutionPool"]], "solvesolution (class in docplex.mp.solution)": [[29, "docplex.mp.solution.SolveSolution"]], "add_var_value() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.add_var_value"]], "as_df() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.as_df"]], "check_as_mip_start() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.check_as_mip_start"]], "clear() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.clear"]], "contains() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.contains"]], "describe_objectives() (docplex.mp.solution.solutionpool method)": [[29, "docplex.mp.solution.SolutionPool.describe_objectives"]], "docplex.mp.solution": [[29, "module-docplex.mp.solution"]], "export() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.export"]], "export_as_json_string() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.export_as_json_string"]], "export_as_mst() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.export_as_mst"]], "export_as_sol() (docplex.mp.solution.solutionpool method)": [[29, "docplex.mp.solution.SolutionPool.export_as_sol"]], "export_as_sol() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.export_as_sol"]], "from_file() (docplex.mp.solution.solvesolution class method)": [[29, "docplex.mp.solution.SolveSolution.from_file"]], "get_blended_objective_value_by_priority() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_blended_objective_value_by_priority"]], "get_cuts() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_cuts"]], "get_dual_values() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_dual_values"]], "get_num_cuts() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_num_cuts"]], "get_objective_value() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_objective_value"]], "get_reduced_costs() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_reduced_costs"]], "get_sensitivity() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_sensitivity"]], "get_slacks() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_slacks"]], "get_status() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_status"]], "get_value() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_value"]], "get_value_df() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_value_df"]], "get_value_dict() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_value_dict"]], "get_value_list() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_value_list"]], "get_values() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.get_values"]], "has_objective() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.has_objective"]], "is_empty() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.is_empty"]], "is_feasible_solution() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.is_feasible_solution"]], "is_valid_solution() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.is_valid_solution"]], "iter_var_values() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.iter_var_values"]], "iter_variables() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.iter_variables"]], "kpi_value_by_name() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.kpi_value_by_name"]], "mean_objective_value (docplex.mp.solution.solutionpool property)": [[29, "docplex.mp.solution.SolutionPool.mean_objective_value"]], "model (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.model"]], "multi_objective_values (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.multi_objective_values"]], "name (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.name"]], "number_of_var_values (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.number_of_var_values"]], "objective_value (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.objective_value"]], "print_mst() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.print_mst"]], "set_objective_value() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.set_objective_value"]], "size (docplex.mp.solution.solutionpool property)": [[29, "docplex.mp.solution.SolutionPool.size"]], "size (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.size"]], "slack_value() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.slack_value"]], "solve_details (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.solve_details"]], "solved_by (docplex.mp.solution.solvesolution property)": [[29, "docplex.mp.solution.SolveSolution.solved_by"]], "stats (docplex.mp.solution.solutionpool property)": [[29, "docplex.mp.solution.SolutionPool.stats"]], "update() (docplex.mp.solution.solvesolution method)": [[29, "docplex.mp.solution.SolveSolution.update"]], "sosvariableset (class in docplex.mp.sosvarset)": [[30, "docplex.mp.sosvarset.SOSVariableSet"]], "special ordered sets": [[30, "index-0"]], "benders_annotation (docplex.mp.sosvarset.sosvariableset property)": [[30, "docplex.mp.sosvarset.SOSVariableSet.benders_annotation"]], "docplex.mp.sosvarset": [[30, "module-docplex.mp.sosvarset"]], "iter_variables() (docplex.mp.sosvarset.sosvariableset method)": [[30, "docplex.mp.sosvarset.SOSVariableSet.iter_variables"]], "sos_type (docplex.mp.sosvarset.sosvariableset property)": [[30, "docplex.mp.sosvarset.SOSVariableSet.sos_type"]], "to_string() (docplex.mp.sosvarset.sosvariableset method)": [[30, "docplex.mp.sosvarset.SOSVariableSet.to_string"]], "binaryvartype (class in docplex.mp.vartype)": [[31, "docplex.mp.vartype.BinaryVarType"]], "continuousvartype (class in docplex.mp.vartype)": [[31, "docplex.mp.vartype.ContinuousVarType"]], "integervartype (class in docplex.mp.vartype)": [[31, "docplex.mp.vartype.IntegerVarType"]], "semicontinuousvartype (class in docplex.mp.vartype)": [[31, "docplex.mp.vartype.SemiContinuousVarType"]], "semiintegervartype (class in docplex.mp.vartype)": [[31, "docplex.mp.vartype.SemiIntegerVarType"]], "vartype (class in docplex.mp.vartype)": [[31, "docplex.mp.vartype.VarType"]], "cplex_typecode (docplex.mp.vartype.vartype property)": [[31, "docplex.mp.vartype.VarType.cplex_typecode"]], "default_lb (docplex.mp.vartype.semicontinuousvartype property)": [[31, "docplex.mp.vartype.SemiContinuousVarType.default_lb"]], "default_lb (docplex.mp.vartype.semiintegervartype property)": [[31, "docplex.mp.vartype.SemiIntegerVarType.default_lb"]], "default_lb (docplex.mp.vartype.vartype property)": [[31, "docplex.mp.vartype.VarType.default_lb"]], "default_ub (docplex.mp.vartype.vartype property)": [[31, "docplex.mp.vartype.VarType.default_ub"]], "docplex.mp.vartype": [[31, "module-docplex.mp.vartype"]], "is_discrete() (docplex.mp.vartype.binaryvartype method)": [[31, "docplex.mp.vartype.BinaryVarType.is_discrete"]], "is_discrete() (docplex.mp.vartype.continuousvartype method)": [[31, "docplex.mp.vartype.ContinuousVarType.is_discrete"]], "is_discrete() (docplex.mp.vartype.integervartype method)": [[31, "docplex.mp.vartype.IntegerVarType.is_discrete"]], "is_discrete() (docplex.mp.vartype.semicontinuousvartype method)": [[31, "docplex.mp.vartype.SemiContinuousVarType.is_discrete"]], "is_discrete() (docplex.mp.vartype.semiintegervartype method)": [[31, "docplex.mp.vartype.SemiIntegerVarType.is_discrete"]], "is_discrete() (docplex.mp.vartype.vartype method)": [[31, "docplex.mp.vartype.VarType.is_discrete"]], "semi-continuous": [[31, "index-0"]], "semi-integer": [[31, "index-1"]], "short_name (docplex.mp.vartype.vartype property)": [[31, "docplex.mp.vartype.VarType.short_name"]], "to_string() (docplex.mp.vartype.vartype method)": [[31, "docplex.mp.vartype.VarType.to_string"]], "docplex.mp.with_funcs": [[32, "module-docplex.mp.with_funcs"]], "model_objective() (in module docplex.mp.with_funcs)": [[32, "docplex.mp.with_funcs.model_objective"]], "model_parameters() (in module docplex.mp.with_funcs)": [[32, "docplex.mp.with_funcs.model_parameters"]], "model_solvefixed() (in module docplex.mp.with_funcs)": [[32, "docplex.mp.with_funcs.model_solvefixed"]], "docplex.util.cli": [[33, "module-docplex.util.cli"]], "docplex.util.csv_utils": [[34, "module-docplex.util.csv_utils"]], "encode_csv_string() (in module docplex.util.csv_utils)": [[34, "docplex.util.csv_utils.encode_csv_string"]], "write_table_as_csv() (in module docplex.util.csv_utils)": [[34, "docplex.util.csv_utils.write_table_as_csv"]], "abstractlocalenvironment (class in docplex.util.environment)": [[35, "docplex.util.environment.AbstractLocalEnvironment"]], "environment (class in docplex.util.environment)": [[35, "docplex.util.environment.Environment"]], "localenvironment (class in docplex.util.environment)": [[35, "docplex.util.environment.LocalEnvironment"]], "notavailableerror": [[35, "docplex.util.environment.NotAvailableError"]], "outputattachmenttransaction (class in docplex.util.environment)": [[35, "docplex.util.environment.OutputAttachmentTransaction"]], "overrideenvironment (class in docplex.util.environment)": [[35, "docplex.util.environment.OverrideEnvironment"]], "solvedetailsfilter (class in docplex.util.environment)": [[35, "docplex.util.environment.SolveDetailsFilter"]], "abort_callbacks (docplex.util.environment.environment attribute)": [[35, "docplex.util.environment.Environment.abort_callbacks"]], "add_abort_callback() (in module docplex.util.environment)": [[35, "docplex.util.environment.add_abort_callback"]], "close() (docplex.util.environment.outputattachmenttransaction method)": [[35, "docplex.util.environment.OutputAttachmentTransaction.close"]], "commit() (docplex.util.environment.outputattachmenttransaction method)": [[35, "docplex.util.environment.OutputAttachmentTransaction.commit"]], "create_transaction() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.create_transaction"]], "default_solution_storage_handler() (in module docplex.util.environment)": [[35, "docplex.util.environment.default_solution_storage_handler"]], "docplex.util.environment": [[35, "module-docplex.util.environment"]], "filter() (docplex.util.environment.solvedetailsfilter method)": [[35, "docplex.util.environment.SolveDetailsFilter.filter"]], "get_available_core_count() (docplex.util.environment.abstractlocalenvironment method)": [[35, "docplex.util.environment.AbstractLocalEnvironment.get_available_core_count"]], "get_available_core_count() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.get_available_core_count"]], "get_available_core_count() (in module docplex.util.environment)": [[35, "docplex.util.environment.get_available_core_count"]], "get_engine_log_level() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.get_engine_log_level"]], "get_environment() (in module docplex.util.environment)": [[35, "docplex.util.environment.get_environment"]], "get_input_stream() (docplex.util.environment.abstractlocalenvironment method)": [[35, "docplex.util.environment.AbstractLocalEnvironment.get_input_stream"]], "get_input_stream() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.get_input_stream"]], "get_input_stream() (in module docplex.util.environment)": [[35, "docplex.util.environment.get_input_stream"]], "get_output_stream() (docplex.util.environment.abstractlocalenvironment method)": [[35, "docplex.util.environment.AbstractLocalEnvironment.get_output_stream"]], "get_output_stream() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.get_output_stream"]], "get_output_stream() (in module docplex.util.environment)": [[35, "docplex.util.environment.get_output_stream"]], "get_parameter() (docplex.util.environment.abstractlocalenvironment method)": [[35, "docplex.util.environment.AbstractLocalEnvironment.get_parameter"]], "get_parameter() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.get_parameter"]], "get_parameter() (in module docplex.util.environment)": [[35, "docplex.util.environment.get_parameter"]], "get_parameters() (docplex.util.environment.abstractlocalenvironment method)": [[35, "docplex.util.environment.AbstractLocalEnvironment.get_parameters"]], "get_parameters() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.get_parameters"]], "get_stop_callback() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.get_stop_callback"]], "is_debug_mode() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.is_debug_mode"]], "make_attachment_name() (in module docplex.util.environment)": [[35, "docplex.util.environment.make_attachment_name"]], "maketrans() (in module docplex.util.environment)": [[35, "docplex.util.environment.maketrans"]], "publish_solve_details() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.publish_solve_details"]], "read_df() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.read_df"]], "read_df() (in module docplex.util.environment)": [[35, "docplex.util.environment.read_df"]], "record_history_fields (docplex.util.environment.environment attribute)": [[35, "docplex.util.environment.Environment.record_history_fields"]], "record_history_size (docplex.util.environment.environment attribute)": [[35, "docplex.util.environment.Environment.record_history_size"]], "record_interval (docplex.util.environment.environment attribute)": [[35, "docplex.util.environment.Environment.record_interval"]], "remove_abort_callback() (in module docplex.util.environment)": [[35, "docplex.util.environment.remove_abort_callback"]], "set_output_attachment() (docplex.util.environment.abstractlocalenvironment method)": [[35, "docplex.util.environment.AbstractLocalEnvironment.set_output_attachment"]], "set_output_attachment() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.set_output_attachment"]], "set_output_attachment() (in module docplex.util.environment)": [[35, "docplex.util.environment.set_output_attachment"]], "set_output_attachments() (docplex.util.environment.abstractlocalenvironment method)": [[35, "docplex.util.environment.AbstractLocalEnvironment.set_output_attachments"]], "set_output_attachments() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.set_output_attachments"]], "set_output_attachments() (docplex.util.environment.outputattachmenttransaction method)": [[35, "docplex.util.environment.OutputAttachmentTransaction.set_output_attachments"]], "set_output_attachments() (in module docplex.util.environment)": [[35, "docplex.util.environment.set_output_attachments"]], "set_stop_callback() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.set_stop_callback"]], "solution_storage_handler (docplex.util.environment.environment attribute)": [[35, "docplex.util.environment.Environment.solution_storage_handler"]], "stop_callback (docplex.util.environment.environment property)": [[35, "docplex.util.environment.Environment.stop_callback"]], "store_solution() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.store_solution"]], "translate() (in module docplex.util.environment)": [[35, "docplex.util.environment.translate"]], "update_solve_details() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.update_solve_details"]], "update_solve_details() (in module docplex.util.environment)": [[35, "docplex.util.environment.update_solve_details"]], "write_df() (docplex.util.environment.environment method)": [[35, "docplex.util.environment.Environment.write_df"]], "write_df() (in module docplex.util.environment)": [[35, "docplex.util.environment.write_df"]]}}) \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/sport_scheduling.html b/docs/2.29.245/docs/mp/sport_scheduling.html new file mode 100644 index 0000000..3469e93 --- /dev/null +++ b/docs/2.29.245/docs/mp/sport_scheduling.html @@ -0,0 +1,263 @@ + + + + + + + + + + sport_scheduling.py — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

sport_scheduling.py

+

How can a sports league schedule matches between teams in different divisions such that the teams play each other +the appropriate number of times and maximize the objective of scheduling intradivision matches as late +as possible in the season?

+

A sports league with two divisions needs to schedule games such that each team plays every team within its division a specified +number of times and plays every team in the other division a specified number of times. Each week, a team plays exactly one game. +The preference is for intradivisional matches to be held as late as possible in the season. To model this preference, there is an +incentive for intradivisional matches; this incentive increases in a non-linear manner by week. +The problem consists of assigning an opponent to each team each week in order to maximize the total of the incentives.

+

This example works only with the unlimited version of IBM ILOG CPLEX Optimization Studio as it exceeds the limits of the Community Edition.

+
  1# --------------------------------------------------------------------------
+  2# Source file provided under Apache License, Version 2.0, January 2004,
+  3# http://www.apache.org/licenses/
+  4# (c) Copyright IBM Corp. 2015, 2018
+  5# --------------------------------------------------------------------------
+  6
+  7from collections import namedtuple
+  8
+  9from docplex.mp.model import Model
+ 10from docplex.util.environment import get_environment
+ 11
+ 12
+ 13# ----------------------------------------------------------------------------
+ 14# Initialize the problem data
+ 15# ----------------------------------------------------------------------------
+ 16nbs = (8, 3, 2)
+ 17
+ 18team_div1 = {"Baltimore Ravens", "Cincinnati Bengals", "Cleveland Browns",
+ 19             "Pittsburgh Steelers", "Houston Texans", "Indianapolis Colts",
+ 20             "Jacksonville Jaguars", "Tennessee Titans", "Buffalo Bills",
+ 21             "Miami Dolphins", "New England Patriots", "New York Jets",
+ 22             "Denver Broncos", "Kansas City Chiefs", "Oakland Raiders",
+ 23             "San Diego Chargers"}
+ 24
+ 25team_div2 = {"Chicago Bears", "Detroit Lions", "Green Bay Packers",
+ 26             "Minnesota Vikings", "Atlanta Falcons", "Carolina Panthers",
+ 27             "New Orleans Saints", "Tampa Bay Buccaneers", "Dallas Cowboys",
+ 28             "New York Giants", "Philadelphia Eagles", "Washington Redskins",
+ 29             "Arizona Cardinals", "San Francisco 49ers", "Seattle Seahawks",
+ 30             "St. Louis Rams"}
+ 31
+ 32Match = namedtuple("Matches", ["team1", "team2", "is_divisional"])
+ 33
+ 34
+ 35# ----------------------------------------------------------------------------
+ 36# Build the model
+ 37# ----------------------------------------------------------------------------
+ 38def build_sports(**kwargs):
+ 39    print("* building sport scheduling model instance")
+ 40    mdl = Model('sportSchedCPLEX', **kwargs)
+ 41
+ 42    nb_teams_in_division, nb_intra_divisional, nb_inter_divisional = nbs
+ 43    assert len(team_div1) == len(team_div2)
+ 44    mdl.teams = list(team_div1 | team_div2)
+ 45    # team index ranges from 1 to 2N
+ 46    team_range = range(1, 2 * nb_teams_in_division + 1)
+ 47
+ 48    # Calculate the number of weeks necessary.
+ 49    nb_weeks = (nb_teams_in_division - 1) * nb_intra_divisional + nb_teams_in_division * nb_inter_divisional
+ 50    weeks = range(1, nb_weeks + 1)
+ 51    mdl.weeks = weeks
+ 52
+ 53    print("{0} games, {1} intradivisional, {2} interdivisional"
+ 54          .format(nb_weeks, (nb_teams_in_division - 1) * nb_intra_divisional,
+ 55                  nb_teams_in_division * nb_inter_divisional))
+ 56
+ 57    # Season is split into two halves.
+ 58    first_half_weeks = range(1, nb_weeks // 2 + 1)
+ 59    nb_first_half_games = nb_weeks // 3
+ 60
+ 61    # All possible matches (pairings) and whether of not each is intradivisional.
+ 62    matches = [Match(t1, t2, 1 if (t2 <= nb_teams_in_division or t1 > nb_teams_in_division) else 0)
+ 63               for t1 in team_range for t2 in team_range if t1 < t2]
+ 64    mdl.matches = matches
+ 65    # Number of games to play between pairs depends on
+ 66    # whether the pairing is intradivisional or not.
+ 67    nb_play = {m: nb_intra_divisional if m.is_divisional == 1 else nb_inter_divisional for m in matches}
+ 68
+ 69    plays = mdl.binary_var_matrix(keys1=matches, keys2=weeks,
+ 70                                  name=lambda mw: "play_%d_%d_w%d" % (mw[0].team1, mw[0].team2, mw[1]))
+ 71    mdl.plays = plays
+ 72
+ 73    for m in matches:
+ 74        mdl.add_constraint(mdl.sum(plays[m, w] for w in weeks) == nb_play[m],
+ 75                           "correct_nb_games_%d_%d" % (m.team1, m.team2))
+ 76
+ 77    for w in weeks:
+ 78        # Each team must play exactly once in a week.
+ 79        for t in team_range:
+ 80            max_teams_in_division = (plays[m, w] for m in matches if m.team1 == t or m.team2 == t)
+ 81            mdl.add_constraint(mdl.sum(max_teams_in_division) == 1,
+ 82                               "plays_exactly_once_%d_%s" % (w, t))
+ 83
+ 84    # Games between the same teams cannot be on successive weeks.
+ 85    mdl.add_constraints(plays[m, w] + plays[m, w + 1] <= 1
+ 86                        for w in weeks for m in matches if w < nb_weeks)
+ 87
+ 88    # Some intradivisional games should be in the first half.
+ 89    for t in team_range:
+ 90        max_teams_in_division = [plays[m, w] for w in first_half_weeks for m in matches if
+ 91                                 m.is_divisional == 1 and (m.team1 == t or m.team2 == t)]
+ 92
+ 93        mdl.add_constraint(mdl.sum(max_teams_in_division) >= nb_first_half_games,
+ 94                           "in_division_first_half_%s" % t)
+ 95
+ 96    # postpone divisional matches as much as possible
+ 97    # we weight each play variable with the square of w.
+ 98    mdl.maximize(mdl.sum(plays[m, w] * w * w for w in weeks for m in matches if m.is_divisional))
+ 99    return mdl
+100
+101# a named tuple to store solution
+102TSolution = namedtuple("TSolution", ["week", "is_divisional", "team1", "team2"])
+103
+104
+105def print_sports_solution(mdl):
+106    # iterate with weeks first
+107    solution = [TSolution(w, m.is_divisional, mdl.teams[m.team1], mdl.teams[m.team2])
+108                for w in mdl.weeks for m in mdl.matches
+109                if mdl.plays[m, w].to_bool()]
+110
+111    currweek = 0
+112    print("Intradivisional games are marked with a *")
+113    for s in solution:
+114        # assume records are sorted by increasing week indices.
+115        if s.week != currweek:
+116            currweek = s.week
+117            print(" == == == == == == == == == == == == == == == == ")
+118            print("On week %d" % currweek)
+119
+120        print("    {0:s}{1} will meet the {2}".format("*" if s.is_divisional else "", s.team1, s.team2))
+121
+122
+123# ----------------------------------------------------------------------------
+124# Solve the model and display the result
+125# ----------------------------------------------------------------------------
+126if __name__ == '__main__':
+127    # Build the model
+128    model = build_sports()
+129    model.print_information()
+130    # Solve the model. If a key has been specified above, the solve
+131    # will use IBM Decision Optimization on cloud.
+132    if model.solve():
+133        model.report()
+134        print_sports_solution(model)
+135        # Save the CPLEX solution as "solution.json" program output
+136        with get_environment().get_output_stream("solution.json") as fp:
+137            model.solution.export(fp, "json")
+138    else:
+139        print("Problem could not be solved: " + model.solve_details.get_status())
+140    model.end()
+
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/sports_scheduling.html b/docs/2.29.245/docs/mp/sports_scheduling.html new file mode 100644 index 0000000..610a869 --- /dev/null +++ b/docs/2.29.245/docs/mp/sports_scheduling.html @@ -0,0 +1,908 @@ + + + + + + + + + + Use decision optimization to help a sports league schedule its games — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Use decision optimization to help a sports league schedule its games

+

This tutorial includes everything you need to set up decision +optimization engines, build mathematical programming models, and arrive +at a good working schedule for a sports league’s games.

+

When you finish this tutorial, you’ll have a foundational knowledge of +Prescriptive Analytics.

+
+

This notebook is part of Prescriptive Analytics for +Python

+

It requires either an installation of CPLEX +Optimizers +or it can be run on IBM Watson Studio +Cloud (Sign up for a +free IBM Cloud +account +and you can start using Watson Studio Cloud right away).

+
+

Table of contents:

+ +
+

The business problem: Games Scheduling in the National Football League

+
    +

  • A sports league with two divisions must schedule games so that each +team plays every team within its division a given number of times, +and each team plays teams in the other division a given number of +times.

    • +

  • A team plays exactly one game each week.

    • +

  • A pair of teams cannot play each other on consecutive weeks.

    • +

  • While a third of a team’s intradivisional games must be played in the +first half of the season, the preference is for intradivisional games +to be held as late as possible in the season.

    +
      +

    • To model this preference, there is an incentive for +intradivisional games that increases each week as a square of the +week.

      • +

    • An opponent must be assigned to each team each week to maximize +the total of the incentives..

      • +
    +
    • +
+

This is a type of discrete optimization problem that can be solved by +using either Integer Programming (IP) or Constraint Programming +(CP).

+
+

Integer Programming is the class of problems defined as the +optimization of a linear function, subject to linear constraints over +integer variables.

+
+
+

Constraint Programming problems generally have discrete decision +variables, but the constraints can be logical, and the arithmetic +expressions are not restricted to being linear.

+
+

For the purposes of this tutorial, we will illustrate a solution with +mathematical programming (MIP).

+
+
+

How decision optimization can help

+
    +

  • Prescriptive analytics (decision optimization) technology recommends +actions that are based on desired outcomes. It takes into account +specific scenarios, resources, and knowledge of past and current +events. With this insight, your organization can make better +decisions and have greater control of business outcomes.

    • +

  • Prescriptive analytics is the next step on the path to insight-based +actions. It creates value through synergy with predictive analytics, +which analyzes data to predict future outcomes.

    • +
  • +
    Prescriptive analytics takes that insight to the next level by +suggesting the optimal way to handle that future situation. +Organizations that can act fast in dynamic conditions and make +superior decisions in uncertain environments gain a strong +competitive advantage.
    +

    +
    +
    • +
+

With prescriptive analytics, you can:

+
    +

  • Automate the complex decisions and trade-offs to better manage your +limited resources.

    • +

  • Take advantage of a future opportunity or mitigate a future risk.

    • +

  • Proactively update recommendations based on changing events.

    • +

  • Meet operational goals, increase customer loyalty, prevent threats +and fraud, and optimize business processes.

    • +
+
+
+

Use decision optimization

+
+

Step 1: Import the library

+

Run the following code to import the Decision Optimization CPLEX +Modeling library. The DOcplex library contains the two modeling +packages, Mathematical Programming (docplex.mp) and Constraint +Programming (docplex.cp).

+
import sys
+try:
+    import docplex.mp
+except:
+    raise Exception('Please install docplex. See https://pypi.org/project/docplex/')
+
+
+

If CPLEX is not installed, install CPLEX Community edition.

+
try:
+    import cplex
+except:
+    raise Exception('Please install CPLEX. See https://pypi.org/project/cplex/')
+
+
+
+
+

Step 2: Model the data

+

In this scenario, the data is simple. There are eight teams in each +division, and the teams must play each team in the division once and +each team outside the division once.

+

Use a Python module, Collections, which implements some data +structures that will help solve some problems. Named tuples helps to +define meaning of each position in a tuple. This helps the code be more +readable and self-documenting. You can use named tuples in any place +where you use tuples.

+

In this example, you create a namedtuple to contain information for +points. You are also defining some of the parameters.

+
# Teams in 1st division
+team_div1 = ["Baltimore Ravens","Cincinnati Bengals", "Cleveland Browns","Pittsburgh Steelers","Houston Texans",
+                "Indianapolis Colts","Jacksonville Jaguars","Tennessee Titans","Buffalo Bills","Miami Dolphins",
+                "New England Patriots","New York Jets","Denver Broncos","Kansas City Chiefs","Oakland Raiders",
+                "San Diego Chargers"]
+
+# Teams in 2nd division
+team_div2 = ["Chicago Bears","Detroit Lions","Green Bay Packers","Minnesota Vikings","Atlanta Falcons",
+                "Carolina Panthers","New Orleans Saints","Tampa Bay Buccaneers","Dallas Cowboys","New York Giants",
+                "Philadelphia Eagles","Washington Redskins","Arizona Cardinals","San Francisco 49ers",
+                "Seattle Seahawks","St. Louis Rams"]
+
+
+
#number_of_matches_to_play = 1  # Number of match to play between two teams on the league
+# Schedule parameters
+nb_teams_in_division = 5
+max_teams_in_division = 10
+number_of_matches_inside_division = 1
+number_of_matches_outside_division = 1
+
+
+

Use basic HTML and a stylesheet to format the data.

+
CSS = """
+body {
+    margin: 0;
+    font-family: Helvetica;
+}
+table.dataframe {
+    border-collapse: collapse;
+    border: none;
+}
+table.dataframe tr {
+    border: none;
+}
+table.dataframe td, table.dataframe th {
+    margin: 0;
+    border: 1px solid white;
+    padding-left: 0.25em;
+    padding-right: 0.25em;
+}
+table.dataframe th:not(:empty) {
+    background-color: #fec;
+    text-align: left;
+    font-weight: normal;
+}
+table.dataframe tr:nth-child(2) th:empty {
+    border-left: none;
+    border-right: 1px dashed #888;
+}
+table.dataframe td {
+    border: 2px solid #ccf;
+    background-color: #f4f4ff;
+}
+    table.dataframe thead th:first-child {
+        display: none;
+    }
+    table.dataframe tbody th {
+        display: none;
+    }
+"""
+
+from IPython.core.display import HTML
+HTML('<style>{}</style>'.format(CSS))
+
+
+

Now you will import the pandas library. Pandas is an open source +Python library for data analysis. It uses two data structures, Series +and DataFrame, which are built on top of NumPy.

+

A Series is a one-dimensional object similar to an array, list, or +column in a table. It will assign a labeled index to each item in the +series. By default, each item receives an index label from 0 to N, where +N is the length of the series minus one.

+

A DataFrame is a tabular data structure comprised of rows and +columns, similar to a spreadsheet, database table, or R’s data.frame +object. Think of a DataFrame as a group of Series objects that share an +index (the column names).

+

In the example, each division (the AFC and the NFC) is part of a +DataFrame.

+
import pandas as pd
+
+team1 = pd.DataFrame(team_div1)
+team2 = pd.DataFrame(team_div2)
+team1.columns = ["AFC"]
+team2.columns = ["NFC"]
+
+teams = pd.concat([team1,team2], axis=1)
+
+
+

The following display function is a tool to show different +representations of objects. When you issue the display(teams) command, +you are sending the output to the notebook so that the result is stored +in the document.

+
from IPython.display import display
+
+display(teams)
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AFCNFC
0Baltimore RavensChicago Bears
1Cincinnati BengalsDetroit Lions
2Cleveland BrownsGreen Bay Packers
3Pittsburgh SteelersMinnesota Vikings
4Houston TexansAtlanta Falcons
5Indianapolis ColtsCarolina Panthers
6Jacksonville JaguarsNew Orleans Saints
7Tennessee TitansTampa Bay Buccaneers
8Buffalo BillsDallas Cowboys
9Miami DolphinsNew York Giants
10New England PatriotsPhiladelphia Eagles
11New York JetsWashington Redskins
12Denver BroncosArizona Cardinals
13Kansas City ChiefsSan Francisco 49ers
14Oakland RaidersSeattle Seahawks
15San Diego ChargersSt. Louis Rams
+
+
+

Step 3: Prepare the data

+

Given the number of teams in each division and the number of +intradivisional and interdivisional games to be played, you can +calculate the total number of teams and the number of weeks in the +schedule, assuming every team plays exactly one game per week.

+

The season is split into halves, and the number of the intradivisional +games that each team must play in the first half of the season is +calculated.

+
import numpy as np
+
+nb_teams = 2 * nb_teams_in_division
+teams = range(nb_teams)
+
+# Calculate the number of weeks necessary
+nb_inside_div = (nb_teams_in_division - 1) * number_of_matches_inside_division
+nb_outside_div = nb_teams_in_division * number_of_matches_outside_division
+nb_weeks = nb_inside_div + nb_outside_div
+
+
+# Weeks to schedule
+weeks = range(nb_weeks)
+
+# Season is split into two halves
+first_half_weeks = range(int(np.floor(nb_weeks / 2)))
+nb_first_half_games = int(np.floor(nb_weeks / 3))
+
+
+
from collections import namedtuple
+
+match = namedtuple("match",["team1","team2","is_divisional"])
+
+matches = {match(t1,t2, 1 if ( t2 <= nb_teams_in_division or t1 > nb_teams_in_division) else 0)
+           for t1 in teams for t2 in teams if t1 < t2}
+
+
+

Number of games to play between pairs depends on whether the pairing is +intradivisional or not.

+
nb_play = { m :  number_of_matches_inside_division if m.is_divisional==1
+                                                   else number_of_matches_outside_division
+                   for m in matches}
+
+
+
+
+

Step 4: Set up the prescriptive model

+
from docplex.mp.environment import Environment
+env = Environment()
+env.print_information()
+
+
+
* system is: Windows 64bit
+* Python version 3.7.3, located at: c:\local\python373\python.exe
+* docplex is present, version is (2, 11, 0)
+* pandas is present, version is 0.25.1
+
+

Create the DOcplex model

+

The model contains all the business constraints and defines the +objective.

+
from docplex.mp.model import Model
+
+mdl = Model("sports")
+
+
+
+
+

Define the decision variables

+
plays = mdl.binary_var_matrix(matches, weeks, lambda ij: "x_%s_%d" %(str(ij[0]), ij[1]))
+
+
+
+
+

Express the business constraints

+
+
Each pair of teams must play the correct number of games.
+
mdl.add_constraints( mdl.sum(plays[m,w]  for w in weeks) == nb_play[m]
+                   for m in matches)
+mdl.print_information()
+
+
+
Model: sports
+ - number of variables: 405
+   - binary=405, integer=0, continuous=0
+ - number of constraints: 45
+   - linear=45
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Each team must play exactly once in a week.
+
mdl.add_constraints( mdl.sum(plays[m,w] for m in matches if (m.team1 == t or m.team2 == t) )  == 1
+                   for w in weeks for t in teams)
+mdl.print_information()
+
+
+
Model: sports
+ - number of variables: 405
+   - binary=405, integer=0, continuous=0
+ - number of constraints: 135
+   - linear=135
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Games between the same teams cannot be on successive weeks.
+
mdl.add_constraints( plays[m,w] + plays[m,w+1] <= 1
+                   for w in weeks
+                   for m in matches
+                   if w < nb_weeks-1)
+mdl.print_information()
+
+
+
Model: sports
+ - number of variables: 405
+   - binary=405, integer=0, continuous=0
+ - number of constraints: 495
+   - linear=495
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Some intradivisional games should be in the first half.
+
mdl.add_constraints( mdl.sum(plays[m,w]  for w in first_half_weeks for  m in matches
+                            if (((m.team1 == t or m.team2 == t) and m.is_divisional == 1 )))
+                    >= nb_first_half_games
+                   for t in teams)
+mdl.print_information()
+
+
+
Model: sports
+ - number of variables: 405
+   - binary=405, integer=0, continuous=0
+ - number of constraints: 505
+   - linear=505
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
+

Express the objective

+

The objective function for this example is designed to force +intradivisional games to occur as late in the season as possible. The +incentive for intradivisional games increases by week. There is no +incentive for interdivisional games.

+
gain = { w : w*w for w in weeks}
+
+# If an intradivisional pair plays in week w, Gain[w] is added to the objective.
+mdl.maximize( mdl.sum (m.is_divisional * gain[w] * plays[m,w] for m in matches for w in weeks) )
+
+
+
+
+
+

Solve with Decision Optimization

+

You will get the best solution found after n seconds, due to a time +limit parameter.

+
mdl.print_information()
+
+assert mdl.solve(), "!!! Solve of the model fails"
+mdl.report()
+
+
+
Model: sports
+ - number of variables: 405
+   - binary=405, integer=0, continuous=0
+ - number of constraints: 505
+   - linear=505
+ - parameters: defaults
+ - problem type is: MILP
+* model sports solved with objective = 260
+
+
+
+
+

Step 5: Investigate the solution and then run an example analysis

+

Determine which of the scheduled games will be a replay of one of the +last 10 Super Bowls. We start by creating a pandas DataFrame that +contains the year and teams who played the last 10 Super Bowls.

+
try: # Python 2
+    team_league = dict({t : team_div1[t] for t in range(nb_teams_in_division) }.items() +  \
+                {t+nb_teams_in_division : team_div2[t] for t in range(nb_teams_in_division) }.items()
+            )
+except: # Python 3
+    team_league = dict(list({t : team_div1[t] for t in range(nb_teams_in_division) }.items()) +  \
+                list({t+nb_teams_in_division : team_div2[t] for t in range(nb_teams_in_division) }.items()))
+
+
+
sol = namedtuple("solution",["week","is_divisional", "team1", "team2"])
+
+solution = [sol(w, m.is_divisional, team_league[m.team1], team_league[m.team2]) for m in matches for w in weeks if plays[m,w].solution_value == 1]
+
+
+
nfl_finals = [("2016", "Carolina Panthers", "Denver Broncos"),
+              ("2015", "New England Patriots", "Seattle Seahawks"),
+              ("2014", "Seattle Seahawks", "Denver Broncos"),
+              ("2013", "Baltimore Ravens", "San Francisco 49ers"),
+              ("2012", "New York Giants", "New England Patriots "),
+              ("2011", "Green Bay Packers", "Pittsburgh Steelers"),
+              ("2010", "New Orleans Saints", "Indianapolis Colts"),
+              ("2009", "Pittsburgh Steelers", "Arizona Cardinals"),
+              ("2008", "New York Giants", "New England Patriots"),
+              ("2007", "Indianapolis Colts", "Chicago Bears")
+             ]
+nfl_meetings = {(t[1], t[2]) for t in nfl_finals}
+winners_bd = pd.DataFrame(nfl_finals)
+winners_bd.columns = ["year", "team1", "team2"]
+
+
+
display(winners_bd)
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
yearteam1team2
02016Carolina PanthersDenver Broncos
12015New England PatriotsSeattle Seahawks
22014Seattle SeahawksDenver Broncos
32013Baltimore RavensSan Francisco 49ers
42012New York GiantsNew England Patriots
52011Green Bay PackersPittsburgh Steelers
62010New Orleans SaintsIndianapolis Colts
72009Pittsburgh SteelersArizona Cardinals
82008New York GiantsNew England Patriots
92007Indianapolis ColtsChicago Bears
+

We now look for the games in our solution that are replays of one of the +past 10 Super Bowls.

+
months = ["January", "February", "March", "April", "May", "June",
+          "July", "August", "September", "October", "November", "December"]
+report = []
+for m in solution:
+    if (m.team1, m.team2) in nfl_meetings:
+        report.append((m.week, months[m.week//4], m.team1, m.team2))
+    if (m.team2, m.team1) in nfl_meetings:
+        report.append((m.week, months[m.week//4], m.team2, m.team1))
+
+print(report)
+matches_bd = pd.DataFrame(report)
+matches_bd.columns = ["week", "Month", "Team1", "Team2"]
+
+
+
[(4, 'February', 'Green Bay Packers', 'Pittsburgh Steelers')]
+
+
+
try: #pandas >= 0.17
+    display(matches_bd.sort_values(by='week'))
+except:
+    display(matches_bd.sort('week'))
+
+
+
+ + + + + + + + + + + + + + + + + + + + +
weekMonthTeam1Team2
04FebruaryGreen Bay PackersPittsburgh Steelers
+
+
+
+

Summary

+

You learned how to set up and use IBM Decision Optimization CPLEX +Modeling for Python to formulate a Constraint Programming model and +solve it with CPLEX.

+ +

Copyright � 2017-2019 IBM. IPLA licensed Sample Materials.

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/support.html b/docs/2.29.245/docs/mp/support.html new file mode 100644 index 0000000..e90f106 --- /dev/null +++ b/docs/2.29.245/docs/mp/support.html @@ -0,0 +1,124 @@ + + + + + + + + + + IBM® Elite Support for DOcplex — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

IBM® Elite Support for DOcplex

+
+

Comprehensive support for the Eclipse platform provided by IBM

+

IBM® Elite Support for Decision Optimization CPLEX Modeling for Python is a technical support package for DOcplex, an open source development environment. +This offering gives you the advantage of using open software with reliable expert support from IBM. +You gain the support you need to build mission-critical applications with this Python modeling package.

+
+
This Elite Support provides:
    +

  • Support for the DOcplex packages.

    • +

  • Phone support at no additional cost. IBM support services are available through IBM online issue management tools or by phone, and 24x7 phone support is available for severity 1 issues.

    • +

  • An efficient defect fix process. Defect submissions go through a triage process, and fixes are delivered by the IBM development team.

    • +
+
+
+

Contact your sales representative for more details or contact IBM here in the “Contact IBM” section.

+
+
+

Support portal

+

You can access the Decision Optimization support portal here.

+
+
+

Contacts

+ +
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/troubleshooting.html b/docs/2.29.245/docs/mp/troubleshooting.html new file mode 100644 index 0000000..5369aaa --- /dev/null +++ b/docs/2.29.245/docs/mp/troubleshooting.html @@ -0,0 +1,139 @@ + + + + + + + + + + Troubleshooting — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

Troubleshooting

+
    +

  • What if I get warnings about SSL while my code is running?

    +
      +

    • These types of warnings indicate that you might be using an unsupported version of Python and +need additional Python libraries. Some details are provided +here.

      • +
    +
    • +

  • How do I check if my local CPLEX® Optimizer is used or not?

    +
      +

    • DOcplex examples issue warnings that state whether a CPLEX Optimizer wrapper is present or not. For example, CPLEX wrapper is present, version is 12.6.3.0, located at: C:\CPLEX_Studio1263.

      • +

    • If an invalid version of CPLEX Optimizer is detected (for example V12.6.1), DOcplex raises an error that indicates the cause.

      • +

    • If no CPLEX Optimizer version is detected, then DOcplex examples raise the message CPLEX wrapper is not available.

      • +
    +
    • +

  • What if I don’t have pip?

    +
      +

    • The lack of pip indicates that you are using an unsupported version of Python since pip is delivered as a standard package +with versions 2.7.9+, 3.4, and 3.5.

      • +
    +
    • +

  • Ask your question in IBM® forums for:

    + +
    • +
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/ucp_pandas.html b/docs/2.29.245/docs/mp/ucp_pandas.html new file mode 100644 index 0000000..e9dfc4b --- /dev/null +++ b/docs/2.29.245/docs/mp/ucp_pandas.html @@ -0,0 +1,1819 @@ + + + + + + + + + + The Unit Commitment Problem (UCP) — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

The Unit Commitment Problem (UCP)

+

This tutorial includes everything you need to set up IBM Decision +Optimization CPLEX Modeling for Python (DOcplex), build a Mathematical +Programming model, and get its solution by solving the model on the +cloud with IBM ILOG CPLEX Optimizer.

+

When you finish this tutorial, you’ll have a foundational knowledge of +Prescriptive Analytics.

+
+

This notebook is part of Prescriptive Analytics for +Python

+

It requires either an installation of CPLEX +Optimizers +or it can be run on IBM Watson Studio +Cloud (Sign up for a +free IBM Cloud +account +and you can start using Watson Studio Cloud right away).

+
+

Table of contents:

+ +
+
+

Describe the business problem

+
    +

  • The Model estimates the lower cost of generating electricity within a +given plan. Depending on the demand for electricity, we turn on or +off units that generate power and which have operational properties +and costs.

    • +

  • The Unit Commitment Problem answers the question “Which power +generators should I run at which times and at what level in order to +satisfy the demand for electricity?”. This model helps users to find +not only a feasible answer to the question, but one that also +optimizes its solution to meet as many of the electricity company’s +overall goals as possible.

    • +
+
+
+

How decision optimization can help

+
    +

  • Prescriptive analytics (decision optimization) technology recommends +actions that are based on desired outcomes. It takes into account +specific scenarios, resources, and knowledge of past and current +events. With this insight, your organization can make better +decisions and have greater control of business outcomes.

    • +

  • Prescriptive analytics is the next step on the path to insight-based +actions. It creates value through synergy with predictive analytics, +which analyzes data to predict future outcomes.

    • +
  • +
    Prescriptive analytics takes that insight to the next level by +suggesting the optimal way to handle that future situation. +Organizations that can act fast in dynamic conditions and make +superior decisions in uncertain environments gain a strong +competitive advantage.
    +

    +
    +
    • +
+

With prescriptive analytics, you can:

+
    +

  • Automate the complex decisions and trade-offs to better manage your +limited resources.

    • +

  • Take advantage of a future opportunity or mitigate a future risk.

    • +

  • Proactively update recommendations based on changing events.

    • +

  • Meet operational goals, increase customer loyalty, prevent threats +and fraud, and optimize business processes.

    • +
+
+
+

Checking minimum requirements

+

This notebook uses some features of pandas that are available in +version 0.17.1 or above.

+
import pip
+REQUIRED_MINIMUM_PANDAS_VERSION = '0.17.1'
+try:
+    import pandas as pd
+    assert pd.__version__ >= REQUIRED_MINIMUM_PANDAS_VERSION
+except:
+    raise Exception("Version " + REQUIRED_MINIMUM_PANDAS_VERSION + " or above of Pandas is required to run this notebook")
+
+
+
+
+

Use decision optimization

+
+

Step 1: Import the library

+

Run the following code to the import the Decision Optimization CPLEX +Modeling library. The DOcplex library contains the two modeling +packages, Mathematical Programming (docplex.mp) and Constraint +Programming (docplex.cp).

+
import sys
+try:
+    import docplex.mp
+except:
+    raise Exception('Please install docplex. See https://pypi.org/project/docplex/')
+
+
+
+
+

Step 2: Model the data

+
+

Load data from a pandas DataFrame

+

Data for the Unit Commitment Problem is provided as a pandas +DataFrame. For a standalone notebook, we provide the raw data as Python +collections, but real data could be loaded from an Excel sheet, also +using pandas.

+
import pandas as pd
+from pandas import DataFrame, Series
+
+# make matplotlib plots appear inside the notebook
+import matplotlib.pyplot as plt
+%matplotlib inline
+from pylab import rcParams
+rcParams['figure.figsize'] = 11, 5 ############################ <-Use this to change the plot
+
+
+

Update the configuration of notebook so that display matches browser +window width.

+
from IPython.core.display import HTML
+HTML("<style>.container { width:100%; }</style>")
+
+
+
+
+

Available energy technologies

+

The following df_energy DataFrame stores CO2 cost information, indexed +by energy type.

+
energies = ["coal", "gas", "diesel", "wind"]
+df_energy = DataFrame({"co2_cost": [30, 5, 15, 0]}, index=energies)
+
+# Display the 'df_energy' Data Frame
+df_energy
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
co2_cost
coal30
gas5
diesel15
wind0
+

The following df_units DataFrame stores common elements for units of a +given technology.

+
all_units = ["coal1", "coal2",
+             "gas1", "gas2", "gas3", "gas4",
+             "diesel1", "diesel2", "diesel3", "diesel4"]
+
+ucp_raw_unit_data = {
+        "energy": ["coal", "coal", "gas", "gas", "gas", "gas", "diesel", "diesel", "diesel", "diesel"],
+        "initial" : [400, 350, 205, 52, 155, 150, 78, 76, 0, 0],
+        "min_gen": [100, 140, 78, 52, 54.25, 39, 17.4, 15.2, 4, 2.4],
+        "max_gen": [425, 365, 220, 210, 165, 158, 90, 87, 20, 12],
+        "operating_max_gen": [400, 350, 205, 197, 155, 150, 78, 76, 20, 12],
+        "min_uptime": [15, 15, 6, 5, 5, 4, 3, 3, 1, 1],
+        "min_downtime":[9, 8, 7, 4, 3, 2, 2, 2, 1, 1],
+        "ramp_up":   [212, 150, 101.2, 94.8, 58, 50, 40, 60, 20, 12],
+        "ramp_down": [183, 198, 95.6, 101.7, 77.5, 60, 24, 45, 20, 12],
+        "start_cost": [5000, 4550, 1320, 1291, 1280, 1105, 560, 554, 300, 250],
+        "fixed_cost": [208.61, 117.37, 174.12, 172.75, 95.353, 144.52, 54.417, 54.551, 79.638, 16.259],
+        "variable_cost": [22.536, 31.985, 70.5, 69, 32.146, 54.84, 40.222, 40.522, 116.33, 76.642],
+        }
+
+df_units = DataFrame(ucp_raw_unit_data, index=all_units)
+
+# Display the 'df_units' Data Frame
+df_units
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
energyinitialmin_genmax_genoperating_max_genmin_uptimemin_downtimeramp_upramp_downstart_costfixed_costvariable_cost
coal1coal400100.00425400159212.0183.05000208.61022.536
coal2coal350140.00365350158150.0198.04550117.37031.985
gas1gas20578.0022020567101.295.61320174.12070.500
gas2gas5252.002101975494.8101.71291172.75069.000
gas3gas15554.251651555358.077.5128095.35332.146
gas4gas15039.001581504250.060.01105144.52054.840
diesel1diesel7817.4090783240.024.056054.41740.222
diesel2diesel7615.2087763260.045.055454.55140.522
diesel3diesel04.0020201120.020.030079.638116.330
diesel4diesel02.4012121112.012.025016.25976.642
+
+
+
+

Step 3: Prepare the data

+

The pandas merge operation is used to create a join between the +df_units and df_energy DataFrames. Here, the join is performed based +on the ‘energy’ column of df_units and index column of df_energy.

+

By default, merge performs an inner join. That is, the resulting +DataFrame is based on the intersection of keys from both input +DataFrames.

+
# Add a derived co2-cost column by merging with df_energies
+# Use energy key from units and index from energy dataframe
+df_up = pd.merge(df_units, df_energy, left_on="energy", right_index=True)
+df_up.index.names=['units']
+
+# Display first rows of new 'df_up' Data Frame
+df_up.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
energyinitialmin_genmax_genoperating_max_genmin_uptimemin_downtimeramp_upramp_downstart_costfixed_costvariable_costco2_cost
units
coal1coal400100.00425400159212.0183.05000208.61022.53630
coal2coal350140.00365350158150.0198.04550117.37031.98530
gas1gas20578.0022020567101.295.61320174.12070.5005
gas2gas5252.002101975494.8101.71291172.75069.0005
gas3gas15554.251651555358.077.5128095.35332.1465
+

The demand is stored as a pandas Series indexed from 1 to the number +of periods.

+
raw_demand = [1259.0, 1439.0, 1289.0, 1211.0, 1433.0, 1287.0, 1285.0, 1227.0, 1269.0, 1158.0, 1277.0, 1417.0, 1294.0, 1396.0, 1414.0, 1386.0,
+              1302.0, 1215.0, 1433.0, 1354.0, 1436.0, 1285.0, 1332.0, 1172.0, 1446.0, 1367.0, 1243.0, 1275.0, 1363.0, 1208.0, 1394.0, 1345.0,
+              1217.0, 1432.0, 1431.0, 1356.0, 1360.0, 1364.0, 1286.0, 1440.0, 1440.0, 1313.0, 1389.0, 1385.0, 1265.0, 1442.0, 1435.0, 1432.0,
+              1280.0, 1411.0, 1440.0, 1258.0, 1333.0, 1293.0, 1193.0, 1440.0, 1306.0, 1264.0, 1244.0, 1368.0, 1437.0, 1236.0, 1354.0, 1356.0,
+              1383.0, 1350.0, 1354.0, 1329.0, 1427.0, 1163.0, 1339.0, 1351.0, 1174.0, 1235.0, 1439.0, 1235.0, 1245.0, 1262.0, 1362.0, 1184.0,
+              1207.0, 1359.0, 1443.0, 1205.0, 1192.0, 1364.0, 1233.0, 1281.0, 1295.0, 1357.0, 1191.0, 1329.0, 1294.0, 1334.0, 1265.0, 1207.0,
+              1365.0, 1432.0, 1199.0, 1191.0, 1411.0, 1294.0, 1244.0, 1256.0, 1257.0, 1224.0, 1277.0, 1246.0, 1243.0, 1194.0, 1389.0, 1366.0,
+              1282.0, 1221.0, 1255.0, 1417.0, 1358.0, 1264.0, 1205.0, 1254.0, 1276.0, 1435.0, 1335.0, 1355.0, 1337.0, 1197.0, 1423.0, 1194.0,
+              1310.0, 1255.0, 1300.0, 1388.0, 1385.0, 1255.0, 1434.0, 1232.0, 1402.0, 1435.0, 1160.0, 1193.0, 1422.0, 1235.0, 1219.0, 1410.0,
+              1363.0, 1361.0, 1437.0, 1407.0, 1164.0, 1392.0, 1408.0, 1196.0, 1430.0, 1264.0, 1289.0, 1434.0, 1216.0, 1340.0, 1327.0, 1230.0,
+              1362.0, 1360.0, 1448.0, 1220.0, 1435.0, 1425.0, 1413.0, 1279.0, 1269.0, 1162.0, 1437.0, 1441.0, 1433.0, 1307.0, 1436.0, 1357.0,
+              1437.0, 1308.0, 1207.0, 1420.0, 1338.0, 1311.0, 1328.0, 1417.0, 1394.0, 1336.0, 1160.0, 1231.0, 1422.0, 1294.0, 1434.0, 1289.0]
+nb_periods = len(raw_demand)
+print("nb periods = {}".format(nb_periods))
+
+demand = Series(raw_demand, index = range(1, nb_periods+1))
+
+# plot demand
+demand.plot(title="Demand")
+
+
+
nb periods = 192
+
+
+
<matplotlib.axes._subplots.AxesSubplot at 0x23fbad3d588>
+
+
+_images/ucp_pandas_20_2.png +
+
+

Step 4: Set up the prescriptive model

+
from docplex.mp.environment import Environment
+env = Environment()
+env.print_information()
+
+
+
* system is: Windows 64bit
+* Python version 3.7.3, located at: c:\local\python373\python.exe
+* docplex is present, version is (2, 11, 0)
+* pandas is present, version is 0.25.1
+
+

Create the DOcplex model

+

The model contains all the business constraints and defines the +objective.

+
from docplex.mp.model import Model
+
+ucpm = Model("ucp")
+
+
+
+
+

Define the decision variables

+

Decision variables are:

+
    +

  • The variable in_use[u,t] is 1 if and only if unit u is working at +period t.

    • +

  • The variable turn_on[u,t] is 1 if and only if unit u is in +production at period t.

    • +

  • The variable turn_off[u,t] is 1 if unit u is switched off at +period t.

    • +

  • The variable production[u,t] is a continuous variables representing +the production of energy for unit u at period t.

    • +
+
units = all_units
+# periods range from 1 to nb_periods included
+periods = range(1, nb_periods+1)
+
+# in use[u,t] is true iff unit u is in production at period t
+in_use = ucpm.binary_var_matrix(keys1=units, keys2=periods, name="in_use")
+
+# true if unit u is turned on at period t
+turn_on = ucpm.binary_var_matrix(keys1=units, keys2=periods, name="turn_on")
+
+# true if unit u is switched off at period t
+# modeled as a continuous 0-1 variable, more on this later
+turn_off = ucpm.continuous_var_matrix(keys1=units, keys2=periods, lb=0, ub=1, name="turn_off")
+
+# production of energy for unit u at period t
+production = ucpm.continuous_var_matrix(keys1=units, keys2=periods, name="p")
+
+# at this stage we have defined the decision variables.
+ucpm.print_information()
+
+
+
Model: ucp
+ - number of variables: 7680
+   - binary=3840, integer=0, continuous=3840
+ - number of constraints: 0
+   - linear=0
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
# Organize all decision variables in a DataFrame indexed by 'units' and 'periods'
+df_decision_vars = DataFrame({'in_use': in_use, 'turn_on': turn_on, 'turn_off': turn_off, 'production': production})
+# Set index names
+df_decision_vars.index.names=['units', 'periods']
+
+# Display first few rows of 'df_decision_vars' DataFrame
+df_decision_vars.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
in_useturn_onturn_offproduction
unitsperiods
coal11in_use_coal1_1turn_on_coal1_1turn_off_coal1_1p_coal1_1
2in_use_coal1_2turn_on_coal1_2turn_off_coal1_2p_coal1_2
3in_use_coal1_3turn_on_coal1_3turn_off_coal1_3p_coal1_3
4in_use_coal1_4turn_on_coal1_4turn_off_coal1_4p_coal1_4
5in_use_coal1_5turn_on_coal1_5turn_off_coal1_5p_coal1_5
+
+
+

Express the business constraints

+
+
Linking in-use status to production
+

Whenever the unit is in use, the production must be within the minimum +and maximum generation.

+
# Create a join between 'df_decision_vars' and 'df_up' Data Frames based on common index id (ie: 'units')
+# In 'df_up', one keeps only relevant columns: 'min_gen' and 'max_gen'
+df_join_decision_vars_up = df_decision_vars.join(df_up[['min_gen', 'max_gen']], how='inner')
+
+# Display first few rows of joined Data Frames
+df_join_decision_vars_up.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
in_useturn_onturn_offproductionmin_genmax_gen
unitsperiods
coal11in_use_coal1_1turn_on_coal1_1turn_off_coal1_1p_coal1_1100.0425
2in_use_coal1_2turn_on_coal1_2turn_off_coal1_2p_coal1_2100.0425
3in_use_coal1_3turn_on_coal1_3turn_off_coal1_3p_coal1_3100.0425
4in_use_coal1_4turn_on_coal1_4turn_off_coal1_4p_coal1_4100.0425
5in_use_coal1_5turn_on_coal1_5turn_off_coal1_5p_coal1_5100.0425
+
import pandas as pb
+print(pd.__version__)
+
+
+
0.25.1
+
+
+
# When in use, the production level is constrained to be between min and max generation.
+for item in df_join_decision_vars_up.itertuples(index=False):
+    ucpm += (item.production <= item.max_gen * item.in_use)
+    ucpm += (item.production >= item.min_gen * item.in_use)
+
+
+
+
+
Initial state
+

The solution must take into account the initial state. The initial state +of use of the unit is determined by its initial production level.

+
# Initial state
+# If initial production is nonzero, then period #1 is not a turn_on
+# else turn_on equals in_use
+# Dual logic is implemented for turn_off
+for u in units:
+    if df_up.initial[u] > 0:
+        # if u is already running, not starting up
+        ucpm.add_constraint(turn_on[u, 1] == 0)
+        # turnoff iff not in use
+        ucpm.add_constraint(turn_off[u, 1] + in_use[u, 1] == 1)
+    else:
+        # turn on at 1 iff in use at 1
+        ucpm.add_constraint(turn_on[u, 1] == in_use[u, 1])
+        # already off, not switched off at t==1
+        ucpm.add_constraint(turn_off[u, 1] == 0)
+ucpm.print_information()
+
+
+
Model: ucp
+ - number of variables: 7680
+   - binary=3840, integer=0, continuous=3840
+ - number of constraints: 3860
+   - linear=3860
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Ramp-up / ramp-down constraint
+

Variations of the production level over time in a unit is constrained by +a ramp-up / ramp-down process.

+

We use the pandas groupby operation to collect all decision +variables for each unit in separate series. Then, we iterate over units +to post constraints enforcing the ramp-up / ramp-down process by setting +upper bounds on the variation of the production level for consecutive +periods.

+
# Use groupby operation to process each unit
+for unit, r in df_decision_vars.groupby(level='units'):
+    u_ramp_up = df_up.ramp_up[unit]
+    u_ramp_down = df_up.ramp_down[unit]
+    u_initial = df_up.initial[unit]
+    # Initial ramp up/down
+    # Note that r.production is a Series that can be indexed as an array (ie: first item index = 0)
+    ucpm.add_constraint(r.production[0] - u_initial <= u_ramp_up)
+    ucpm.add_constraint(u_initial - r.production[0] <= u_ramp_down)
+    for (p_curr, p_next) in zip(r.production, r.production[1:]):
+        ucpm.add_constraint(p_next - p_curr <= u_ramp_up)
+        ucpm.add_constraint(p_curr - p_next <= u_ramp_down)
+
+ucpm.print_information()
+
+
+
Model: ucp
+ - number of variables: 7680
+   - binary=3840, integer=0, continuous=3840
+ - number of constraints: 7700
+   - linear=7700
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Turn on / turn off
+

The following constraints determine when a unit is turned on or off.

+

We use the same pandas groupby operation as in the previous +constraint to iterate over the sequence of decision variables for each +unit.

+
# Turn_on, turn_off
+# Use groupby operation to process each unit
+for unit, r in df_decision_vars.groupby(level='units'):
+    for (in_use_curr, in_use_next, turn_on_next, turn_off_next) in zip(r.in_use, r.in_use[1:], r.turn_on[1:], r.turn_off[1:]):
+        # if unit is off at time t and on at time t+1, then it was turned on at time t+1
+        ucpm.add_constraint(in_use_next - in_use_curr <= turn_on_next)
+
+        # if unit is on at time t and time t+1, then it was not turned on at time t+1
+        # mdl.add_constraint(in_use_next + in_use_curr + turn_on_next <= 2)
+
+        # if unit is on at time t and off at time t+1, then it was turned off at time t+1
+        ucpm.add_constraint(in_use_curr - in_use_next + turn_on_next == turn_off_next)
+ucpm.print_information()
+
+
+
Model: ucp
+ - number of variables: 7680
+   - binary=3840, integer=0, continuous=3840
+ - number of constraints: 11520
+   - linear=11520
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
+
+
Minimum uptime and downtime
+

When a unit is turned on, it cannot be turned off before a minimum +uptime. Conversely, when a unit is turned off, it cannot be turned on +again before a minimum downtime.

+

Again, let’s use the same pandas groupby operation to implement this +constraint for each unit.

+
# Minimum uptime, downtime
+for unit, r in df_decision_vars.groupby(level='units'):
+    min_uptime   = df_up.min_uptime[unit]
+    min_downtime = df_up.min_downtime[unit]
+    # Note that r.turn_on and r.in_use are Series that can be indexed as arrays (ie: first item index = 0)
+    for t in range(min_uptime, nb_periods):
+        ctname = "min_up_{0!s}_{1}".format(*r.index[t])
+        ucpm.add_constraint(ucpm.sum(r.turn_on[(t - min_uptime) + 1:t + 1]) <= r.in_use[t], ctname)
+
+    for t in range(min_downtime, nb_periods):
+        ctname = "min_down_{0!s}_{1}".format(*r.index[t])
+        ucpm.add_constraint(ucpm.sum(r.turn_off[(t - min_downtime) + 1:t + 1]) <= 1 - r.in_use[t], ctname)
+
+
+
+
+
Demand constraint
+

Total production level must be equal or higher than demand on any +period.

+

This time, the pandas operation groupby is performed on “periods” +since we have to iterate over the list of all units for each period.

+
# Enforcing demand
+# we use a >= here to be more robust,
+# objective will ensure  we produce efficiently
+for period, r in df_decision_vars.groupby(level='periods'):
+    total_demand = demand[period]
+    ctname = "ct_meet_demand_%d" % period
+    ucpm.add_constraint(ucpm.sum(r.production) >= total_demand, ctname)
+
+
+
+
+
+

Express the objective

+

Operating the different units incur different costs: fixed cost, +variable cost, startup cost, co2 cost.

+

In a first step, we define the objective as a non-weighted sum of all +these costs.

+

The following pandas join operation groups all the data to calculate +the objective in a single DataFrame.

+
# Create a join between 'df_decision_vars' and 'df_up' Data Frames based on common index ids (ie: 'units')
+# In 'df_up', one keeps only relevant columns: 'fixed_cost', 'variable_cost', 'start_cost' and 'co2_cost'
+df_join_obj = df_decision_vars.join(
+    df_up[['fixed_cost', 'variable_cost', 'start_cost', 'co2_cost']], how='inner')
+
+# Display first few rows of joined Data Frame
+df_join_obj.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
in_useturn_onturn_offproductionfixed_costvariable_coststart_costco2_cost
unitsperiods
coal11in_use_coal1_1turn_on_coal1_1turn_off_coal1_1p_coal1_1208.6122.536500030
2in_use_coal1_2turn_on_coal1_2turn_off_coal1_2p_coal1_2208.6122.536500030
3in_use_coal1_3turn_on_coal1_3turn_off_coal1_3p_coal1_3208.6122.536500030
4in_use_coal1_4turn_on_coal1_4turn_off_coal1_4p_coal1_4208.6122.536500030
5in_use_coal1_5turn_on_coal1_5turn_off_coal1_5p_coal1_5208.6122.536500030
+
# objective
+total_fixed_cost = ucpm.sum(df_join_obj.in_use * df_join_obj.fixed_cost)
+total_variable_cost = ucpm.sum(df_join_obj.production * df_join_obj.variable_cost)
+total_startup_cost = ucpm.sum(df_join_obj.turn_on * df_join_obj.start_cost)
+total_co2_cost = ucpm.sum(df_join_obj.production * df_join_obj.co2_cost)
+total_economic_cost = total_fixed_cost + total_variable_cost + total_startup_cost
+
+total_nb_used = ucpm.sum(df_decision_vars.in_use)
+total_nb_starts = ucpm.sum(df_decision_vars.turn_on)
+
+# store expression kpis to retrieve them later.
+ucpm.add_kpi(total_fixed_cost   , "Total Fixed Cost")
+ucpm.add_kpi(total_variable_cost, "Total Variable Cost")
+ucpm.add_kpi(total_startup_cost , "Total Startup Cost")
+ucpm.add_kpi(total_economic_cost, "Total Economic Cost")
+ucpm.add_kpi(total_co2_cost     , "Total CO2 Cost")
+ucpm.add_kpi(total_nb_used, "Total #used")
+ucpm.add_kpi(total_nb_starts, "Total #starts")
+
+# minimize sum of all costs
+ucpm.minimize(total_fixed_cost + total_variable_cost + total_startup_cost + total_co2_cost)
+
+
+
+
+

Solve with Decision Optimization

+

If you’re using a Community Edition of CPLEX runtimes, depending on the +size of the problem, the solve stage may fail and will need a paying +subscription or product installation.

+
ucpm.print_information()
+
+
+
Model: ucp
+ - number of variables: 7680
+   - binary=3840, integer=0, continuous=3840
+ - number of constraints: 15455
+   - linear=15455
+ - parameters: defaults
+ - problem type is: MILP
+
+
+
assert ucpm.solve(), "!!! Solve of the model fails"
+
+
+
ucpm.report()
+
+
+
* model ucp solved with objective = 14213082.064
+*  KPI: Total Fixed Cost    = 161025.131
+*  KPI: Total Variable Cost = 8865900.433
+*  KPI: Total Startup Cost  = 2832.000
+*  KPI: Total Economic Cost = 9029757.564
+*  KPI: Total CO2 Cost      = 5183324.500
+*  KPI: Total #used         = 1335.000
+*  KPI: Total #starts       = 3.000
+
+
+
+
+
+

Step 5: Investigate the solution and then run an example analysis

+

Now let’s store the results in a new pandas DataFrame.

+

For convenience, the different figures are organized into pivot tables +with periods as row index and units as columns. The pandas +unstack operation does this for us.

+
df_prods = df_decision_vars.production.apply(lambda v: v.solution_value).unstack(level='units')
+df_used = df_decision_vars.in_use.apply(lambda v: v.solution_value).unstack(level='units')
+df_started = df_decision_vars.turn_on.apply(lambda v: v.solution_value).unstack(level='units')
+
+# Display the first few rows of the pivoted 'production' data
+df_prods.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
unitscoal1coal2diesel1diesel2diesel3diesel4gas1gas2gas3gas4
periods
1425.0215.090.087.00.00.0109.452.0165.0115.6
2425.0365.090.087.00.00.078.071.0165.0158.0
3425.0312.090.087.00.00.00.052.0165.0158.0
4425.0234.090.087.00.00.00.052.0165.0158.0
5425.0365.090.087.00.00.00.0143.0165.0158.0
+

From these raw DataFrame results, we can compute derived results. For +example, for a given unit and period, the reserve r(u,t) is defined as +the unit’s maximum generation minus the current production.

+
df_spins = DataFrame(df_up.max_gen.to_dict(), index=periods) - df_prods
+
+# Display the first few rows of the 'df_spins' Data Frame, representing the reserve for each unit, over time
+df_spins.head()
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
coal1coal2diesel1diesel2diesel3diesel4gas1gas2gas3gas4
10.0150.00.00.020.012.0110.6158.00.042.4
20.00.00.00.020.012.0142.0139.00.00.0
30.053.00.00.020.012.0220.0158.00.00.0
40.0131.00.00.020.012.0220.0158.00.00.0
50.00.00.00.020.012.0220.067.00.00.0
+

Let’s plot the evolution of the reserves for the “coal2” unit:

+
df_spins.coal2.plot(style='o-', ylim=[0,200])
+
+
+
<matplotlib.axes._subplots.AxesSubplot at 0x23fd903bf60>
+
+
+_images/ucp_pandas_54_1.png +

Now we want to sum all unit reserves to compute the global spinning +reserve. We need to sum all columns of the DataFrame to get an +aggregated time series. We use the pandas sum method with axis=1 +(for rows).

+
global_spin = df_spins.sum(axis=1)
+global_spin.plot(title="Global spinning reserve")
+
+
+
<matplotlib.axes._subplots.AxesSubplot at 0x23fda312710>
+
+
+_images/ucp_pandas_56_1.png +
+

Number of plants online by period

+

The total number of plants online at each period t is the sum of in_use +variables for all units at this period. Again, we use the pandas sum +with axis=1 (for rows) to sum over all units.

+
df_used.sum(axis=1).plot(title="Number of plants online", kind='line', style="r-", ylim=[0, len(units)])
+
+
+
<matplotlib.axes._subplots.AxesSubplot at 0x23fda37f9b0>
+
+
+_images/ucp_pandas_58_1.png +
+
+

Costs by period

+
# extract unit cost data
+all_costs = ["fixed_cost", "variable_cost", "start_cost", "co2_cost"]
+df_costs = df_up[all_costs]
+
+running_cost = df_used * df_costs.fixed_cost
+startup_cost = df_started * df_costs.start_cost
+variable_cost = df_prods * df_costs.variable_cost
+co2_cost = df_prods * df_costs.co2_cost
+total_cost = running_cost + startup_cost + variable_cost + co2_cost
+
+running_cost.sum(axis=1).plot(style='g')
+startup_cost.sum(axis=1).plot(style='r')
+variable_cost.sum(axis=1).plot(style='b',logy=True)
+co2_cost.sum(axis=1).plot(style='k')
+
+
+
<matplotlib.axes._subplots.AxesSubplot at 0x23fda3c7e80>
+
+
+_images/ucp_pandas_60_1.png +
+
+

Cost breakdown by unit and by energy

+
# Calculate sum by column (by default, axis = 0) to get total cost for each unit
+cost_by_unit = total_cost.sum()
+
+# Create a dictionary storing energy type for each unit, from the corresponding pandas Series
+unit_energies = df_up.energy.to_dict()
+
+# Group cost by unit type and plot total cost by energy type in a pie chart
+gb = cost_by_unit.groupby(unit_energies)
+# gb.sum().plot(kind='pie')
+gb.sum().plot.pie(figsize=(6, 6),autopct='%.2f',fontsize=15)
+
+plt.title('total cost by energy type', bbox={'facecolor':'0.8', 'pad':5})
+
+
+
Text(0.5, 1.0, 'total cost by energy type')
+
+
+_images/ucp_pandas_62_1.png +
+
+
+

Arbitration between CO2 cost and economic cost

+

Economic cost and CO2 cost usually push in opposite directions. In the +above discussion, we have minimized the raw sum of economic cost and CO2 +cost, without weights. But how good could we be on CO2, regardless of +economic constraints? To know this, let’s solve again with CO2 cost as +the only objective.

+
# first retrieve the co2 and economic kpis
+co2_kpi = ucpm.kpi_by_name("co2") # does a name matching
+eco_kpi = ucpm.kpi_by_name("eco")
+prev_co2_cost = co2_kpi.compute()
+prev_eco_cost = eco_kpi.compute()
+print("* current CO2 cost is: {}".format(prev_co2_cost))
+print("* current $$$ cost is: {}".format(prev_eco_cost))
+# now set the objective
+old_objective = ucpm.objective_expr # save it
+ucpm.minimize(co2_kpi.as_expression())
+
+
+
* current CO2 cost is: 5183324.5
+* current $$$ cost is: 9029757.56390015
+
+
+
assert ucpm.solve(), "Solve failed"
+
+
+
min_co2_cost = ucpm.objective_value
+min_co2_eco_cost = eco_kpi.compute()
+print("* absolute minimum for CO2 cost is {}".format(min_co2_cost))
+print("* at this point $$$ cost is {}".format(min_co2_eco_cost))
+
+
+
* absolute minimum for CO2 cost is 3399032.0
+* at this point $$$ cost is 12434227.620000225
+
+
+

As expected, we get a significantly lower CO2 cost when minimized alone, +at the price of a higher economic cost.

+

We could do a similar analysis for economic cost to estimate the +absolute minimum of the economic cost, regardless of CO2 cost.

+
# minimize only economic cost
+ucpm.minimize(eco_kpi.as_expression())
+
+
+
assert ucpm.solve(), "Solve failed"
+
+
+
min_eco_cost = ucpm.objective_value
+min_eco_co2_cost = co2_kpi.compute()
+print("* absolute minimum for $$$ cost is {}".format(min_eco_cost))
+print("* at this point CO2 cost is {}".format(min_eco_co2_cost))
+
+
+
* absolute minimum for $$$ cost is 8887433.859000005
+* at this point CO2 cost is 5375417.0
+
+
+

Again, the absolute minimum for economic cost is lower than the figure +we obtained in the original model where we minimized the sum of +economic and CO2 costs, but here we significantly increase the CO2.

+

But what happens in between these two extreme points?

+

To investigate, we will divide the interval of CO2 cost values in +smaller intervals, add an upper limit on CO2, and minimize economic cost +with this constraint. This will give us a Pareto optimal point with at +most this CO2 value.

+

To avoid adding many constraints, we add only one constraint with an +extra variable, and we change only the upper bound of this CO2 limit +variable between successive solves.

+

Then we iterate (with a fixed number of iterations) and collect the cost +values.

+
# add extra variable
+co2_limit = ucpm.continuous_var(lb=0)
+# add a named constraint which limits total co2 cost to this variable:
+max_co2_ctname = "ct_max_co2"
+co2_ct = ucpm.add_constraint(co2_kpi.as_expression() <= co2_limit, max_co2_ctname)
+
+
+
co2min = min_co2_cost
+co2max = min_eco_co2_cost
+def explore_ucp(nb_iters, eps=1e-5):
+
+    step = (co2max-co2min)/float(nb_iters)
+    co2_ubs = [co2min + k * step for k in range(nb_iters+1)]
+
+    # ensure we minimize eco
+    ucpm.minimize(eco_kpi.as_expression())
+    all_co2s = []
+    all_ecos = []
+    for k in range(nb_iters+1):
+        co2_ub = co2min + k * step
+        print(" iteration #{0} co2_ub={1}".format(k, co2_ub))
+        co2_limit.ub = co2_ub + eps
+        assert ucpm.solve() is not None, "Solve failed"
+        cur_co2 = co2_kpi.compute()
+        cur_eco = eco_kpi.compute()
+        all_co2s.append(cur_co2)
+        all_ecos.append(cur_eco)
+    return all_co2s, all_ecos
+
+
+
#explore the co2/eco frontier in 50 points
+co2s, ecos = explore_ucp(nb_iters=50)
+
+
+
iteration #0 co2_ub=3399032.0
+iteration #1 co2_ub=3438559.7
+iteration #2 co2_ub=3478087.4
+iteration #3 co2_ub=3517615.1
+iteration #4 co2_ub=3557142.8
+iteration #5 co2_ub=3596670.5
+iteration #6 co2_ub=3636198.2
+iteration #7 co2_ub=3675725.9
+iteration #8 co2_ub=3715253.6
+iteration #9 co2_ub=3754781.3
+iteration #10 co2_ub=3794309.0
+iteration #11 co2_ub=3833836.7
+iteration #12 co2_ub=3873364.4
+iteration #13 co2_ub=3912892.1
+iteration #14 co2_ub=3952419.8
+iteration #15 co2_ub=3991947.5
+iteration #16 co2_ub=4031475.2
+iteration #17 co2_ub=4071002.9
+iteration #18 co2_ub=4110530.6
+iteration #19 co2_ub=4150058.3
+iteration #20 co2_ub=4189586.0
+iteration #21 co2_ub=4229113.7
+iteration #22 co2_ub=4268641.4
+iteration #23 co2_ub=4308169.1
+iteration #24 co2_ub=4347696.8
+iteration #25 co2_ub=4387224.5
+iteration #26 co2_ub=4426752.2
+iteration #27 co2_ub=4466279.9
+iteration #28 co2_ub=4505807.6
+iteration #29 co2_ub=4545335.3
+iteration #30 co2_ub=4584863.0
+iteration #31 co2_ub=4624390.7
+iteration #32 co2_ub=4663918.4
+iteration #33 co2_ub=4703446.1
+iteration #34 co2_ub=4742973.8
+iteration #35 co2_ub=4782501.5
+iteration #36 co2_ub=4822029.2
+iteration #37 co2_ub=4861556.9
+iteration #38 co2_ub=4901084.6
+iteration #39 co2_ub=4940612.3
+iteration #40 co2_ub=4980140.0
+iteration #41 co2_ub=5019667.7
+iteration #42 co2_ub=5059195.4
+iteration #43 co2_ub=5098723.1
+iteration #44 co2_ub=5138250.8
+iteration #45 co2_ub=5177778.5
+iteration #46 co2_ub=5217306.2
+iteration #47 co2_ub=5256833.9
+iteration #48 co2_ub=5296361.6
+iteration #49 co2_ub=5335889.3
+iteration #50 co2_ub=5375417.0
+
+
+
# normalize all values by dividing by their maximum
+eco_max = min_co2_eco_cost
+nxs = [c / co2max for c in co2s]
+nys = [e / eco_max for e in ecos]
+# plot a scatter chart of x=co2, y=costs
+plt.scatter(nxs, nys)
+# plot as one point
+plt.plot(prev_co2_cost/co2max, prev_eco_cost/eco_max, "rH", markersize=16)
+plt.xlabel("co2 cost")
+plt.ylabel("economic cost")
+plt.show()
+
+
+_images/ucp_pandas_75_0.png +

This figure demonstrates that the result obtained in the initial model +clearly favored economic cost over CO2 cost: CO2 cost is well above 95% +of its maximum value.

+
+
+
+

Summary

+

You learned how to set up and use IBM Decision Optimization CPLEX +Modeling for Python to formulate a Mathematical Programming model and +solve it with IBM Decision Optimization on Cloud.

+ +

Copyright � 2017-2019 IBM. IPLA licensed Sample Materials.

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp/warehouse.html b/docs/2.29.245/docs/mp/warehouse.html new file mode 100644 index 0000000..27896ee --- /dev/null +++ b/docs/2.29.245/docs/mp/warehouse.html @@ -0,0 +1,523 @@ + + + + + + + + + + The Warehouse Problem — DOcplex.MP: Mathematical Programming Modeling for Python V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

The Warehouse Problem

+

The Warehouse Problem is a well-know optimization case found in many +textbooks. The problem consists, given a set of candidate warehouse +locations and a set of stores to decide which warehouse to open and +which warehouse will server which store.

+
+

Input Data

+

Data is provided as follows:

+
    +

  • For each warehouse, we require a tuple (name, capacity, fixed-cost), +where name is the unique name of the warehouse, capacity is the +maximum number of stores it can supply and fixed_cost is the cost +incurred by opening the warehouse.

    • +

  • For each couple (warehouse, store) a supply_cost which estimates +the cost of supplying this store by this warehouse.

    • +
+

A compact way of representing the data is a Python dictionary: for +each warehouse tuple, list all supply costs for all stores.

+
+
+

Business Decisions

+

The problem consists in deciding which warehouse will be open and for +each store, by which warehouse it will be supplied.

+
+
+

Business Constraints

+

Decisions must satisfy the following (simplified) business constraints:

+
    +

  1. Unicity: each store is supplied by one unique warehouse

    2. +

  2. A store can only be supplied by an open warehouse

    3. +

  3. Capacity: the number of stores supplied by a warehouse must be less +than its capacity

    4. +
+
+
+

Business Objective

+

The goal is to minimize the total cost incurred by the decisions, which +is made of two costs:

+
    +

  • The Total Opening Cost is the sum of opening costs ranging over all +open warehouses.

    • +

  • The Total Supply Cost is the sum of supply costs for all the chosen +(warehouse, store) pairs

    • +
+

To begin with, let’s define a small warehouse dataset:

+
WAREHOUSES = {
+    ('Bonn', 1, 20): [20, 28, 74, 2, 46, 42, 1, 10, 93, 47],
+    ('Bordeaux', 4, 35): [24, 27, 97, 55, 96, 22, 5, 73, 35, 65],
+    ('London', 2, 32): [11, 82, 71, 73, 59, 29, 73, 13, 63, 55],
+    ('Paris', 1, 37): [25, 83, 96, 69, 83, 67, 59, 43, 85, 71],
+    ('Rome', 2, 25): [30, 74, 70, 61, 54, 59, 56, 96, 46, 95],
+    ('Brussels', 2, 28): [30, 74, 70, 61, 34, 59, 56, 96, 46, 95]
+}
+
+print(WAREHOUSES)
+print("#candidate warehouses=%d" % len(WAREHOUSES))
+print("#stores to supply=%d" % len(list(WAREHOUSES.values())[0]))
+
+
+
{('London', 2, 32): [11, 82, 71, 73, 59, 29, 73, 13, 63, 55], ('Bordeaux', 4, 35): [24, 27, 97, 55, 96, 22, 5, 73, 35, 65], ('Paris', 1, 37): [25, 83, 96, 69, 83, 67, 59, 43, 85, 71], ('Bonn', 1, 20): [20, 28, 74, 2, 46, 42, 1, 10, 93, 47], ('Brussels', 2, 28): [30, 74, 70, 61, 34, 59, 56, 96, 46, 95], ('Rome', 2, 25): [30, 74, 70, 61, 54, 59, 56, 96, 46, 95]}
+#candidate warehouses=6
+#stores to supply=10
+
+
+

Each key in the dictionary is a tuple with three fields: the name (a +string), the capacity (a positive integer) and the fixed cost (also +positive). Each value is a list of length 10 (the number of stores to +supply). the k^th element of the list being the supply cost from the +warehouse to the k^th store. For example,

+
    +

  • London warehouse can supply at most two stores

    • +

  • London warehouse has an opening cost of 30

    • +

  • The cost incurred by supplying the first store from London is 11

    • +
+
+
+

The math model

+
+
+

Solving with DOcplex

+

Now let’s solve this problem with DOcplex. First, we define named tuples +to store information relative to warehouses and stores in a clear and +convenient manner.

+
from collections import namedtuple
+
+class TWareHouse(namedtuple("TWarehouse1", ["id", "capacity", "fixed_cost"])):
+    def __str__(self):
+        return self.id
+
+class TStore(namedtuple("TStore1", ["id"])):
+    def __str__(self):
+        return 'store_%d' % self.id
+
+
+

Second, we compute the set of warehouse and store tuples. The use of +itervalues from the six module is a technicality to ensure +portability across Python 2 and Python3. We chose to model stores by an +integer range from 1 to nb_stores for convenience.

+
from six import itervalues
+
+nb_stores = 0 if not WAREHOUSES else len(next(itervalues(WAREHOUSES)))
+warehouses = [TWareHouse(*wrow) for wrow in WAREHOUSES.keys()]
+# we'll use the warehouses dictionary as a two-entry dictionary
+supply_costs = WAREHOUSES
+# we count stores from 1 to NSTORES included for convenience
+stores = [TStore(idx) for idx in range(1, nb_stores + 1)]
+
+
+
+
+

The model

+

First we need one instance of model to store our modeling artefacts

+
try:
+    import docplex.mp
+except:
+    !pip install docplex
+
+
+
from docplex.mp.environment import Environment
+env = Environment()
+env.print_information()
+
+
+
* system is: Windows 64bit
+* Python is present, version is 2.7.11
+* docplex is present, version is (2, 7, 113)
+
+
+
from docplex.mp.model import Model
+warehouse_model = Model()
+
+
+
+

Defining decision variables

+

In DOcplex, decision variables are related to objects of the business +model. In our case, we have two decisions to make: which warehouse is +open and, for each store, from which warehouse is it supplied.

+

First, we create one binary (yes/no) decision variable for each +warehouse: the variable will be equal to 1 if and only if the warehouse +is open. We use the binary_var_dict method of the model object to +create a dictionary from warehouses to variables. The first argument +states that keys of the dictionary will be our warehouse objects; the +second argument is a a simple string *’open’, that is used to generate +names for variables, by suffixing ‘open’ with the string representation +of warehouse objects (in other terms the output of the str() Python +function. This is the reason why we redefined the method **str** +method of class TWarehouse in the beginning.

+
open_vars = warehouse_model.binary_var_dict(keys=warehouses, name='open')
+
+
+

Second, we define one binary variable for each pair or (warehouse, +store). This is done using the method binary_var_matrix; in this +case keys to variables are all (warehouse, store) pairs.

+

The naming scheme applies to both components of pairs,for example the +variable deciding whether the London warehouse supplies store 1 will be +named supply_London_store_1.

+
supply_vars = warehouse_model.binary_var_matrix(warehouses, stores, 'supply')
+
+
+

At this step, we can check how many variables we have defined. as we +have 5 warehouses and 10 stores, we expect to have defined 5*10 + 5 = +55 variables.

+
warehouse_model.print_information()
+
+
+
Model: docplex_model1
+ - number of variables: 66
+   - binary=66, integer=0, continuous=0
+ - number of constraints: 0
+ -   LE=0, EQ=0, GE=0, RNG=0
+ - parameters: defaults
+
+
+

As expected, we have not defined any constraints yet.

+
+
+
+

Defining constraints

+

The first constraint states that each store is supplied by exactly one +warehouse. In other terms, the sum of supply variables for a given +store, ranging over all warehouses, must be equal to 1. Printing model +information, we check that this code defines 10 constraints

+
for s in stores:
+    warehouse_model.add_constraint(warehouse_model.sum(supply_vars[w, s] for w in warehouses) == 1)
+warehouse_model.print_information()
+
+
+
Model: docplex_model1
+ - number of variables: 66
+   - binary=66, integer=0, continuous=0
+ - number of constraints: 10
+ -   LE=0, EQ=10, GE=0, RNG=0
+ - parameters: defaults
+
+
+

The second constraints states that a store can be supplied only by an +open warehouse. To model this, we use a little trick of logic, +converting this logical implication (w supplies s) => w is open into an +inequality between binary variables, as in:

+
for s in stores:
+    for w in warehouses:
+        warehouse_model.add_constraint(supply_vars[w, s] <= open_vars[w])
+
+
+

whenever a supply var from warehouse w equals one, its open variable +will also be equal to one. Conversely, when the open variable is zero, +all supply variable for this warehouse will be zero. This constraint +does not prevent having an open warehouse supplying no stores. Though +this could be taken care of by adding an extra constraint, this is not +necessary as such cases will be automatically eliminated by searching +for the minimal cost (see the objective section).

+

The third constraint states the capacity limitation on each warehouse. +Note the overloading of the logical operator <= to express the +constraint.

+
for w in warehouses:
+    warehouse_model.add_constraint(warehouse_model.sum(supply_vars[w, s] for s in stores) <= w.capacity)
+
+
+

At this point we can summarize the variables and constraint we have +defined in the model.

+
warehouse_model.print_information()
+
+
+
Model: docplex_model1
+ - number of variables: 66
+   - binary=66, integer=0, continuous=0
+ - number of constraints: 76
+ -   LE=66, EQ=10, GE=0, RNG=0
+ - parameters: defaults
+
+
+
+
+

Defining the Objective

+

The objective is to minimize the total costs. There are two costs:

+
    +

  • the opening cost which is incurred each time a warehouse is open

    • +

  • the supply cost which is incurred by the assignments of warehouses to +stores

    • +
+

We define two linear expressions to model these two costs and state that +our objective is to minimize the sum.

+
total_opening_cost = warehouse_model.sum(open_vars[w] * w.fixed_cost for w in warehouses)
+total_opening_cost.name = "Total Opening Cost"
+
+def _get_supply_cost(warehouse, store):
+    ''' A nested function to return the supply costs from a warehouse and a store'''
+    return supply_costs[warehouse][store.id - 1]
+
+total_supply_cost = warehouse_model.sum([supply_vars[w,s] * _get_supply_cost(w, s) for w in warehouses for s in stores])
+total_supply_cost.name = "Total Supply Cost"
+
+warehouse_model.minimize(total_opening_cost + total_supply_cost)
+
+
+

The model is now complete and we can solve it and get the final optimal +objective

+
+
+

Solving the model

+
ok = warehouse_model.solve()
+assert ok
+obj = warehouse_model.objective_value
+print("optimal objective is %g" % obj)
+
+
+
optimal objective is 433
+
+
+

But there’s more: we can precise the value of those two costs, by +evaluating the value of the two expressions. Here we see that the +opening cost is 140 and the supply cost is 293.

+
opening_cost_obj = total_opening_cost.solution_value
+supply_cost_obj = total_supply_cost.solution_value
+print("total opening cost=%g" % opening_cost_obj)
+print("total supply cost=%g" % supply_cost_obj)
+
+# store results for later on...
+results=[]
+results.append((opening_cost_obj, supply_cost_obj))
+
+
+
total opening cost=140
+total supply cost=293
+
+
+
+
+

Displaying results

+

We can leverage the graphic toolkit maptplotlib to display the +results. First, let’s draw a pie chart of opening cost vs. supply costs +to clearly see the respective impact of both costs.

+
if env.has_matplotlib:
+    import matplotlib.pyplot as plt
+    %matplotlib inline
+
+def display_costs(costs, labels, colors):
+    if env.has_matplotlib:
+        plt.axis("equal")
+        plt.pie(costs, labels=labels, colors=colors, autopct="%1.1f%%")
+        plt.show()
+    else:
+        print("warning: no display")
+
+display_costs(costs=[opening_cost_obj, supply_cost_obj],
+              labels=["Opening Costs", "Supply Costs"],
+              colors=["gold", "lightBlue"])
+
+
+_images/warehouse_38_0.png +

We can also display the breakdown of supply costs per warehouse. First, +compute the sum of supply cost values for each warehouse: we need to sum +the actual supply cost from w to s for those pairs (w, s) whose variable +is true (here we test the value to be >=0.9, testing equality to 1 would +not be robust because of numerical precision issues)

+
supply_cost_by_warehouse = [ sum(_get_supply_cost(w,s) for s in stores if supply_vars[w,s].solution_value >= 0.9) for w in warehouses]
+wh_labels = [w.id for w in warehouses]
+display_costs(supply_cost_by_warehouse, wh_labels, None)
+
+
+_images/warehouse_40_0.png +
+
+

Exploring the Pareto frontier

+

remember we solved the model by minimizing the sum of the two costs, +getting an optimal solution with total cost of 383, with opening costs = +120 and supply costs = 263.

+

In some cases, it might be interesting to wonder what is the absolute +minimum of any of these two costs: what if we’d like to minimize opening +costs first, and then the supply cost (of course keeping the +best opeing cost we obtained in first phase.

+

This is very easy to achieve with DOcplex, using the +“solve_lexicographic” method on the model. This method takes two +arguments: the first one is a list of expressions, the second one a list +of senses (Minimize or Maximize), the default being to Minimize each +expression.

+

In this section we will explore hat happens when we minimize opening +costs then supply costs and conversely when we minimize supply costs +and then opening costs.

+
opening_first_then_supply = [ total_opening_cost, total_supply_cost]
+warehouse_model.solve_lexicographic(goals=opening_first_then_supply)
+
+opening1 = total_opening_cost.solution_value
+supply1 = total_supply_cost.solution_value
+results.append( (opening1, supply1))
+
+
+
* lexicographic ok, #passes=2, results=[120, 352]
+   - Total Opening Cost =120.000
+   - Total Supply Cost =352.000
+
+
+

From this we can see that the model has successfully solved twice and +that the absolute minimum of opening cost is 120, and for this value, +the minimum supply cost is 263. Remember that in our first attempt we +minimized the combined sum and obtained (120,263, but now we know 120 is +the best we can achieve. The supply cost is now 352 , for a total +combined cost of 472 which is indeed greater than the value of 433 we +found when optimizing the combined sum.

+

Now let’s do the reverse: minimize supply cost and then opening cost. +What if the goal of minimizing total supply cost supersedes the second +goal of optimizing total opening cost? The code is straightforward:

+
supply_first_then_opening = [ total_supply_cost, total_opening_cost]
+warehouse_model.solve_lexicographic(goals=supply_first_then_opening)
+opening2 = total_opening_cost.solution_value
+supply2 = total_supply_cost.solution_value
+
+results.append( (opening2, supply2))
+
+
+
* lexicographic ok, #passes=2, results=[288, 152]
+   - Total Supply Cost =288.000
+   - Total Opening Cost =152.000
+
+
+

Here, we obtain (152, 288), supply costs is down from 352 to 288 but +opening cost raises from 120 to 150. We can check that the combined sum +is 288+152 = 440, which is grater than the optimal of 433 we found at +the beginning.

+
+

Pareto Diagram

+

We can plot these three points on a (opening, supply) plane:

+
def display_pareto(res):
+    if env.has_matplotlib:
+        plt.cla()
+        plt.xlabel('Opening Costs')
+        plt.ylabel('Supply Costs')
+        colors = ['g', 'r', 'b']
+        markers = ['o', '<', '>']
+        nb_res = len(res)
+        pts = []
+        for i, r in enumerate(res):
+            opening, supply = r
+            p = plt.scatter(opening, supply, color=colors[i%3], s=50+10*i, marker=markers[i%3])
+            pts.append(p)
+        plt.legend(pts,
+               ('Sum', 'Opening_first', 'Supply_first'),
+               scatterpoints=1,
+               loc='best',
+               ncol=3,
+               fontsize=8)
+        plt.show()
+    else:
+        print("Warning: no display")
+
+display_pareto(results)
+
+
+_images/warehouse_47_0.png +
+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/mp_vs_cp.html b/docs/2.29.245/docs/mp_vs_cp.html new file mode 100644 index 0000000..2569bbb --- /dev/null +++ b/docs/2.29.245/docs/mp_vs_cp.html @@ -0,0 +1,169 @@ + + + + + + + + + + Mathematical programming versus constraint programming — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

Mathematical programming versus constraint programming

+

Mathematical programming and constraint programming are two technologies critical to solving complex planning and scheduling problems.

+

At IBM®, we find that knowing both technologies is important in addressing some of the most difficult optimization problems.

+

To make the most of each, it is important to understand their similarities and differences.

+
+

General model structure

+
+
    +

  • A constraint programming optimization model has the same structure as a mathematical programming model: a set of decision variables, an objective function to maximize or minimize, and a set of constraints.

    • +
+
+
+
+

Modeling differences

+
+
    +

  • A constraint programming model natively supports logical constraints as well as a full range of arithmetic expressions, including modulo, integer division, minimum, maximum, and an expression which indexes an array of values by a decision variable.

    • +

  • A constraint programming model can also use specialized constraints, such as the “all-different” constraint, that can accelerate searches for frequently used patterns.

    • +

  • A constraint programming model has no limitation on the arithmetic constraints that can be set on decision variables, while a mathematical programming engine is specific to a class of problems whose formulation satisfies certain mathematical properties (for example: quadratic, MIQCP, and convex vs non-convex).

    • +

  • A constraint programming model supports only discrete decision variables (integer or Boolean) and activity and time-based variables, while a mathematical programming model supports either discrete or continuous decision variables.

    • +
+
+
+
+

Optimization engine differences

+
+
    +

  • A constraint programming engine makes decisions on variables and values and, after each decision, performs a set of logical inferences to reduce the available options for the remaining variables’ domains. In contrast, a mathematical programming engine, in the context of discrete optimization, uses a combination of relaxations (strengthened by cutting-planes) and “branch and bound”.

    • +

  • A constraint programming engine proves optimality by showing that no better solution than the current one can be found, while a mathematical programming engine will use different techniques such as +a lower bound proof provided by cuts and linear relaxation.

    • +

  • A constraint programming engine does not make assumptions on the mathematical properties of the solution space (convexity, linearity etc.), while a mathematical programming engine requires that the model falls in a well-defined mathematical category such as Mixed Integer Quadratic Programming (MIQP).

    • +
+
+
+
+

Mathematical programming / Constraint programming comparison table

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Mathematical programming

Constraint programming

Conflict detection

Yes

Yes

Relaxation

Yes

Lower bound and optimality gap measure

Yes

Optimality proof

Yes

Yes

Modeler support

Yes

Yes

Model-and-run

Yes

Yes

Modeling limitations

Restricted to linear and quadratic problems

Restricted to discrete problems

Specialized constraints

Yes

Logical constraints

Yes

Yes

Theoretical basis

Algebra

Logical inferences

+
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/objects.inv b/docs/2.29.245/docs/objects.inv new file mode 100644 index 0000000..5f6290e --- /dev/null +++ b/docs/2.29.245/docs/objects.inv @@ -0,0 +1,5 @@ +# Sphinx inventory version 2 +# Project: IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) +# Version: V2.29 +# The remainder of this file is compressed using zlib. +xÚ…QËnÂ0¼ç+ö@êµ7"Z T.½E®³8–ü’½ÒêGôËêà„&ÔKÍîŒgvòçÅëªX—+T?Ö–Ãìòœ7¤ä 3•Ù[±XnŠ¹®ÇÛ0mÏ2îÆcî^Ð$Áî[È3iœ·Â3­¥™@#MŸgºb¨:M2/ÝoÜ$ŠŒ*ó„;W£ÄÚ%ZÌ€u$µüb$­4B¼V¬Ü‰š8½/Üo$ýU¯?ø9Jj òœŠfÿ2õJã8OX"—¡³RŽ}åÛuñ[£ê”÷ÖÃöüb¦m}ãLî4I:R[…ýÁô¤}£ͨÁø‘œ©I+ÚU‡Pñ+„õ/Ý¡B”m¸W÷Èñ?QRði¢€ÌófJLØPùy¾e³Ð:g=ôÐ¥…Ÿo(”$„]¿Û|Y¦’ ö \ No newline at end of file diff --git a/docs/2.29.245/docs/search.html b/docs/2.29.245/docs/search.html new file mode 100644 index 0000000..fbfa8e1 --- /dev/null +++ b/docs/2.29.245/docs/search.html @@ -0,0 +1,101 @@ + + + + + + + + + Search — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + + +
+ +
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/2.29.245/docs/searchindex.js b/docs/2.29.245/docs/searchindex.js new file mode 100644 index 0000000..b5fc7a1 --- /dev/null +++ b/docs/2.29.245/docs/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["CHANGELOG", "README.md", "cp", "getting_started", "getting_started_python", "index", "mp", "mp_vs_cp", "support"], "filenames": ["CHANGELOG.rst", "README.md.rst", "cp.rst", "getting_started.rst", "getting_started_python.rst", "index.rst", "mp.rst", "mp_vs_cp.rst", "support.rst"], "titles": ["Changelog", "README.md", "Overview of constraint programming", "Setting up an optimization engine", "Getting started with docplex", "IBM® Decision Optimization CPLEX® Modeling for Python", "Overview of mathematical programming", "Mathematical programming versus constraint programming", "IBM\u00ae Elite Support for DOcplex"], "terms": {"each": [0, 2, 6, 7], "record": 0, "solv": [0, 1, 2, 3, 5, 7], "histori": 0, "us": [0, 2, 6, 7, 8], "uniqu": [0, 2], "timestamp": 0, "its": [0, 2, 6], "field": [0, 6], "In": [0, 2, 6, 7], "docplex": [0, 1, 3], "cp": [0, 1, 3], "robustifi": 0, "handl": [0, 5, 6], "callback": [0, 2], "messag": 0, "come": 0, "from": [0, 2, 3, 4, 5, 6, 8], "optim": [0, 1, 4, 8], "allow": [0, 2, 3, 6], "numpi": [0, 1, 4, 5], "pep517": 0, "pep518": 0, "build": [0, 2, 6, 8], "faster": 0, "pwl": 0, "pr": 0, "support": [0, 4, 5, 6, 7], "transact": 0, "output": 0, "attach": 0, "op": 0, "file": 0, "paramet": [0, 2], "improv": [0, 6], "nurs": 0, "exampl": [0, 1, 2, 3, 5, 7], "option": [0, 2, 4, 7], "cplex": [0, 1, 2, 8], "import": [0, 6, 7], "qiskit": 0, "fix": [0, 6, 8], "cut": [0, 6, 7], "getter": 0, "studio": [0, 1, 5], "runtim": [0, 3], "cleanup": 0, "code": 0, "relat": [0, 2], "watson": [0, 3], "machin": [0, 1, 2, 3], "learn": [0, 3, 4, 6], "mp": [0, 1, 3], "sensit": 0, "analysi": [0, 4], "solut": [0, 2, 6, 7], "infer": [0, 7], "statement": 0, "sub_circuit": 0, "constraint": [0, 3, 4, 6], "condit": [0, 5], "modul": [0, 1, 5], "sched_jobshop_blackbox": 0, "py": 0, "set": [0, 2, 5, 7], "multi": [0, 2], "object": [0, 2, 6, 7], "bug": [0, 5, 8], "correct": 0, "document": [0, 1, 3, 4], "url": 0, "current": [0, 4, 5, 7], "offer": [0, 8], "remov": [0, 2], "deprec": 0, "docloud_context": 0, "perform": [0, 2, 4, 6, 7], "model": [0, 1, 3, 6, 8], "ad": 0, "new": [0, 4, 5, 6], "blackbox": 0, "function": [0, 6, 7], "featur": [0, 2, 4, 6], "wrote": 0, "full": [0, 3, 7], "searchtyp": 0, "neighborhood": [0, 2], "same_common_subsequ": 0, "problem": [0, 1, 2, 5, 7], "order": [0, 2, 3, 6], "comput": [0, 2, 4, 5, 6], "actual": 0, "zeppelin": 0, "variant": 0, "sum": 0, "variabl": [0, 2, 3, 6, 7], "number": [0, 2], "argument": [0, 2], "all": [0, 2, 7], "python2": 0, "compat": [0, 2], "determinist": 0, "time": [0, 2, 6, 7], "detail": [0, 2, 3, 4, 8], "linear": [0, 2, 5, 7], "relax": [0, 6, 7], "now": 0, "so": [0, 2, 3], "solve_with_go": 0, "quadrat": [0, 6, 7], "sub": 0, "solvesolut": 0, "kpi_value_by_nam": 0, "get_value_dict": 0, "about": [0, 3, 6], "precis": 0, "filter": 0, "when": [0, 2, 3, 4, 6], "updat": [0, 3, 4, 5], "rh": 0, "nan": 0, "valu": [0, 2, 5, 6, 7], "rais": 0, "except": 0, "add": [0, 1, 5], "method": [0, 6], "get_objective_valu": 0, "get_objective_bound": 0, "get_objective_gap": 0, "cpomodelsolut": 0, "cposolveresult": 0, "access": [0, 1, 3, 4, 8], "directli": 0, "first": [0, 2, 3, 4, 6], "bound": [0, 6, 7], "gap": [0, 7], "real": [0, 2, 6], "call": 0, "abort_search": 0, "instead": 0, "kill": 0, "solver": [0, 3, 6], "get_paramet": 0, "cposolv": 0, "retriev": 0, "differ": [0, 2], "provid": [0, 3, 4, 6, 7], "can": [0, 1, 2, 3, 4, 5, 6, 7, 8], "match": [0, 2, 4], "between": [0, 2], "both": [0, 2, 4, 6, 7], "import_solut": 0, "contextu": 0, "temporarili": 0, "modifi": 0, "aspect": 0, "model_paramet": 0, "block": 0, "model_object": 0, "temporari": 0, "name": [0, 6], "express": [0, 2, 7], "i": [0, 1, 3, 4, 6, 7, 8], "need": [0, 1, 2, 3, 4, 5, 6, 8], "displai": 0, "customiz": 0, "space": [0, 2, 7], "separ": 0, "maximum": [0, 7], "length": 0, "veri": 0, "long": [0, 2], "refer": [0, 3, 4, 5, 6], "class": [0, 7], "var": 0, "move": [0, 2], "dvar": 0, "lp": 0, "export": 0, "prioriti": 0, "pass": 0, "replac": 0, "context": [0, 7], "attribut": 0, "solve_with_start_next": 0, "solve_with_search_next": 0, "keep": [0, 4], "ascend": 0, "modelanonym": 0, "gener": [0, 2, 6], "random": 0, "element": 0, "kpi": 0, "cpo": [0, 3], "format": 0, "python": [0, 1, 3, 8], "interv": [0, 2], "tupl": 0, "ar": [0, 1, 2, 3, 4, 5, 6, 7, 8], "cpomodel": 0, "accept": 0, "multipl": [0, 6], "list": [0, 3, 4, 5], "pool": 0, "sol": 0, "fast": [0, 5], "batch": [0, 2], "change_var_lower_bound": 0, "change_var_upper_bound": 0, "reset": 0, "seed": 0, "wa": [0, 3, 6], "co": 0, "releas": [0, 6], "creation": 0, "warn": 0, "solve_statu": 0, "advmodel": 0, "ha": [0, 2, 6, 7], "checker": 0, "enabl": [0, 2, 6], "default": [0, 2, 3], "avoid": 0, "error": 0, "up": [0, 2, 5], "user": 0, "disabl": 0, "type": [0, 2], "check": [0, 3, 4], "get": [0, 1], "print": 0, "sav": 0, "round": 0, "behavior": 0, "step": [0, 5], "oper": [0, 2, 4, 5, 6], "statu": [0, 2], "conflict": [0, 2, 7], "refin": 0, "send": 0, "receiv": 0, "enhanc": 0, "The": [0, 3, 4, 6], "search_next": 0, "return": 0, "onli": [0, 7], "particular": [0, 6], "just": 0, "feasibl": [0, 2], "rework": 0, "complet": [0, 2], "statist": 0, "cpomodelstatist": 0, "add_cpo": 0, "write": 0, "cporefineconflictresult": 0, "gz": 0, "remove_express": 0, "one": [0, 2, 4, 7], "shot": 0, "describ": [0, 2], "how": [0, 6], "privat": 0, "flat": 0, "string": 0, "represent": 0, "constant": 0, "json": 0, "case": 0, "doubl": 0, "ident": 0, "latest": [0, 1, 3], "pickl": 0, "edit": [0, 1, 3, 4], "an": [0, 1, 2, 4, 5, 7, 8], "piecewis": 0, "could": 0, "environ": [0, 5, 8], "docplex_cp_context": 0, "configur": [0, 3], "check_list": 0, "report": [0, 5, 8], "execut": 0, "docloud": 0, "includ": [0, 2, 3, 4, 6, 7], "custom": [0, 2, 5], "better": [0, 2, 5, 6, 7], "directori": [0, 4], "sort_nam": 0, "drive": 0, "sort": 0, "declar": [0, 2], "mai": [0, 2, 4], "crash": 0, "local": [0, 3], "add_quadratic_constraint": 0, "populate_solution_pool": 0, "nativ": [0, 7], "solurt": 0, "absolut": 0, "rel": 0, "toler": 0, "if_then": 0, "form": 0, "b": 0, "addit": [0, 8], "boolean": [0, 2, 7], "For": [0, 2, 3, 4, 5, 6], "been": 0, "instal": [0, 1, 6], "If": [0, 3, 4, 5], "version": [0, 1, 3, 4, 5], "cplex_studio_dirxxx": [0, 3], "found": [0, 2, 3, 7], "unless": 0, "engin": [0, 2, 4, 5], "state": [0, 2], "otherwis": 0, "pngfile": 0, "visu": 0, "show": [0, 7], "store": 0, "png": 0, "screen": 0, "make": [0, 2, 5, 6, 7], "info": 0, "also": [0, 2, 4, 6, 7], "avail": [0, 2, 3, 4, 5, 6, 7, 8], "refine_conflict": 0, "integerdomain": 0, "repres": [0, 2, 6, 8], "domain": [0, 2, 5, 7], "integ": [0, 2, 7], "specif": [0, 5, 7], "__str__": 0, "ceil": 0, "floor": 0, "trunc": 0, "sgn": 0, "38": 0, "cumulexpr": 0, "zero": 0, "implement": 0, "factor": 0, "common": [0, 2], "scal_prod": 0, "arrai": [0, 2, 7], "size": [0, 1, 3], "strict_lexicograph": 0, "lexicograph": [0, 2], "failur": 0, "explan": [0, 6], "explain_failur": 0, "log": 0, "tag": 0, "sever": [0, 2, 8], "manag": [0, 2, 5, 6, 8], "process": [0, 2, 5, 8], "timeout": 0, "delai": [0, 2], "cpoptim": 0, "last": 0, "search": [0, 2, 3, 6, 7], "next": [0, 5], "sequenc": [0, 2], "run": [0, 3, 6, 7], "result": [0, 2, 6], "quadratic_dual_slack": 0, "were": [0, 6], "incorrectli": 0, "pars": 0, "section": [0, 6, 8], "add_constraint": 0, "comment": 0, "get_fail_statu": 0, "solveresult": 0, "wrong": 0, "dequ": 0, "collect": 0, "abc": 0, "track": 0, "event": [0, 5], "notebook": [0, 3, 4], "cloud": [0, 3, 5], "agent": 0, "depend": [0, 1, 2, 3, 4, 6], "packag": [0, 8], "you": [0, 1, 2, 3, 4, 5, 6, 8], "explicit": 0, "pip": [0, 1], "docplexcloud": 0, "export_as_mps_str": 0, "export_as_sav_str": 0, "dettime_limit": 0, "limit": [0, 1, 2, 3, 5, 6, 7], "mi": 0, "interpret": [0, 4], "none": 0, "cplexcloud": 0, "node": 0, "alwai": 0, "repeat": 0, "restart": 0, "start": [0, 2, 3], "where": [0, 3], "stop": 0, "keyword": 0, "time_limit": 0, "is_valid_solut": 0, "modelread": 0, "rang": [0, 2, 7], "invert": 0, "read": 0, "set_lex_multiobj": 0, "abstol": 0, "reltol": 0, "ignor": 0, "proper": 0, "add_indicator_constraint": 0, "line": 0, "direct": 0, "logsearchtag": 0, "public": 0, "minor": 0, "concern": 0, "compil": 0, "linearrelax": 0, "copi": 0, "mip": 0, "possibl": [0, 2, 6], "see": [0, 1, 3, 4], "relax_linear": 0, "interact": [0, 4, 5, 6], "much": [0, 6], "k": [0, 4], "x": [0, 4], "did": 0, "notifi": 0, "cts_by_nam": 0, "true": 0, "constructor": 0, "logic": [0, 2, 7], "binari": 0, "freeli": 0, "nest": 0, "1217": 0, "log_output": 0, "creat": [0, 3, 5, 6], "empti": 0, "logical_and": 0, "typeerror": 0, "occur": 0, "progressdata": 0, "initi": [0, 1, 3], "which": [0, 2, 4, 5, 6, 7], "prevent": [0, 5], "work": [0, 2], "properli": 0, "add_ind": 0, "comprehens": 0, "len": 0, "equal": 0, "clarifi": 0, "four": [0, 6], "off": [0, 5, 6], "numer": [0, 2], "specifi": [0, 2, 3, 4], "encod": 0, "nonconvex": 0, "qp": 0, "lazi": 0, "add_lazy_constraint": 0, "add_user_cut_constraint": 0, "basi": [0, 6, 7], "basis_statu": 0, "mst": 0, "effort": 0, "level": [0, 2, 5, 6], "ba": 0, "ord": 0, "dictionari": 0, "correctli": 0, "progress": 0, "listen": 0, "set_lp_start_basi": 0, "try": 0, "member": [0, 1, 3], "doe": [0, 4, 7], "exist": [0, 3, 4], "thrown": 0, "map_solut": 0, "parser": 0, "startingpoint": 0, "skip": 0, "experiment": 0, "simplifi": 0, "reduc": [0, 2, 6, 7], "singl": 0, "second": [0, 6], "share": 0, "librari": [0, 1, 2, 5, 6], "iter": 0, "global": [0, 3, 4], "get_version_info": 0, "get_solver_verion": 0, "By": 0, "without": 0, "cpoparamet": 0, "allowed_assign": 0, "forbidden_assign": 0, "On": 0, "thar": 0, "mzn": 0, "gzip": 0, "zip": 0, "unexpect": 0, "ex": 0, "link": 0, "rawgit": 0, "com": [0, 1, 3, 4, 5, 8], "thi": [0, 1, 2, 3, 5, 6, 8], "servic": [0, 2, 3, 4, 5, 8], "go": [0, 5, 8], "end": [0, 2], "life": [0, 2], "solve_lexicograph": 0, "should": 0, "set_multi_object": 0, "prefer": 0, "sourc": [0, 5, 8], "submit": 0, "http": [0, 1, 3, 4], "ibm": [0, 1, 2, 6, 7], "biz": [0, 1], "bdyhhk": 0, "being": 0, "futur": [0, 1, 5], "api": [0, 5], "indic": 0, "no_overlap": 0, "always_const": 0, "always_equ": 0, "point": 0, "what": [0, 6], "domain_min": 0, "domain_max": 0, "domain_iter": 0, "domain_contain": 0, "cpointvar": 0, "cpointvarsolut": 0, "consequ": 0, "multipli": 0, "product": [0, 2, 3, 6], "previou": [0, 5], "slack": 0, "dual": 0, "A": [0, 2, 4, 6, 7], "must": [0, 2, 3, 4], "belong": 0, "valid": 0, "infeas": 0, "e": 0, "lb": 0, "ub": 0, "fail": 0, "thei": [0, 2, 3, 6], "two": [0, 7], "non": [0, 2, 7], "compliant": 0, "becaus": 0, "_": [0, 3, 4, 8], "parenthes": 0, "split": 0, "fzn": 0, "stuff": 0, "construct": [0, 2], "save": 0, "30": 0, "convers": 0, "extend": 0, "set_paramet": 0, "clone": 0, "given": [0, 2], "add_paramet": 0, "associ": [0, 2, 6], "locat": [0, 6], "anoth": 0, "auto": 0, "searchphas": 0, "more": [0, 3, 8], "mean_ub": 0, "mean_lb": 0, "standard_devi": 0, "phase": 0, "slope_piecewise_linear": 0, "coordinate__piecewise_linear": 0, "timelimit": 0, "worker": 0, "cli": 0, "gain": [0, 5, 8], "publish": 0, "kei": 0, "credenti": 0, "config": 0, "min": 0, "max": 0, "flatzinc": 0, "capabl": [0, 1, 3], "minizinc": 0, "challeng": [0, 6], "side": 0, "No": 0, "have": [0, 3, 4, 5, 6], "realloc": 0, "same": [0, 7], "get_express": 0, "get_named_expressions_dict": 0, "solverprogresspanellisten": 0, "automat": [0, 1, 2, 3, 4], "loop": 0, "substitut": 0, "whole": 0, "overwrit": 0, "__bool__": 0, "accident": 0, "special": [0, 2, 7], "min_of": 0, "max_of": 0, "all_diff": 0, "length_for_renam": 0, "length_for_alia": 0, "add_var": 0, "shortcut": 0, "add_integer_var_solut": 0, "add_interval_var_solut": 0, "__contains__": 0, "easili": [0, 1, 2, 5], "verifi": [0, 4], "export_model": 0, "get_cpo_str": 0, "some": [0, 2, 6, 7], "docplex2": 0, "port": 0, "aix": [0, 4], "plinux": [0, 4], "scikit": 0, "transform": 0, "panda": [0, 4, 5], "scipi": [0, 4], "matrix": 0, "equival": 0, "rshift": 0, "meta": 0, "discret": [0, 2, 6, 7], "truth": 0, "hook": 0, "intermedi": 0, "coo": 0, "csr": 0, "run_se": 0, "searchstatu": 0, "searchstopcaus": 0, "propag": [0, 2], "individu": [0, 2], "identifi": [0, 2], "everywher": 0, "unus": 0, "cposolverlisten": 0, "put": 0, "solver_listen": 0, "contain": [0, 2], "sampl": [0, 4], "autostoplisten": 0, "standard": [0, 2, 3, 4], "usag": 0, "solvelisten": 0, "greater": [0, 5], "accuraci": 0, "angel": 0, "minim": [0, 2, 6, 7], "maxim": [0, 2, 6, 7], "solver_angel": 0, "renam": 0, "solver_loc": 0, "shadow": 0, "still": 0, "preserv": 0, "solverangel": 0, "solverloc": 0, "angelexcept": 0, "localsolverexcept": 0, "logical_or": 0, "abl": 0, "defect": [0, 8], "forbiden_assign": 0, "wrongli": 0, "convert": 0, "tupe": 0, "tuple_set": 0, "them": [0, 5, 6], "data": [0, 4, 5, 6], "prepar": 0, "sched_rcpspmm_json": 0, "raw": 0, "cpotupleset": 0, "simpli": 0, "tupleset": 0, "requir": [0, 1, 2, 6, 7], "overload": 0, "builtin": 0, "ani": [0, 2], "other": [0, 2, 6], "state_funct": 0, "transit": [0, 2], "howev": 0, "automaticreplai": 0, "get_search_statu": 0, "get_stop_caus": 0, "cos12": 0, "reduced_cost": 0, "import_model": 0, "respect": [0, 2], "scheduling_tuto": 0, "ipynb": 0, "extens": [0, 2, 6], "tutori": [0, 5, 6], "schedul": [0, 6, 7], "cumul": [0, 2], "start_search": 0, "auto_publish": 0, "script": 0, "util": 0, "set_stop_callback": 0, "get_stop_callback": 0, "job": [0, 2], "abort": 0, "bender": 0, "decomposit": 0, "annot": 0, "benders_annot": 0, "properti": [0, 2, 7], "govern": 0, "report_kpi": 0, "unicod": 0, "There": 0, "": [0, 2, 4, 6], "simpl": [0, 4, 6], "command": [0, 3, 4], "interfac": 0, "It": [0, 2, 5, 6], "termin": 0, "m": [0, 4], "help": [0, 4, 5, 6, 8], "That": 0, "your": [0, 1, 4, 8], "cplex_config": 0, "delet": 0, "too": 0, "docplex_cli": 0, "magic": 0, "docplex_url": 0, "docplex_kei": 0, "mechan": [0, 2], "defin": [0, 2, 7], "breakpoint": 0, "slope": 0, "arithmet": [0, 2, 7], "subtract": 0, "scale": [0, 2], "undergon": 0, "signific": 0, "overhaul": 0, "averag": 0, "50": 0, "part": [0, 4], "benefit": [0, 2], "fulli": 0, "similarli": 0, "complex": [0, 2, 5, 7], "workflow": 0, "after": [0, 2, 4, 7], "again": 0, "anaconda": [0, 3, 4], "via": [0, 3, 4], "conda": [0, 5], "home": [0, 3, 4], "commun": [0, 1, 3], "free": [0, 1, 2, 3, 4, 5, 6], "docplexrc": 0, "drop": 0, "sinc": [0, 2], "known": 0, "incompat": [0, 2], "abstractmodel": 0, "absmodel": 0, "upgrad": [0, 3, 4], "client": 0, "offici": 0, "effici": [0, 2, 6, 8], "aggreg": 0, "larg": [0, 2, 3, 6], "proxi": 0, "issu": [0, 6, 8], "fatal": 0, "take": [0, 5], "over": [0, 2, 4, 6], "valueerror": 0, "datafram": 0, "index": [0, 7], "get_valu": 0, "longer": 0, "previous": [0, 6], "jobsolvestatu": 0, "unknown": 0, "reg": [1, 2, 3, 4, 6, 7], "decis": [1, 2, 3, 4, 6, 7, 8], "welcom": [1, 5], "licens": [1, 5], "under": [1, 5], "apach": [1, 5], "v2": 1, "0": [1, 3, 5], "With": [1, 5], "quickli": [1, 2, 5], "power": [1, 5, 6], "applic": [1, 5, 6, 8], "ilog": [1, 2, 5, 6], "compos": [1, 5], "2": [1, 3, 4, 5], "namespac": 1, "v12": [1, 3], "10": 1, "later": [1, 3], "friendli": [1, 5], "ibmdecisionoptim": [1, 3, 4], "github": [1, 4], "io": 1, "doc": 1, "archiv": 1, "23": 1, "222": 1, "22": 1, "213": 1, "21": 1, "207": 1, "20": [1, 6], "204": 1, "19": 1, "202": 1, "18": 1, "200": 1, "16": [1, 3], "195": [1, 4], "www": [1, 3, 4], "account": [1, 3, 4, 5], "u": [1, 6, 8], "en": 1, "signup": 1, "formid": 1, "urx": 1, "20028": 1, "term": 1, "faculti": [1, 3], "research": [1, 3, 6], "profession": [1, 2, 3, 6], "accredit": [1, 3], "institut": [1, 3, 6], "unlimit": 1, "through": [1, 2, 5, 8], "academ": [1, 2, 3, 6], "student": 1, "These": [1, 2, 6], "third": 1, "parti": 1, "pypi": [1, 3, 4, 5], "org": [1, 4], "request": 1, "six": 1, "certifi": 1, "deliv": [1, 6, 8], "januari": 1, "2004": 1, "txt": 1, "ldquo": 2, "rdquo": 2, "find": [2, 3, 4, 7], "combinatori": 2, "primarili": 2, "scienc": [2, 4, 6], "fundament": [2, 6], "graph": 2, "theori": 2, "contrast": [2, 7], "mathemat": [2, 3, 4], "algebra": [2, 7], "invalu": 2, "deal": 2, "mani": [2, 3, 4, 6], "world": [2, 6], "whether": [2, 6], "hand": 2, "peopl": 2, "relationship": [2, 6], "activ": [2, 7], "fashion": 2, "criteria": 2, "heurist": 2, "mix": [2, 7], "satisfi": [2, 7], "theoret": [2, 7], "deduct": 2, "inform": [2, 3, 6], "perhap": 2, "further": 2, "variou": [2, 5, 6], "strategi": 2, "until": 2, "assign": 2, "everi": [2, 6], "proce": 2, "major": 2, "enumer": 2, "bucket": 2, "period": 2, "therefor": 2, "formul": [2, 6, 7], "regardless": 2, "relev": 2, "millisecond": 2, "minut": 2, "hour": 2, "capac": 2, "tempor": 2, "pure": 2, "consist": [2, 6], "decid": 2, "most": [2, 4, 6, 7], "instanc": [2, 3, 4], "satisfact": 2, "distinguish": 2, "disjunct": 2, "parallel": [2, 6], "exceed": 2, "preemptiv": 2, "cannot": 2, "interrupt": 2, "combin": [2, 6, 7], "basic": [2, 6], "revolv": 2, "around": 2, "busi": [2, 5, 6], "polici": 2, "while": [2, 6, 7], "meet": [2, 4, 5], "goal": [2, 5], "task": 2, "final": [2, 6], "group": 2, "breakdown": 2, "structur": 2, "preced": 2, "appli": [2, 6], "typic": 2, "cost": [2, 6, 8], "tardi": 2, "total": 2, "durat": 2, "presenc": 2, "finit": 2, "reservoir": 2, "inventori": 2, "calendar": 2, "date": 2, "overlap": 2, "break": 2, "chang": [2, 3, 5, 6], "enforc": 2, "pack": 2, "item": 2, "dimens": 2, "weight": 2, "budget": 2, "lexic": 2, "conveni": 2, "symmetri": 2, "count": 2, "deviat": 2, "concept": [2, 6], "wai": [2, 3, 4, 5], "workabl": 2, "awar": 2, "algorithm": [2, 5], "determin": [2, 6], "best": 2, "setup": 2, "mainten": 2, "restrict": [2, 6, 7], "deliveri": 2, "due": 2, "exploit": 2, "aggress": 2, "elimin": 2, "reduct": 2, "intern": [2, 6], "difficult": [2, 6, 7], "alloc": 2, "certain": [2, 7], "systemat": [2, 6], "reach": 2, "easier": 2, "throughout": 2, "rapidli": 2, "travers": 2, "tree": 2, "explor": 2, "One": 2, "approach": 2, "abil": 2, "flexibli": 2, "backtrack": 2, "earli": 2, "choic": [2, 6], "turn": [2, 4], "out": 2, "dead": 2, "adapt": 2, "techniqu": [2, 7], "dynam": [2, 5], "dure": 2, "ln": 2, "ga": 2, "genet": 2, "built": [2, 6], "redund": 2, "reformul": 2, "architectur": 2, "column": 2, "test": [2, 6], "tune": 2, "definit": [2, 6], "lectur": [2, 6], "languag": [2, 6], "acceler": [2, 7], "develop": [2, 3, 6, 8], "onlin": [2, 4, 5, 6, 8], "train": [2, 4, 5, 6], "pascal": 2, "van": 2, "hentenryck": 2, "book": [2, 4, 5, 6], "principl": [2, 4], "krzysztof": 2, "apt": 2, "morgan": 2, "kaufmann": 2, "seri": [2, 4], "artifici": 2, "intellig": 2, "rina": 2, "dechter": 2, "handbook": 2, "foundat": [2, 6], "francesca": 2, "rossi": 2, "peter": 2, "beek": 2, "tobi": 2, "walsh": 2, "baptist": 2, "le": 2, "pape": 2, "nuijten": 2, "youtub": [2, 6], "video": [2, 6], "w": 2, "dr": 2, "kruk": 2, "american": 2, "univers": [2, 4, 6], "colloquium": 2, "societi": [2, 6], "\u00bd": [3, 4, 8], "\u00bc": [3, 4, 8], "\u215b": [3, 4, 8], "\u00be": [3, 4, 8], "\u215c": [3, 4, 8], "\u215d": [3, 4, 8], "\u215e": [3, 4, 8], "\u00b5": [3, 4, 8], "\u03c9": [3, 4, 8], "\u00aa": [3, 4, 8], "\u00ba": [3, 4, 8], "\u00b9": [3, 4, 8], "\u00b2": [3, 4, 8], "\u00b3": [3, 4, 8], "program": [3, 4], "8": 3, "higher": 3, "additionnali": 3, "here": [3, 4, 5, 8], "deploy": [3, 6], "download": [3, 4], "anacondacloud": 3, "ai": 3, "qualifi": 3, "organ": [3, 5], "join": 3, "select": 3, "softwar": [3, 6, 8], "charg": 3, "deploi": 3, "host": [3, 4], "sign": [3, 4], "ll": [3, 4], "alreadi": [3, 4], "befor": 3, "written": [3, 6], "do": 3, "ultim": 3, "system": 3, "follow": [3, 4, 6], "look": [3, 4], "inspect": 3, "xxx": 3, "overrid": 3, "behaviour": 3, "experi": [3, 4], "1000": 3, "tool": [3, 8], "7": [3, 4], "9": 3, "3": [3, 4], "6": [3, 4], "easi": [3, 4], "uninstal": [3, 4], "readm": [3, 4], "md": [3, 4], "distribut": [3, 4, 6], "platform": [3, 4], "window": [3, 4], "linux": [3, 4], "x86": 3, "64": [3, 4], "osx": 3, "c": [3, 4, 6], "continuum": [3, 4], "channel": [3, 4], "ppc64le": [3, 4], "To": [4, 7], "As": 4, "altern": 4, "choos": 4, "__": 4, "anyth": 4, "easiest": 4, "involv": [4, 6], "bit": 4, "lifespan": 4, "we": [4, 7], "mac": 4, "z": 4, "ssl": 4, "might": [4, 6], "want": 4, "editor": 4, "debugg": 4, "pycharm": 4, "pydev": 4, "good": 4, "popular": 4, "math": 4, "visual": 4, "project": 4, "microsoft": 4, "virtual": 4, "base": [4, 5, 6, 7], "site": 4, "clean": 4, "extract": 4, "5": 4, "cours": 4, "everybodi": 4, "gather": 4, "analyz": [4, 5], "michigan": 4, "introduct": [4, 6], "1": [4, 8], "rice": 4, "big": 4, "hard": [4, 6], "introduc": 4, "modern": 4, "bill": 4, "lubanov": 4, "5th": 4, "mark": 4, "lutz": 4, "high": [4, 6], "practic": [4, 6], "human": 4, "micha": 4, "gorelick": 4, "doug": 4, "hellmann": 4, "cookbook": 4, "david": 4, "beazlei": 4, "brian": 4, "jone": 4, "essenti": 4, "nutshel": [4, 5], "alex": 4, "martelli": 4, "scientif": 4, "scratch": 4, "joel": 4, "gru": 4, "wrangl": 4, "ipython": 4, "mckinnei": 4, "overview": [4, 5], "eli": 4, "bressert": 4, "beginn": 4, "guid": 4, "ivan": 4, "idri": 4, "confer": 4, "recommend": 5, "action": 5, "desir": 5, "outcom": 5, "scenario": 5, "resourc": 5, "knowledg": 5, "past": 5, "insight": 5, "control": 5, "path": 5, "synergi": 5, "predict": 5, "suggest": 5, "situat": [5, 6], "act": 5, "superior": 5, "uncertain": 5, "strong": 5, "competit": 5, "advantag": [5, 8], "autom": 5, "trade": 5, "opportun": 5, "mitig": 5, "risk": 5, "proactiv": 5, "increas": [5, 6], "loyalti": 5, "threat": 5, "fraud": 5, "topic": 5, "present": [5, 6], "versu": 5, "beyond": 5, "manual": 5, "pleas": [5, 8], "contact": 5, "dofeedback": [5, 8], "wwpdl": [5, 8], "vnet": [5, 8], "social": 5, "media": 5, "revolution": 6, "year": 6, "ago": 6, "commerci": 6, "market": 6, "gave": 6, "unpreced": 6, "flexibl": 6, "reliabl": [6, 8], "novel": 6, "itself": 6, "pun": 6, "simplex": 6, "invent": 6, "georg": 6, "dantzig": 6, "1947": 6, "becam": 6, "entir": 6, "evolv": 6, "embrac": 6, "becom": 6, "leader": 6, "children": 6, "categori": [6, 7], "familiar": 6, "interest": 6, "goe": 6, "highest": 6, "down": 6, "advanc": 6, "extern": 6, "behind": 6, "compon": 6, "quantiti": 6, "affect": 6, "quantifi": 6, "mean": 6, "effect": 6, "proport": 6, "magnitud": 6, "seem": 6, "overli": 6, "manner": 6, "industri": 6, "manufactur": 6, "blend": 6, "econom": 6, "plan": [6, 7], "factori": 6, "farm": 6, "food": 6, "refineri": 6, "suppli": 6, "chain": 6, "tabl": 6, "manpow": 6, "transport": 6, "network": 6, "flow": 6, "sometim": 6, "enough": 6, "captur": 6, "essenc": 6, "particularli": 6, "open": [6, 8], "warehous": 6, "continu": [6, 7], "convex": [6, 7], "cone": 6, "vehicl": 6, "rout": 6, "facil": 6, "personnel": 6, "plant": 6, "commit": 6, "materi": 6, "design": 6, "harder": 6, "than": [6, 7], "sophist": 6, "violat": 6, "innov": 6, "technologi": [6, 7], "made": 6, "consid": 6, "intract": 6, "thu": 6, "framework": 6, "profit": 6, "constrain": 6, "leverag": 6, "robust": 6, "million": 6, "lead": 6, "impress": 6, "rate": 6, "ampl": 6, "serv": 6, "well": [6, 7], "speed": 6, "todai": 6, "biggest": 6, "divers": 6, "european": 6, "mit": 6, "princeton": 6, "baltimor": 6, "optimis": 6, "dimitri": 6, "bertsima": 6, "john": 6, "n": 6, "tsitsikli": 6, "understand": [6, 7], "jiri": 6, "matousek": 6, "bernd": 6, "gartner": 6, "h": 6, "p": 6, "william": 6, "wilei": 6, "robert": 6, "j": 6, "vanderbei": 6, "springer": 6, "playlist": 6, "feder": 6, "societ": 6, "francais": 6, "de": 6, "recherch": 6, "operationel": 6, "et": 6, "d": 6, "aid": 6, "la": 6, "yourself": 6, "ponder": 6, "monthli": 6, "puzzl": 6, "puzzlor": 6, "mathematician": 6, "critic": [7, 8], "At": 7, "know": 7, "address": 7, "similar": 7, "modulo": 7, "divis": 7, "minimum": 7, "frequent": 7, "pattern": 7, "whose": 7, "miqcp": 7, "v": 7, "either": 7, "remain": 7, "strengthen": 7, "plane": 7, "branch": 7, "prove": 7, "lower": 7, "proof": 7, "assumpt": 7, "etc": 7, "fall": 7, "miqp": 7, "detect": 7, "ye": 7, "measur": 7, "technic": 8, "give": 8, "expert": 8, "mission": 8, "phone": 8, "24x7": 8, "submiss": 8, "triag": 8, "team": 8, "sale": 8}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"changelog": [0, 5], "chang": 0, "2": 0, "29": 0, "245": 0, "28": 0, "240": 0, "2024": 0, "08": 0, "27": 0, "239": 0, "04": 0, "26": 0, "237": 0, "2023": 0, "07": 0, "25": 0, "236": 0, "01": 0, "24": 0, "232": 0, "2022": 0, "11": 0, "231": 0, "23": 0, "222": 0, "03": 0, "22": 0, "213": 0, "2021": 0, "09": 0, "21": 0, "207": 0, "06": 0, "20": 0, "204": 0, "02": 0, "19": 0, "202": 0, "2020": 0, "12": 0, "18": 0, "200": 0, "3": 0, "17": 0, "196": 0, "16": 0, "15": 0, "194": 0, "14": 0, "186": 0, "05": 0, "13": 0, "184": 0, "182": 0, "2019": 0, "176": 0, "10": 0, "155": 0, "154": 0, "151": 0, "9": 0, "141": 0, "8": 0, "125": 0, "2018": 0, "7": 0, "113": 0, "6": 0, "94": 0, "5": 0, "92": 0, "4": 0, "61": 0, "2017": 0, "44": 0, "34": 0, "1": 0, "0": 0, "630": 0, "readm": 1, "md": 1, "overview": [2, 6], "constraint": [2, 5, 7], "program": [2, 5, 6, 7], "what": [2, 5], "i": [2, 5], "technologi": [2, 5], "base": 2, "schedul": 2, "The": 2, "power": 2, "model": [2, 4, 5, 7], "run": 2, "optim": [2, 3, 5, 6, 7], "more": [2, 4, 6], "resourc": [2, 4, 6], "without": [2, 6], "cp": [2, 5], "set": [3, 4], "up": [3, 4], "an": [3, 6], "engin": [3, 7], "get": [3, 4, 5], "ibm": [3, 4, 5, 8], "setup": 3, "us": [3, 4, 5], "ilog": 3, "cplex": [3, 4, 5, 6], "studio": [3, 4], "your": [3, 5], "comput": 3, "instal": [3, 4], "ce": 3, "librari": [3, 4], "pip": [3, 4], "conda": [3, 4], "packag": [3, 4], "start": [4, 5], "docplex": [4, 5, 8], "cloud": 4, "solv": [4, 6], "python": [4, 5], "watson": 4, "environ": 4, "system": 4, "requir": 4, "develop": [4, 5], "tool": 4, "manag": 4, "exampl": [4, 6], "reg": 5, "decis": 5, "aka": 5, "prescript": 5, "analyt": 5, "discov": 5, "mathemat": [5, 6, 7], "mp": 5, "give": 5, "u": 5, "feedback": 5, "connect": 5, "linear": 6, "essenti": 6, "techniqu": 6, "problem": 6, "integ": 6, "mix": 6, "algorithm": 6, "versu": 7, "gener": 7, "structur": 7, "differ": 7, "comparison": 7, "tabl": 7, "elit": 8, "support": 8, "comprehens": 8, "eclips": 8, "platform": 8, "provid": 8, "portal": 8, "contact": 8}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx.ext.viewcode": 1, "sphinx": 58}, "alltitles": {"Changelog": [[0, "changelog"], [5, "changelog"]], "Changed in 2.29.245:": [[0, "changed-in-2-29-245"]], "Changed in 2.28.240 (2024.08):": [[0, "changed-in-2-28-240-2024-08"]], "Changed in 2.27.239 (2024.04):": [[0, "changed-in-2-27-239-2024-04"], [0, "id1"]], "Changed in 2.26.237 (2023.07):": [[0, "changed-in-2-26-237-2023-07"]], "Changed in 2.25.236 (2023.01):": [[0, "changed-in-2-25-236-2023-01"]], "Changed in 2.24.232 (2022.11):": [[0, "changed-in-2-24-232-2022-11"]], "Changed in 2.24.231 (2022.11):": [[0, "changed-in-2-24-231-2022-11"]], "Changed in 2.23.222 (2022.03):": [[0, "changed-in-2-23-222-2022-03"]], "Changed in 2.22.213 (2021.09):": [[0, "changed-in-2-22-213-2021-09"]], "Changed in 2.21.207 (2021.06):": [[0, "changed-in-2-21-207-2021-06"]], "Changed in 2.20.204 (2021.02):": [[0, "changed-in-2-20-204-2021-02"]], "Changed in 2.19.202 (2020.12):": [[0, "changed-in-2-19-202-2020-12"]], "Changed in 2.18.200 (2020.11.#3):": [[0, "changed-in-2-18-200-2020-11-3"]], "Changed in 2.17.196 (2020.11.#2):": [[0, "changed-in-2-17-196-2020-11-2"]], "Changed in 2.16.196 (2020.11):": [[0, "changed-in-2-16-196-2020-11"]], "Changed in 2.15.194 (2020.07):": [[0, "changed-in-2-15-194-2020-07"]], "Changed in 2.14.186 (2020.05):": [[0, "changed-in-2-14-186-2020-05"]], "Changed in 2.13.184 (2020.03):": [[0, "changed-in-2-13-184-2020-03"]], "Changed in 2.12.182 (2019.12):": [[0, "changed-in-2-12-182-2019-12"]], "Changed in 2.11.176 (2019.11):": [[0, "changed-in-2-11-176-2019-11"]], "Changed in 2.10.155 (2019.08):": [[0, "changed-in-2-10-155-2019-08"]], "Changed in 2.10.154 (2019.07):": [[0, "changed-in-2-10-154-2019-07"]], "Changed in 2.10.151 (2019.07):": [[0, "changed-in-2-10-151-2019-07"]], "Changed in 2.9.141 (2019.03):": [[0, "changed-in-2-9-141-2019-03"]], "Changed in 2.8.125 (2018.10):": [[0, "changed-in-2-8-125-2018-10"]], "Changed in 2.7.113 (2018.07):": [[0, "changed-in-2-7-113-2018-07"]], "Changed in 2.6.94 (2018.04):": [[0, "changed-in-2-6-94-2018-04"]], "Changed in 2.5.92 (2018.03):": [[0, "changed-in-2-5-92-2018-03"]], "Changed in 2.4.61 (2017.11):": [[0, "changed-in-2-4-61-2017-11"]], "Changed in 2.3.44 (2017.09):": [[0, "changed-in-2-3-44-2017-09"]], "Changed in 2.2.34 (2017.07):": [[0, "changed-in-2-2-34-2017-07"]], "Changed in 2.1.28:": [[0, "changed-in-2-1-28"]], "Changed in 2.0.15:": [[0, "changed-in-2-0-15"]], "Changed in 1.0.630:": [[0, "changed-in-1-0-630"]], "README.md": [[1, "readme-md"]], "Overview of constraint programming": [[2, "overview-of-constraint-programming"]], "What is constraint programming technology?": [[2, "what-is-constraint-programming-technology"]], "What is constraint-based scheduling?": [[2, "what-is-constraint-based-scheduling"]], "The power of modeling in constraint programming": [[2, "the-power-of-modeling-in-constraint-programming"]], "The model-and-run constraint programming optimizer": [[2, "the-model-and-run-constraint-programming-optimizer"]], "More resources on constraint programming, with or without CP Optimizer": [[2, "more-resources-on-constraint-programming-with-or-without-cp-optimizer"]], "Setting up an optimization engine": [[3, "setting-up-an-optimization-engine"]], "Get IBM\u00ae optimizers": [[3, "get-ibmreg-optimizers"]], "Engine setup": [[3, "engine-setup"]], "Using IBM ILOG CPLEX Optimization Studio on your computer": [[3, "using-ibm-ilog-cplex-optimization-studio-on-your-computer"]], "Installing IBM ILOG CPLEX Optimization CE": [[3, "installing-ibm-ilog-cplex-optimization-ce"]], "Installing IBM ILOG CPLEX Optimization library with pip": [[3, "installing-ibm-ilog-cplex-optimization-library-with-pip"]], "Installing the IBM ILOG CPLEX Optimization library with conda install packager": [[3, "installing-the-ibm-ilog-cplex-optimization-library-with-conda-install-packager"]], "Getting started with docplex": [[4, "getting-started-with-docplex"]], "Cloud: Solving Python models using IBM Watson Studio Cloud": [[4, "cloud-solving-python-models-using-ibm-watson-studio-cloud"]], "Setting up a Python environment": [[4, "setting-up-a-python-environment"]], "System requirements": [[4, "system-requirements"]], "Get Python development tools": [[4, "get-python-development-tools"]], "Installing the CPLEX modeling library with pip": [[4, "installing-the-cplex-modeling-library-with-pip"]], "Installing the CPLEX modeling library with conda install packager": [[4, "installing-the-cplex-modeling-library-with-conda-install-packager"]], "Managing environments": [[4, "managing-environments"]], "Installing examples": [[4, "installing-examples"]], "More resources on Python": [[4, "more-resources-on-python"]], "IBM® Decision Optimization CPLEX® Modeling for Python": [[5, "ibmreg-decision-optimization-cplexreg-modeling-for-python"]], "What is Decision Optimization aka Prescriptive Analytics?": [[5, "what-is-decision-optimization-aka-prescriptive-analytics"]], "Discovering the IBM Decision Optimization technologies": [[5, "discovering-the-ibm-decision-optimization-technologies"]], "Getting started with DOcplex": [[5, "getting-started-with-docplex"]], "Developing with DOcplex": [[5, "developing-with-docplex"]], "Mathematical Programming Modeling for Python using docplex.mp (DOcplex.MP)": [[5, "mathematical-programming-modeling-for-python-using-docplex-mp-docplex-mp"]], "Constraint Programming Modeling for Python using docplex.cp (DOcplex.CP)": [[5, "constraint-programming-modeling-for-python-using-docplex-cp-docplex-cp"]], "Give us your feedback": [[5, "give-us-your-feedback"]], "Connect with Decision Optimization": [[5, "connect-with-decision-optimization"]], "Overview of mathematical programming": [[6, "overview-of-mathematical-programming"]], "Linear programming: An essential optimization technique": [[6, "linear-programming-an-essential-optimization-technique"]], "Examples of problems solved with linear programming": [[6, "examples-of-problems-solved-with-linear-programming"]], "Integer programming": [[6, "integer-programming"]], "Examples of mixed integer programming problems": [[6, "examples-of-mixed-integer-programming-problems"]], "CPLEX algorithms": [[6, "cplex-algorithms"]], "More resources on linear programming, with or without CPLEX": [[6, "more-resources-on-linear-programming-with-or-without-cplex"]], "Mathematical programming versus constraint programming": [[7, "mathematical-programming-versus-constraint-programming"]], "General model structure": [[7, "general-model-structure"]], "Modeling differences": [[7, "modeling-differences"]], "Optimization engine differences": [[7, "optimization-engine-differences"]], "Mathematical programming / Constraint programming comparison table": [[7, "mathematical-programming-constraint-programming-comparison-table"]], "IBM\u00ae Elite Support for DOcplex": [[8, "ibmreg-elite-support-for-docplex"]], "Comprehensive support for the Eclipse platform provided by IBM": [[8, "comprehensive-support-for-the-eclipse-platform-provided-by-ibm"]], "Support portal": [[8, "support-portal"]], "Contacts": [[8, "contacts"]]}, "indexentries": {"constraint programming": [[2, "index-0"], [7, "index-0"]], "constraint programming optimizer": [[2, "index-3"]], "constraint-based scheduling": [[2, "index-1"]], "modeling in constraint programming": [[2, "index-2"]], "cplex algorithms": [[6, "index-4"]], "integer programming": [[6, "index-2"]], "linear programming": [[6, "index-1"]], "mathematical programming": [[6, "index-0"], [7, "index-0"]], "mixed integer programming": [[6, "index-3"]]}}) \ No newline at end of file diff --git a/docs/2.29.245/docs/support.html b/docs/2.29.245/docs/support.html new file mode 100644 index 0000000..184cf53 --- /dev/null +++ b/docs/2.29.245/docs/support.html @@ -0,0 +1,108 @@ + + + + + + + + + + IBM® Elite Support for DOcplex — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + + + + + + + + + + + + + +
+
+
+
+ +
+

IBM® Elite Support for DOcplex

+
+

Comprehensive support for the Eclipse platform provided by IBM

+

IBM® Elite Support for Decision Optimization CPLEX Modeling for Python is a technical support package for DOcplex, an open source development environment. +This offering gives you the advantage of using open software with reliable expert support from IBM. +You gain the support you need to build mission-critical applications with this Python modeling package.

+
+
This Elite Support provides:
    +

  • Support for the DOcplex packages.

    • +

  • Phone support at no additional cost. IBM support services are available through IBM online issue management tools or by phone, and 24x7 phone support is available for severity 1 issues.

    • +

  • An efficient defect fix process. Defect submissions go through a triage process, and fixes are delivered by the IBM development team.

    • +
+
+
+

Contact your sales representative for more details or contact IBM here in the “Contact IBM” section.

+
+
+

Support portal

+

You can access the Decision Optimization support portal here.

+
+
+

Contacts

+ +
+
+ + +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/docs/CHANGELOG.html b/docs/CHANGELOG.html index 5cfa7eb..76a57e3 100644 --- a/docs/CHANGELOG.html +++ b/docs/CHANGELOG.html @@ -2,25 +2,24 @@ - + - - - Changelog — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.25 documentation - - + + + + Changelog — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + - - - - - - + + + + - + - +
-
-

Changelog

-
-

Changed in 2.25.236:

+
+

Changelog

+
+

Changed in 2.29.245:

+
    +

  • each record of a solve history use a unique timestamp for its fields

    • +
+
+
+

Changed in 2.28.240 (2024.08):

    -
  • Support of .ops files for parameter handling.
    • -
  • Improvement on the Nurse example.
    • +

  • In docplex.cp: robustify the handling of callback messages coming from CP Optimizer

    • +

  • Allows to use numpy 2.0

-
-
-

Changed in 2.24.232 (2022.11):

+ +
+

Changed in 2.27.239 (2024.04):

    -
  • Optional CPLEX import for qiskit
    • -
  • Fix in cut getter
    • +

  • Allows to use numpy 2.0

-
-
-

Changed in 2.24.231 (2022.11):

+ +
+

Changed in 2.27.239 (2024.04):

    -
  • Support for CPLEX Optimization Studio 22.1.1 runtimes.
    • -
  • Cleanup of the code related to Watson Machine Learning.
    • -
  • -
    In docplex.mp:
    -
      -
    • Support for sensitivity analysis in Solution.
      • -
    • Fixes in Solution handling.
      • +

    • PEP517, PEP518 build

      • +

    • Faster PWLs from PR#6.

      • +
    +
+
+

Changed in 2.26.237 (2023.07):

+
    +

  • Support for transactional output attachments

    • +
+
+
+

Changed in 2.25.236 (2023.01):

+
    +

  • Support of .ops files for parameter handling.

    • +

  • Improvement on the Nurse example.

    • +
+
+
+

Changed in 2.24.232 (2022.11):

+
    +

  • Optional CPLEX import for qiskit

    • +

  • Fix in cut getter

    • +
+
+
+

Changed in 2.24.231 (2022.11):

+
    +

  • Support for CPLEX Optimization Studio 22.1.1 runtimes.

    • +

  • Cleanup of the code related to Watson Machine Learning.

    • +
  • +
    In docplex.mp:
      +

    • Support for sensitivity analysis in Solution.

      • +

    • Fixes in Solution handling.

    • -
  • In docplex.cp: +

  • In docplex.cp: * Support for ‘inferred’ statement. * Support for ‘sub_circuit’ constraint. -* Fixed conditional module importation in sched_jobshop_blackbox.py

    • +* Fixed conditional module importation in sched_jobshop_blackbox.py

-
-
-

Changed in 2.23.222 (2022.03):

+ +
+

Changed in 2.23.222 (2022.03):

    -
  • Support for CPLEX Optimization Studio 22.1 runtimes.
    • -
  • -
    In docplex.mp:
    -
      -
    • Support of parameter sets for multi objective optimization.
      • -
    • Bug fix for multi objective optimization.
      • -
    • Correct documentation urls to current CPLEX offering.
      • -
    • Removal of the deprecated docloud_context.
      • -
    • Performance improvements for model building with 22.1
      • +

    • Support for CPLEX Optimization Studio 22.1 runtimes.

      • +
    • +
      In docplex.mp:
        +

      • Support of parameter sets for multi objective optimization.

        • +

      • Bug fix for multi objective optimization.

        • +

      • Correct documentation urls to current CPLEX offering.

        • +

      • Removal of the deprecated docloud_context.

        • +

      • Performance improvements for model building with 22.1

      • -
    • -
      In docplex.cp:
      -
        -
      • Added a new module blackbox to allow the new blackbox function feature
        • -
      • Wrote full documentation on blackbox functions
        • -
      • Added a new SearchType ‘Neighborhood’
        • -
      • Fixed a bug in modeler.same_common_subsequence
        • -
      • Fixed problem of order of computation of actual solving parameters.
        • +
      • +
        In docplex.cp:
          +

        • Added a new module blackbox to allow the new blackbox function feature

          • +

        • Wrote full documentation on blackbox functions

          • +

        • Added a new SearchType ‘Neighborhood’

          • +

        • Fixed a bug in modeler.same_common_subsequence

          • +

        • Fixed problem of order of computation of actual solving parameters.

      -
-
-

Changed in 2.22.213 (2021.09):

+ +
+

Changed in 2.22.213 (2021.09):

    -
  • Removed zeppelin examples
    • -
  • -
    In docplex.mp:
    -
      -
    • Added a variant of Model.sum() with variable number of arguments: Model.sums()
      • -
    • Removed all Python2 compatibility code
      • -
    • Added deterministic time in solve details.
      • -
    • Linear relaxer now relaxes SOS variable sets (linear sum relaxation)
      • -
    • Fixed a bug on Model.solve_with_goals() with quadratic sub-objectives
      • -
    • Fixed a bug in SolveSolution.kpi_value_by_name
      • -
    • Fixed a bug in SolveSolution.get_value_dict() about precision filtering
      • -
    • Fixed a bug when updating a constraint rhs with a NaN value now raises exception.
      • +

    • Removed zeppelin examples

      • +
    • +
      In docplex.mp:
        +

      • Added a variant of Model.sum() with variable number of arguments: Model.sums()

        • +

      • Removed all Python2 compatibility code

        • +

      • Added deterministic time in solve details.

        • +

      • Linear relaxer now relaxes SOS variable sets (linear sum relaxation)

        • +

      • Fixed a bug on Model.solve_with_goals() with quadratic sub-objectives

        • +

      • Fixed a bug in SolveSolution.kpi_value_by_name

        • +

      • Fixed a bug in SolveSolution.get_value_dict() about precision filtering

        • +

      • Fixed a bug when updating a constraint rhs with a NaN value now raises exception.

      • -
    • -
      In docplex.cp:
      -
        -
      • -
        Add new methods get_objective_value(), get_objective_bound() and get_objective_gap() on CpoModelSolution
        -
        and CpoSolveResult to access directly the first objective, bound or gap.
        +
      • +
        In docplex.cp:
          +
        • +
          Add new methods get_objective_value(), get_objective_bound() and get_objective_gap() on CpoModelSolution

          and CpoSolveResult to access directly the first objective, bound or gap.

          +
          • -
        • Support real call to abort_search() instead of killing the solver.
          • -
        • Add a method get_parameters() to CpoSolver to retrieve actual solving parameters.
          • -
        • Fix problem of order of computation of actual solving parameters.
          • +

        • Support real call to abort_search() instead of killing the solver.

          • +

        • Add a method get_parameters() to CpoSolver to retrieve actual solving parameters.

          • +

        • Fix problem of order of computation of actual solving parameters.

      -
-
-

Changed in 2.21.207 (2021.06):

+ +
+

Changed in 2.21.207 (2021.06):

    -
  • -
    In docplex.mp:
    -
      -
    • -
      Add support for importing solution from a different model, provided variables
      -
      can be matched between both models (Model.import_solution)
      +
    • +
      In docplex.mp:
        +
      • +
        Add support for importing solution from a different model, provided variables

        can be matched between both models (Model.import_solution)

        +
        • -
      • -
        Added contextual function to temporarily modify aspects of the model:
        -
        model_parameters to change parameters in a block, model_objective to set a temporary objective in a block.
        +
      • +
        Added contextual function to temporarily modify aspects of the model:

        model_parameters to change parameters in a block, model_objective to set a temporary objective in a block.

        +
        • -
      • Naming expressions is now deprecated, use a temporary variable if needed.
        • -
      • -
        Display of expressions in constraints is customizable: use a space separator (or not),
        -
        set a maximum length for very long expression.
        +

      • Naming expressions is now deprecated, use a temporary variable if needed.

        • +
      • +
        Display of expressions in constraints is customizable: use a space separator (or not),

        set a maximum length for very long expression.

        +
        • -
      • Fixed documentation references to class Var, moved from linear to dvar
        • -
      • Fixed a bug in LP export for multi-objective models with no priorities passed
        • +

      • Fixed documentation references to class Var, moved from linear to dvar

        • +

      • Fixed a bug in LP export for multi-objective models with no priorities passed

      • -
    • -
      In docplex.cp:
      -
        -
      • Replace context attribute solve_with_start_next by solve_with_search_next, keeping ascending compatibility.
        • -
      • Support solver parameter ModelAnonymizer to generate random names for all model elements (except KPIs) in the CPO file format.
        • -
      • Optimize generation of CPO expressions from Python expressions
        • -
      • Interval variable solutions tuples are now named tuples.
        • -
      • Method CpoModel.add() now accepts multiple expressions (or lists of expressions) to add to the model.
        • +
      • +
        In docplex.cp:
          +

        • Replace context attribute solve_with_start_next by solve_with_search_next, keeping ascending compatibility.

          • +

        • Support solver parameter ModelAnonymizer to generate random names for all model elements (except KPIs) in the CPO file format.

          • +

        • Optimize generation of CPO expressions from Python expressions

          • +

        • Interval variable solutions tuples are now named tuples.

          • +

        • Method CpoModel.add() now accepts multiple expressions (or lists of expressions) to add to the model.

      -
-
-

Changed in 2.20.204 (2021.02):

+ +
+

Changed in 2.20.204 (2021.02):

    -
  • -
    In docplex.mp:
    -
      -
    • Add support for exporting solutions and solution pools to SOL format.
      • -
    • -
      Add fast methods for changing batches of variable bounds:
      -
      Model.change_var_lower_bounds, Model.change_var_upper_bounds
      +
    • +
      In docplex.mp:
        +

      • Add support for exporting solutions and solution pools to SOL format.

        • +
      • +
        Add fast methods for changing batches of variable bounds:

        Model.change_var_lower_bounds, Model.change_var_upper_bounds

        +
        • -
      • Reset random seed value for cplex 12.10 , was different from COS release value.
        • -
      • Improved performance of variable creation
        • -
      • Removed a warning about accessing a deprecated “solve_status” in solve.
        • -
      • -
        docplex.mp.AdvModel now has checker enabled by default to avoid Python errors.
        -
        Is is up to the user to disable type-checking to get maximum performance.
        +

      • Reset random seed value for cplex 12.10 , was different from COS release value.

        • +

      • Improved performance of variable creation

        • +

      • Removed a warning about accessing a deprecated “solve_status” in solve.

        • +
      • +
        docplex.mp.AdvModel now has checker enabled by default to avoid Python errors.

        Is is up to the user to disable type-checking to get maximum performance.

        +
        • -
      • Fixed a bug about not printing updated variable bounds in MPS and SAV
        • -
      • Changed the default rounding behavior: solution values are not rounded by default.
        • +

      • Fixed a bug about not printing updated variable bounds in MPS and SAV

        • +

      • Changed the default rounding behavior: solution values are not rounded by default.

      • -
    • -
      In docplex.cp:
      -
        -
      • Fix problems on step function operations.
        • -
      • Add status in conflict refiner solution object.
        • -
      • Fix a bug to not send and receive conflict in CPO format if no conflict.
        • -
      • Enhance printing of model solution.
        • -
      • The method search_next(), returns only new solutions of the model. -In particular, no new solution is returned if solve status just change from Feasible to Optimal.
        • -
      • Rework completely model statistics (CpoModelStatistics)
        • -
      • Add a parameter add_cpo to the write method of CpoRefineConflictResult
        • +
      • +
        In docplex.cp:
          +

        • Fix problems on step function operations.

          • +

        • Add status in conflict refiner solution object.

          • +

        • Fix a bug to not send and receive conflict in CPO format if no conflict.

          • +

        • Enhance printing of model solution.

          • +

        • The method search_next(), returns only new solutions of the model. +In particular, no new solution is returned if solve status just change from Feasible to Optimal.

          • +

        • Rework completely model statistics (CpoModelStatistics)

          • +

        • Add a parameter add_cpo to the write method of CpoRefineConflictResult

      -
-
-

Changed in 2.19.202 (2020.12):

+ +
+

Changed in 2.19.202 (2020.12):

    -
  • -
    In docplex.mp:
    -
      -
    • Exporting models to SAV.gz format is now supported.
      • +
    • +
      In docplex.mp:
        +

      • Exporting models to SAV.gz format is now supported.

      • -
    • -
      In docplex.cp:
      -
        -
      • Add a new method remove_expressions() to CpoModel that removes a list of expressions in one shot.
        • -
      • Update documentation to describe how to set private solver parameters.
        • -
      • Add functions to export and import context as flat file.
        • -
      • Fix a bug on the string representation of calls to constant() modeling function.
        • -
      • Add JSON filter in case of double identical value for objective.
        • -
      • Add functions to export and import context as flat file.
        • -
      • Fix a bug on the string representation of calls to constant() modeling function.
        • -
      • Add JSON filter in case of double value for objective.
        • +
      • +
        In docplex.cp:
          +

        • Add a new method remove_expressions() to CpoModel that removes a list of expressions in one shot.

          • +

        • Update documentation to describe how to set private solver parameters.

          • +

        • Add functions to export and import context as flat file.

          • +

        • Fix a bug on the string representation of calls to constant() modeling function.

          • +

        • Add JSON filter in case of double identical value for objective.

          • +

        • Add functions to export and import context as flat file.

          • +

        • Fix a bug on the string representation of calls to constant() modeling function.

          • +

        • Add JSON filter in case of double value for objective.

      -
-
-

Changed in 2.18.200 (2020.11.#3):

+ +
+

Changed in 2.18.200 (2020.11.#3):

    -
  • -
    In docplex.mp:
    -
      -
    • Latest supported CPLEX Optimization Studio is now 20.1
      • +
    • +
      In docplex.mp:
        +

      • Latest supported CPLEX Optimization Studio is now 20.1

    -
-
-

Changed in 2.17.196 (2020.11.#2):

+ +
+

Changed in 2.17.196 (2020.11.#2):

    -
  • -
    In docplex.mp:
    -
      -
    • Fixed a bug with pickling: edition of a constraint in a pickled model raised an error
      • -
    • Fixed a bug with pickling: models with piecewise-linear constraints could not be pickled
      • +
    • +
      In docplex.mp:
        +

      • Fixed a bug with pickling: edition of a constraint in a pickled model raised an error

        • +

      • Fixed a bug with pickling: models with piecewise-linear constraints could not be pickled

      • -
    • -
      In docplex.cp:
      -
        -
      • Add environment variable DOCPLEX_CP_CONTEXT to modify configuration
        • -
      • Add new module check_list that print a report on execution environment
        • -
      • Remove DOcloud from documentation (including code)
        • -
      • Rework customization of configuration and better support of default directory
        • -
      • Add new configuration parameter model.sort_names to drive sort of variable declarations in CPO file format.
        • -
      • Fix a problem that may crash Python in case of abort_search with local solve.
        • +
      • +
        In docplex.cp:
          +

        • Add environment variable DOCPLEX_CP_CONTEXT to modify configuration

          • +

        • Add new module check_list that print a report on execution environment

          • +

        • Remove DOcloud from documentation (including code)

          • +

        • Rework customization of configuration and better support of default directory

          • +

        • Add new configuration parameter model.sort_names to drive sort of variable declarations in CPO file format.

          • +

        • Fix a problem that may crash Python in case of abort_search with local solve.

      -
-
-

Changed in 2.16.196 (2020.11):

+ +
+

Changed in 2.16.196 (2020.11):

    -
  • -
    In docplex.mp:
    -
      -
    • add Model.add_quadratic_constraints() to add a batch of quadratic constraints
      • -
    • add Model.populate_solution_pool() for a native support of solurtion pools
      • -
    • support of CPLEX 20.1
      • -
    • compatible with Python 3.8 (only with CPLEX 20.1)
      • -
    • enable changing absolute and relative tolerances for multi-objectives
      • -
    • Optimization of Model.if_then: when condition is of the form b==1 (or 0), no additional boolean -variable is generated
      • -
    • For solving, docplex.mp now uses the cplex module if it has been installed. If not, docplex.mp +
    • +
      In docplex.mp:
        +

      • add Model.add_quadratic_constraints() to add a batch of quadratic constraints

        • +

      • add Model.populate_solution_pool() for a native support of solurtion pools

        • +

      • support of CPLEX 20.1

        • +

      • compatible with Python 3.8 (only with CPLEX 20.1)

        • +

      • enable changing absolute and relative tolerances for multi-objectives

        • +

      • Optimization of Model.if_then: when condition is of the form b==1 (or 0), no additional boolean +variable is generated

        • +

      • For solving, docplex.mp now uses the cplex module if it has been installed. If not, docplex.mp checks for the latest installed version of CPLEX Optimization Studio (COS) (using the CPLEX_STUDIO_DIRXXX environment variables) and use the cplex if a COS is found, unless the configuration of the engine -states otherwise.

        • -
      -
      -
      -
      • -
    • -
      In docplex.cp:
      -
        -
      • Add pngfile= parameter to visu.show() method to store in a PNG file instead of display on screen.
        • -
      • Make parameters and solver infos also available in refine_conflict solution.
        • -
      • Add a IntegerDomain class used to represent domain of integer variables, with a specific __str__ method
        • -
      • Add new functions ceil(), floor(), trunc(), round() and sgn()
        • -
      • Remove all warnings generated by Python 38
        • -
      • Optimize creation of add expressions with CumulExpr and zero
        • -
      • Implement configurable factorization of common model expressions when generating CPO format
        • -
      • Add checking of scal_prod() array sizes at modeling time
        • -
      • Add strict_lexicographic() and checking of strict_lexicographic() and lexicographic() array sizes at modeling time.
        • -
      • Add failure explanation as new method explain_failure() allowing to log failure tags or get details on one or several failures.
        • -
      • Enhance management of local solve sub-process timeout with detailed error and configurable timeout delay
        • -
      • For solving, docplex.cp now uses the cpoptimizer executable if it has been installed. If not, docplex.cp +states otherwise.

        • +
      +
      +
      +
      • +
    • +
      In docplex.cp:
        +

      • Add pngfile= parameter to visu.show() method to store in a PNG file instead of display on screen.

        • +

      • Make parameters and solver infos also available in refine_conflict solution.

        • +

      • Add a IntegerDomain class used to represent domain of integer variables, with a specific __str__ method

        • +

      • Add new functions ceil(), floor(), trunc(), round() and sgn()

        • +

      • Remove all warnings generated by Python 38

        • +

      • Optimize creation of add expressions with CumulExpr and zero

        • +

      • Implement configurable factorization of common model expressions when generating CPO format

        • +

      • Add checking of scal_prod() array sizes at modeling time

        • +

      • Add strict_lexicographic() and checking of strict_lexicographic() and lexicographic() array sizes at modeling time.

        • +

      • Add failure explanation as new method explain_failure() allowing to log failure tags or get details on one or several failures.

        • +

      • Enhance management of local solve sub-process timeout with detailed error and configurable timeout delay

        • +

      • For solving, docplex.cp now uses the cpoptimizer executable if it has been installed. If not, docplex.cp checks for the latest installed version of CPLEX Optimization Studio (COS) (using the CPLEX_STUDIO_DIRXXX environment variables) and use the cpoptimizer if a COS is found, unless the configuration of the engine -states otherwise.

        • -
      • Support last optimal solution in search/next sequence
        • -
      • Support of solver parameters in all next() solutions
        • -
      • Add solver version in process info attached to a run result
        • +states otherwise.

        +

      • Support last optimal solution in search/next sequence

        • +

      • Support of solver parameters in all next() solutions

        • +

      • Add solver version in process info attached to a run result

    -
-
-

Changed in 2.15.194 (2020.07):

+ +
+

Changed in 2.15.194 (2020.07):

    -
  • -
    In docplex.mp:
    -
      -
    • add Model.quadratic_dual_slacks()
      • -
    • Fixed a bug in multi-objectives: objectives were incorrectly rounded
      • -
    • Fixed a bug in Model.report(): multiple objective values were not displayed()
      • +
    • +
      In docplex.mp:
        +

      • add Model.quadratic_dual_slacks()

        • +

      • Fixed a bug in multi-objectives: objectives were incorrectly rounded

        • +

      • Fixed a bug in Model.report(): multiple objective values were not displayed()

      • -
    • -
      In docplex.cp:
      -
        -
      • Add conflict in CPO format in refine conflict result
        • -
      • Fix problem when parsing KPIs section of a CPO model
        • -
      • Add method add_constraint() to model for compatibility with docplex.mp
        • -
      • Comment method get_fail_status() of SolveResult as deprecated.
        • -
      • Fix problem of wrong import of deque in collections.abc
        • +
      • +
        In docplex.cp:
          +

        • Add conflict in CPO format in refine conflict result

          • +

        • Fix problem when parsing KPIs section of a CPO model

          • +

        • Add method add_constraint() to model for compatibility with docplex.mp

          • +

        • Comment method get_fail_status() of SolveResult as deprecated.

          • +

        • Fix problem of wrong import of deque in collections.abc

      -
-
-

Changed in 2.14.186 (2020.05):

+ +
+

Changed in 2.14.186 (2020.05):

    -
  • Updated tracking events in Watson studio notebooks.
    • -
  • -
    In docplex.mp:
    -
      -
    • Model.solve() will not use solve on cloud unless agent is specifically set to ‘docloud`.
      • +

    • Updated tracking events in Watson studio notebooks.

      • +
    • +
      In docplex.mp:
        +

      • Model.solve() will not use solve on cloud unless agent is specifically set to ‘docloud`.

    -
-
-

Changed in 2.13.184 (2020.03):

+ +
+

Changed in 2.13.184 (2020.03):

    -
  • Removed dependency to the docloud package. Now you need to explicitely install the package using pip install docloud to use DOcplexcloud.
    • -
  • -
    In docplex.mp:
    -
      -
    • added Model.export_as_mps_string(), Model.export_as_sav_string()
      • -
    • -
      fixed a bug with dettime_limit: solving with a deterministic time limit
      -
      was mis-interpreted as a solve failure, returning None.
      +

    • Removed dependency to the docloud package. Now you need to explicitely install the package using pip install docloud to use DOcplexcloud.

      • +
    • +
      In docplex.mp:
        +

      • added Model.export_as_mps_string(), Model.export_as_sav_string()

        • +
      • +
        fixed a bug with dettime_limit: solving with a deterministic time limit

        was mis-interpreted as a solve failure, returning None.

        +
        • -
      • fixed bug on cplexcloud solve: number of nodes processed was always zero.
        • -
      • repeated solves incorrectly restarted from start of search, now start from where the last solve stopped.
        • -
      • added keyword argument ‘time_limit’ to Model.solve() to set a temporary time limit.
        • -
      • added new method SolveSolution.is_valid_solution()
        • -
      • fixed a bug in ModelReader: ranged constraints bounds were inverted when reading from SAV or MPS.
        • -
      • fixed a bug in Model.set_lex_multiobj(): arguments abstols, reltols were ignored.
        • -
      • added proper type-checking for Model.add_indicator_constraints()
        • -
      • added docplex.mp.check_list/py to check local installation.
        • +

      • fixed bug on cplexcloud solve: number of nodes processed was always zero.

        • +

      • repeated solves incorrectly restarted from start of search, now start from where the last solve stopped.

        • +

      • added keyword argument ‘time_limit’ to Model.solve() to set a temporary time limit.

        • +

      • added new method SolveSolution.is_valid_solution()

        • +

      • fixed a bug in ModelReader: ranged constraints bounds were inverted when reading from SAV or MPS.

        • +

      • fixed a bug in Model.set_lex_multiobj(): arguments abstols, reltols were ignored.

        • +

      • added proper type-checking for Model.add_indicator_constraints()

        • +

      • added docplex.mp.check_list/py to check local installation.

      • -
    • -
      In docplex.cp:
      -
        -
      • Enable reading of #line directives when parsing a CPO file
        • -
      • Remove parameter LogSearchTags from public parameters
        • -
      • Fix a minor problem concerning compilation of KPI expressions in CPO format
        • +
      • +
        In docplex.cp:
          +

        • Enable reading of #line directives when parsing a CPO file

          • +

        • Remove parameter LogSearchTags from public parameters

          • +

        • Fix a minor problem concerning compilation of KPI expressions in CPO format

      -
-
-

Changed in 2.12.182 (2019.12):

+ +
+

Changed in 2.12.182 (2019.12):

    -
  • -
    In docplex.mp:
    -
      -
    • Added a LinearRelaxer class to make a linearized copy of a MIP model (if possible). -see class docplex.mp.relax_linear.LinearRelaxer
      • -
    • Conflict refiner default behavior is now identical to CPLEX interactive -(the new behavior is much faster).
      • -
    • Bug fixed: expressions of the form k*x did not notify constraints when modified.
      • -
    • Fixed: message “ignored keyword argument” was incorrectly printed when setting -cts_by_name=True in model constructor.
      • +
    • +
      In docplex.mp:
        +

      • Added a LinearRelaxer class to make a linearized copy of a MIP model (if possible). +see class docplex.mp.relax_linear.LinearRelaxer

        • +

      • Conflict refiner default behavior is now identical to CPLEX interactive +(the new behavior is much faster).

        • +

      • Bug fixed: expressions of the form k*x did not notify constraints when modified.

        • +

      • Fixed: message “ignored keyword argument” was incorrectly printed when setting +cts_by_name=True in model constructor.

    -
-
-

Changed in 2.11.176 (2019.11):

+ +
+

Changed in 2.11.176 (2019.11):

    -
  • Added support for CPLEX 12.10
    • -
  • -
    In docplex.mp:
    -
      -
    • Logical expressions, binary variables, and constraints can now be freely nested with logical operators.
      • -
    • Fixed a print of ‘CPLEX Error 1217’ in log for multi-objective problems.
      • -
    • Fixed a bug when setting log_output to a file name: file was created, but empty.
      • +

    • Added support for CPLEX 12.10

      • +
    • +
      In docplex.mp:
        +

      • Logical expressions, binary variables, and constraints can now be freely nested with logical operators.

        • +

      • Fixed a print of ‘CPLEX Error 1217’ in log for multi-objective problems.

        • +

      • Fixed a bug when setting log_output to a file name: file was created, but empty.

    -
-
-

Changed in 2.10.155 (2019.08):

+ +
+

Changed in 2.10.155 (2019.08):

    -
  • Fixed bug in logical_and() when result var is set to 0.
    • +

  • Fixed bug in logical_and() when result var is set to 0.

-
-
-

Changed in 2.10.154 (2019.07):

+ +
+

Changed in 2.10.154 (2019.07):

    -
  • Fixed TypeError occuring in python 3.7 in progressData initialization.
    • +

  • Fixed TypeError occuring in python 3.7 in progressData initialization.

-
-
-

Changed in 2.10.151 (2019.07):

+ +
+

Changed in 2.10.151 (2019.07):

    -
  • -
    In docplex.mp:
    -
      -
    • fixed a bug in ModelReader when reading SAV files with no names
      • -
    • fixed a bug in mip starts, which prevented mip starts with piecewise -functions to work properly.
      • -
    • fixed bug on Model.add_indicators() using comprehensions (len() was called).
      • -
    • Added support for the ‘!=’ (not equals) operator in expressions.
      • -
    • Clarified four types of checker: on, off, numeric and full. -Pass checker=<name> at model creation to specify which checker is used.
      • -
    • fixed a bug in solution JSON encoder for nonconvex QP problems.
      • -
    • Add direct support for lazy constraints, see Model.add_lazy_constraints()
      • -
    • Add direct support for user cuts, see Model.add_user_cut_constraints()
      • -
    • Get basis status of variables in LP problems, see Var.basis_status
      • -
    • Read MIP start files (MST format)
      • -
    • Allow to set the effort level for a MIP solution.
      • -
    • Read basis status files (in BAS format)
      • -
    • Read variable priority orders (in ORD format)
      • -
    • fixed bug in functional KPIs, solution argument was not passed on.
      • -
    • Enable constraint name dictionary at Model creation time: Model(cts_by_name=True)
      • -
    • Multi-objective is now pickled correctly
      • -
    • Multi-objective is now copied in Model.copy()
      • -
    • Wrote full documentation on progress listeners
      • -
    • Added Model.set_lp_start_basis() to provide an initial basis for LP problems.
      • -
    -
    -
    -
    • -
  • -
    In docplex.cp:
    -
      -
    • When trying to access a solution member that does not exists, an exception is thrown instead of returning None.
      • -
    • Add a new map_solution function that replace in a Python object all model expressions by their value in a solve result.
      • -
    • In CPO parser, fix a problem reading #line statements in startingPoint section.
      • -
    • In CPO parser, skip experimental section ‘expressions’ in ‘startingPoint’ section.
      • -
    • Simplify writing of interval variable domains reduced to a single value.
      • -
    • Adding a second objective function now raises an exception
      • -
    • Add new experimental local solve with a shared library.
      • -
    • Enable iterators to specify the domain of an integer variable
      • -
    • Add global methods get_version_info() and get_solver_verion() in docplex.cp.solver.
      • -
    • By default, generate CPO model without explicit format version.
      • -
    • Add a method reset() on CpoParameters object.
      • -
    • Modeling method allowed_assignments() and forbidden_assignments() can now accept an empty list of tuples.
      • -
    • On CpoModelSolution object, add a function map_solution() thar replace variables by their value in a python object.
      • -
    • Add parser for LP models
      • -
    • Add possibility to import CPO, MZN and LP models in gzip and zip format.
      • -
    • Enhance management of unexpected errors thrown by cpoptimizer.exe
      • -
    -
    -
    -
    • -
-
-
-

Changed in 2.9.141 (2019.03):

+
  • +
    In docplex.mp:
      +

    • fixed a bug in ModelReader when reading SAV files with no names

      • +

    • fixed a bug in mip starts, which prevented mip starts with piecewise +functions to work properly.

      • +

    • fixed bug on Model.add_indicators() using comprehensions (len() was called).

      • +

    • Added support for the ‘!=’ (not equals) operator in expressions.

      • +

    • Clarified four types of checker: on, off, numeric and full. +Pass checker=<name> at model creation to specify which checker is used.

      • +

    • fixed a bug in solution JSON encoder for nonconvex QP problems.

      • +

    • Add direct support for lazy constraints, see Model.add_lazy_constraints()

      • +

    • Add direct support for user cuts, see Model.add_user_cut_constraints()

      • +

    • Get basis status of variables in LP problems, see Var.basis_status

      • +

    • Read MIP start files (MST format)

      • +

    • Allow to set the effort level for a MIP solution.

      • +

    • Read basis status files (in BAS format)

      • +

    • Read variable priority orders (in ORD format)

      • +

    • fixed bug in functional KPIs, solution argument was not passed on.

      • +

    • Enable constraint name dictionary at Model creation time: Model(cts_by_name=True)

      • +

    • Multi-objective is now pickled correctly

      • +

    • Multi-objective is now copied in Model.copy()

      • +

    • Wrote full documentation on progress listeners

      • +

    • Added Model.set_lp_start_basis() to provide an initial basis for LP problems.

      • +
    +
    +
    +
    • +
  • +
    In docplex.cp:
      +

    • When trying to access a solution member that does not exists, an exception is thrown instead of returning None.

      • +

    • Add a new map_solution function that replace in a Python object all model expressions by their value in a solve result.

      • +

    • In CPO parser, fix a problem reading #line statements in startingPoint section.

      • +

    • In CPO parser, skip experimental section ‘expressions’ in ‘startingPoint’ section.

      • +

    • Simplify writing of interval variable domains reduced to a single value.

      • +

    • Adding a second objective function now raises an exception

      • +

    • Add new experimental local solve with a shared library.

      • +

    • Enable iterators to specify the domain of an integer variable

      • +

    • Add global methods get_version_info() and get_solver_verion() in docplex.cp.solver.

      • +

    • By default, generate CPO model without explicit format version.

      • +

    • Add a method reset() on CpoParameters object.

      • +

    • Modeling method allowed_assignments() and forbidden_assignments() can now accept an empty list of tuples.

      • +

    • On CpoModelSolution object, add a function map_solution() thar replace variables by their value in a python object.

      • +

    • Add parser for LP models

      • +

    • Add possibility to import CPO, MZN and LP models in gzip and zip format.

      • +

    • Enhance management of unexpected errors thrown by cpoptimizer.exe

      • +
    +
    +
    +
    • + + +
    +

    Changed in 2.9.141 (2019.03):

      -
    • -
      In docplex.mp:
      -
        -
      • Removed links to rawgit.com as this service is going end of life.
        • -
      • Model.solve_lexicographic() is deprecated. This method should be used +
      • +
        In docplex.mp:
          +

        • Removed links to rawgit.com as this service is going end of life.

          • +

        • Model.solve_lexicographic() is deprecated. This method should be used to perform lexicographic solve with COS 12.8, but with COS 12.9, Model.set_multi_objective() should be used for solving problems -with multiple objectives.

          • +with multiple objectives.

        • -
      • -
        In docplex.cp:
        -
          -
        • Add KPIs supported by CPO Solver 12.9
          • -
        • Update CPO parser to read KPIs section for format 12.9
          • -
        • Add new examples with KPIs.
          • +
        • +
          In docplex.cp:
            +

          • Add KPIs supported by CPO Solver 12.9

            • +

          • Update CPO parser to read KPIs section for format 12.9

            • +

          • Add new examples with KPIs.

        -
    -
    -

    Changed in 2.8.125 (2018.10):

    + +
    +

    Changed in 2.8.125 (2018.10):

      -
    • Solving with solver agent ‘docloud’ is deprecated. +

    • Solving with solver agent ‘docloud’ is deprecated. Models are now preferably solved with local solver, or the python source can be submitted to DOcplexcloud solve service. -See https://ibm.biz/BdYhhK.

      • -
    • -
      In docplex.mp:
      -
        -
      • solve_lexicographic is being deprecated. In a future version, a new api will be available to support multi-objectives.
        • +See https://ibm.biz/BdYhhK.

        +
      • +
        In docplex.mp:
          +

        • solve_lexicographic is being deprecated. In a future version, a new api will be available to support multi-objectives.

        • -
      • -
        In docplex.cp:
        -
          -
        • Fix problem with boolean indicators in no_overlap(), always_constant() and always_equal().
          • -
        • Allow model solution to be used directly as a starting point (ignores what is not integer or interval var).
          • -
        • Add methods domain_min(), domain_max(), domain_iterator() and domain_contains() on both CpoIntVar and CpoIntVarSolution.
          • -
        • Default solver agent is now ‘local’ instead of ‘docloud’. All examples modified consequently.
          • +
        • +
          In docplex.cp:
            +

          • Fix problem with boolean indicators in no_overlap(), always_constant() and always_equal().

            • +

          • Allow model solution to be used directly as a starting point (ignores what is not integer or interval var).

            • +

          • Add methods domain_min(), domain_max(), domain_iterator() and domain_contains() on both CpoIntVar and CpoIntVarSolution.

            • +

          • Default solver agent is now ‘local’ instead of ‘docloud’. All examples modified consequently.

        -
    -
    -

    Changed in 2.7.113 (2018.07):

    + +
    +

    Changed in 2.7.113 (2018.07):

      -
    • -
      In docplex.mp:
      -
        -
      • Multiplying a constant expression by a quadratic expression raised an exception. Now returns the -product of the quadratic expression and the constant value.
        • -
      • Model.solve_lexicographic() on cloud now send the previous pass solution as a MIP start (for MIP problems)
        • -
      • The slack of quadratic constraints always returned zero. Now returns the correct value.
        • -
      • Accessing the dual (or slack) of a constraint that is not added to the model returned zero; now it raises an exception. A constraint must belong to a model to return a valid dual (or slack) value
        • -
      • Range constraints with infeasible domain (i.e. lb > ub) did not fail to solve. Now they raise a modeling exception.
        • -
      • Multiplying two absolute value expressions raised an exception. Now fixed.
        • -
      • When using tuples in variable dictionaries, the default name generation used to generate non-LP-compliant names, -because of ( and ). Now the name generator formats the tuples with a “_” separator without parentheses.
        • +
      • +
        In docplex.mp:
          +

        • Multiplying a constant expression by a quadratic expression raised an exception. Now returns the +product of the quadratic expression and the constant value.

          • +

        • Model.solve_lexicographic() on cloud now send the previous pass solution as a MIP start (for MIP problems)

          • +

        • The slack of quadratic constraints always returned zero. Now returns the correct value.

          • +

        • Accessing the dual (or slack) of a constraint that is not added to the model returned zero; now it raises an exception. A constraint must belong to a model to return a valid dual (or slack) value

          • +

        • Range constraints with infeasible domain (i.e. lb > ub) did not fail to solve. Now they raise a modeling exception.

          • +

        • Multiplying two absolute value expressions raised an exception. Now fixed.

          • +

        • When using tuples in variable dictionaries, the default name generation used to generate non-LP-compliant names, +because of ( and ). Now the name generator formats the tuples with a “_” separator without parentheses.

        • -
      • -
        In docplex.cp:
        -
          -
        • Split fzn stuff in a separate package docplex.cp.fzn
          • -
        • Optimize construction of arrays in FZN parser
          • -
        • Enhance FZN parser and save 30% time
          • +
        • +
          In docplex.cp:
            +

          • Split fzn stuff in a separate package docplex.cp.fzn

            • +

          • Optimize construction of arrays in FZN parser

            • +

          • Enhance FZN parser and save 30% time

        -
    -
    -

    Changed in 2.6.94 (2018.04):

    + +
    +

    Changed in 2.6.94 (2018.04):

      -
    • -
      In docplex.cp:
      -
        -
      • Allow CpoModel.add() to accept list of constraints.
        • -
      • Fix a bug in the conversion of an array of boolean constants into CPO expression.
        • -
      • Extend CpoModel method set_parameters() to accept a dictionary and/or optional list of updates using named arguments.
        • -
      • Method CpoModel.set_parameters() now clone the CpoParameters object given in arguments.
        • -
      • Add a new method CpoModel.add_parameters() that updates parameters associated to the model.
        • -
      • Fix wrong source location (not in real model source) when CpoModel.add() is called from another docplex.cp method.
        • -
      • When constraint auto-naming is on (in particular for refine_conflict(), searchPhases are no more included in the process.
        • -
      • Parameters mean_UB and mean_LB are now optional in standard_deviation()
        • -
      • CpoModel.add() checks that the added expression is limited to constraint, boolean, objective or search phase.
        • -
      • Add documented functions slope_piecewise_linear() and coordinate__piecewise_linear() in modeler.py.
        • -
      • Remove default configuration settings for parameters TimeLimit and Workers.
        • +
      • +
        In docplex.cp:
          +

        • Allow CpoModel.add() to accept list of constraints.

          • +

        • Fix a bug in the conversion of an array of boolean constants into CPO expression.

          • +

        • Extend CpoModel method set_parameters() to accept a dictionary and/or optional list of updates using named arguments.

          • +

        • Method CpoModel.set_parameters() now clone the CpoParameters object given in arguments.

          • +

        • Add a new method CpoModel.add_parameters() that updates parameters associated to the model.

          • +

        • Fix wrong source location (not in real model source) when CpoModel.add() is called from another docplex.cp method.

          • +

        • When constraint auto-naming is on (in particular for refine_conflict(), searchPhases are no more included in the process.

          • +

        • Parameters mean_UB and mean_LB are now optional in standard_deviation()

          • +

        • CpoModel.add() checks that the added expression is limited to constraint, boolean, objective or search phase.

          • +

        • Add documented functions slope_piecewise_linear() and coordinate__piecewise_linear() in modeler.py.

          • +

        • Remove default configuration settings for parameters TimeLimit and Workers.

      -
    -
    -

    Changed in 2.5.92 (2018.03):

    + +
    +

    Changed in 2.5.92 (2018.03):

      -
    • -
      docplex.cli gains new features:
      -
        -
      • option --details will display solve details as they are published on -DOcplexcloud.
        • -
      • options --url and -key allow specification of credentials without -using a config file.
        • +
      • +
        docplex.cli gains new features:
          +

        • option --details will display solve details as they are published on +DOcplexcloud.

          • +

        • options --url and -key allow specification of credentials without +using a config file.

        • -
      • -
        In docplex.cp:
        -
          -
        • Fix problem with min() and max() that did not support optional key.
          • -
        • Add a Flatzinc parser capable of reading Minizinc Challenge problems.
          • -
        • Move expression dependencies analysis from model to compiler side.
          • -
        • No more constraint to have a unique name for model expressions. Compiler reallocate private names when needed.
          • -
        • Multiple variables or expressions with the same public name is now allowed.
          • -
        • Replace method CpoModel.get_expression() by CpoModel.get_named_expressions_dict().
          • -
        • Make SolverProgressPanelListener work properly with Python 2
          • -
        • Solve is automatically set to start/next loop when SolverProgressPanelListener is used.
          • -
        • In CpoModel, add a method that allows to substitute a function by another in the whole model.
          • -
        • Overwrite method __bool__ to avoid accidental use of CPO expressions as Python booleans.
          • -
        • Add special cases to search for the local CP Optimizer Interactive executable.
          • -
        • Allow methods min(), max(), min_of() and max_of() to support variable number of arguments.
          • -
        • Allow method all_diff() to support variable number of arguments.
          • -
        • Context parameter ‘length_for_rename’ is deprecated. Only length_for_alias is used.
          • -
        • Add a method add_var() in CpoModelSolution as a shortcut to add_integer_var_solution() and add_interval_var_solution()
          • -
        • Overwrite method __contains__() in CpoModelSolution to easily verify that a solution to a given variable is in the solution.
          • -
        • When called on a model, export_model() and get_cpo_string() disable all model optimization options.
          • +
        • +
          In docplex.cp:
            +

          • Fix problem with min() and max() that did not support optional key.

            • +

          • Add a Flatzinc parser capable of reading Minizinc Challenge problems.

            • +

          • Move expression dependencies analysis from model to compiler side.

            • +

          • No more constraint to have a unique name for model expressions. Compiler reallocate private names when needed.

            • +

          • Multiple variables or expressions with the same public name is now allowed.

            • +

          • Replace method CpoModel.get_expression() by CpoModel.get_named_expressions_dict().

            • +

          • Make SolverProgressPanelListener work properly with Python 2

            • +

          • Solve is automatically set to start/next loop when SolverProgressPanelListener is used.

            • +

          • In CpoModel, add a method that allows to substitute a function by another in the whole model.

            • +

          • Overwrite method __bool__ to avoid accidental use of CPO expressions as Python booleans.

            • +

          • Add special cases to search for the local CP Optimizer Interactive executable.

            • +

          • Allow methods min(), max(), min_of() and max_of() to support variable number of arguments.

            • +

          • Allow method all_diff() to support variable number of arguments.

            • +

          • Context parameter ‘length_for_rename’ is deprecated. Only length_for_alias is used.

            • +

          • Add a method add_var() in CpoModelSolution as a shortcut to add_integer_var_solution() and add_interval_var_solution()

            • +

          • Overwrite method __contains__() in CpoModelSolution to easily verify that a solution to a given variable is in the solution.

            • +

          • When called on a model, export_model() and get_cpo_string() disable all model optimization options.

        -
    -
    -

    Changed in 2.4.61 (2017.11):

    + +
    +

    Changed in 2.4.61 (2017.11):

      -
    • -
      Both docplex.mp & docplex.cp:
      -
        -
      • Support for CPLEX engines 12.8. Some features of docplex2.4 are available only with engines >= 12.8.
        • -
      • Adding new ports (AIX, plinux).
        • -
      • Examples are now available as Zeppelin notebooks.
        • +
      • +
        Both docplex.mp & docplex.cp:
          +

        • Support for CPLEX engines 12.8. Some features of docplex2.4 are available only with engines >= 12.8.

          • +

        • Adding new ports (AIX, plinux).

          • +

        • Examples are now available as Zeppelin notebooks.

        • -
      • -
        In docplex.mp:
        -
          -
        • Express a linear problem as a scikit-learn transformer by providing a numpy, a pandas or scipy matrix.
          • -
        • Logical constraints: constraint equivalence, if-then & rshift operator.
          • -
        • Meta-constraints: allow the use of discrete -linear constraints in expressions, using their truth value.
          • -
        • Solve hook to add a method to be called at each intermediate solution.
          • -
        • KPIS automatically published at each intermediate solution if running on docplexcloud python worker.
          • -
        • Support for scipy coo & csr matrixes.
          • -
        • Fixed a bug in Model.add_constraints() when passing a string instead of a list of strings.
          • +
        • +
          In docplex.mp:
            +

          • Express a linear problem as a scikit-learn transformer by providing a numpy, a pandas or scipy matrix.

            • +

          • Logical constraints: constraint equivalence, if-then & rshift operator.

            • +

          • Meta-constraints: allow the use of discrete +linear constraints in expressions, using their truth value.

            • +

          • Solve hook to add a method to be called at each intermediate solution.

            • +

          • KPIS automatically published at each intermediate solution if running on docplexcloud python worker.

            • +

          • Support for scipy coo & csr matrixes.

            • +

          • Fixed a bug in Model.add_constraints() when passing a string instead of a list of strings.

          • -
        • -
          In docplex.cp:
          -
            -
          • add new method run_seeds() to execute a model multiple times, available with local solver 12.8.
            • -
          • add support of new solver infos ‘SearchStatus’ and ‘SearchStopCause’.
            • -
          • In method docplex.cp.model.CpoModel.propagate(), add possibility to add an optional constraint to the model.
            • -
          • add domain iterator in integer variables and integer variables solutions, allowing to get domain -as a list of individual integers.
            • -
          • add possibility to identify some model variables as KPIs of the model.
            • -
          • add abort_search() method on solver (not supported everywhere)
            • -
          • Rework code generation to enhance performances and remove unused variables that was pointed by removed expressions.
            • -
          • add possibility to add one or more CpoSolverListener to put some callback functions +
          • +
            In docplex.cp:
              +

            • add new method run_seeds() to execute a model multiple times, available with local solver 12.8.

              • +

            • add support of new solver infos ‘SearchStatus’ and ‘SearchStopCause’.

              • +

            • In method docplex.cp.model.CpoModel.propagate(), add possibility to add an optional constraint to the model.

              • +

            • add domain iterator in integer variables and integer variables solutions, allowing to get domain +as a list of individual integers.

              • +

            • add possibility to identify some model variables as KPIs of the model.

              • +

            • add abort_search() method on solver (not supported everywhere)

              • +

            • Rework code generation to enhance performances and remove unused variables that was pointed by removed expressions.

              • +

            • add possibility to add one or more CpoSolverListener to put some callback functions when solve is started, ended, or when a solution is found. Implementation is provided in new python module docplex.cp.solver.solver_listener that also contains sample -listeners SolverProgressPanelListener and AutoStopListener.

              • -
            • Using parameter context.solver.solve_with_start_next, enable solve() method to execute a start/next loop instead -of standard solve. This enables, for optimization problems, usage of SolveListeners with a greater progress accuracy.
              • -
            • Completely remove deprecated ‘angel’ to identify local solver.
              • -
            • Deprecate usage of methods minimize() and maximize() on docplex.cp.CpoModel.
              • -
            • Add methods get_objective_bounds() and get_objective_gaps() in solution objects.
              • +listeners SolverProgressPanelListener and AutoStopListener.

              +

            • Using parameter context.solver.solve_with_start_next, enable solve() method to execute a start/next loop instead +of standard solve. This enables, for optimization problems, usage of SolveListeners with a greater progress accuracy.

              • +

            • Completely remove deprecated ‘angel’ to identify local solver.

              • +

            • Deprecate usage of methods minimize() and maximize() on docplex.cp.CpoModel.

              • +

            • Add methods get_objective_bounds() and get_objective_gaps() in solution objects.

          -
    -
    -

    Changed in 2.3.44 (2017.09):

    + +
    +

    Changed in 2.3.44 (2017.09):

      -
    • Module docplex.cp.model.solver_angel.py has been renamed solver_local.py. +

    • Module docplex.cp.model.solver_angel.py has been renamed solver_local.py. A shadow copy with previous name still exist to preserve ascending compatibility. -Module docplex.cp.model.config.py is modified to refer this new module.

      • -
    • Class docplex.cp.model.solver_local.SolverAngel has been renamed SolverLocal. -A shadow copy with previous name still exist to preserve ascending compatibility.
      • -
    • Class docplex.cp.model.solver_local.AngelException has been renamed LocalSolverException. -A shadow copy with previous name still exist to preserve ascending compatibility.
      • -
    • Functions logical_and() and logical_or() are able to accept a list of model boolean expressions.
      • -
    • Fix defect on allowed_assignments() and forbiden_assignments() that was wrongly converting -list of tupes into tuple_set.
      • -
    • Update all examples to add comments and split them in sections data / prepare / model / solve
      • -
    • Add new sched_RCPSPMM_json.py example that reads data from JSON file instead of raw data file.
      • -
    • Rename all visu examples with more explicit names.
      • -
    • Remove the object class CpoTupleSet. Tuple sets can be constructed only by calling tuple_set() method, or more +Module docplex.cp.model.config.py is modified to refer this new module.

      • +

    • Class docplex.cp.model.solver_local.SolverAngel has been renamed SolverLocal. +A shadow copy with previous name still exist to preserve ascending compatibility.

      • +

    • Class docplex.cp.model.solver_local.AngelException has been renamed LocalSolverException. +A shadow copy with previous name still exist to preserve ascending compatibility.

      • +

    • Functions logical_and() and logical_or() are able to accept a list of model boolean expressions.

      • +

    • Fix defect on allowed_assignments() and forbiden_assignments() that was wrongly converting +list of tupes into tuple_set.

      • +

    • Update all examples to add comments and split them in sections data / prepare / model / solve

      • +

    • Add new sched_RCPSPMM_json.py example that reads data from JSON file instead of raw data file.

      • +

    • Rename all visu examples with more explicit names.

      • +

    • Remove the object class CpoTupleSet. Tuple sets can be constructed only by calling tuple_set() method, or more simply by passing directly a Python iterable of iterables when a tupleset is required -(in expressions allowed_assignments() and forbidden_assignments)

      • -
    • Allow logical_and() and logical_or() to accept a list of boolean expressions.
      • -
    • Add overloading of builtin functions all() and any() as other form of logical_and() and logical_or().
      • -
    • In no_overlap() and state_function(), transition matrix can be passed directly as a Python iterable of iterables of integers,
      • -
    • Editable transition matrix, created with a size only, is deprecated. However it is still available for ascending compatibility.
      • -
    • Add conditional() modeling function
      • -
    • Parameter ‘AutomaticReplay’ is deprecated.
      • -
    • Add get_search_status() and get_stop_cause() on object CpoSolveResult, available for solver COS12.8
      • -
    • Improved performance of Var.reduced_cost() in docplex.mp.
      • -
    -
    -
    -

    Changed in 2.2.34 (2017.07):

    -
      -
    • Methods docplex.cp.model.export_model() and docplex.cp.model.import_model() -have been added to respectively generate or parse a model in CPO format.
      • -
    • Methods docplex.cp.model.minimize() and docplex.cp.model.maximize() -have been added to directly indicate an objective at model level.
      • -
    • Notebook example scheduling_tuto.ipynb contains an extensive tutorial -to solve scheduling problems with CP.
      • -
    • Modeling method sum() now supports sum of cumul expressions.
      • -
    • Methods docplex.cp.model.start_search() allows to start a new -search sequence directly from the model object.
      • -
    • When setting context.solver.auto_publish is set, and using the CPLEX +(in expressions allowed_assignments() and forbidden_assignments)

      • +

    • Allow logical_and() and logical_or() to accept a list of boolean expressions.

      • +

    • Add overloading of builtin functions all() and any() as other form of logical_and() and logical_or().

      • +

    • In no_overlap() and state_function(), transition matrix can be passed directly as a Python iterable of iterables of integers,

      • +

    • Editable transition matrix, created with a size only, is deprecated. However it is still available for ascending compatibility.

      • +

    • Add conditional() modeling function

      • +

    • Parameter ‘AutomaticReplay’ is deprecated.

      • +

    • Add get_search_status() and get_stop_cause() on object CpoSolveResult, available for solver COS12.8

      • +

    • Improved performance of Var.reduced_cost() in docplex.mp.

      • +
    + +
    +

    Changed in 2.2.34 (2017.07):

    +
      +

    • Methods docplex.cp.model.export_model() and docplex.cp.model.import_model() +have been added to respectively generate or parse a model in CPO format.

      • +

    • Methods docplex.cp.model.minimize() and docplex.cp.model.maximize() +have been added to directly indicate an objective at model level.

      • +

    • Notebook example scheduling_tuto.ipynb contains an extensive tutorial +to solve scheduling problems with CP.

      • +

    • Modeling method sum() now supports sum of cumul expressions.

      • +

    • Methods docplex.cp.model.start_search() allows to start a new +search sequence directly from the model object.

      • +

    • When setting context.solver.auto_publish is set, and using the CPLEX engine, KPIs and current objective are automatically published when the -script is run on DOcplexcloud Python worker.

      • -
    • When setting context.solver.auto_publish is set, and using the CP +script is run on DOcplexcloud Python worker.

      • +

    • When setting context.solver.auto_publish is set, and using the CP engine, current objective is automatically published when the -script is run on DOcplexcloud Python worker.

      • -
    • docplex.util.environment.Environment.set_stop_callback and +script is run on DOcplexcloud Python worker.

      • +

    • docplex.util.environment.Environment.set_stop_callback and docplex.util.environment.Environment.get_stop_callback are added so that -you can add a callback when the DOcplexcloud job is aborted.

      • +you can add a callback when the DOcplexcloud job is aborted.

    -
    -
    -

    Changed in 2.1.28:

    + +
    +

    Changed in 2.1.28:

      -
    • New methods Model.logical_or() and Model.logical_and() handle -logical operations on binary variables.
      • -
    • DOcplex now supports CPLEX 12.7.1 and Benders decomposition. Set annotations +

    • New methods Model.logical_or() and Model.logical_and() handle +logical operations on binary variables.

      • +

    • DOcplex now supports CPLEX 12.7.1 and Benders decomposition. Set annotations on constraints and variables using the benders_annotation property and use -the proper CPLEX parameters governing Benders decomposition.

      • -
    • CPLEX tutorials: in the documentation and as notebooks in the examples.
      • -
    • Fixed a bug in docplex.mp.solution.SolveSolution.display() and in -docplex.mp.solution.Model.report_kpi() when using unicode variable names.
      • -
    • There’s now a simple command line interface for DOcplexcloud. It can be run +the proper CPLEX parameters governing Benders decomposition.

      • +

    • CPLEX tutorials: in the documentation and as notebooks in the examples.

      • +

    • Fixed a bug in docplex.mp.solution.SolveSolution.display() and in +docplex.mp.solution.Model.report_kpi() when using unicode variable names.

      • +

    • There’s now a simple command line interface for DOcplexcloud. It can be run in a terminal. python -m docplex.cli help for more info. That command line reads your DOcplexcloud credentials in your cplex_config.py file. It allows you to submit, list, delete jobs on DOcplexcloud. The cli is available in notebooks too, using the %docplex_cli magics. %docplex_cli help for some help. In a notebook, credentials can be passed using %docplex_url and -%docplex_key magics.

      • -
    • Removing constraints in 1 call
      • -
    • Bug fixes when editing an existing model.
      • -
    • Bug fix in the relaxation mechanism when using docplexcloud.
      • -
    -
    -
    -

    Changed in 2.0.15:

    +%docplex_key magics.

    +

  • Removing constraints in 1 call

    • +

  • Bug fixes when editing an existing model.

    • +

  • Bug fix in the relaxation mechanism when using docplexcloud.

    • + + +
    +

    Changed in 2.0.15:

      -
    • Piecewise linear (PWL) functions are now supported. An API is now available +

    • Piecewise linear (PWL) functions are now supported. An API is now available on docplex.mp.model to create PWL functions and to create constraints using these PWL functions. PWL functions may be defined with breakpoints (default API) or by using slopes. Some simple arithmetic is -also available to build new PWL functions by adding, subtracting, or scaling existing PWL functions.

      • -
    • DOcplex has undergone a significant overhaul effort that has resulted in an average of 30-50% improvement -of modeling run-time performance. All parts of the API benefit from the performance improvements: creation of variables and constraints, removal of constraints, computation of sums of variables, and so on.
      • -
    • Constraints are now fully editable: +also available to build new PWL functions by adding, subtracting, or scaling existing PWL functions.

      • +

    • DOcplex has undergone a significant overhaul effort that has resulted in an average of 30-50% improvement +of modeling run-time performance. All parts of the API benefit from the performance improvements: creation of variables and constraints, removal of constraints, computation of sums of variables, and so on.

      • +

    • Constraints are now fully editable: the expressions of a constraint can be modified. -Similarly, the objective expression can also be modified. This allows for complex workflows in which the model is modified after a solve and then solved again.

      • -
    • docplex is now available on Anaconda cloud and can be installed via the conda installation packager. +Similarly, the objective expression can also be modified. This allows for complex workflows in which the model is modified after a solve and then solved again.

      • +

    • docplex is now available on Anaconda cloud and can be installed via the conda installation packager. See the IBM Anaconda home -CPLEX Community Edition for Python is also provided on Anaconda Cloud to get free local solving capabilities with limitations.

      • -
    • Support of ~/.docplexrc configuration files for docplex.mp.context.Context is now dropped. -This feature has been deprecated since 1.0.0.
      • -
    • Known incompatibility: class docplex.mp.model.AbstractModel moved to docplex.mp.absmodel.AbstractModel. -Samples using this class have been updated.
      • -
    -
    -
    -

    Changed in 1.0.630:

    -
      -
    • Added support for CPLEX 12.7 and Python 3.5.
      • -
    • Upgraded the DOcplexcloud client to version 1.0.202.
      • -
    • Module docplex.mp.advmodel is now officially supported. This module +CPLEX Community Edition for Python is also provided on Anaconda Cloud to get free local solving capabilities with limitations.

      • +

    • Support of ~/.docplexrc configuration files for docplex.mp.context.Context is now dropped. +This feature has been deprecated since 1.0.0.

      • +

    • Known incompatibility: class docplex.mp.model.AbstractModel moved to docplex.mp.absmodel.AbstractModel. +Samples using this class have been updated.

      • +
    + +
    +

    Changed in 1.0.630:

    +
      +

    • Added support for CPLEX 12.7 and Python 3.5.

      • +

    • Upgraded the DOcplexcloud client to version 1.0.202.

      • +

    • Module docplex.mp.advmodel is now officially supported. This module provides support for efficient, specialized aggregator methods for large -models.

      • -
    • When solving on DOcplexcloud, proxies can now be specified with the -context.solver.docloud.proxies property.
      • -
    • When two constraints are defined with the same name, issue a warning instead of -a fatal exception. The last constraint defined will take over the first one in the name directory.
      • -
    • Fix ValueError when passing a pandas DataFrame as variable keys (using -DataFrame indexes).
      • -
    • Solution.get_values() returns a collection of variable values in one call.
      • -
    • docplex.mp.model no longer imports docloud.status. Any status +models.

      • +

    • When solving on DOcplexcloud, proxies can now be specified with the +context.solver.docloud.proxies property.

      • +

    • When two constraints are defined with the same name, issue a warning instead of +a fatal exception. The last constraint defined will take over the first one in the name directory.

      • +

    • Fix ValueError when passing a pandas DataFrame as variable keys (using +DataFrame indexes).

      • +

    • Solution.get_values() returns a collection of variable values in one call.

      • +

    • docplex.mp.model no longer imports docloud.status. Any status previously initialized as JobSolveStatus.UNKNOWN is now initialized as -None.

      • -
    • Minor improvements to notebooks and examples.
      • +None.

      +

    • Minor improvements to notebooks and examples.

    -
    -
    + + +
    +
    \ No newline at end of file diff --git a/docs/README.md.html b/docs/README.md.html index 62f21cd..3fbb333 100644 --- a/docs/README.md.html +++ b/docs/README.md.html @@ -2,25 +2,24 @@ - + - - - README.md — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.25 documentation - - + + + + README.md — IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation + + - - - - - - + + + + - + - +
    -
    -

    README.md

    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
    # IBM&reg; Decision Optimization Modeling for Python (DOcplex)
-
-Welcome to the IBM&reg; Decision Optimization Modeling for Python.
-Licensed under the Apache License v2.0.
-
-With this library, you can quickly and easily add the power of optimization to
-your application. You need IBM ILOG CPLEX Optimization Studio to solve the models.
-
-This library is composed of 2 modules:
-
-* IBM&reg; Decision Optimization CPLEX Optimizer Modeling for Python - with namespace docplex.mp
-* IBM&reg; Decision Optimization CP Optimizer Modeling for Python - with namespace docplex.cp
-
-Solving with CPLEX requires that IBM&reg; ILOG CPLEX Optimization Studio V12.10 or later
-is installed on your machine.
-
-This library is numpy friendly.
-
-## Install the library
-
-```
-   pip install docplex
-```
-
-## Get the documentation and examples
-
-* [Latest documentation](http://ibmdecisionoptimization.github.io/docplex-doc/)
-* Documentation archives:
-   * [2.23.222](http://ibmdecisionoptimization.github.io/docplex-doc/2.23.222)
-   * [2.22.213](http://ibmdecisionoptimization.github.io/docplex-doc/2.22.213)
-   * [2.21.207](http://ibmdecisionoptimization.github.io/docplex-doc/2.21.207)
-   * [2.20.204](http://ibmdecisionoptimization.github.io/docplex-doc/2.20.204)
-   * [2.19.202](http://ibmdecisionoptimization.github.io/docplex-doc/2.19.202)
-   * [2.18.200](http://ibmdecisionoptimization.github.io/docplex-doc/2.18.200)
-   * [2.16.195](http://ibmdecisionoptimization.github.io/docplex-doc/2.16.195)
-* [Examples](https://github.com/IBMDecisionOptimization/docplex-examples)
-
-## Get your IBM&reg; ILOG CPLEX Optimization Studio edition
-
-- You can get a free [Community Edition](https://www.ibm.com/account/reg/us-en/signup?formid=urx-20028)
- of CPLEX Optimization Studio, with limited solving capabilities in term of problem size.
-
-- Faculty members, research professionals at accredited institutions can get access to an unlimited version of CPLEX through the
- [IBM&reg; Academic Initiative](http://ibm.biz/cplex-free-for-students).
-
-## Dependencies
-
-These third-party dependencies are automatically installed with ``pip``
-
-- [futures](https://pypi.python.org/pypi/futures)
-- [requests](https://pypi.python.org/pypi/requests)
-- [six](https://pypi.python.org/pypi/six)
-- [certifi](https://pypi.python.org/pypi/certifi)
-
-
-
-## License
-
-This library is delivered under the  Apache License Version 2.0, January 2004 (see LICENSE.txt).
+  
    
+
    README.md
    
+
     1# IBM&reg; Decision Optimization Modeling for Python (DOcplex)
+ 2
+ 3Welcome to the IBM&reg; Decision Optimization Modeling for Python.
+ 4Licensed under the Apache License v2.0.
+ 5
+ 6With this library, you can quickly and easily add the power of optimization to
+ 7your application. You need IBM ILOG CPLEX Optimization Studio to solve the models.
+ 8
+ 9This library is composed of 2 modules:
+10
+11* IBM&reg; Decision Optimization CPLEX Optimizer Modeling for Python - with namespace docplex.mp
+12* IBM&reg; Decision Optimization CP Optimizer Modeling for Python - with namespace docplex.cp
+13
+14Solving with CPLEX requires that IBM&reg; ILOG CPLEX Optimization Studio V12.10 or later
+15is installed on your machine.
+16
+17This library is numpy friendly.
+18
+19## Install the library
+20
+21```
+22   pip install docplex
+23```
+24
+25## Get the documentation and examples
+26
+27* [Latest documentation](http://ibmdecisionoptimization.github.io/docplex-doc/)
+28* Documentation archives:
+29   * [2.23.222](http://ibmdecisionoptimization.github.io/docplex-doc/2.23.222)
+30   * [2.22.213](http://ibmdecisionoptimization.github.io/docplex-doc/2.22.213)
+31   * [2.21.207](http://ibmdecisionoptimization.github.io/docplex-doc/2.21.207)
+32   * [2.20.204](http://ibmdecisionoptimization.github.io/docplex-doc/2.20.204)
+33   * [2.19.202](http://ibmdecisionoptimization.github.io/docplex-doc/2.19.202)
+34   * [2.18.200](http://ibmdecisionoptimization.github.io/docplex-doc/2.18.200)
+35   * [2.16.195](http://ibmdecisionoptimization.github.io/docplex-doc/2.16.195)
+36* [Examples](https://github.com/IBMDecisionOptimization/docplex-examples)
+37
+38## Get your IBM&reg; ILOG CPLEX Optimization Studio edition
+39
+40- You can get a free [Community Edition](https://www.ibm.com/account/reg/us-en/signup?formid=urx-20028)
+41 of CPLEX Optimization Studio, with limited solving capabilities in term of problem size.
+42
+43- Faculty members, research professionals at accredited institutions can get access to an unlimited version of CPLEX through the
+44 [IBM&reg; Academic Initiative](http://ibm.biz/cplex-free-for-students).
+45
+46## Dependencies
+47
+48These third-party dependencies are automatically installed with ``pip``
+49
+50- [futures](https://pypi.python.org/pypi/futures)
+51- [requests](https://pypi.python.org/pypi/requests)
+52- [six](https://pypi.python.org/pypi/six)
+53- [certifi](https://pypi.python.org/pypi/certifi)
+54
+55
+56
+57## License
+58
+59This library is delivered under the  Apache License Version 2.0, January 2004 (see LICENSE.txt).
 
    
-
    + +
    +
    \ No newline at end of file diff --git a/docs/_static/basic.css b/docs/_static/basic.css index 0807176..2a1ca75 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -15,6 +15,12 @@ div.clearer { clear: both; } +div.section::after { + display: block; + content: ''; + clear: left; +} + /* -- relbar ---------------------------------------------------------------- */ div.related { @@ -49,7 +55,7 @@ div.sphinxsidebarwrapper { div.sphinxsidebar { float: left; - width: 230px; + width: 210px; margin-left: -100%; font-size: 90%; word-wrap: break-word; @@ -124,7 +130,7 @@ ul.search li a { font-weight: bold; } -ul.search li div.context { +ul.search li p.context { color: #888; margin: 2px 0 0 30px; text-align: left; @@ -216,7 +222,7 @@ table.modindextable td { /* -- general body styles --------------------------------------------------- */ div.body { - min-width: 450px; + min-width: 360px; max-width: 800px; } @@ -261,19 +267,25 @@ p.rubric { font-weight: bold; } -img.align-left, .figure.align-left, object.align-left { +img.align-left, figure.align-left, .figure.align-left, object.align-left { clear: left; float: left; margin-right: 1em; } -img.align-right, .figure.align-right, object.align-right { +img.align-right, figure.align-right, .figure.align-right, object.align-right { clear: right; float: right; margin-left: 1em; } -img.align-center, .figure.align-center, object.align-center { +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { display: block; margin-left: auto; margin-right: auto; @@ -287,30 +299,45 @@ img.align-center, .figure.align-center, object.align-center { text-align: center; } +.align-default { + text-align: center; +} + .align-right { text-align: right; } /* -- sidebars -------------------------------------------------------------- */ -div.sidebar { +div.sidebar, +aside.sidebar { margin: 0 0 0.5em 1em; border: 1px solid #ddb; - padding: 7px 7px 0 7px; + padding: 7px; background-color: #ffe; width: 40%; float: right; + clear: right; + overflow-x: auto; } p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; - padding: 7px 7px 0 7px; + padding: 7px; margin: 10px 0 10px 0; } @@ -332,10 +359,6 @@ div.admonition dt { font-weight: bold; } -div.admonition dl { - margin-bottom: 0; -} - p.admonition-title { margin: 0px 10px 5px 0px; font-weight: bold; @@ -346,9 +369,34 @@ div.body p.centered { margin-top: 25px; } +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + /* -- tables ---------------------------------------------------------------- */ table.docutils { + margin-top: 10px; + margin-bottom: 10px; border: 0; border-collapse: collapse; } @@ -358,6 +406,11 @@ table.align-center { margin-right: auto; } +table.align-default { + margin-left: auto; + margin-right: auto; +} + table caption span.caption-number { font-style: italic; } @@ -373,10 +426,6 @@ table.docutils td, table.docutils th { border-bottom: 1px solid #aaa; } -table.footnote td, table.footnote th { - border: 0 !important; -} - th { text-align: left; padding-right: 5px; @@ -391,22 +440,34 @@ table.citation td { border-bottom: none; } +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + /* -- figures --------------------------------------------------------------- */ -div.figure { +div.figure, figure { margin: 0.5em; padding: 0.5em; } -div.figure p.caption { +div.figure p.caption, figcaption { padding: 0.3em; } -div.figure p.caption span.caption-number { +div.figure p.caption span.caption-number, +figcaption span.caption-number { font-style: italic; } -div.figure p.caption span.caption-text { +div.figure p.caption span.caption-text, +figcaption span.caption-text { } /* -- field list styles ----------------------------------------------------- */ @@ -433,10 +494,71 @@ table.field-list td, table.field-list th { /* -- hlist styles ---------------------------------------------------------- */ +table.hlist { + margin: 1em 0; +} + table.hlist td { vertical-align: top; } +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + /* -- other body styles ----------------------------------------------------- */ @@ -460,11 +582,81 @@ ol.upperroman { list-style: upper-roman; } +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + dl { margin-bottom: 15px; } -dd p { +dd > :first-child { margin-top: 0px; } @@ -478,6 +670,21 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + dt:target, span.highlighted { background-color: #fbe54e; } @@ -491,14 +698,6 @@ dl.glossary dt { font-size: 1.1em; } -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - .versionmodified { font-style: italic; } @@ -537,11 +736,26 @@ dl.glossary dt { font-style: oblique; } +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + abbr, acronym { border-bottom: dotted 1px; cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { @@ -549,29 +763,69 @@ pre { overflow-y: hidden; /* fixes display issues on Chrome browsers */ } +pre, div[class*="highlight-"] { + clear: both; +} + span.pre { -moz-hyphens: none; -ms-hyphens: none; -webkit-hyphens: none; hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; } td.linenos pre { - padding: 5px 0px; border: 0; background-color: transparent; color: #aaa; } table.highlighttable { - margin-left: 0.5em; + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; } table.highlighttable td { - padding: 0 0.5em 0 0.5em; + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; } div.code-block-caption { + margin-top: 1em; padding: 2px 5px; font-size: small; } @@ -580,8 +834,14 @@ div.code-block-caption code { background-color: transparent; } -div.code-block-caption + div > div.highlight > pre { - margin-top: 0; +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ } div.code-block-caption span.caption-number { @@ -593,21 +853,7 @@ div.code-block-caption span.caption-text { } div.literal-block-wrapper { - padding: 1em 1em 0; -} - -div.literal-block-wrapper div.highlight { - margin: 0; -} - -code.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -code.descclassname { - background-color: transparent; + margin: 1em 0; } code.xref, a code { @@ -648,8 +894,7 @@ span.eqno { } span.eqno a.headerlink { - position: relative; - left: 0px; + position: absolute; z-index: 1; } diff --git a/docs/_static/bizstyle.css b/docs/_static/bizstyle.css index 0464a74..9a6c900 100644 --- a/docs/_static/bizstyle.css +++ b/docs/_static/bizstyle.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- business style theme. * - * :copyright: Copyright 2011-2014 by Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -39,6 +39,11 @@ div.document { -webkit-box-shadow: 2px 2px 5px #000; } +div.documentwrapper { + float: left; + width: 100%; +} + div.bodywrapper { margin: 0 0 0 240px; border-left: 1px solid #ccc; @@ -48,6 +53,9 @@ div.body { margin: 0; padding: 0.5em 20px 20px 20px; } +div.bodywrapper { + margin: 0 0 0 calc(210px + 30px); +} div.related { font-size: 1em; @@ -94,7 +102,6 @@ div.sphinxsidebarwrapper { } div.sphinxsidebar { - margin: 0; padding: 0.5em 12px 12px 12px; width: 210px; font-size: 1em; @@ -288,6 +295,8 @@ div.quotebar { border: 1px solid #ccc; } +nav.contents, +aside.topic, div.topic { background-color: #f8f8f8; } @@ -400,6 +409,15 @@ p.versionchanged span.versionmodified { background-color: #DCE6A0; } +dl.field-list > dt { + color: white; + background-color: #82A0BE; +} + +dl.field-list > dd { + background-color: #f7f7f7; +} + /* -- table styles ---------------------------------------------------------- */ table.docutils { diff --git a/docs/_static/bizstyle.js b/docs/_static/bizstyle.js index 14f9cdb..cade463 100644 --- a/docs/_static/bizstyle.js +++ b/docs/_static/bizstyle.js @@ -6,36 +6,25 @@ // // This theme was created by referring to 'sphinxdoc' // -// :copyright: Copyright 2012-2014 by Sphinx team, see AUTHORS. +// :copyright: Copyright 2007-2023 by Sphinx team, see AUTHORS. // :license: BSD, see LICENSE for details. // -$(document).ready(function(){ - if (navigator.userAgent.indexOf('iPhone') > 0 || - navigator.userAgent.indexOf('Android') > 0) { - $("li.nav-item-0 a").text("Top"); +const initialiseBizStyle = () => { + if (navigator.userAgent.indexOf("iPhone") > 0 || navigator.userAgent.indexOf("Android") > 0) { + document.querySelector("li.nav-item-0 a").innerText = "Top" } + const truncator = item => {if (item.textContent.length > 20) { + item.title = item.innerText + item.innerText = item.innerText.substr(0, 17) + "..." + } + } + document.querySelectorAll("div.related:first ul li:not(.right) a").slice(1).forEach(truncator); + document.querySelectorAll("div.related:last ul li:not(.right) a").slice(1).forEach(truncator); +} - $("div.related:first ul li:not(.right) a").slice(1).each(function(i, item){ - if (item.text.length > 20) { - var tmpstr = item.text - $(item).attr("title", tmpstr); - $(item).text(tmpstr.substr(0, 17) + "..."); - } - }); - $("div.related:last ul li:not(.right) a").slice(1).each(function(i, item){ - if (item.text.length > 20) { - var tmpstr = item.text - $(item).attr("title", tmpstr); - $(item).text(tmpstr.substr(0, 17) + "..."); - } - }); -}); +window.addEventListener("resize", + () => (document.querySelector("li.nav-item-0 a").innerText = (window.innerWidth <= 776) ? "Top" : "IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.29 documentation") +) -$(window).resize(function(){ - if ($(window).width() <= 776) { - $("li.nav-item-0 a").text("Top"); - } - else { - $("li.nav-item-0 a").text("IBM® Decision Optimization CPLEX® Modeling for Python (DOcplex) V2.25 documentation"); - } -}); \ No newline at end of file +if (document.readyState !== "loading") initialiseBizStyle() +else document.addEventListener("DOMContentLoaded", initialiseBizStyle) \ No newline at end of file diff --git a/docs/_static/css3-mediaqueries_src.js b/docs/_static/css3-mediaqueries_src.js index f21dd49..7878620 100644 --- a/docs/_static/css3-mediaqueries_src.js +++ b/docs/_static/css3-mediaqueries_src.js @@ -1035,7 +1035,7 @@ domReady(function enableCssMediaQueries() { var vpw = cssHelper.getViewportWidth(); var vph = cssHelper.getViewportHeight(); // check whether vp size has really changed, because IE also triggers resize event when body size changes - // 20px allowance to accomodate short appearance of scrollbars in IE in some cases + // 20px allowance to accommodate short appearance of scrollbars in IE in some cases if (Math.abs(vpw - cvpw) > scrollbarWidth || Math.abs(vph - cvph) > scrollbarWidth) { cvpw = vpw; cvph = vph; diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js index 344db17..d06a71d 100644 --- a/docs/_static/doctools.js +++ b/docs/_static/doctools.js @@ -2,314 +2,155 @@ * doctools.js * ~~~~~~~~~~~ * - * Sphinx JavaScript utilities for all documentation. + * Base JavaScript utilities for all Sphinx HTML documentation. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); } - return result; }; -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var bbox = span.getBBox(); - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - var parentOfText = node.parentNode.parentNode; - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} - /** * Small JavaScript module for the documentation. */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); }, /** * i18n support */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", // gettext and ngettext don't access this so that the functions // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } }, - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; }, - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; }, /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + * helper function to focus on search bar */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); }, /** - * highlight the search words provided in the url in the text + * Initialise the domain index toggle buttons */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

    ' + _('Hide Search Matches') + '

    ') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, + }; - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); }, - initOnKeyListeners: function() { - $(document).keyup(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); } - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); } + break; } } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } }); - } + }, }; // quick alias for translations -_ = Documentation.gettext; +const _ = Documentation.gettext; -$(document).ready(function() { - Documentation.init(); -}); +_ready(Documentation.init); diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index f2473bf..732359c 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,10 +1,14 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: 'V2.25', - LANGUAGE: 'None', + VERSION: 'V2.29', + LANGUAGE: 'en', COLLAPSE_INDEX: false, + BUILDER: 'html', FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt', NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, }; \ No newline at end of file diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js index 5266fb1..250f566 100644 --- a/docs/_static/language_data.js +++ b/docs/_static/language_data.js @@ -5,15 +5,16 @@ * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ -var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; -/* Non-minified version JS is _stemmer.js if file is provided */ +/* Non-minified version is copied as a separate JS file, is available */ + /** * Porter Stemmer */ @@ -196,102 +197,3 @@ var Stemmer = function() { } } - - - - -var splitChars = (function() { - var result = {}; - var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, - 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, - 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, - 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, - 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, - 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, - 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, - 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, - 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, - 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; - var i, j, start, end; - for (i = 0; i < singles.length; i++) { - result[singles[i]] = true; - } - var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], - [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], - [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], - [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], - [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], - [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], - [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], - [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], - [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], - [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], - [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], - [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], - [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], - [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], - [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], - [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], - [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], - [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], - [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], - [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], - [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], - [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], - [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], - [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], - [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], - [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], - [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], - [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], - [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], - [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], - [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], - [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], - [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], - [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], - [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], - [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], - [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], - [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], - [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], - [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], - [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], - [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], - [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], - [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], - [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], - [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], - [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], - [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], - [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; - for (i = 0; i < ranges.length; i++) { - start = ranges[i][0]; - end = ranges[i][1]; - for (j = start; j <= end; j++) { - result[j] = true; - } - } - return result; -})(); - -function splitQuery(query) { - var result = []; - var start = -1; - for (var i = 0; i < query.length; i++) { - if (splitChars[query.charCodeAt(i)]) { - if (start !== -1) { - result.push(query.slice(start, i)); - start = -1; - } - } else if (start === -1) { - start = i; - } - } - if (start !== -1) { - result.push(query.slice(start)); - } - return result; -} - - diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css index 691aeb8..0d49244 100644 --- a/docs/_static/pygments.css +++ b/docs/_static/pygments.css @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #FF0000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 5ff3180..97d56a7 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -4,22 +4,24 @@ * * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ +"use strict"; -if (!Scorer) { - /** - * Simple result scoring code. - */ +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { var Scorer = { // Implement the following function to further tweak the score for each result - // The function takes a result array [filename, title, anchor, descr, score] + // The function takes a result array [docname, title, anchor, descr, score, filename] // and returns the new score. /* - score: function(result) { - return result[4]; + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score }, */ @@ -28,423 +30,508 @@ if (!Scorer) { // or matches in the last dotted part of the object name objPartialMatch: 6, // Additive scores depending on the priority of the object - objPrio: {0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5}, // used to be unimportantResults + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, // Used when the priority is not in the mapping. objPrioDefault: 0, // query found in title title: 15, + partialTitle: 7, // query found in terms - term: 5 + term: 5, + partialTerm: 2, }; } -if (!splitQuery) { - function splitQuery(query) { - return query.split(/\s+/); +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = docUrlRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = docUrlRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings } /** * Search Module */ -var Search = { - - _index : null, - _queued_query : null, - _pulse_status : -1, - - init : function() { - var params = $.getQueryParameters(); - if (params.q) { - var query = params.q[0]; - $('input[name="q"]')[0].value = query; - this.performSearch(query); - } +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; }, - loadIndex : function(url) { - $.ajax({type: "GET", url: url, data: null, - dataType: "script", cache: true, - complete: function(jqxhr, textstatus) { - if (textstatus != "success") { - document.getElementById("searchindexloader").src = url; - } - }}); + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); }, - setIndex : function(index) { - var q; - this._index = index; - if ((q = this._queued_query) !== null) { - this._queued_query = null; - Search.query(q); + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); } }, - hasIndex : function() { - return this._index !== null; - }, + hasIndex: () => Search._index !== null, - deferQuery : function(query) { - this._queued_query = query; - }, + deferQuery: (query) => (Search._queued_query = query), - stopPulse : function() { - this._pulse_status = 0; - }, + stopPulse: () => (Search._pulse_status = -1), - startPulse : function() { - if (this._pulse_status >= 0) - return; - function pulse() { - var i; + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { Search._pulse_status = (Search._pulse_status + 1) % 4; - var dotString = ''; - for (i = 0; i < Search._pulse_status; i++) - dotString += '.'; - Search.dots.text(dotString); - if (Search._pulse_status > -1) - window.setTimeout(pulse, 500); - } + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; pulse(); }, /** * perform a search for something (or wait until index is loaded) */ - performSearch : function(query) { + performSearch: (query) => { // create the required interface elements - this.out = $('#search-results'); - this.title = $('

    ' + _('Searching') + '

    ').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('

    ').appendTo(this.out); - this.output = $(' - - +
    -
    -

    Overview of constraint programming

    -
    -

    What is constraint programming technology?

    +
    +

    Overview of constraint programming

    +
    +

    What is constraint programming technology?

    Constraint programming technology is used to find solutions to scheduling and combinatorial optimization problems. It is based primarily on computer science fundamentals, such as logic programming and graph theory, in contrast to mathematical programming, which is based on numerical linear algebra.

    Constraint programming is invaluable when dealing with the complexity of many real-world sequencing and scheduling problems.

    @@ -70,165 +54,185 @@

    What is constraint programming technology? -

    What is constraint-based scheduling?

    +

    +
    +

    What is constraint-based scheduling?

    Given a set of resources with given capacities, a set of activities with given processing times and resource requirements, and a set of temporal constraints between activities, a “pure” scheduling problem consists of deciding when to perform each activity so that both temporal constraints and resource constraints are satisfied. Most scheduling problems can easily be represented as instances of the constraint satisfaction problem: given a set of variables, a set of possible values (domain) for each variable, and a set of constraints between the variables, assign a value to each variable so that all the constraints are satisfied.

    -
    -
    Several types of scheduling problems can be distinguished:
    -
      -
    • In disjunctive scheduling, each resource can perform at most one activity at a time. In cumulative scheduling, a resource can run several activities in parallel, as long as the resource capacity is not exceeded.
      • -
    • In non-preemptive scheduling, activities cannot be interrupted. Each activity A must be performed without interruption from its start time to its end time. In preemptive scheduling, activities can be interrupted at any time, for example, to allow some other activities perform.
      • +
      +
      Several types of scheduling problems can be distinguished:
        +

      • In disjunctive scheduling, each resource can perform at most one activity at a time. In cumulative scheduling, a resource can run several activities in parallel, as long as the resource capacity is not exceeded.

        • +

      • In non-preemptive scheduling, activities cannot be interrupted. Each activity A must be performed without interruption from its start time to its end time. In preemptive scheduling, activities can be interrupted at any time, for example, to allow some other activities perform.

      Many real-life scheduling problems are complex combinations of these basic problems.

      -
    -
    -

    The power of modeling in constraint programming

    + +
    +

    The power of modeling in constraint programming

    Modeling in constraint programming revolves around the details of what is possible. For example, if you need to schedule a large number of resources and activities that respect capacity limitations, operational sequencing requirements, and business policies while meeting individual customer service goals, these modeling features are available to you:

      -
    • Optional tasks
        -
      • Model activities or processes that may or may not be performed in the final schedule.
        • -
      • Tasks can be grouped to match the work breakdown structure of a problem.
        • +

      • Optional tasks

        +
          +

        • Model activities or processes that may or may not be performed in the final schedule.

          • +

        • Tasks can be grouped to match the work breakdown structure of a problem.

        • -
      • Precedence constraints
          -
        • Model dependencies between tasks.
          • -
        • Can include a delay.
          • -
        • Can be applied to group of intervals.
          • +

        • Precedence constraints

          +
            +

          • Model dependencies between tasks.

            • +

          • Can include a delay.

            • +

          • Can be applied to group of intervals.

          • -
        • Expressions on interval properties
            -
          • Express typical scheduling costs such as tardiness costs, completion costs or total duration.
            • -
          • The presence status of an optional interval can be used to express completion costs or resource costs.
            • -
          • Can be applied to group of intervals.
            • +

          • Expressions on interval properties

            +
              +

            • Express typical scheduling costs such as tardiness costs, completion costs or total duration.

              • +

            • The presence status of an optional interval can be used to express completion costs or resource costs.

              • +

            • Can be applied to group of intervals.

            • -
          • Finite capacity reservoirs and resources
              -
            • Specify limits on the number of tasks that can be performed in parallel with a common resources.
              • -
            • Set constraints on inventory levels.
              • +

            • Finite capacity reservoirs and resources

              +
                +

              • Specify limits on the number of tasks that can be performed in parallel with a common resources.

                • +

              • Set constraints on inventory levels.

              • -
            • Set-up times and batches - Calendars
                -
              • State that some tasks cannot start or end on some dates.
                • -
              • State that some tasks that cannot overlap some dates.
                • -
              • Define resource breaks.
                • -
              • State that resource productivity changes over time.
                • +

              • Set-up times and batches - Calendars

                +
                  +

                • State that some tasks cannot start or end on some dates.

                  • +

                • State that some tasks that cannot overlap some dates.

                  • +

                • Define resource breaks.

                  • +

                • State that resource productivity changes over time.

                • -
              • Resource states
                  -
                • These modeling features can be used for combinatorial optimization problems.
                  • -
                • Arithmetic linear and non-linear constraints.
                  • -
                • Logical constraints.
                  • +

                • Resource states

                  +
                    +

                  • These modeling features can be used for combinatorial optimization problems.

                    • +

                  • Arithmetic linear and non-linear constraints.

                    • +

                  • Logical constraints.

                  • -
                • Specialized constraints and expressions.
                    -
                  • The all-different constraint: Enforces uniqueness for each variable in an array.
                    • -
                  • The pack constraint: Packs items into containers with finite capacity in one dimension (time, weight, budget, and so on).
                    • -
                  • The lexicographic constraint: Enforces a lexical ordering between groups of decision variables and is convenient to break symmetries.
                    • -
                  • The count expression.
                    • -
                  • The standard deviation expression.
                    • +

                  • Specialized constraints and expressions.

                    +
                      +

                    • The all-different constraint: Enforces uniqueness for each variable in an array.

                      • +

                    • The pack constraint: Packs items into containers with finite capacity in one dimension (time, weight, budget, and so on).

                      • +

                    • The lexicographic constraint: Enforces a lexical ordering between groups of decision variables and is convenient to break symmetries.

                      • +

                    • The count expression.

                      • +

                    • The standard deviation expression.

                    • -
                  • Compatibility and incompatibility constraints
                      -
                    • Define possible assignments for arrays of decision variables. They can be used, for instance, to model allowed transitions in a sequencing problem.
                      • +

                    • Compatibility and incompatibility constraints

                      +
                        +

                      • Define possible assignments for arrays of decision variables. They can be used, for instance, to model allowed transitions in a sequencing problem.

                    -
    -
    -

    The model-and-run constraint programming optimizer

    + +
    +

    The model-and-run constraint programming optimizer

    Some concepts are fundamental to the way constraint programming generates workable schedules and solutions from such complexity:

      -
    • Awareness of time. CP Optimizer algorithms can determine the best sequence of activities that satisfy capacity limitations, setup times, maintenance requirements, availability restrictions, individual delivery due dates, and more by exploiting the information in the specialized scheduling and combinatorial optimization modeling constructs.
      • -
    • Aggressive elimination of possibilities. Domain reduction is the internal mechanism that makes difficult allocation, sequencing, and scheduling problems manageable. Every resource or activity to be scheduled has a certain number of possible values that can be systematically reduced until a solution is reached. Every reduction makes the problem easier since the optimizer propagates the results of the decision throughout the model.
      • -
    • Rapidly traversing the decision tree. The concept of systematically exploring a decision tree for feasible and efficient solutions relates to domain reduction. One benefit of this structured approach is the ability to move flexibly throughout the search space and to backtrack when early choices turn out to be dead ends.
      • -
    • Adaptive Search. The default search consists of several search techniques that are dynamically changed during the search by adapting to the problem at hand. The different search techniques include but are not restricted to LNS (large neighborhood search) and GA (genetic algorithms).
      • +

    • Awareness of time. CP Optimizer algorithms can determine the best sequence of activities that satisfy capacity limitations, setup times, maintenance requirements, availability restrictions, individual delivery due dates, and more by exploiting the information in the specialized scheduling and combinatorial optimization modeling constructs.

      • +

    • Aggressive elimination of possibilities. Domain reduction is the internal mechanism that makes difficult allocation, sequencing, and scheduling problems manageable. Every resource or activity to be scheduled has a certain number of possible values that can be systematically reduced until a solution is reached. Every reduction makes the problem easier since the optimizer propagates the results of the decision throughout the model.

      • +

    • Rapidly traversing the decision tree. The concept of systematically exploring a decision tree for feasible and efficient solutions relates to domain reduction. One benefit of this structured approach is the ability to move flexibly throughout the search space and to backtrack when early choices turn out to be dead ends.

      • +

    • Adaptive Search. The default search consists of several search techniques that are dynamically changed during the search by adapting to the problem at hand. The different search techniques include but are not restricted to LNS (large neighborhood search) and GA (genetic algorithms).

    These concepts are built into the model-and-run optimizer of CP Optimizer but are also available to build a customized search.

    The optimizer

      -
    • Solves a large range of problems with default settings
      • -
    • Automatically removes redundant constraints
      • -
    • Reformulates the model to use constraints that are more efficiently propagated
      • -
    • Identifies conflicting constraints
      • -
    • Quickly finds feasible solutions for use in multi-model architectures such as column generation
      • +

    • Solves a large range of problems with default settings

      • +

    • Automatically removes redundant constraints

      • +

    • Reformulates the model to use constraints that are more efficiently propagated

      • +

    • Identifies conflicting constraints

      • +

    • Quickly finds feasible solutions for use in multi-model architectures such as column generation

    The optimizer is tested on an extensive library of models, and the search engine can be tuned by parameters or callbacks.

    -
    -
    -

    More resources on constraint programming, with or without CP Optimizer

    + +
    +

    More resources on constraint programming, with or without CP Optimizer

    -
    + + +
    +
    \ No newline at end of file diff --git a/docs/cp/README.md.html b/docs/cp/README.md.html index 577dbd3..c9812d5 100644 --- a/docs/cp/README.md.html +++ b/docs/cp/README.md.html @@ -2,25 +2,24 @@ - + - - - README.md — DOcplex.CP: Constraint Programming Modeling for Python V2.25 documentation - - + + + + README.md — DOcplex.CP: Constraint Programming Modeling for Python V2.29 documentation + + - - - - - - + + + + - + - +
    -
    -

    README.md

    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
    # IBM&reg; Decision Optimization Modeling for Python (DOcplex)
-
-Welcome to the IBM&reg; Decision Optimization Modeling for Python.
-Licensed under the Apache License v2.0.
-
-With this library, you can quickly and easily add the power of optimization to
-your application. You need IBM ILOG CPLEX Optimization Studio to solve the models.
-
-This library is composed of 2 modules:
-
-* IBM&reg; Decision Optimization CPLEX Optimizer Modeling for Python - with namespace docplex.mp
-* IBM&reg; Decision Optimization CP Optimizer Modeling for Python - with namespace docplex.cp
-
-Solving with CPLEX requires that IBM&reg; ILOG CPLEX Optimization Studio V12.10 or later
-is installed on your machine.
-
-This library is numpy friendly.
-
-## Install the library
-
-```
-   pip install docplex
-```
-
-## Get the documentation and examples
-
-* [Latest documentation](http://ibmdecisionoptimization.github.io/docplex-doc/)
-* Documentation archives:
-   * [2.23.222](http://ibmdecisionoptimization.github.io/docplex-doc/2.23.222)
-   * [2.22.213](http://ibmdecisionoptimization.github.io/docplex-doc/2.22.213)
-   * [2.21.207](http://ibmdecisionoptimization.github.io/docplex-doc/2.21.207)
-   * [2.20.204](http://ibmdecisionoptimization.github.io/docplex-doc/2.20.204)
-   * [2.19.202](http://ibmdecisionoptimization.github.io/docplex-doc/2.19.202)
-   * [2.18.200](http://ibmdecisionoptimization.github.io/docplex-doc/2.18.200)
-   * [2.16.195](http://ibmdecisionoptimization.github.io/docplex-doc/2.16.195)
-* [Examples](https://github.com/IBMDecisionOptimization/docplex-examples)
-
-## Get your IBM&reg; ILOG CPLEX Optimization Studio edition
-
-- You can get a free [Community Edition](https://www.ibm.com/account/reg/us-en/signup?formid=urx-20028)
- of CPLEX Optimization Studio, with limited solving capabilities in term of problem size.
-
-- Faculty members, research professionals at accredited institutions can get access to an unlimited version of CPLEX through the
- [IBM&reg; Academic Initiative](http://ibm.biz/cplex-free-for-students).
-
-## Dependencies
-
-These third-party dependencies are automatically installed with ``pip``
-
-- [futures](https://pypi.python.org/pypi/futures)
-- [requests](https://pypi.python.org/pypi/requests)
-- [six](https://pypi.python.org/pypi/six)
-- [certifi](https://pypi.python.org/pypi/certifi)
-
-
-
-## License
-
-This library is delivered under the  Apache License Version 2.0, January 2004 (see LICENSE.txt).
+  
    
+
    README.md
    
+
     1# IBM&reg; Decision Optimization Modeling for Python (DOcplex)
+ 2
+ 3Welcome to the IBM&reg; Decision Optimization Modeling for Python.
+ 4Licensed under the Apache License v2.0.
+ 5
+ 6With this library, you can quickly and easily add the power of optimization to
+ 7your application. You need IBM ILOG CPLEX Optimization Studio to solve the models.
+ 8
+ 9This library is composed of 2 modules:
+10
+11* IBM&reg; Decision Optimization CPLEX Optimizer Modeling for Python - with namespace docplex.mp
+12* IBM&reg; Decision Optimization CP Optimizer Modeling for Python - with namespace docplex.cp
+13
+14Solving with CPLEX requires that IBM&reg; ILOG CPLEX Optimization Studio V12.10 or later
+15is installed on your machine.
+16
+17This library is numpy friendly.
+18
+19## Install the library
+20
+21```
+22   pip install docplex
+23```
+24
+25## Get the documentation and examples
+26
+27* [Latest documentation](http://ibmdecisionoptimization.github.io/docplex-doc/)
+28* Documentation archives:
+29   * [2.23.222](http://ibmdecisionoptimization.github.io/docplex-doc/2.23.222)
+30   * [2.22.213](http://ibmdecisionoptimization.github.io/docplex-doc/2.22.213)
+31   * [2.21.207](http://ibmdecisionoptimization.github.io/docplex-doc/2.21.207)
+32   * [2.20.204](http://ibmdecisionoptimization.github.io/docplex-doc/2.20.204)
+33   * [2.19.202](http://ibmdecisionoptimization.github.io/docplex-doc/2.19.202)
+34   * [2.18.200](http://ibmdecisionoptimization.github.io/docplex-doc/2.18.200)
+35   * [2.16.195](http://ibmdecisionoptimization.github.io/docplex-doc/2.16.195)
+36* [Examples](https://github.com/IBMDecisionOptimization/docplex-examples)
+37
+38## Get your IBM&reg; ILOG CPLEX Optimization Studio edition
+39
+40- You can get a free [Community Edition](https://www.ibm.com/account/reg/us-en/signup?formid=urx-20028)
+41 of CPLEX Optimization Studio, with limited solving capabilities in term of problem size.
+42
+43- Faculty members, research professionals at accredited institutions can get access to an unlimited version of CPLEX through the
+44 [IBM&reg; Academic Initiative](http://ibm.biz/cplex-free-for-students).
+45
+46## Dependencies
+47
+48These third-party dependencies are automatically installed with ``pip``
+49
+50- [futures](https://pypi.python.org/pypi/futures)
+51- [requests](https://pypi.python.org/pypi/requests)
+52- [six](https://pypi.python.org/pypi/six)
+53- [certifi](https://pypi.python.org/pypi/certifi)
+54
+55
+56
+57## License
+58
+59This library is delivered under the  Apache License Version 2.0, January 2004 (see LICENSE.txt).
 
    
-
    + +
    +
    \ No newline at end of file diff --git a/docs/cp/_modules/docplex/cp/blackbox.html b/docs/cp/_modules/docplex/cp/blackbox.html index c677e81..9540289 100644 --- a/docs/cp/_modules/docplex/cp/blackbox.html +++ b/docs/cp/_modules/docplex/cp/blackbox.html @@ -2,25 +2,23 @@ - + - - - docplex.cp.blackbox — DOcplex.CP: Constraint Programming Modeling for Python V2.25 documentation - - + + + docplex.cp.blackbox — DOcplex.CP: Constraint Programming Modeling for Python V2.29 documentation + + - - - - - - + + + + - + - +
    @@ -247,7 +230,7 @@

    Source code for docplex.cp.blackbox

     #-----------------------------------------------------------------------------
 
 
    [docs]class CpoBlackboxFunction(object):
-    """ This class represents the descriptor of a blackbox function.
+    """ This class represents the descriptor of a blackbox function.
 
     A blackbox function is defined by:
 
@@ -296,7 +279,7 @@ 
    Source code for docplex.cp.blackbox
     
     def __init__(self, impl=None, dimension=1, argtypes=None, name=None, parallel=False, bounds_parameter=None,
                  args_with_vars=False, cachesize=-1, globalcache=False):
-        """ **Constructor**
+        """ **Constructor**
 
         The list of function argument types is optional.
         If not given, it is automatically determined as the most common types of the expression arguments used
@@ -396,7 +379,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def set_name(self, nm):
-        """ Set the name of the blackbox function
+        """ Set the name of the blackbox function
 
         Args:
             nm: Name of the blackbox function
@@ -405,7 +388,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def get_name(self):
-        """ Get the name of the blackbox function
+        """ Get the name of the blackbox function
 
         Returns:
             Name of the blackbox function
@@ -414,7 +397,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def set_dimension(self, dim):
-        """ Set the dimension of this blackbox function, i.e. the number of values that it returns.
+        """ Set the dimension of this blackbox function, i.e. the number of values that it returns.
 
         Args:
             dim: Number of result values (size of the result list or array)
@@ -423,7 +406,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def get_dimension(self):
-        """ Get the dimension of this blackbox function
+        """ Get the dimension of this blackbox function
 
         Returns:
             Number of result values (size of the result list or array)
@@ -432,7 +415,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def set_implementation(self, impl):
-        """ Set the blackbox function implementation
+        """ Set the blackbox function implementation
 
         Args:
             impl:  Blackbox function implementation
@@ -441,7 +424,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def get_implementation(self):
-        """ Get the blackbox function implementation
+        """ Get the blackbox function implementation
 
         Returns:
             Blackbox function implementation
@@ -450,7 +433,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def has_implementation(self):
-        """ Get if the blackbox function has an implementation
+        """ Get if the blackbox function has an implementation
 
         Returns:
             True if the blackbox function has an implementation
@@ -459,7 +442,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def get_arg_types(self):
-        """ Get the list of argument types
+        """ Get the list of argument types
 
         Returns:
             List of argument types, objects of class :class:`~docplex.cp.catalog.CpoType`
@@ -468,7 +451,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def set_parallel_eval(self, par):
-        """ Set parallel evaluation enablement indicator.
+        """ Set parallel evaluation enablement indicator.
 
         Args:
             par:  Parallel evaluation indicator.
@@ -477,7 +460,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def is_parallel_eval(self):
-        """ Check if parallel evaluation is allowed.
+        """ Check if parallel evaluation is allowed.
 
         Returns:
             True if parallel evaluation is allowed, false oherwise
@@ -486,7 +469,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def set_cache_size(self, size):
-        """ Set the size of evaluation cache.
+        """ Set the size of evaluation cache.
 
         Args:
             size: Cache size, -1 for default, 0 for none.
@@ -495,7 +478,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def get_cache_size(self):
-        """ Get the size of the evaluation cache
+        """ Get the size of the evaluation cache
 
         Returns:
             Evaluation cache size, -1 for default, 0 for none.
@@ -504,7 +487,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def set_global_cache(self, glob):
-        """ Set the global cache indicator.
+        """ Set the global cache indicator.
 
         When set, there is a single evaluation cache for all the blackbox function call instances.
 
@@ -515,7 +498,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def is_global_cache(self):
-        """ Check if a global cache has been set.
+        """ Check if a global cache has been set.
 
         Returns:
             True if there is a global cache for this function.
@@ -524,7 +507,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def get_eval_count(self):
-        """ Get the number of times this blackbox function has been evaluated
+        """ Get the number of times this blackbox function has been evaluated
 
         Returns:
             number of times this blackbox function has been evaluated
@@ -533,13 +516,13 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def reset_eval_count(self):
-        """ Reset the number of times this blackbox function has been evaluated
+        """ Reset the number of times this blackbox function has been evaluated
         """
         self.eval_count = 0
    
 
 
 
    [docs]    def build_model_call(self, *args):
-        """ Build a model expression representing a call to this blackbox function.
+        """ Build a model expression representing a call to this blackbox function.
 
         Args:
             *args:  List of expressions that are arguments of the function
@@ -562,7 +545,7 @@ 
    Source code for docplex.cp.blackbox
     
 
     def __call__(self, *args):
-        """ Build a model expression representing a call to this blackbox function.
+        """ Build a model expression representing a call to this blackbox function.
 
         Args:
             *args:  List of expressions that are arguments of the function
@@ -574,7 +557,7 @@ 
    Source code for docplex.cp.blackbox
     
 
     def __str__(self):
-        """ Build a string representing this blackbox function.
+        """ Build a string representing this blackbox function.
 
         Returns:
             String representing this blackbox function.
@@ -585,7 +568,7 @@ 
    Source code for docplex.cp.blackbox
     
 
     def _eval_function(self, rbnds, *args):
-        """ Evaluate the function from the list of parameter values
+        """ Evaluate the function from the list of parameter values
 
         Args:
             rbnds: Known result bounds, None in unknown
@@ -633,7 +616,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]    def eval(self, *args):
-        """ Evaluate the function from the list of parameter values
+        """ Evaluate the function from the list of parameter values
 
         This function evaluates the blackbox function without providing bounds.
 
@@ -646,7 +629,7 @@ 
    Source code for docplex.cp.blackbox
     
 
     def _update_check_arg_types(self, argexprs):
-        """ Update function argument types from a list of argument expressions
+        """ Update function argument types from a list of argument expressions
 
         Args:
             argexprs:  List of expressions that are arguments of the function
@@ -679,7 +662,7 @@ 
    Source code for docplex.cp.blackbox
     
 
     def _update_dimension(self, anx):
-        """ Update blackbox dimension with an evaluation index
+        """ Update blackbox dimension with an evaluation index
 
         Args:
             anx:  Evaluation index
@@ -689,13 +672,13 @@ 
    Source code for docplex.cp.blackbox
     
 
 
    [docs]class CpoBlackboxFunctionCall(CpoFunctionCall):
-    """ This class represent all model expression nodes that call a blackbox function.
+    """ This class represent all model expression nodes that call a blackbox function.
     """
     __slots__ = ('blackbox',  # Blackbox function descriptor
                 )
 
     def __init__(self, bbf, oprnds):
-        """ **Constructor**
+        """ **Constructor**
         Args:
             bbf:    Blackbox function descriptor
             oprnds: List of operand expressions.
@@ -705,7 +688,7 @@ 
    Source code for docplex.cp.blackbox
             self.blackbox = bbf
 
     def _equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         This particular method just checks local attributes, but does not check recursively children if any.
         Recursion is implemented by method equals() that uses a self-managed stack to avoid too many
@@ -734,7 +717,7 @@ 
    Source code for docplex.cp.blackbox
     
 
 def _get_argument_type(a):
-    """ Get the blackbox argument type corresponding to a given argument type
+    """ Get the blackbox argument type corresponding to a given argument type
 
     Args:
         a: Argument value
@@ -752,9 +735,24 @@ 
    Source code for docplex.cp.blackbox
     
 
    
 
+            
    
           
    
         
    
       
    
+      
       
    
     
    
     
     
   
 
\ No newline at end of file
diff --git a/docs/cp/_modules/docplex/cp/config.html b/docs/cp/_modules/docplex/cp/config.html
index 3c4db34..1ab4802 100644
--- a/docs/cp/_modules/docplex/cp/config.html
+++ b/docs/cp/_modules/docplex/cp/config.html
@@ -2,25 +2,23 @@
 
 
 
-
+
   
-    
-    
-    docplex.cp.config — DOcplex.CP: Constraint Programming Modeling for Python V2.25 documentation
-    
-    
+    
+    
+    docplex.cp.config — DOcplex.CP: Constraint Programming Modeling for Python V2.29 documentation
+    
+    
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
     
     
-    
+    
     
   
     
-      
+    
      
 
     
    
       
    
@@ -65,7 +48,7 @@ 
    Source code for docplex.cp.config
     # (c) Copyright IBM Corp. 2015 - 2022
 # --------------------------------------------------------------------------
 
-"""
+r"""
 Configuration of the CP Optimizer Python API
 
 This module is the top-level handler of the configuration parameters for
@@ -558,7 +541,7 @@ 
    Source code for docplex.cp.config
     #=============================================================================
 
 
    [docs]def get_default():
-    """ Get the default context
+    """ Get the default context
 
     Default context is also accessible with the global variable 'context' in this module.
 
@@ -569,7 +552,7 @@ 
    Source code for docplex.cp.config
     
 
 
    [docs]def set_default(ctx):
-    """ Set the default context.
+    """ Set the default context.
 
     Default context becomes accessible in the global variable 'context' in this module.
 
@@ -588,7 +571,7 @@ 
    Source code for docplex.cp.config
     #=============================================================================
 
 def _get_port_name():
-    """ Get the COS port name for the calling environment
+    """ Get the COS port name for the calling environment
 
     Returns:
         COS port name, None if not found
@@ -609,7 +592,7 @@ 
    Source code for docplex.cp.config
     
 
 def _build_search_path (ctx):
-    """ Build the path where search for executables
+    """ Build the path where search for executables
 
     Args:
         ctx:  Context to get information from
@@ -660,7 +643,7 @@ 
    Source code for docplex.cp.config
     
 
 def _search_exec_file(file, ctx):
-    """ Search the first occurrence of an executable.
+    """ Search the first occurrence of an executable.
 
     Args:
         file:  Executable file name
@@ -730,7 +713,7 @@ 
    Source code for docplex.cp.config
                 raise CpoException("CPO solver does not accept a parameter named '{}'".format(key))
 
 def _get_effective_context(**kwargs):
-    """ Build a effective context from a variable list of arguments that may specify changes to default.
+    """ Build a effective context from a variable list of arguments that may specify changes to default.
 
     Args:
         context (optional):   Source context, if not default.
@@ -790,7 +773,7 @@ 
    Source code for docplex.cp.config
     
 
 def _eval_file(file):
-    """ If found in python path, evaluate the content of a python module in this module.
+    """ If found in python path, evaluate the content of a python module in this module.
     Args:
         file: Python file to evaluate
     """
@@ -840,9 +823,24 @@ 
    Source code for docplex.cp.config
         ctx.write()
 
    
 
+            
    
           
    
         
    
       
    
+      
       
    
     
    
     
     
   
 
\ No newline at end of file
diff --git a/docs/cp/_modules/docplex/cp/expression.html b/docs/cp/_modules/docplex/cp/expression.html
index 5382a3e..dd0b0a4 100644
--- a/docs/cp/_modules/docplex/cp/expression.html
+++ b/docs/cp/_modules/docplex/cp/expression.html
@@ -2,25 +2,23 @@
 
 
 
-
+
   
-    
-    
-    docplex.cp.expression — DOcplex.CP: Constraint Programming Modeling for Python V2.25 documentation
-    
-    
+    
+    
+    docplex.cp.expression — DOcplex.CP: Constraint Programming Modeling for Python V2.29 documentation
+    
+    
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
     
     
-    
+    
     
   
     
-      
+    
      
 
     
    
       
    
@@ -136,13 +119,13 @@ 
    Source code for docplex.cp.expression
     #==============================================================================
 
 
    [docs]class IntegerDomain(tuple):
-    """ Class representing the domain of an integer variable.
+    """ Class representing the domain of an integer variable.
     """
 
     # Do not implement constructor, not supported in Python 3 (not investigated)
 
     def __str__(self):
-        """ Build a string representing this domain, using mathematical convention """
+        """ Build a string representing this domain, using mathematical convention """
         # Check fixed domain
         if (len(self) == 1) and not isinstance(self[0], (tuple, list)):
             return str(self[0])
@@ -164,7 +147,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoExpr(object):
-    """ This class is the super class of all classes representing a CPO expression.
+    """ This class is the super class of all classes representing a CPO expression.
     """
     __slots__ = ('type',             # Expression result type
                  'name',             # Name of the expression (None if none)
@@ -175,7 +158,7 @@ 
    Source code for docplex.cp.expression
         __array_priority__ = 100
 
     def __init__(self, type, name):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             type:   Expression type, object of class CpoType.
@@ -187,12 +170,12 @@ 
    Source code for docplex.cp.expression
     
 
     def __hash__(self):
-        """ Redefinition of hash function (mandatory for Python 3)
+        """ Redefinition of hash function (mandatory for Python 3)
         """
         return int(id(self) / 16)
 
 
-    '''
+    '''
     # These functions are required with standard 'pickle'
     # But DO NOT activate them with cloudpickle
     def __getstate__(self):
@@ -209,7 +192,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def set_name(self, name):
-        """ Set the name of the expression.
+        """ Set the name of the expression.
 
         This method returns this expression. It enables fluent calls such as: mdl.add((a + b == 1).set_name("myname"))
 
@@ -226,7 +209,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def get_name(self):
-        """ Get the name of the expression.
+        """ Get the name of the expression.
 
         Returns:
             Name of the expression, None if not defined
@@ -235,7 +218,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def get_priority(self):
-        """ Get the expression operation priority.
+        """ Get the expression operation priority.
 
         This method is extended by functions requiring a different priority.
 
@@ -246,7 +229,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def has_name(self):
-        """ Check if this expression has a name
+        """ Check if this expression has a name
 
         Returns:
             True if this expression has a name, False otherwise.
@@ -255,7 +238,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def get_type(self):
-        """ Get the type of this expression.
+        """ Get the type of this expression.
 
         Returns:
             Expression type
@@ -264,7 +247,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def is_type(self, xtyp):
-        """ Check if the type of this expression is a given one
+        """ Check if the type of this expression is a given one
 
         Args:
             xtyp:  Expected type
@@ -275,7 +258,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def is_kind_of(self, tp):
-        """ Checks if the type of this expression type is compatible with another type.
+        """ Checks if the type of this expression type is compatible with another type.
 
         Args:
             tp: Other type to check.
@@ -287,7 +270,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def is_variable(self):
-        """ Check if this expression is a variable
+        """ Check if this expression is a variable
 
         Returns:
             True if this expression is a variable
@@ -296,7 +279,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def get_max_depth(self):
-        """ Gets the maximum expression depth.
+        """ Gets the maximum expression depth.
 
         Returns:
             Max expression depth.
@@ -321,7 +304,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def get_node_count(self):
-        """ Gets the total expression node count.
+        """ Gets the total expression node count.
 
         Node count is the total number of function calls and atoms in this expression.
         If a sub-expression is present multiple times, it is counted only once.
@@ -333,7 +316,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def pretty_print(self, out=None, mxdepth=None, mxargs=None, adsize=False, indent="", curdepth=0):
-        """ Pretty print expression in a way that shows its structure.
+        """ Pretty print expression in a way that shows its structure.
 
         Args:
             out:      (optional) Print output (stream or file name, None for stdout)
@@ -347,7 +330,7 @@ 
    Source code for docplex.cp.expression
     
 
     def __nonzero__(self):
-        """ Safe function to protect for use of CpoExpr as boolean.
+        """ Safe function to protect for use of CpoExpr as boolean.
 
         This may occur when using comparison operators that create a CpoExpr instead of actually compare with
         another expression.
@@ -359,7 +342,7 @@ 
    Source code for docplex.cp.expression
     
 
     def __bool__(self):
-        """ Safe function to protect for use of CpoExpr as boolean.
+        """ Safe function to protect for use of CpoExpr as boolean.
 
         This may occur when using comparison operators that create a CpoExpr instead of actually compare with
         another expression.
@@ -373,7 +356,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         Implementation is required with a different name than __eq__ name because this function is already
         overloaded to construct model expression with operator '=='.
@@ -387,7 +370,7 @@ 
    Source code for docplex.cp.expression
     
 
     def _equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         This particular method just checks local attributes, but does not check recursively children if any.
         Recursion is implemented by method equals() that uses a self-managed stack to avoid too many
@@ -402,7 +385,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]    def compare(self, other):
-        """ Compare this expression with another.
+        """ Compare this expression with another.
 
         Args:
             other: Other CpoExpr to compare with.
@@ -425,7 +408,7 @@ 
    Source code for docplex.cp.expression
     
 
     def __str__(self):
-        """ Convert this expression into a string """
+        """ Convert this expression into a string """
         if is_string(self.name):
             return to_printable_id(self.name) + " = " + _to_string(self)
         else:
@@ -434,25 +417,25 @@ 
    Source code for docplex.cp.expression
         # Operators overloading
 
     def __ne__(self, other):
-        """ Not equal """
+        """ Not equal """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_FloatExpr) and other.is_kind_of(Type_FloatExpr), "Operands of != should be integer or float expressions"
         return CpoFunctionCall(Oper_diff, Type_BoolExpr, (self, other))
 
     def __eq__(self, other):
-        """ Equal """
+        """ Equal """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_FloatExpr) and other.is_kind_of(Type_FloatExpr), "Operands of == should be integer or float expressions"
         return CpoFunctionCall(Oper_equal, Type_BoolExpr, (self, other))
 
     def __gt__(self, other):
-        """ Greater """
+        """ Greater """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_FloatExpr) and other.is_kind_of(Type_FloatExpr), "Operands of > should be integer or float expressions"
         return CpoFunctionCall(Oper_greater, Type_BoolExpr, (self, other))
 
     def __ge__(self, other):
-        """ Greater or equal """
+        """ Greater or equal """
         other = build_cpo_expr(other)
         if self.is_kind_of(Type_IntExpr):
             if other.is_kind_of(Type_FloatExpr):
@@ -466,13 +449,13 @@ 
    Source code for docplex.cp.expression
             return CpoFunctionCall(Oper_greater_or_equal, Type_Constraint, (self, other))
 
     def __lt__(self, other):
-        """ Less """
+        """ Less """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_FloatExpr) and other.is_kind_of(Type_FloatExpr), "Operands of < should be integer or float expressions"
         return CpoFunctionCall(Oper_less, Type_BoolExpr, (self, other))
 
     def __le__(self, other):
-        """ Less or equal """
+        """ Less or equal """
         other = build_cpo_expr(other)
         if self.is_kind_of(Type_IntExpr):
             if other.is_kind_of(Type_FloatExpr):
@@ -486,7 +469,7 @@ 
    Source code for docplex.cp.expression
             return CpoFunctionCall(Oper_less_or_equal, Type_Constraint, (self, other))
 
     def __add__(self, other):
-        """ Plus """
+        """ Plus """
         other = build_cpo_expr(other)
         # Check integer expression
         if self.is_kind_of(Type_IntExpr):
@@ -512,15 +495,15 @@ 
    Source code for docplex.cp.expression
             raise AssertionError("Operands of + should be integer, float or cumul expressions")
 
     def __radd__(self, other):
-        """ Plus (right) """
+        """ Plus (right) """
         return build_cpo_expr(other).__add__(self)
 
     def __pos__(self):
-        """ Unary plus """
+        """ Unary plus """
         return self
 
     def __sub__(self, other):
-        """ Minus """
+        """ Minus """
         other = build_cpo_expr(other)
         if self.is_kind_of(Type_IntExpr):
             if other.is_kind_of(Type_IntExpr):
@@ -535,11 +518,11 @@ 
    Source code for docplex.cp.expression
             return CpoFunctionCall(Oper_minus, Type_CumulExpr, (self, other))
 
     def __rsub__(self, other):
-        """ Minus (right) """
+        """ Minus (right) """
         return build_cpo_expr(other).__sub__(self)
 
     def __neg__(self):
-        """ Unary minus """
+        """ Unary minus """
         if self.is_kind_of(Type_IntExpr):
             return CpoFunctionCall(Oper_minus, Type_IntExpr, (self,))
         if self.is_kind_of(Type_FloatExpr):
@@ -548,7 +531,7 @@ 
    Source code for docplex.cp.expression
             return CpoFunctionCall(Oper_minus, Type_CumulExpr, (self,))
 
     def __mul__(self, other):
-        """ Multiply """
+        """ Multiply """
         other = build_cpo_expr(other)
         if self.is_kind_of(Type_IntExpr):
             if other.is_kind_of(Type_IntExpr):
@@ -559,61 +542,61 @@ 
    Source code for docplex.cp.expression
             return CpoFunctionCall(Oper_times, Type_FloatExpr, (self, other))
 
     def __rmul__(self, other):
-        """ Multiply (right) """
+        """ Multiply (right) """
         return build_cpo_expr(other).__mul__(self)
 
     def __div__(self, other):
-        """ Float divide """
+        """ Float divide """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_FloatExpr) and other.is_kind_of(Type_FloatExpr), "Operands of / should be float or integer expressions"
         return CpoFunctionCall(Oper_float_div, Type_FloatExpr, (self, other))
 
     def __rdiv__(self, other):
-        """ Float divide (right) """
+        """ Float divide (right) """
         return build_cpo_expr(other).__div__(self)
 
     def __truediv__(self, other):
-        """ Float divide (Python 3) """
+        """ Float divide (Python 3) """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_FloatExpr) and other.is_kind_of(Type_FloatExpr), "Operands of / should be float or integer expressions"
         return CpoFunctionCall(Oper_float_div, Type_FloatExpr, (self, other))
 
     def __rtruediv__(self, other):
-        """ Float divide (right) (Python 3) """
+        """ Float divide (right) (Python 3) """
         return build_cpo_expr(other).__truediv__(self)
 
     def __floordiv__(self, other):
-        """ Integer divide (Python 3) """
+        """ Integer divide (Python 3) """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_IntExpr) and other.is_kind_of(Type_IntExpr), "Operands of // should be integer expressions"
         return CpoFunctionCall(Oper_int_div, Type_IntExpr, (self, other))
 
     def __rfloordiv__(self, other):
-        """ Integer divide (right) (Python 3) """
+        """ Integer divide (right) (Python 3) """
         return build_cpo_expr(other).__floordiv__(self)
 
     def __mod__(self, other):
-        """ Modulo """
+        """ Modulo """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_IntExpr) and other.is_kind_of(Type_IntExpr), "Operands of % should be integer expressions"
         return CpoFunctionCall(Oper_mod, Type_IntExpr, (self, other))
 
     def __rmod__(self, other):
-        """ Power (right) """
+        """ Power (right) """
         return build_cpo_expr(other).__mod__(self)
 
     def __pow__(self, other):
-        """ Power """
+        """ Power """
         other = build_cpo_expr(other)
         assert self.is_kind_of(Type_FloatExpr) and other.is_kind_of(Type_FloatExpr), "Operands of ** (power) should be float expressions"
         return CpoFunctionCall(Oper_power, Type_FloatExpr, (self, other))
 
     def __rpow__(self, other):
-        """ Power (right) """
+        """ Power (right) """
         return build_cpo_expr(other).__pow__(self)
 
     def __and__(self, other):
-        """ Binary and used to represent logical and """
+        """ Binary and used to represent logical and """
         # if other is True:  # Do not use == because it is overloaded
         #     return self
         # if other is False:  # Do not use == because it is overloaded
@@ -623,11 +606,11 @@ 
    Source code for docplex.cp.expression
             return CpoFunctionCall(Oper_logical_and, Type_BoolExpr, (self, other))
 
     def __rand__(self, other):
-        """ Binary and used to represent logical and (right) """
+        """ Binary and used to represent logical and (right) """
         return build_cpo_expr(other).__and__(self)
 
     def __or__(self, other):
-        """ Binary or used to represent logical or """
+        """ Binary or used to represent logical or """
         # if other is False:  # Do not use == because it is overloaded
         #     return self
         # if other is True:  # Do not use == because it is overloaded
@@ -637,23 +620,23 @@ 
    Source code for docplex.cp.expression
             return CpoFunctionCall(Oper_logical_or, Type_BoolExpr, (self, other))
 
     def __ror__(self, other):
-        """ Binary or used to represent logical or (right) """
+        """ Binary or used to represent logical or (right) """
         return build_cpo_expr(other).__or__(self)
 
     def __invert__(self):
-        """ Binary not used to represent logical not (right) """
+        """ Binary not used to represent logical not (right) """
         assert self.is_kind_of(Type_BoolExpr), "Operands of ~ (logical not) should be a boolean expression"
         return CpoFunctionCall(Oper_logical_not, Type_BoolExpr, (self,))
    
 
 
 
 
    [docs]class CpoValue(CpoExpr):
-    """ CPO model expression representing a constant value. """
+    """ CPO model expression representing a constant value. """
     __slots__ = ('value',  # Python value of the constant
                 )
 
     def __init__(self, value, type):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             value:  Constant value.
@@ -666,7 +649,7 @@ 
    Source code for docplex.cp.expression
             self.value = value
 
     def _equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         This particular method just checks local attributes, but does not check recursively children if any.
         Recursion is implemented by method equals() that uses a self-managed stack to avoid too many
@@ -688,12 +671,12 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoAlias(CpoExpr):
-    """ CPO model expression representing a symbolic alias on an expression. """
+    """ CPO model expression representing a symbolic alias on an expression. """
     __slots__ = ('expr',  # Target expression
                 )
 
     def __init__(self, expr, name):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             expr:  Target expression
@@ -707,7 +690,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoFunctionCall(CpoExpr):
-    """ This class represent all model expression nodes that call a predefined modeler function.
+    """ This class represent all model expression nodes that call a predefined modeler function.
 
     All modeling functions are available in module :mod:`docplex.cp.modeler`.
     """
@@ -715,7 +698,7 @@ 
    Source code for docplex.cp.expression
                     )
 
     def __init__(self, oper, rtype, oprnds):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             oper:   Operation descriptor
@@ -732,7 +715,7 @@ 
    Source code for docplex.cp.expression
             self.children = oprnds
 
 
    [docs]    def get_priority(self):
-        """ Get the operation priority.
+        """ Get the operation priority.
 
         Returns:
             Operation priority
@@ -740,7 +723,7 @@ 
    Source code for docplex.cp.expression
             return self.operation.priority
    
 
     def _equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         This particular method just checks local attributes, but does not check recursively children if any.
         Recursion is implemented by method equals() that uses a self-managed stack to avoid too many
@@ -755,12 +738,12 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoVariable(CpoExpr):
-    """ This class is an abstract class extended by all expression nodes that represent a CPO variable.
+    """ This class is an abstract class extended by all expression nodes that represent a CPO variable.
     """
     __slots__ = ()
 
     def __init__(self, type, name):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             type:   Expression type.
@@ -769,7 +752,7 @@ 
    Source code for docplex.cp.expression
             super(CpoVariable, self).__init__(type, name)
 
 
    [docs]    def is_variable(self):
-        """ Check if this expression is a variable
+        """ Check if this expression is a variable
 
         Returns:
             True if this expression is a variable
@@ -778,7 +761,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoIntVar(CpoVariable):
-    """ This class represents an *integer variable* that can be used in a CPO model.
+    """ This class represents an *integer variable* that can be used in a CPO model.
 
     This object should not be created explicitly, but using one of the following factory method:
 
@@ -795,7 +778,7 @@ 
    Source code for docplex.cp.expression
             self.domain = dom
 
 
    [docs]    def set_domain(self, domain):
-        """ Sets the domain of the variable.
+        """ Sets the domain of the variable.
 
         The domain of the variable is a list or tuple of:
 
@@ -813,7 +796,7 @@ 
    Source code for docplex.cp.expression
             self.domain = _build_int_var_domain(None, None, domain)
    
 
 
    [docs]    def get_domain(self):
-        """ Gets the domain of the variable.
+        """ Gets the domain of the variable.
 
         The domain of the variable can be:
 
@@ -829,7 +812,7 @@ 
    Source code for docplex.cp.expression
             return self.domain
    
 
 
    [docs]    def get_domain_min(self):
-        """ Gets the domain lower bound.
+        """ Gets the domain lower bound.
 
         Returns:
             Domain lower bound.
@@ -837,7 +820,7 @@ 
    Source code for docplex.cp.expression
             return get_domain_min(self.domain)
    
 
 
    [docs]    def get_domain_max(self):
-        """ Gets the domain upper bound.
+        """ Gets the domain upper bound.
 
         Returns:
             Domain upper bound.
@@ -845,7 +828,7 @@ 
    Source code for docplex.cp.expression
             return get_domain_max(self.domain)
    
 
 
    [docs]    def domain_iterator(self):
-        """ Iterator on the individual values of an integer variable domain.
+        """ Iterator on the individual values of an integer variable domain.
 
         Returns:
             Value iterator on the domain of this variable.
@@ -853,7 +836,7 @@ 
    Source code for docplex.cp.expression
             return _domain_iterator(self.domain)
    
 
 
    [docs]    def domain_contains(self, value):
-        """ Check whether a given value is in the domain of the variable
+        """ Check whether a given value is in the domain of the variable
 
         Args:
             val: Value to check
@@ -864,18 +847,18 @@ 
    Source code for docplex.cp.expression
     
     @property
     def lb(self):
-        """ This property is used to get lower bound of the variable domain.
+        """ This property is used to get lower bound of the variable domain.
         """
         return self.get_domain_min()
 
     @property
     def ub(self):
-        """ This property is used to get upper bound of the variable domain.
+        """ This property is used to get upper bound of the variable domain.
         """
         return self.get_domain_max()
 
 
    [docs]    def is_bool_var(self):
-        """ Check if the domain of this variable is reduced to boolean, 0, 1
+        """ Check if the domain of this variable is reduced to boolean, 0, 1
 
         Returns:
             True if this variable is a boolean variable
@@ -883,7 +866,7 @@ 
    Source code for docplex.cp.expression
             return self.domain == (0, 1) or self.domain == ((0, 1),)
    
 
 
    [docs]    def is_binary(self):
-        """ Check if the domain of this variable is reduced to boolean, 0, 1
+        """ Check if the domain of this variable is reduced to boolean, 0, 1
 
         Returns:
             True if this variable is a boolean variable
@@ -891,7 +874,7 @@ 
    Source code for docplex.cp.expression
             return self.domain == (0, 1) or self.domain == ((0, 1),)
    
 
 
    [docs]    def equals(self, other):
-        """ Checks if this expression is equivalent to another
+        """ Checks if this expression is equivalent to another
 
         Args:
             other: Other object to compare with.
@@ -919,7 +902,7 @@ 
    Source code for docplex.cp.expression
             self.type = Type_BoolVar
 
 
    [docs]    def is_bool_var(self):
-        """ Check if the domain of this variable is reduced to boolean, 0, 1
+        """ Check if the domain of this variable is reduced to boolean, 0, 1
 
         Returns:
             True if this variable is a boolean variable
@@ -927,7 +910,7 @@ 
    Source code for docplex.cp.expression
             return True
    
 
 
    [docs]    def is_binary(self):
-        """ Check if the domain of this variable is reduced to boolean, 0, 1
+        """ Check if the domain of this variable is reduced to boolean, 0, 1
 
         Returns:
             True if this variable is a boolean variable
@@ -1016,7 +999,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoIntervalVar(CpoVariable):
-    """ This class represents an *interval variable* that can be used in a CPO model.
+    """ This class represents an *interval variable* that can be used in a CPO model.
 
     This object should not be created explicitly, but using one of the following factory method
     :meth:`interval_var`, :meth:`interval_var_list`, or :meth:`interval_var_dict`.
@@ -1044,7 +1027,7 @@ 
    Source code for docplex.cp.expression
                 self.children = (intensity,)
 
 
    [docs]    def set_start(self, intv):
-        """ Sets the start interval.
+        """ Sets the start interval.
 
         Args:
             intv: Start of the interval (single integer or interval expressed as a tuple of 2 integers).
@@ -1052,7 +1035,7 @@ 
    Source code for docplex.cp.expression
             self.start = _check_arg_interval(intv, "intv")
    
 
 
    [docs]    def get_start(self):
-        """ Gets the start of the interval.
+        """ Gets the start of the interval.
 
         Returns:
             Start of the interval (interval expressed as a tuple of 2 integers).
@@ -1060,7 +1043,7 @@ 
    Source code for docplex.cp.expression
             return self.start
    
 
 
    [docs]    def set_start_min(self, mn):
-        """ Sets the minimum value of the start interval.
+        """ Sets the minimum value of the start interval.
 
         Args:
             mn: Min value of the start of the interval.
@@ -1070,7 +1053,7 @@ 
    Source code for docplex.cp.expression
             self.start = (mn, self.start[1])
    
 
 
    [docs]    def set_start_max(self, mx):
-        """ Sets the maximum value of the start interval.
+        """ Sets the maximum value of the start interval.
 
         Args:
             mx: Max value of the start of the interval.
@@ -1080,7 +1063,7 @@ 
    Source code for docplex.cp.expression
             self.start = (self.start[0], mx)
    
 
 
    [docs]    def set_end(self, intv):
-        """ Sets the end of the interval.
+        """ Sets the end of the interval.
 
         Args:
             intv: End of the interval (single integer or interval expressed as a tuple of 2 integers).
@@ -1088,7 +1071,7 @@ 
    Source code for docplex.cp.expression
             self.end = _check_arg_interval(intv, "intv")
    
 
 
    [docs]    def get_end(self):
-        """ Gets the end of the interval.
+        """ Gets the end of the interval.
 
         Returns:
             End of the interval (interval expressed as a tuple of 2 integers)
@@ -1096,7 +1079,7 @@ 
    Source code for docplex.cp.expression
             return self.end
    
 
 
    [docs]    def set_end_min(self, mn):
-        """ Sets the minimum value of the end interval.
+        """ Sets the minimum value of the end interval.
 
         Args:
             mn: Min value of the end of the interval.
@@ -1106,7 +1089,7 @@ 
    Source code for docplex.cp.expression
             self.end = (mn, self.end[1])
    
 
 
    [docs]    def set_end_max(self, mx):
-        """ Sets the maximum value of the end of the interval.
+        """ Sets the maximum value of the end of the interval.
 
         Args:
             mx: Max value of the end of the interval.
@@ -1116,7 +1099,7 @@ 
    Source code for docplex.cp.expression
             self.end = (self.end[0], mx)
    
 
 
    [docs]    def set_length(self, intv):
-        """ Sets the length interval.
+        """ Sets the length interval.
 
         Args:
             intv: Length of the interval (single integer or interval expressed as a tuple of 2 integers).
@@ -1124,7 +1107,7 @@ 
    Source code for docplex.cp.expression
             self.length = _check_arg_interval(intv, "intv")
    
 
 
    [docs]    def get_length(self):
-        """ Gets the length interval.
+        """ Gets the length interval.
 
         Returns:
             Length of the interval (interval expressed as a tuple of 2 integers).
@@ -1132,7 +1115,7 @@ 
    Source code for docplex.cp.expression
             return self.length
    
 
 
    [docs]    def set_length_min(self, mn):
-        """ Sets the minimum value of the length interval.
+        """ Sets the minimum value of the length interval.
 
         Args:
             mn: Min value of the length of the interval min value.
@@ -1142,7 +1125,7 @@ 
    Source code for docplex.cp.expression
             self.length = (mn, self.length[1])
    
 
 
    [docs]    def set_length_max(self, mx):
-        """ Sets the maximum value of the length interval.
+        """ Sets the maximum value of the length interval.
 
         Args:
             mx: Max value of the length of the interval.
@@ -1152,7 +1135,7 @@ 
    Source code for docplex.cp.expression
             self.length = (self.length[0], mx)
    
 
 
    [docs]    def set_size(self, intv):
-        """ Sets the size of the interval.
+        """ Sets the size of the interval.
 
         Args:
             intv: Size of the interval (single integer or interval expressed as a tuple of 2 integers).
@@ -1160,7 +1143,7 @@ 
    Source code for docplex.cp.expression
             self.size = _check_arg_interval(intv, "intv")
    
 
 
    [docs]    def get_size(self):
-        """ Gets the size of the interval.
+        """ Gets the size of the interval.
 
         Returns:
             Size of the interval (interval expressed as a tuple of 2 integers).
@@ -1168,7 +1151,7 @@ 
    Source code for docplex.cp.expression
             return self.size
    
 
 
    [docs]    def set_size_min(self, mn):
-        """ Sets the minimum value of the size interval.
+        """ Sets the minimum value of the size interval.
 
         Args:
             mn: Min value of the size of the interval.
@@ -1178,7 +1161,7 @@ 
    Source code for docplex.cp.expression
             self.size = (mn, self.size[1])
    
 
 
    [docs]    def set_size_max(self, mx):
-        """ Sets the maximum value of the size interval.
+        """ Sets the maximum value of the size interval.
 
         Args:
             mx: Max value of the size of the interval.
@@ -1188,11 +1171,11 @@ 
    Source code for docplex.cp.expression
             self.size = (self.size[0], mx)
    
 
 
    [docs]    def set_present(self):
-        """ Specifies that this IntervalVar must be present. """
+        """ Specifies that this IntervalVar must be present. """
         self.presence = _PRES_PRESENT
    
 
 
    [docs]    def is_present(self):
-        """ Check if this interval variable must be present.
+        """ Check if this interval variable must be present.
 
         Returns:
             True if this interval variable must be present, False otherwise.
@@ -1200,11 +1183,11 @@ 
    Source code for docplex.cp.expression
             return self.presence == _PRES_PRESENT
    
 
 
    [docs]    def set_absent(self):
-        """ Specifies that this interval variable must be absent. """
+        """ Specifies that this interval variable must be absent. """
         self.presence = _PRES_ABSENT
    
 
 
    [docs]    def is_absent(self):
-        """ Check if this interval variable must be absent.
+        """ Check if this interval variable must be absent.
 
         Returns:
             True if this interval variable must be absent, False otherwise.
@@ -1212,11 +1195,11 @@ 
    Source code for docplex.cp.expression
             return self.presence == _PRES_ABSENT
    
 
 
    [docs]    def set_optional(self):
-        """ Specifies that this interval variable is optional. """
+        """ Specifies that this interval variable is optional. """
         self.presence = _PRES_OPTIONAL
    
 
 
    [docs]    def is_optional(self):
-        """ Check if this interval variable is optional.
+        """ Check if this interval variable is optional.
 
         Returns:
             True if this interval variable is optional, False otherwise.
@@ -1224,7 +1207,7 @@ 
    Source code for docplex.cp.expression
             return self.presence == _PRES_OPTIONAL
    
 
 
    [docs]    def set_intensity(self, intensity):
-        """ Sets the intensity function of this interval var.
+        """ Sets the intensity function of this interval var.
 
         Args:
            intensity:  Intensity function (None, or StepFunction).
@@ -1237,7 +1220,7 @@ 
    Source code for docplex.cp.expression
                 self.children = (intensity,)
    
 
 
    [docs]    def get_intensity(self):
-        """ Gets the intensity function of this interval var.
+        """ Gets the intensity function of this interval var.
 
         Returns:
            Intensity function (None, or StepFunction).
@@ -1245,7 +1228,7 @@ 
    Source code for docplex.cp.expression
             return self.intensity
    
 
 
    [docs]    def set_granularity(self, granularity):
-        """ Sets the scale of the intensity function.
+        """ Sets the scale of the intensity function.
 
         Args:
             granularity: Scale of the intensity function (integer).
@@ -1254,7 +1237,7 @@ 
    Source code for docplex.cp.expression
             self.granularity = granularity
    
 
 
    [docs]    def get_granularity(self):
-        """ Get the scale of the intensity function.
+        """ Get the scale of the intensity function.
 
         Returns:
             Scale of the intensity function, None for default (100)
@@ -1262,7 +1245,7 @@ 
    Source code for docplex.cp.expression
             return self.granularity
    
 
     def _equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         This particular method just checks local attributes, but does not check recursively children if any.
         Recursion is implemented by method equals() that uses a self-managed stack to avoid too many
@@ -1287,13 +1270,13 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoSequenceVar(CpoVariable):
-    """ This class represents an *sequence variable* that can be used in a CPO model.
+    """ This class represents an *sequence variable* that can be used in a CPO model.
     """
     __slots__ = ('types',  # Variable types
                 )
 
     def __init__(self, vars, types=None, name=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Creates an instance of sequence variable on the set of interval variables defined by the array 'vars'.
         A list of non-negative integer types can be optionally specified.
@@ -1324,7 +1307,7 @@ 
    Source code for docplex.cp.expression
             self.types = types
 
 
    [docs]    def get_interval_variables(self):
-        """ Gets the array of variables.
+        """ Gets the array of variables.
 
         Returns:
             Array of interval variables that are in the sequence.
@@ -1332,7 +1315,7 @@ 
    Source code for docplex.cp.expression
             return self.children
    
 
 
    [docs]    def get_vars(self):
-        """ Gets the array of variables in this sequence variable.
+        """ Gets the array of variables in this sequence variable.
 
         Returns:
             Array of interval variables
@@ -1340,7 +1323,7 @@ 
    Source code for docplex.cp.expression
             return self.children
    
 
 
    [docs]    def get_types(self):
-        """ Gets the array of types.
+        """ Gets the array of types.
 
         Returns:
             Array of variable types (array of integers), None if no type defined.
@@ -1348,7 +1331,7 @@ 
    Source code for docplex.cp.expression
             return self.types
    
 
     def _equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         This particular method just checks local attributes, but does not check recursively children if any.
         Recursion is implemented by method equals() that uses a self-managed stack to avoid too many
@@ -1369,12 +1352,12 @@ 
    Source code for docplex.cp.expression
             return True
 
     def __len__(self):
-        """ Get the length of the sequence variable (number of variables) """
+        """ Get the length of the sequence variable (number of variables) """
         return len(self.children)
    
 
 
 
    [docs]class CpoTransitionMatrix(CpoValue):
-    """ This class represents a *transition matrix* that is used in CPO model to
+    """ This class represents a *transition matrix* that is used in CPO model to
     represent transition distances.
 
     A transition matrix is a square matrix of non-negative integers that represents a minimal distance between
@@ -1402,7 +1385,7 @@ 
    Source code for docplex.cp.expression
         __slots__ = ()  # Matrix stored in value field
 
     def __init__(self, size=None, values=None, name=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             size (optional):   Matrix size (width and height),
@@ -1433,7 +1416,7 @@ 
    Source code for docplex.cp.expression
                     "All matrix values should be positive integers"
 
 
    [docs]    def get_size(self):
-        """ Returns the size of the matrix.
+        """ Returns the size of the matrix.
 
         Returns:
             Matrix size.
@@ -1441,7 +1424,7 @@ 
    Source code for docplex.cp.expression
             return len(self.value)
    
 
 
    [docs]    def get_value(self, from_state, to_state):
-        """ Returns a value in the transition matrix.
+        """ Returns a value in the transition matrix.
 
         Args:
             from_state: Index of the from state.
@@ -1452,7 +1435,7 @@ 
    Source code for docplex.cp.expression
             return self.value[from_state][to_state]
    
 
 
    [docs]    def get_all_values(self):
-        """ Returns an iterator on all matrix values, in row/column order
+        """ Returns an iterator on all matrix values, in row/column order
 
         Returns:
             Iterator on all values
@@ -1461,7 +1444,7 @@ 
    Source code for docplex.cp.expression
             return (self.value[f][t] for f in sizerg for t in sizerg)
    
 
 
    [docs]    def get_matrix(self):
-        """ Returns the complete transition matrix.
+        """ Returns the complete transition matrix.
 
         Returns:
             Transition matrix as a list of integers that is the concatenation of all matrix rows.
@@ -1469,7 +1452,7 @@ 
    Source code for docplex.cp.expression
             return self.value
    
 
 
    [docs]    def set_value(self, from_state, to_state, value):
-        """ Sets a value in the transition matrix.
+        """ Sets a value in the transition matrix.
 
         Args:
             from_state: Index of the from state.
@@ -1481,7 +1464,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]class CpoStateFunction(CpoVariable):
-    """ This class represents a *state function* expression node.
+    """ This class represents a *state function* expression node.
 
     State functions are used by *interval variables* to represent the evolution of a state variable over time.
     """
@@ -1489,7 +1472,7 @@ 
    Source code for docplex.cp.expression
                     )
 
     def __init__(self, trmtx=None, name=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             trmtx (optional): An optional transition matrix defining the transition distance between consecutive states
@@ -1503,7 +1486,7 @@ 
    Source code for docplex.cp.expression
             self.set_transition_matrix(trmtx)
 
 
    [docs]    def set_transition_matrix(self, trmtx):
-        """ Sets the transition matrix.
+        """ Sets the transition matrix.
 
         Args:
         trmtx : A transition matrix defining the transition distance between consecutive states of the state function.
@@ -1521,7 +1504,7 @@ 
    Source code for docplex.cp.expression
                 self.children = (trmtx,)
    
 
 
    [docs]    def get_transition_matrix(self):
-        """ Returns the transition matrix.
+        """ Returns the transition matrix.
 
         Returns:
             Transition matrix, None if none.
@@ -1529,7 +1512,7 @@ 
    Source code for docplex.cp.expression
             return self.trmtx
    
 
     def _equals(self, other):
-        """ Checks the equality of this expression with another object.
+        """ Checks the equality of this expression with another object.
 
         This particular method just checks local attributes, but does not check recursively children if any.
         Recursion is implemented by method equals() that uses a self-managed stack to avoid too many
@@ -1550,7 +1533,7 @@ 
    Source code for docplex.cp.expression
     #==============================================================================
 
 
    [docs]def integer_var(min=None, max=None, name=None, domain=None):
-    """ Creates an integer variable.
+    """ Creates an integer variable.
 
     An integer variable is a decision variable with a set of potential values called 'domain of the variable'.
     This domain can be expressed either:
@@ -1585,7 +1568,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def integer_var_list(size, min=None, max=None, name=None, domain=None):
-    """ Creates a list of integer variables.
+    """ Creates a list of integer variables.
 
     This methods creates a list of integer variables whose size is given as first parameter.
     All other parameters are identical to those requested by the method integer_var()
@@ -1618,7 +1601,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def integer_var_dict(keys, min=None, max=None, name=None, domain=None):
-    """ Creates a dictionary of integer variables.
+    """ Creates a dictionary of integer variables.
 
     This methods creates a dictionary of integer variables associated to a list of keys given as first parameter.
     All other parameters are identical to those requested by the method integer_var()
@@ -1657,7 +1640,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def binary_var(name=None):
-    """ Creates a binary integer variable.
+    """ Creates a binary integer variable.
 
     An binary variable is an integer variable with domain limited to 0 and 1
 
@@ -1670,7 +1653,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def binary_var_list(size, name=None):
-    """ Creates a list of binary variables.
+    """ Creates a list of binary variables.
 
     This methods creates a list of binary variables.
 
@@ -1687,7 +1670,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def binary_var_dict(keys, name=None):
-    """ Creates a dictionary of binary variables.
+    """ Creates a dictionary of binary variables.
 
     This methods creates a dictionary of binary variables associated to a list of keys given as first parameter.
 
@@ -1708,7 +1691,7 @@ 
    Source code for docplex.cp.expression
     
 
    [docs]def interval_var(start=None, end=None, length=None, size=None,
                  intensity=None, granularity=None, optional=False, name=None):
-    """ Creates an interval variable.
+    """ Creates an interval variable.
 
     An interval decision variable represents an unknown of a scheduling problem, in particular an interval of time
     during which something happens (an activity is carried out) whose position in time is unknown.
@@ -1759,7 +1742,7 @@ 
    Source code for docplex.cp.expression
     
 
    [docs]def interval_var_list(asize, start=None, end=None, length=None, size=None,
                  intensity=None, granularity=None, optional=False, name=None):
-    """ Creates a list of interval variables.
+    """ Creates a list of interval variables.
 
     If a name is given, each variable of the array is created with this
     name concatenated with the index of the variable in the list.
@@ -1801,7 +1784,7 @@ 
    Source code for docplex.cp.expression
     
 
    [docs]def interval_var_dict(keys, start=None, end=None, length=None, size=None,
                  intensity=None, granularity=None, optional=False, name=None):
-    """ Creates a list of interval variables.
+    """ Creates a list of interval variables.
 
     If a name is given, each variable of the array is created with this
     name concatenated with the index of the variable in the list.
@@ -1846,7 +1829,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def sequence_var(vars, types=None, name=None):
-    """ Creates a new sequence variable (list of interval variables).
+    """ Creates a new sequence variable (list of interval variables).
 
     This method creates an instance of sequence variable on the set of interval variables defined
     by the array 'vars'.
@@ -1955,7 +1938,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def transition_matrix(szvals, name=None):
-    """ Creates a new transition matrix (square matrix of integers).
+    """ Creates a new transition matrix (square matrix of integers).
 
     A transition matrix is a square matrix of non-negative integers that represents a minimal distance between
     two interval variables.
@@ -1996,7 +1979,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def tuple_set(tset, name=None):
-    """ Create a tuple set.
+    """ Create a tuple set.
 
     A tuple set is essentially a matrix of integers, but not necessarily square.
     Boolean expressions allowed_assignments() and forbidden_assignments() use a tuple set to express
@@ -2020,7 +2003,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def state_function(trmtx=None, name=None):
-    """ Create a new State Function
+    """ Create a new State Function
 
     Args:
         trmtx (optional): An optional transition matrix defining the transition distance between consecutive states
@@ -2039,7 +2022,7 @@ 
    Source code for docplex.cp.expression
     #-----------------------------------------------------------------------------
 
 
    [docs]def is_cpo_expr(expr, type=None):
-    """ Check if an expression is a CPO model expression
+    """ Check if an expression is a CPO model expression
 
     Args:
         expr:             Value to check
@@ -2051,7 +2034,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def get_node_count(expr):
-    """ Get the number of model expression nodes in an expression or list of expressions
+    """ Get the number of model expression nodes in an expression or list of expressions
 
     Args:
         expr:   Expression or list of expressions
@@ -2082,7 +2065,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def pretty_print(expr, out=None, mxdepth=None, mxargs=None, adsize=False, indent="", curdepth=0):
-    """ Pretty print expression in a way that shows its structure.
+    """ Pretty print expression in a way that shows its structure.
 
     Args:
         expr:     Expression to print
@@ -2143,7 +2126,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def get_domain_min(d):
-    """ Retrieves the lower bound of an integer or interval variable domain.
+    """ Retrieves the lower bound of an integer or interval variable domain.
 
     The domain can be either:
 
@@ -2165,7 +2148,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def get_domain_max(d):
-    """ Retrieves the upper bound of an integer or interval variable domain.
+    """ Retrieves the upper bound of an integer or interval variable domain.
 
     The domain can be either:
 
@@ -2191,7 +2174,7 @@ 
    Source code for docplex.cp.expression
     #-----------------------------------------------------------------------------
 
 def _pretty_print_children(lstart, lend, lexpr, out, mxdepth, mxargs, adsize, indent, curdepth):
-    """ Pretty print list of expression
+    """ Pretty print list of expression
 
     Args:
         lstart:   List start banner
@@ -2237,7 +2220,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _domain_iterator(d):
-    """ Iterator on the individual values of an integer or interval variable domain.
+    """ Iterator on the individual values of an integer or interval variable domain.
 
     Args:
         d: Domain to iterate
@@ -2260,7 +2243,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _domain_contains(d, val):
-    """ Check whether a domain contains a given value
+    """ Check whether a domain contains a given value
 
     Args:
         d:   Domain
@@ -2290,7 +2273,7 @@ 
    Source code for docplex.cp.expression
     #  - reduce CPO file length as common expressions are easily identified.
 
 class _CacheKeyTuple(tuple):
-    """ Tuple that is used as a key of the expression cache
+    """ Tuple that is used as a key of the expression cache
     It implements a hash function based on ids of the elements, enabling:
      * use of non hashable elements,
      * comparison of CPO expressions that would not be possible because overloading of __eq__
@@ -2310,7 +2293,7 @@ 
    Source code for docplex.cp.expression
     
 
 class _ModelExpressionsCache(object):
-    """ Limited size object cache for CPO expressions.
+    """ Limited size object cache for CPO expressions.
     This cache is limited in size. This means that, if the max size is reached, adding a new
     object removes the oldest.
 
@@ -2345,7 +2328,7 @@ 
    Source code for docplex.cp.expression
             self.nb_create_new = 0
 
     def get_or_create(self, tname, pexpr, kbldr, xbldr):
-        """ Get a value from the cache
+        """ Get a value from the cache
 
         Args:
             tname:  Object type identifier (string)
@@ -2392,11 +2375,11 @@ 
    Source code for docplex.cp.expression
             return cexpr
 
     def size(self):
-        """ Get the current number of expressions in the cache """
+        """ Get the current number of expressions in the cache """
         return len(self.key_list)
 
     def clear(self):
-        """ Clear all dictionary content """
+        """ Clear all dictionary content """
         with self.lock:
             self.obj_dict.clear()
             self.key_list.clear()
@@ -2405,11 +2388,11 @@ 
    Source code for docplex.cp.expression
                 self.nb_create_new = 0
 
     def get_stats(self):
-        """ Get the cache statistics as a tuple (size, nb_get_or_create, nb_found_by_id, nb_found_by_value, nb_create_new) """
+        """ Get the cache statistics as a tuple (size, nb_get_or_create, nb_found_by_id, nb_found_by_value, nb_create_new) """
         return (len(self.key_list), self.nb_found_by_id, self.nb_found_by_value, self.nb_create_new)
 
     def __len__(self):
-        """ Returns the number of elements in this dictionary """
+        """ Returns the number of elements in this dictionary """
         return len(self.obj_dict)
 
 
@@ -2420,7 +2403,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def build_cpo_expr(val):
-    """ Builds a model expression from a given Python value.
+    """ Builds a model expression from a given Python value.
 
     If active, this method uses a cache to return the same CpoExpr for the same value.
 
@@ -2451,7 +2434,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def build_cpo_expr_array(val):
-    """ Builds a mode larray expression from a Python value.
+    """ Builds a mode larray expression from a Python value.
 
     If active, this method uses the value cache to return the same CpoExpr for the same value.
 
@@ -2485,7 +2468,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def build_cpo_tupleset(val):
-    """ Builds a TupleSet model expression from a Python value.
+    """ Builds a TupleSet model expression from a Python value.
 
     If active, this method uses the value cache to return the same CpoExpr for the same value.
 
@@ -2519,7 +2502,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def build_cpo_transition_matrix(val):
-    """ Builds a TransitionMatrix model expression from a Python value.
+    """ Builds a TransitionMatrix model expression from a Python value.
 
     If active, this method uses the value cache to return the same CpoExpr for the same value.
 
@@ -2552,7 +2535,7 @@ 
    Source code for docplex.cp.expression
     
 
 
    [docs]def compare_expressions(x1, x2):
-    """ Compare two expressions for declaration order
+    """ Compare two expressions for declaration order
 
     Args:
         x1: Expression 1
@@ -2581,7 +2564,7 @@ 
    Source code for docplex.cp.expression
     ###############################################################################
 
 def _create_cpo_array_expr(val):
-    """ Create a new CP array expression from a given array Python value
+    """ Create a new CP array expression from a given array Python value
 
     Args:
         val: Origin value, as a tuple or _CacheKeyTuple
@@ -2606,7 +2589,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _create_cpo_tuple_set(tset):
-    """ Create a new CP tuple set expression from a given Python tuple of tuples
+    """ Create a new CP tuple set expression from a given Python tuple of tuples
 
     Args:
         tset: Origin value, as a tuple of tuples
@@ -2625,7 +2608,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _create_cpo_transition_matrix(trmx):
-    """ Create a new CP transition matrix expression from a given Python tuple of tuples
+    """ Create a new CP transition matrix expression from a given Python tuple of tuples
 
     Args:
         tset: Origin value, as a tuple of tuples
@@ -2643,7 +2626,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _get_cpo_array_type(val):
-    """ Determine the CPO type of a given Python array value
+    """ Determine the CPO type of a given Python array value
     Args:
         val: Python value (list or tuple)
     Returns:
@@ -2674,7 +2657,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _get_cpo_type(val):
-    """ Determine the CPO type for a given Python value
+    """ Determine the CPO type for a given Python value
     Args:
         val: Python value
     Returns:
@@ -2703,13 +2686,13 @@ 
    Source code for docplex.cp.expression
     
 
 def _clear_value_cache():
-    """ Clear the cache of CPO values
+    """ Clear the cache of CPO values
     """
     _CPO_VALUES_FROM_PYTHON.clear()
 
 
 def _get_cpo_type_str(val):
-    """ Get the CPO type name of a value
+    """ Get the CPO type name of a value
 
     Args:
         val: Value
@@ -2720,7 +2703,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _create_operation(oper, params):
-    """ Create a new expression that matches an operation descriptor
+    """ Create a new expression that matches an operation descriptor
 
     Search in the signatures which one matches a set or arguments
     and then create an instance of the returned expression
@@ -2768,7 +2751,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _is_cpo_int(arg):
-    """ Check that a value is a valid integer for cpo
+    """ Check that a value is a valid integer for cpo
     Args:
         arg:  Value to check
     Returns:
@@ -2778,7 +2761,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _is_cpo_int_interval(val):
-    """ Check if a value represents an interval of CPO integers
+    """ Check if a value represents an interval of CPO integers
     Args:
         val:  Value to check
     Returns:
@@ -2788,7 +2771,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _is_cpo_interval_value(arg):
-    """ Check that a value is a valid value for an interval
+    """ Check that a value is a valid value for an interval
     Args:
         arg:  Value to check
     Returns:
@@ -2798,7 +2781,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _check_arg_boolean(arg, name):
-    """ Check that an argument is a boolean and raise error if wrong
+    """ Check that an argument is a boolean and raise error if wrong
     Args:
         arg:  Argument value
         name: Argument name
@@ -2812,7 +2795,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _check_arg_integer(arg, name):
-    """ Check that an argument is an valid integer value and raises error if wrong
+    """ Check that an argument is an valid integer value and raises error if wrong
     Args:
         arg:  Argument value
         name: Argument name
@@ -2826,7 +2809,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _check_arg_interval(arg, name):
-    """ Check that an argument is an interval and raise error if wrong
+    """ Check that an argument is an interval and raise error if wrong
     Args:
         arg:  Argument value
         name: Argument name
@@ -2853,7 +2836,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _build_int_var_domain(min, max, domain):
-    """ Create/check integer variable domain from integer variable creation parameters
+    """ Create/check integer variable domain from integer variable creation parameters
     Args:
         min:    Domain min value, None if extensive list.
         max:    Domain max value, None if extensive list.
@@ -2895,7 +2878,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _check_arg_step_function(arg, name):
-    """ Check that an argument is a step function and raise error if wrong
+    """ Check that an argument is a step function and raise error if wrong
     Args:
         arg:  Argument value
         name: Argument name
@@ -2909,7 +2892,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _check_arg_intensity(intensity, granularity):
-    """ Check the intensity parameter of an interval var.
+    """ Check the intensity parameter of an interval var.
     Args:
        intensity:   Intensity function (None, or StepFunction).
        granularity: Granularity
@@ -2924,7 +2907,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _check_and_expand_interval_tuples(name, arr):
-    """ Check that a list contains only integers and expand interval tuples if any
+    """ Check that a list contains only integers and expand interval tuples if any
     Args:
         name:  Argument name
         arr:   Array of integers and/or intervals
@@ -2949,7 +2932,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _get_matching_signature(oper, args):
-    """ Search the first operation signature matched by a list of arguments
+    """ Search the first operation signature matched by a list of arguments
 
     Args:
         oper: Operation where searching signature
@@ -2962,7 +2945,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _is_matching_arguments(sgn, args):
-    """ Check if a list of argument expressions matches this signature
+    """ Check if a list of argument expressions matches this signature
 
     Args:
         sgn:  Signature descriptor
@@ -2986,7 +2969,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _is_equal_expressions(v1, v2):
-    """ Check if two expressions can be considered as equivalent.
+    """ Check if two expressions can be considered as equivalent.
 
     This method handles values that can be CPO expressions, None, and manage possible
     differences between number representations.
@@ -3057,7 +3040,7 @@ 
    Source code for docplex.cp.expression
     
 
 def _is_equal_values(v1, v2):
-    """ Check if two values can be considered as equivalent.
+    """ Check if two values can be considered as equivalent.
 
     This method handles values that can be CPO expressions, None, and manage possible
     differences between number representations.
@@ -3088,13 +3071,13 @@ 
    Source code for docplex.cp.expression
     
 
 def _reset_cache():
-    """ Reset expression cache (for testing purpose).
+    """ Reset expression cache (for testing purpose).
     """
     _CPO_VALUES_FROM_PYTHON.clear()
 
 
 def _to_string(expr):
-    """ Build a string representing an expression.
+    """ Build a string representing an expression.
     Args:
         expr:  Expression to convert into string
     Returns:
@@ -3104,9 +3087,24 @@ 
    Source code for docplex.cp.expression
         return compiler.expr_to_string(expr)
 
    
 
+            
    
           
    
         
    
       
    
+      
       
    
     
    
     
     
   
 
\ No newline at end of file
diff --git a/docs/cp/_modules/docplex/cp/function.html b/docs/cp/_modules/docplex/cp/function.html
index 5f66da3..1c39cde 100644
--- a/docs/cp/_modules/docplex/cp/function.html
+++ b/docs/cp/_modules/docplex/cp/function.html
@@ -2,25 +2,23 @@
 
 
 
-
+
   
-    
-    
-    docplex.cp.function — DOcplex.CP: Constraint Programming Modeling for Python V2.25 documentation
-    
-    
+    
+    
+    docplex.cp.function — DOcplex.CP: Constraint Programming Modeling for Python V2.29 documentation
+    
+    
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
     
     
-    
+    
     
   
     
-      
+    
      
 
     
    
       
    
@@ -89,7 +72,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]class CpoFunction(CpoExpr):
-    """ Parent class for step and segmented functions.
+    """ Parent class for step and segmented functions.
     """
     __slots__ = ('_s0',  # Initial slope of the function
                  '_v0',  # Initial value of the function
@@ -99,7 +82,7 @@ 
    Source code for docplex.cp.function
                      )
 
     def __init__(self, typ, s0=None, v0=None, x=None, v=None, s=None, name=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             typ: Function type.
@@ -150,7 +133,7 @@ 
    Source code for docplex.cp.function
     
 
     def _get_expr_string(self):
-        """ Get the string representing this expression, name excluded. """
+        """ Get the string representing this expression, name excluded. """
         return "Function(...)"
 
 
@@ -190,7 +173,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]    def get_value(self, t):
-        """ Gets the value of the function.
+        """ Gets the value of the function.
 
         Gets the value of the function for an abscissa `t`.
         Complexity is in `O(log n)` for a function with `n` segments.
@@ -217,7 +200,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]    def copy(self, type=None):
-        """ Creates and returns a copy of the function. """
+        """ Creates and returns a copy of the function. """
         res = copy.copy(self)
         res._x = self._x[:]
         res._v = self._v[:]
@@ -228,7 +211,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]    def set_slope(self, x1, x2, v1, s):
-        """ Sets the value of the invoking function over an interval.
+        """ Sets the value of the invoking function over an interval.
 
         Sets the value of the invoking function on interval `[x1,x2)`
         to equal to `f(x) = v1 + s * (x-x1)`.
@@ -332,7 +315,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]    def add_slope(self, x1, x2, v1, s):
-        """ Adds a piecewise linear step on an interval.
+        """ Adds a piecewise linear step on an interval.
 
         Adds a piecewise linear step `f(x) = v1 + s * (x-x1)` to the invoking
         function on interval `[x1,x2)`.
@@ -529,7 +512,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]    def set_value(self, x1, x2, v):
-        """ Sets the value of the function over an interval.
+        """ Sets the value of the function over an interval.
 
         Sets the value of the invoking function to be constant and equal to `v`
         on the interval `[x1,x2)`.
@@ -543,7 +526,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]    def add_value(self, x1, x2, v):
-        """ Adds a constant to the value of the function over an interval.
+        """ Adds a constant to the value of the function over an interval.
 
         Adds constant value `v` to the value of the invoking function
         on the interval `[x1,x2)`.
@@ -561,7 +544,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]class CpoSegmentedFunction(CpoFunction):
-    """ Class representing a segmented function.
+    """ Class representing a segmented function.
 
     In CP Optimizer, piecewise linear functions are typically used in modeling a known function of time,
     for instance the cost that is incurred for completing an activity after a known date.
@@ -574,7 +557,7 @@ 
    Source code for docplex.cp.function
         """
 
     def __init__(self, segment0=None, segments=None, name=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             segment0 (tuple): Initial segment of the function (slope, vright).
@@ -597,7 +580,7 @@ 
    Source code for docplex.cp.function
             super(CpoSegmentedFunction, self).__init__(Type_SegmentedFunction, s0=s0, v0=v0, x=x, v=v, s=s, name=name)
 
 
    [docs]    def get_segment_list(self):
-        """ Returns the list of segments of the function.
+        """ Returns the list of segments of the function.
         """
         segments = [(self.s0, self.v0)]
         for i in range(len(self.x)):
@@ -605,7 +588,7 @@ 
    Source code for docplex.cp.function
             return segments
    
 
     def __str__(self):
-        """ Build a string representing this function. """
+        """ Build a string representing this function. """
         res = "SegmentedFunction(" + str(self.get_segment_list()) + ")"
         if self.name:
             res = self.name + "=" + res
@@ -613,7 +596,7 @@ 
    Source code for docplex.cp.function
     
 
 
    [docs]class CpoStepFunction(CpoFunction):
-    """ Class representing a step function.
+    """ Class representing a step function.
 
     In CP Optimizer, stepwise functions are typically used to model the efficiency of a resource over time.
 
@@ -629,7 +612,7 @@ 
    Source code for docplex.cp.function
         To change this default value, the first step should be (INTERVAL_MIN, value).
     """
     def __init__(self, steps=None, name=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             steps: (Optional) Function steps, expressed as a list of couples (x, val).
@@ -651,7 +634,7 @@ 
    Source code for docplex.cp.function
                 super(CpoStepFunction, self).__init__(typ=Type_StepFunction, s0=None, v0=v0, x=x, v=v, s=None, name=name)
 
 
    [docs]    def get_step_list(self):
-        """ Returns the list of steps of the function.
+        """ Returns the list of steps of the function.
         """
         steps = []
         if self.v0 != 0:
@@ -661,7 +644,7 @@ 
    Source code for docplex.cp.function
             return steps
    
 
     def __str__(self):
-        """ Build a string representing this function. """
+        """ Build a string representing this function. """
         res = "StepFunction(" + str(self.get_step_list()) + ")"
         if self.name:
             res = self.name + "=" + res
@@ -670,9 +653,24 @@ 
    Source code for docplex.cp.function
     
 
    
 
+            
    
           
    
         
    
       
    
+      
       
    
     
    
     
     
   
 
\ No newline at end of file
diff --git a/docs/cp/_modules/docplex/cp/fzn/fzn_parser.html b/docs/cp/_modules/docplex/cp/fzn/fzn_parser.html
index a878e83..01ecc60 100644
--- a/docs/cp/_modules/docplex/cp/fzn/fzn_parser.html
+++ b/docs/cp/_modules/docplex/cp/fzn/fzn_parser.html
@@ -2,25 +2,23 @@
 
 
 
-
+
   
-    
-    
-    docplex.cp.fzn.fzn_parser — DOcplex.CP: Constraint Programming Modeling for Python V2.25 documentation
-    
-    
+    
+    
+    docplex.cp.fzn.fzn_parser — DOcplex.CP: Constraint Programming Modeling for Python V2.29 documentation
+    
+    
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
     
     
-    
+    
     
   
     
-      
+    
      
 
     
    
       
    
@@ -136,10 +119,10 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     ###############################################################################
 
 
    [docs]class FznParserException(CpoException):
-    """ The base class for exceptions raised by the CPO parser
+    """ The base class for exceptions raised by the CPO parser
     """
     def __init__(self, msg):
-        """ Create a new exception
+        """ Create a new exception
         Args:
             msg: Error message
         """
@@ -153,13 +136,13 @@ 
    Source code for docplex.cp.fzn.fzn_parser
                                                            ))
 
 
    [docs]class FznObject(object):
-    """ Descriptor of a FZN object
+    """ Descriptor of a FZN object
     """
     __slots__ = ()
    
 
 
 
    [docs]class FznParameter(FznObject):
-    """ Descriptor of a FZN parameter
+    """ Descriptor of a FZN parameter
     """
     __slots__ = ('name',   # Parameter name
                  'type',   # Parameter type
@@ -167,7 +150,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
                      'value',  # Initial value (if any)
                  )
     def __init__(self, name, type, size, value):
-        """ Create a new FZN parameter
+        """ Create a new FZN parameter
         Args:
             name:   Name of the parameter
             type:   Type of the parameter
@@ -195,7 +178,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]class FznVariable(FznObject):
-    """ Descriptor of a FZN variable
+    """ Descriptor of a FZN variable
     """
     __slots__ = ('name',           # Variable name
                  'type',           # Variable type (String)
@@ -208,7 +191,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
                      'ref_vars',   # Tuple of variables referenced by this variable
                  )
     def __init__(self, name, type, domain, annotations, size, value):
-        """ Create a new FZN variable
+        """ Create a new FZN variable
         Args:
             name:         Name of the variable
             type:         Variable type
@@ -225,28 +208,28 @@ 
    Source code for docplex.cp.fzn.fzn_parser
             self.value = value
 
 
    [docs]    def is_defined(self):
-        """ Check if the variable is introduced
+        """ Check if the variable is introduced
         Return:
             True if variable is introduced, False otherwise
         """
         return 'is_defined_var' in self.annotations
    
 
 
    [docs]    def is_introduced(self):
-        """ Check if the variable is introduced
+        """ Check if the variable is introduced
         Return:
             True if variable is introduced, False otherwise
         """
         return 'var_is_introduced' in self.annotations
    
 
 
    [docs]    def is_output(self):
-        """ Check if the variable is introduced
+        """ Check if the variable is introduced
         Return:
             True if variable is introduced, False otherwise
         """
         return ('output_var' in self.annotations) or ('output_array' in self.annotations)
    
 
     def _get_domain_bounds(self):
-        """ Get the variable domain bounds
+        """ Get the variable domain bounds
         Return:
             Tuple of values, or single value if identical
         """
@@ -284,7 +267,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]class FznConstraint(FznObject):
-    """ Descriptor of a FZN constraint
+    """ Descriptor of a FZN constraint
     """
     __slots__ = ('predicate',  # Name of the predicate
                  'args',       # Arguments
@@ -294,7 +277,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
                      'ref_vars',   # Tuple of variables referenced by this constraint, but not defined
                  )
     def __init__(self, predicate, args, annotations):
-        """ Create a new FZN constraint
+        """ Create a new FZN constraint
         Args:
             predicate:    Name of the predicate
             args:         List or arguments
@@ -306,7 +289,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
             self.ref_vars = ()
 
     def _ref_vars_iterator(self):
-        """ Iterator on the variables that are referenced in the arguments of this constraint.
+        """ Iterator on the variables that are referenced in the arguments of this constraint.
         Returns:
             Iterator on all variables referenced by this constraint
         """
@@ -339,7 +322,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]class FznObjective(FznObject):
-    """ Descriptor of a FZN objective
+    """ Descriptor of a FZN objective
     """
     __slots__ = ('operation',   # Objective operation in 'satisfy', 'minimize', 'maximize'
                  'expr',        # Target expression
@@ -347,7 +330,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
                     )
 
     def __init__(self, operation, expr, annotations):
-        """ Create a new FZN constraint
+        """ Create a new FZN constraint
         Args:
             operation:   Objective operation in 'satisfy', 'minimize', 'maximize'
             expr:        Target expression
@@ -362,7 +345,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]class FznReader(object):
-    """ Reader of FZN file format """
+    """ Reader of FZN file format """
     __slots__ = ('source_file',  # Source file
                  'tokenizer',    # Reading tokenizer
                  'token',        # Last read token
@@ -375,7 +358,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
                      )
 
     def __init__(self, mdl=None):
-        """ Create a new FZN reader
+        """ Create a new FZN reader
         """
         super(FznReader, self).__init__()
         self.source_file = None
@@ -389,7 +372,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]    def parse(self, cfile):
-        """ Parse a FZN file
+        """ Parse a FZN file
 
         Args:
             cfile: FZN file to read
@@ -404,7 +387,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]    def parse_string(self, str):
-        """ Parse a string
+        """ Parse a string
 
         Result of the parsing is added to the current result model.
 
@@ -417,7 +400,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]    def write(self, out=None):
-        """ Write the model.
+        """ Write the model.
 
         If the given output is a string, it is considered as a file name that is opened by this method
         using 'utf-8' encoding.
@@ -445,7 +428,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_document(self):
-        """ Read all FZN document
+        """ Read all FZN document
         """
         try:
             self._next_token()
@@ -468,7 +451,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_predicate(self):
-        """ Read a predicate declaration
+        """ Read a predicate declaration
 
         This function is called with first token already read and terminates with next token already read.
 
@@ -488,7 +471,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_parameter_or_variable(self):
-        """ Read a parameter or variable declaration
+        """ Read a parameter or variable declaration
 
         This function is called with first token already read and terminates with next token already read.
 
@@ -546,7 +529,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_variable(self, arsize):
-        """ Read a variable declaration
+        """ Read a variable declaration
 
         This function is called with first token already read and terminates with next token already read.
 
@@ -587,7 +570,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_constraint(self):
-        """ Read a constraint
+        """ Read a constraint
 
         This function is called with first token already read and terminates with next token already read.
 
@@ -629,7 +612,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_objective(self):
-        """ Read solve objective
+        """ Read solve objective
 
         This function is called with first token already read and terminates with next token already read.
 
@@ -666,7 +649,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_expression(self):
-        """ Read an expression
+        """ Read an expression
 
         First expression token is already read.
         Function exits with current token following the last expression token
@@ -760,7 +743,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_array_size(self):
-        """ Read an array size declaration
+        """ Read an array size declaration
 
         First expression token is already read.
         Function exits with current token following the last expression token
@@ -795,7 +778,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_var_domain(self):
-        """ Read the domain of a variable.
+        """ Read the domain of a variable.
 
         First expression token is already read.
         Function exits with current token following the last expression token
@@ -853,7 +836,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _read_annotations(self):
-        """ Read a list of annotations
+        """ Read a list of annotations
 
         First expression token is already read.
         Function exits with current token following the last expression token
@@ -884,7 +867,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _next_token(self):
-        """ Read next token
+        """ Read next token
         Returns:
             Next read token, None if end of input
         """
@@ -894,7 +877,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _check_token(self, tok, etok):
-        """ Check that a read token is a given one an raise an exception if not
+        """ Check that a read token is a given one an raise an exception if not
         Args:
             tok: Read token
             etok: Expected token
@@ -904,7 +887,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _raise_exception(self, msg):
-        """ Raise a Parsing exception
+        """ Raise a Parsing exception
         Args:
             msg:  Exception message
         """
@@ -913,7 +896,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]class FznParser(object):
-    """ Reader of FZN file format """
+    """ Reader of FZN file format """
     __slots__ = ('model',          # Read model
                  'compiled',       # Model compiled indicator
                  'reader',         # FZN reader
@@ -934,7 +917,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
                      )
 
     def __init__(self, mdl=None):
-        """ Create a new FZN format parser
+        """ Create a new FZN format parser
 
         Args:
             mdl:  Model to fill, None (default) to create a new one.
@@ -954,7 +937,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]    def get_model(self):
-        """ Get the model that have been parsed
+        """ Get the model that have been parsed
 
         Return:
             CpoModel result of the parsing
@@ -966,7 +949,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]    def parse(self, cfile):
-        """ Parse a FZN file
+        """ Parse a FZN file
 
         Args:
             cfile: FZN file to read
@@ -979,7 +962,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]    def parse_string(self, str):
-        """ Parse a string
+        """ Parse a string
 
         Result of the parsing is added to the current result model.
 
@@ -990,7 +973,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 
    [docs]    def get_output_variables(self):
-        """ Get the list of model output variables
+        """ Get the list of model output variables
 
         Returns:
             List of output variables, in declaration order.
@@ -999,7 +982,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _write_model(self, out=None):
-        """ Print read model (short version)
+        """ Print read model (short version)
         Args:
             out (optional): Output stream. Default is stdout
         """
@@ -1010,14 +993,14 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _get_cpo_expr_map(self):
-        """ For testing, get the map of CPO expressions
+        """ For testing, get the map of CPO expressions
         """
         self.get_model()
         return self.cpo_exprs
 
 
     def _compile_to_model(self):
-        """ Compile FZN model into CPO model
+        """ Compile FZN model into CPO model
         """
         # Initialize processing
         self.cpo_exprs = {}
@@ -1064,7 +1047,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_parameter(self, fp):
-        """ Compile a FZN parameter into CPO model
+        """ Compile a FZN parameter into CPO model
         Args:
             fp: Flatzinc parameter, object of class FznParameter
         """
@@ -1081,7 +1064,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_variable(self, fv):
-        """ Compile a FZN variable into CPO model
+        """ Compile a FZN variable into CPO model
         Args:
             fv: Flatzinc variable
         """
@@ -1126,7 +1109,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_constraint(self, fc):
-        """ Compile a FZN constraint into CPO model
+        """ Compile a FZN constraint into CPO model
         Args:
             fv: Flatzinc constraint
         """
@@ -1140,7 +1123,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_objective(self, fo):
-        """ Compile a FZN objective into CPO model
+        """ Compile a FZN objective into CPO model
         Args:
             fo: Flatzinc objective
         """
@@ -1154,7 +1137,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _reduce_model(self):
-        """ Reduce model size by factorizing expressions when possible
+        """ Reduce model size by factorizing expressions when possible
         """
         # Access main model elements
         variables = self.variables
@@ -1255,7 +1238,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _insert_in_constraints(self, fc, cx, varsctsr):
-        """ Insert a constraint or a variable in constraints after all its members are defined
+        """ Insert a constraint or a variable in constraints after all its members are defined
         Args:
             fc:         FZN constraint or variable to insert
             cx:         Start insertion index
@@ -1286,7 +1269,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _determine_connex_variables(self, def_var_map):
-        """ Search connex sub-graphes in variables dependencies and put all multi-variables connex parts as cpo variables
+        """ Search connex sub-graphes in variables dependencies and put all multi-variables connex parts as cpo variables
         Args:
             def_var_map: Map of constraints where variable is defined
         """
@@ -1344,7 +1327,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _get_cpo_expr(self, expr):
-        """ Retrieve a CPO expression from its FZN representation
+        """ Retrieve a CPO expression from its FZN representation
         Args:
             expr:  FZN expression
         Returns:
@@ -1639,7 +1622,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
             self._compile_op_assign_arg_2(fc, modeler.power)
 
     def _compile_pred_cumulative(self, fc):
-        """ Requires that a set of tasks given by start times s, durations d, and resource requirements r,
+        """ Requires that a set of tasks given by start times s, durations d, and resource requirements r,
         never require more than a global resource bound b at any one time.
         Args:
             fc:  Constraint descriptor, with arguments
@@ -1721,14 +1704,14 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_pred_subcircuit(self, fc):
-        """ Constrains the elements of x to define a subcircuit where x[i] = j means that j is the successor of i and x[i] = i means that i is not in the circuit.
+        """ Constrains the elements of x to define a subcircuit where x[i] = j means that j is the successor of i and x[i] = i means that i is not in the circuit.
         """
         x = [0] + list(self._get_cpo_expr(fc.args[0]).value)
         self._add_to_model(CpoFunctionCall(Oper_sub_circuit, Type_Constraint, (build_cpo_expr(x),) ))
 
 
     def _compile_pred_inverse(self, fc):
-        """ Constrains two arrays of int variables, f and invf, to represent inverse functions. All the values in each array must be within the index set of the other array.
+        """ Constrains two arrays of int variables, f and invf, to represent inverse functions. All the values in each array must be within the index set of the other array.
         Args:
             f:     First function as array of int
             invf:  Inverse function
@@ -1740,7 +1723,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_pred_bool_clause(self, fc):
-        """ Implementation of bool_clause predicate
+        """ Implementation of bool_clause predicate
         Args:
             a:  First array of booleans
             b:  Second array of booleans
@@ -1767,7 +1750,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_pred_table_int(self, fc):
-        """ Implement custom predicate table_int
+        """ Implement custom predicate table_int
         Args:
             vars:    Array of variables
             values:  List of values
@@ -1784,7 +1767,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_pred_lex_less_bool(self, fc):
-        """ Requires that the array vars1 is strictly lexicographically less than array vars2
+        """ Requires that the array vars1 is strictly lexicographically less than array vars2
         Args:
             vars1:  First array of variables
             vars2:  Second array of variables
@@ -1801,7 +1784,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _get_domain_bounds(self, x):
-        """ Get min and max bounds of an expression, integer variable or integer
+        """ Get min and max bounds of an expression, integer variable or integer
         Args:
             expr: CPO integer variable or expression
         Returns:
@@ -1830,7 +1813,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _assign_to_var(self, var, expr):
-        """ Set a identifier with an expression
+        """ Set a identifier with an expression
         Args:
             var:  Target FZN variable
             expr: CPO expression to assign
@@ -1855,7 +1838,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _make_equal(self, var, expr, dvar):
-        """ Make equal two FZN expressions
+        """ Make equal two FZN expressions
         Args:
             var:   FZN variable or value
             expr:  CPO expression to be equal with
@@ -1879,7 +1862,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _constrain_expr_domain(self, expr, var):
-        """ Constrain the domain of an expression to the domain of a variable
+        """ Constrain the domain of an expression to the domain of a variable
         Args:
             expr: CPO expression to constrain
             var:  CPO or FZN integer var to take domain from
@@ -1908,7 +1891,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_op_assign_arg_1(self, fc, op):
-        """ Compile operation with single argument equal to a result
+        """ Compile operation with single argument equal to a result
         Args:
             fc:  Constraint descriptor
             op:  CPO operation to apply to first argument
@@ -1920,7 +1903,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_op_assign_arg_2(self, fc, op):
-        """ Compile operation with two arguments equal to a result
+        """ Compile operation with two arguments equal to a result
         Args:
             fc:  Constraint descriptor
             op:  CPO operation to apply to arguments
@@ -1932,7 +1915,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_op_arg_1(self, fc, op):
-        """ Compile operation with one arguments and no result
+        """ Compile operation with one arguments and no result
         Args:
             fc:  Constraint descriptor
             op:  CPO operation to apply to argument
@@ -1941,7 +1924,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_op_arg_2(self, fc, op):
-        """ Compile operation with two arguments and no result
+        """ Compile operation with two arguments and no result
         Args:
             fc:  Constraint descriptor
             op:  CPO operation to apply to arguments
@@ -1951,7 +1934,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_array_xxx_element(self, fc):
-        """ Compile access to array element """
+        """ Compile access to array element """
         x, t, r = fc.args
         if not is_int(x):
             x = self._get_cpo_expr(x)
@@ -1959,7 +1942,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_xxx_eq(self, fc):
-        """ Compile all equality predicates """
+        """ Compile all equality predicates """
 
         # Access constraint arguments
         a, b = fc.args
@@ -1986,7 +1969,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _compile_scal_prod(self, fc, op, reif=False):
-        """ Compile a scalar product
+        """ Compile a scalar product
         Args:
             fc:  Constraint
             op:  Comparison operation
@@ -2044,7 +2027,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _build_scal_prod_expr(self, coefs, vars, res):
-        """ Build a scal prod expression
+        """ Build a scal prod expression
         Args:
             coefs:  Array of coefficients (integers)
             vars:   Array of FZN variables
@@ -2075,7 +2058,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _add_to_model(self, expr):
-        """ Add an expression to the CPO model
+        """ Add an expression to the CPO model
         Args:
             expr: CPO expression to add
         """
@@ -2098,7 +2081,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
     def _write(self, out=None):
-        """ Write current parser status
+        """ Write current parser status
         Args:
             out (optional):  Write output. sys.stdout if not given
         """
@@ -2119,7 +2102,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     ###############################################################################
 
 def _get_fzn_array(fzo):
-    """ Get the list of objects of an FZN object
+    """ Get the list of objects of an FZN object
     Args:
         fzo: FZN object
     Returns:
@@ -2129,7 +2112,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 def _get_value(expr):
-    """ Get the python value of an expression
+    """ Get the python value of an expression
     Args:
         expr: Expression (python or CPO)
     Returns:
@@ -2139,7 +2122,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 def _build_domain(v):
-    """ Build a variable domain from an initial value
+    """ Build a variable domain from an initial value
     Args:
         v: Variable initial value
     Returns:
@@ -2167,7 +2150,7 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
 def _mutl_by_int(expr, val):
-    """ Create an expression that multiply an expression by an integer
+    """ Create an expression that multiply an expression by an integer
     Args:
         expr: Expression to constrain
         val:  Integer value to multiply expression with
@@ -2185,9 +2168,24 @@ 
    Source code for docplex.cp.fzn.fzn_parser
     
 
    
 
+            
    
           
    
         
    
       
    
+      
       
    
     
    
     
     
   
 
\ No newline at end of file
diff --git a/docs/cp/_modules/docplex/cp/model.html b/docs/cp/_modules/docplex/cp/model.html
index 35ae0e7..287f02c 100644
--- a/docs/cp/_modules/docplex/cp/model.html
+++ b/docs/cp/_modules/docplex/cp/model.html
@@ -2,25 +2,23 @@
 
 
 
-
+
   
-    
-    
-    docplex.cp.model — DOcplex.CP: Constraint Programming Modeling for Python V2.25 documentation
-    
-    
+    
+    
+    docplex.cp.model — DOcplex.CP: Constraint Programming Modeling for Python V2.29 documentation
+    
+    
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
     
     
-    
+    
     
   
     
-      
+    
      
 
     
    
       
    
@@ -163,11 +146,11 @@ 
    Source code for docplex.cp.model
     
 # Model statistics
 
    [docs]class CpoModelStatistics(object):
-    """ This class represents model statistics information.
+    """ This class represents model statistics information.
     """
 
     def __init__(self, model=None, json=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Can be created either by giving source model, or json object.
 
@@ -230,7 +213,7 @@ 
    Source code for docplex.cp.model
     
 
     def _add_variable(self, v):
-        """ Update statistics with a variable.
+        """ Update statistics with a variable.
 
         Args:
             v:  Variable to add
@@ -248,7 +231,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def add(self, other):
-        """ Add other model statistics to this one
+        """ Add other model statistics to this one
 
         Args:
             other:  Other model statistics, object of class CpoModelStatistics
@@ -265,7 +248,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_number_of_variables(self):
-        """ Return the total number of variables.
+        """ Return the total number of variables.
 
         The total number of variables includes:
 
@@ -282,7 +265,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_number_of_expressions(self):
-        """ Return the total number of root expressions.
+        """ Return the total number of root expressions.
 
         Returns:
             Number of model root expressions.
@@ -291,7 +274,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_number_of_constraints(self):
-        """ Return the number of constraints.
+        """ Return the number of constraints.
 
         Returns:
             Number of constraints.
@@ -300,7 +283,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def write(self, out=None, prefix=""):
-        """ Write the statistics
+        """ Write the statistics
 
         Args:
             out (Optional):    Target output, as stream or file name. sys.stdout if not given
@@ -335,7 +318,7 @@ 
    Source code for docplex.cp.model
             out.write("\n")
    
 
 
    [docs]    def to_json(self):
-        """ Build a json object from this statistics
+        """ Build a json object from this statistics
 
         Note: Not all attributes are present, was just for DOcloud usage.
 
@@ -352,7 +335,7 @@ 
    Source code for docplex.cp.model
             }
    
 
     def __str__(self):
-        """ Build a short string representing this object
+        """ Build a short string representing this object
 
         Returns:
             String representing this object
@@ -361,7 +344,7 @@ 
    Source code for docplex.cp.model
                 .format(self.nb_integer_vars, self.nb_interval_vars, self.nb_constraints, self.nb_root_exprs, self.nb_expr_nodes, len(self.operation_usage))
 
     def __eq__(self, other):
-        """ Overwrite equality comparison
+        """ Overwrite equality comparison
 
         Args:
             other: Other object to compare with
@@ -371,16 +354,16 @@ 
    Source code for docplex.cp.model
             return utils.equals(self, other)
 
     def __ne__(self, other):
-        """ Overwrite inequality comparison """
+        """ Overwrite inequality comparison """
         return not self.__eq__(other)
    
 
 
 
    [docs]class CpoModel(object):
-    """ This class is the Python container of a CPO model.
+    """ This class is the Python container of a CPO model.
     """
 
     def __init__(self, name=None, sfile=None, version=None):
-        """ **Constructor**
+        """ **Constructor**
 
         Args:
             name:    (Optional) Model name (source file name).
@@ -436,7 +419,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def add(self, *expr):
-        """ Adds one or several expressions to the model.
+        """ Adds one or several expressions to the model.
 
         This method adds one or more CPO expression to the model.
         A CPO expression is an object of class :class:`~docplex.cp.expression.CpoExpr` or derived, obtained by:
@@ -481,7 +464,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def add_constraint(self, expr):
-        """ Adds a constraint to the model.
+        """ Adds a constraint to the model.
 
         This method has been added for compatibility with *docplex.mp*.
         It is equivalent to method :meth:`~CpoModel.add`
@@ -493,7 +476,7 @@ 
    Source code for docplex.cp.model
     
 
     def _add_with_loc(self, expr, loc):
-        """ Adds an expression with its location to the model.
+        """ Adds an expression with its location to the model.
 
         Args:
             expr: CPO expression (constraint, boolean, objective, etc) to add to the model
@@ -531,7 +514,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def remove(self, *expr):
-        """ Remove one or several expressions from the model.
+        """ Remove one or several expressions from the model.
 
         This method removes one or more CPO expression from the model.
 
@@ -587,7 +570,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def remove_expressions(self, lexpr):
-        """ Remove a list of expressions from the model.
+        """ Remove a list of expressions from the model.
 
         DEPRECATED: use directly :meth:`remove` instead, as it supports multiple or lists of expressions to remove.
 
@@ -606,7 +589,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def minimize(self, expr):
-        """ Add an objective expression to minimize.
+        """ Add an objective expression to minimize.
 
         DEPRECATED: use *add(minimize())* instead.
 
@@ -622,7 +605,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def maximize(self, expr):
-        """ Add an objective expression to maximize.
+        """ Add an objective expression to maximize.
 
         DEPRECATED: use *add(maximize())* instead.
 
@@ -638,7 +621,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def set_parameters(self, params=None, **kwargs):
-        """ Set the solving parameters associated to this model.
+        """ Set the solving parameters associated to this model.
 
         The argument *params* can be either:
 
@@ -681,7 +664,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def add_parameters(self, **kwargs):
-        """ Add parameters to this model.
+        """ Add parameters to this model.
 
         This method adds parameters to the :class:`~docplex.cp.parameters.CpoParameters` object currently
         associated to the model.
@@ -698,7 +681,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def read_ops_file(self, infile):
-        """ Load and set parameters of this model from an OPL-style .ops file.
+        """ Load and set parameters of this model from an OPL-style .ops file.
 
         This method loads parameters from an OPL-style .ops file.  Any existing
         parameter settings which are not overridden by the settings from the
@@ -714,7 +697,7 @@ 
    Source code for docplex.cp.model
             return self.set_parameters(p)
    
 
 
    [docs]    def export_parameters_as_ops_file(self, outfile):
-        """ Write parameters of this model to an OPL-style .ops file.
+        """ Write parameters of this model to an OPL-style .ops file.
 
         This method writes the non-default-valued parameters to an OPL-style .ops file.
 
@@ -727,7 +710,7 @@ 
    Source code for docplex.cp.model
             self.parameters.export_as_ops_file(outfile)
    
 
 
    [docs]    def get_parameters(self):
-        """ Get the solving parameters associated to this model.
+        """ Get the solving parameters associated to this model.
 
         Returns:
             Solving parameters, object of class :class:`~docplex.cp.parameters.CpoParameters`, or None if not defined.
@@ -736,7 +719,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def merge_with_parameters(self, params):
-        """ Merge parameters of this model with external parameters.
+        """ Merge parameters of this model with external parameters.
 
         The model parameters (if any) are overwritten by the given parameters.
         If parameters are defined at model level, they are cloned, and the parameters given as argument are added to
@@ -754,7 +737,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def set_search_phases(self, phases):
-        """ Set a list of search phases
+        """ Set a list of search phases
 
         Args:
             phases: Array of search phases, or single phase
@@ -773,7 +756,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def add_search_phase(self, phase):
-        """ Add a search phase to the list of search phases
+        """ Add a search phase to the list of search phases
 
         This method is deprecated since release 2.3. Use :meth:`~CpoModel.set_search_phases` or
         :meth:`~CpoModel.add` instead.
@@ -791,7 +774,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def set_starting_point(self, stpoint):
-        """ Set a model starting point.
+        """ Set a model starting point.
 
         A starting point specifies a (possibly partial) solution that could be used by CP Optimizer
         to start the search.
@@ -829,7 +812,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_starting_point(self):
-        """ Get the model starting point
+        """ Get the model starting point
 
         Returns:
             Model starting point, None if none
@@ -838,7 +821,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def create_empty_solution(self):
-        """ Create an empty model solution that can be filled to be used as a starting point.
+        """ Create an empty model solution that can be filled to be used as a starting point.
 
         *New in version 2.9*
 
@@ -849,7 +832,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def add_kpi(self, expr, name=None):
-        """ Add a Key Performance Indicator to the model.
+        """ Add a Key Performance Indicator to the model.
 
         A Key Performance Indicators (KPI) is an expression whose value is considered as representative of the
         model solution and its quality.
@@ -906,7 +889,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def remove_kpi(self, kpi):
-        """ Remove a Key Performance Indicator from the model.
+        """ Remove a Key Performance Indicator from the model.
 
         Args:
             kpi:  KPI expression, or KPI name
@@ -923,13 +906,13 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def remove_all_kpis(self):
-        """ Remove all KPIs from this model.
+        """ Remove all KPIs from this model.
         """
         self.kpis.clear()
    
 
 
 
    [docs]    def get_kpis(self):
-        """ Returns the dictionary of this model KPIs.
+        """ Returns the dictionary of this model KPIs.
 
         Returns:
             Ordered dictionary of KPIs.
@@ -940,7 +923,7 @@ 
    Source code for docplex.cp.model
     
 
     def _get_kpi_expressions(self):
-        """ Returns the list of model expressions used in the kpis
+        """ Returns the list of model expressions used in the kpis
 
         This method returns all the KPI expressions that are model expressions (lambda expressions are ignored).
         Name of the KPI is absent.
@@ -953,7 +936,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def add_blackbox_function(self, bbf):
-        """ Add a new blackbox function descriptor to this model.
+        """ Add a new blackbox function descriptor to this model.
 
         Calling this function is mandatory before importing a CPO model that contains references to a blackbox function,
         if the context attribute *context.parser.auto_blackbox* is set to False (default).
@@ -978,7 +961,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_blackbox_functions(self):
-        """ Gets the list of all blackbox functions registered in this model.
+        """ Gets the list of all blackbox functions registered in this model.
 
         Returns:
             List of all blackbox functions occurring in this model, objects of class :class:`~docplex.cp.blackbox.CpoBlackboxFunction`
@@ -987,7 +970,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_blackbox_function(self, name):
-        """ Gets a particular blackbox function from its name.
+        """ Gets a particular blackbox function from its name.
 
         Args:
             name: Name of the blackbox function to search for
@@ -998,7 +981,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_all_expressions(self):
-        """ Gets the list of all model expressions
+        """ Gets the list of all model expressions
 
         Returns:
             List of model expressions including there location (if any).
@@ -1008,7 +991,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_all_variables(self):
-        """ Gets the list of all model variables.
+        """ Gets the list of all model variables.
 
         This method goes across all model expressions to identify all variables that are pointed by them.
         Calling this method on a big model may be slow.
@@ -1038,7 +1021,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_named_expressions_dict(self):
-        """ Gets a dictionary of all named expressions.
+        """ Gets a dictionary of all named expressions.
 
         This method goes across all model expressions to identify all named expressions.
         Calling this method on a big model may be slow.
@@ -1066,7 +1049,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_objective(self):
-        """ Gets the objective expression (maximization or minimization).
+        """ Gets the objective expression (maximization or minimization).
 
         Returns:
             Objective expression, None if satisfaction problem.
@@ -1075,7 +1058,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_objective_expression(self):
-        """ Gets the objective expression (maximization or minimization).
+        """ Gets the objective expression (maximization or minimization).
 
         Returns:
             Objective expression, None if satisfaction problem.
@@ -1084,7 +1067,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_optimization_expression(self):
-        """ Gets the optimization expression (maximization or minimization).
+        """ Gets the optimization expression (maximization or minimization).
 
         DEPRECATED. Use :meth:`~CpoModel.get_objective` instead.
 
@@ -1095,7 +1078,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def is_minimization(self):
-        """ Check if this model represents a minimization problem.
+        """ Check if this model represents a minimization problem.
 
         Returns:
             True if this model represents a minimization problem.
@@ -1104,7 +1087,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def is_maximization(self):
-        """ Check if this model represents a maximization problem.
+        """ Check if this model represents a maximization problem.
 
         Returns:
             True if this model represents a maximization problem.
@@ -1113,7 +1096,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def is_satisfaction(self):
-        """ Check if this model represents a satisfaction problem.
+        """ Check if this model represents a satisfaction problem.
 
         Returns:
             True if this model represents a satisfaction problem.
@@ -1122,7 +1105,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def replace_expression(self, oexpr, nexpr):
-        """ In all model expressions, replace an expression by another.
+        """ In all model expressions, replace an expression by another.
 
         This method goes across all model expressions tree and replace each occurrence of the expression to
         replace by the new expression.
@@ -1158,7 +1141,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_name(self):
-        """ Gets the name of the model.
+        """ Gets the name of the model.
 
         If the name is not explicitly defined, the name is the source file name without its extension.
         If source file name is also undefined, name is None.
@@ -1172,7 +1155,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def set_format_version(self, ver):
-        """ Set the expected version of the CPO format.
+        """ Set the expected version of the CPO format.
 
         If the version is None (default), the model is generated with the most recent version.
         If the solver is not the most recent, the model may be rejected at solve time if a recent feature has been used.
@@ -1185,7 +1168,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_format_version(self):
-        """ Gets the version of the CPO format.
+        """ Gets the version of the CPO format.
 
         This information is set only when parsing an existing CPO model that contains explicitly a version of the format.
         It is usually not set when creating a new model.
@@ -1198,7 +1181,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_source_file(self):
-        """ Gets the name of the source file from which model has been created.
+        """ Gets the name of the source file from which model has been created.
 
         Returns:
             Python source file name. None if undefined.
@@ -1207,7 +1190,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_modeling_duration(self):
-        """ Get the time spent in modeling.
+        """ Get the time spent in modeling.
 
         The time is computes as difference between the last time an expression has been added
         and the model object creation time.
@@ -1219,7 +1202,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def get_statistics(self):
-        """ Get statistics on the model
+        """ Get statistics on the model
 
         This methods compute statistics on the model.
 
@@ -1230,7 +1213,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def print_information(self, out=None):
-        """ Prints model information.
+        """ Prints model information.
 
         DEPRECATED. Use :meth:`write_information` instead.
 
@@ -1241,7 +1224,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def write_information(self, out=None):
-        """ Write various information about the model.
+        """ Write various information about the model.
 
         This method calls the method :meth:`get_statistics` to retrieve information on the model, and then
         print it with source file name and modeling time.
@@ -1270,7 +1253,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def create_solver(self, **kwargs):
-        """ Create a new solver instance attached to this model
+        """ Create a new solver instance attached to this model
 
         All necessary solving parameters are taken from the solving context that is constructed from the following list
         of sources, each one overwriting the previous:
@@ -1304,7 +1287,7 @@ 
    Source code for docplex.cp.model
     
 
 
    [docs]    def solve(self, **kwargs):
-        """ Solves the model.
+        """ Solves the model.
 
         This method solves the model using the appropriate :class:`~docplex.cp.solver.solver.CpoSolver`
         created according to default solving context, possibly modified by the parameters of this method.
@@ -1353,7 +1336,7 @@ 
    Source code for docplex.cp.model