<!doctype html> <html lang="en"> <head> <meta charset="iso-8859-1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>docplex.mp.basic module — DOcplex.MP: Mathematical Programming Modeling for Python V2.30 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=c92c1228" /> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=dd09d6e6"></script> <script src="_static/doctools.js?v=888ff710"></script> <script src="_static/sphinx_highlight.js?v=4825356b"></script> <script src="_static/bizstyle.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="docplex.mp.callbacks.cb_mixin module" href="docplex.mp.callbacks.cb_mixin.html" /> <link rel="prev" title="docplex.mp reference manual" href="refman.html" /> <meta name="viewport" content="width=device-width,initial-scale=1.0" /> <!--[if lt IE 9]> <script src="_static/css3-mediaqueries.js"></script> <![endif]--> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="docplex.mp.callbacks.cb_mixin.html" title="docplex.mp.callbacks.cb_mixin module" accesskey="N">next</a> |</li> <li class="right" > <a href="refman.html" title="docplex.mp reference manual" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">DOcplex.MP: Mathematical Programming Modeling for Python V2.30 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="refman.html" accesskey="U"><strong>docplex.mp</strong> reference manual</a> »</li> <li class="nav-item nav-item-this"><a href="">docplex.mp.basic module</a></li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <section id="docplex-mp-basic-module"> <h1>docplex.mp.basic module<a class="headerlink" href="#docplex-mp-basic-module" title="Permalink to this heading">¶</a></h1> <div class="toctree-wrapper compound"> </div> <span class="target" id="module-docplex.mp.basic"></span><dl class="py class"> <dt class="sig sig-object py" id="docplex.mp.basic.Expr"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">docplex.mp.basic.</span></span><span class="sig-name descname"><span class="pre">Expr</span></span><a class="reference internal" href="_modules/docplex/mp/basic.html#Expr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.Expr" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#docplex.mp.basic.ModelObject" title="docplex.mp.basic.ModelObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelObject</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Operand</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">_AbstractValuable</span></code></p> <p>Parent class for all expression classes.</p> <dl class="py method"> <dt class="sig sig-object py" id="docplex.mp.basic.Expr.contains_var"> <span class="sig-name descname"><span class="pre">contains_var</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dvar</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#Expr.contains_var"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.Expr.contains_var" title="Permalink to this definition">¶</a></dt> <dd><p>Checks whether a variable is present in the expression.</p> <dl class="field-list simple"> <dt class="field-odd">Param<span class="colon">:</span></dt> <dd class="field-odd"><p>dvar (<a class="reference internal" href="docplex.mp.dvar.html#docplex.mp.dvar.Var" title="docplex.mp.dvar.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">docplex.mp.dvar.Var</span></code></a>): A decision variable.</p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>True if the variable is present in the expression, else False.</p> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> <dd class="field-odd"><p>Boolean</p> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="docplex.mp.basic.Expr.is_quad_expr"> <span class="sig-name descname"><span class="pre">is_quad_expr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#Expr.is_quad_expr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.Expr.is_quad_expr" title="Permalink to this definition">¶</a></dt> <dd><p>Returns True if the expression is quadratic</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="docplex.mp.basic.Expr.number_of_variables"> <span class="sig-name descname"><span class="pre">number_of_variables</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#Expr.number_of_variables"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.Expr.number_of_variables" title="Permalink to this definition">¶</a></dt> <dd><dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>The number of variables in the expression.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p>integer</p> </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="docplex.mp.basic.IndexableObject"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">docplex.mp.basic.</span></span><span class="sig-name descname"><span class="pre">IndexableObject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-2</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#IndexableObject"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.IndexableObject" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#docplex.mp.basic.ModelingObjectBase" title="docplex.mp.basic.ModelingObjectBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelingObjectBase</span></code></a></p> <dl class="py method"> <dt class="sig sig-object py" id="docplex.mp.basic.IndexableObject.is_generated"> <span class="sig-name descname"><span class="pre">is_generated</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#IndexableObject.is_generated"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.IndexableObject.is_generated" title="Permalink to this definition">¶</a></dt> <dd><p>Checks whether this object has been generated by another modeling object.</p> <p>If so, the origin object is stored in the <code class="docutils literal notranslate"><span class="pre">_origin</span></code> attribute.</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>True if the objects has been generated.</p> </dd> </dl> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="docplex.mp.basic.IndexableObject.model"> <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#docplex.mp.basic.IndexableObject.model" title="Permalink to this definition">¶</a></dt> <dd><p>This property returns the <a class="reference internal" href="docplex.mp.model.html#docplex.mp.model.Model" title="docplex.mp.model.Model"><code class="xref py py-class docutils literal notranslate"><span class="pre">docplex.mp.model.Model</span></code></a> to which the object belongs.</p> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="docplex.mp.basic.ModelObject"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">docplex.mp.basic.</span></span><span class="sig-name descname"><span class="pre">ModelObject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#ModelObject"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.ModelObject" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_AbstractModelObject</span></code></p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="docplex.mp.basic.ModelingObjectBase"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">docplex.mp.basic.</span></span><span class="sig-name descname"><span class="pre">ModelingObjectBase</span></span><a class="reference internal" href="_modules/docplex/mp/basic.html#ModelingObjectBase"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.ModelingObjectBase" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#docplex.mp.basic.ModelObject" title="docplex.mp.basic.ModelObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelObject</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">_AbstractNamable</span></code></p> <p>Parent class for all modeling objects (variables and constraints).</p> <p>This class is not intended to be instantiated directly.</p> <dl class="py method"> <dt class="sig sig-object py" id="docplex.mp.basic.ModelingObjectBase.has_name"> <span class="sig-name descname"><span class="pre">has_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#ModelingObjectBase.has_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.ModelingObjectBase.has_name" title="Permalink to this definition">¶</a></dt> <dd><p>Checks whether the object has a name.</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>True if the object has a name.</p> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="docplex.mp.basic.ModelingObjectBase.has_user_name"> <span class="sig-name descname"><span class="pre">has_user_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/docplex/mp/basic.html#ModelingObjectBase.has_user_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#docplex.mp.basic.ModelingObjectBase.has_user_name" title="Permalink to this definition">¶</a></dt> <dd><p>Checks whether the object has a valid name given by the user.</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>True if the object has a valid name given by the user.</p> </dd> </dl> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="docplex.mp.basic.ModelingObjectBase.model"> <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#docplex.mp.basic.ModelingObjectBase.model" title="Permalink to this definition">¶</a></dt> <dd><p>This property returns the <a class="reference internal" href="docplex.mp.model.html#docplex.mp.model.Model" title="docplex.mp.model.Model"><code class="xref py py-class docutils literal notranslate"><span class="pre">docplex.mp.model.Model</span></code></a> to which the object belongs.</p> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="docplex.mp.basic.ModelingObjectBase.name"> <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#docplex.mp.basic.ModelingObjectBase.name" title="Permalink to this definition">¶</a></dt> <dd><p>This property is used to get or set the name of the modeling object.</p> </dd></dl> </dd></dl> </section> <div class="clearer"></div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <div> <h3><a href="index.html">Table of Contents</a></h3> <ul> <li><a class="reference internal" href="#">docplex.mp.basic module</a><ul> <li><a class="reference internal" href="#docplex.mp.basic.Expr"><code class="docutils literal notranslate"><span class="pre">Expr</span></code></a><ul> <li><a class="reference internal" href="#docplex.mp.basic.Expr.contains_var"><code class="docutils literal notranslate"><span class="pre">Expr.contains_var()</span></code></a></li> <li><a class="reference internal" href="#docplex.mp.basic.Expr.is_quad_expr"><code class="docutils literal notranslate"><span class="pre">Expr.is_quad_expr()</span></code></a></li> <li><a class="reference internal" href="#docplex.mp.basic.Expr.number_of_variables"><code class="docutils literal notranslate"><span class="pre">Expr.number_of_variables()</span></code></a></li> </ul> </li> <li><a class="reference internal" href="#docplex.mp.basic.IndexableObject"><code class="docutils literal notranslate"><span class="pre">IndexableObject</span></code></a><ul> <li><a class="reference internal" href="#docplex.mp.basic.IndexableObject.is_generated"><code class="docutils literal notranslate"><span class="pre">IndexableObject.is_generated()</span></code></a></li> <li><a class="reference internal" href="#docplex.mp.basic.IndexableObject.model"><code class="docutils literal notranslate"><span class="pre">IndexableObject.model</span></code></a></li> </ul> </li> <li><a class="reference internal" href="#docplex.mp.basic.ModelObject"><code class="docutils literal notranslate"><span class="pre">ModelObject</span></code></a></li> <li><a class="reference internal" href="#docplex.mp.basic.ModelingObjectBase"><code class="docutils literal notranslate"><span class="pre">ModelingObjectBase</span></code></a><ul> <li><a class="reference internal" href="#docplex.mp.basic.ModelingObjectBase.has_name"><code class="docutils literal notranslate"><span class="pre">ModelingObjectBase.has_name()</span></code></a></li> <li><a class="reference internal" href="#docplex.mp.basic.ModelingObjectBase.has_user_name"><code class="docutils literal notranslate"><span class="pre">ModelingObjectBase.has_user_name()</span></code></a></li> <li><a class="reference internal" href="#docplex.mp.basic.ModelingObjectBase.model"><code class="docutils literal notranslate"><span class="pre">ModelingObjectBase.model</span></code></a></li> <li><a class="reference internal" href="#docplex.mp.basic.ModelingObjectBase.name"><code class="docutils literal notranslate"><span class="pre">ModelingObjectBase.name</span></code></a></li> </ul> </li> </ul> </li> </ul> </div> <div> <h4>Previous topic</h4> <p class="topless"><a href="refman.html" title="previous chapter"><strong>docplex.mp</strong> reference manual</a></p> </div> <div> <h4>Next topic</h4> <p class="topless"><a href="docplex.mp.callbacks.cb_mixin.html" title="next chapter">docplex.mp.callbacks.cb_mixin module</a></p> </div> <div id="searchbox" style="display: none" role="search"> <h3 id="searchlabel">Quick search</h3> <div class="searchformwrapper"> <form class="search" action="search.html" method="get"> <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> <input type="submit" value="Go" /> </form> </div> </div> <script>document.getElementById('searchbox').style.display = "block"</script> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="docplex.mp.callbacks.cb_mixin.html" title="docplex.mp.callbacks.cb_mixin module" >next</a> |</li> <li class="right" > <a href="refman.html" title="docplex.mp reference manual" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">DOcplex.MP: Mathematical Programming Modeling for Python V2.30 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="refman.html" ><strong>docplex.mp</strong> reference manual</a> »</li> <li class="nav-item nav-item-this"><a href="">docplex.mp.basic module</a></li> </ul> </div> <div class="footer" role="contentinfo"> © Copyright 2016-2022, IBM®. </div> </body> </html>