Deploying to gh-pages from @ 4dc4b38 🚀

metab0t · Jan 31, 2024 · fbd9653 · fbd9653
1 parent 8d463ee
commit fbd9653
Show file tree

Hide file tree

Showing 13 changed files with 249 additions and 37 deletions.
diff --git a/_sources/index.md.txt b/_sources/index.md.txt
@@ -21,16 +21,16 @@ The key features of PyOptInterface include:
 :widths: grid
 :align: center
 
-| Model | GRB C++ | PyOptInterface | JuMP.jl(direct) | JuMP.jl(default) | Pyomo |
-| --- | --- | --- | --- | --- | --- |
-| fac-25    | 0 | 0  | 1  | 1  | 5   |
-| fac-50    | 1 | 1  | 3  | 5  | 34  |
-| fac-75    | 2 | 4  | 9  | 12 | 115 |
-| fac-100   | 4 | 12 | 26 | 32 | 284 |
-| lqcp-500  | 1 | 0  | 2  | 5  | 24  |
-| lqcp-1000 | 2 | 2  | 6  | 9  | 100 |
-| lqcp-1500 | 4 | 5  | 18 | 23 | 232 |
-| lqcp-2000 | 8 | 10 | 40 | 49 | 403 |
+| Model     | GRB C++ | PyOptInterface | JuMP.jl(direct) | JuMP.jl(default) | Pyomo |
+|-----------|---------|----------------|-----------------|------------------|-------|
+| fac-25    | 0       | 0              | 1               | 1                | 5     |
+| fac-50    | 1       | 1              | 3               | 5                | 34    |
+| fac-75    | 2       | 4              | 9               | 12               | 115   |
+| fac-100   | 4       | 12             | 26              | 32               | 284   |
+| lqcp-500  | 1       | 0              | 2               | 5                | 24    |
+| lqcp-1000 | 2       | 2              | 6               | 9                | 100   |
+| lqcp-1500 | 4       | 5              | 18              | 23               | 232   |
+| lqcp-2000 | 8       | 10             | 40              | 49               | 403   |
 :::
 
 :::{note}

diff --git a/_sources/model.md.txt b/_sources/model.md.txt
@@ -31,21 +31,22 @@ The meanings of these standard attributes are the same as [Model attributes](htt
 
 :::{list-table} **Standard [model attributes](#pyoptinterface.ModelAttribute)**
 :header-rows: 1
+:widths: 20 20
 
 *   - Attribute name
     - Type
 *   - Name
     - str
 *   - ObjectiveSense
-    - <project:#pyoptinterface.ObjectiveSense>
+    - [ObjectiveSense](project:#pyoptinterface.ObjectiveSense)
 *   - DualStatus
-    - <project:#pyoptinterface.ResultStatusCode>
+    - [ResultStatusCode](project:#pyoptinterface.ResultStatusCode)
 *   - PrimalStatus
-    - <project:#pyoptinterface.ResultStatusCode>
+    - [ResultStatusCode](project:#pyoptinterface.ResultStatusCode)
 *   - RawStatusString
     - str
 *   - TerminationStatus
-    - <project:#pyoptinterface.TerminationStatusCode>
+    - [TerminationStatusCode](project:#pyoptinterface.TerminationStatusCode)
 *   - BarrierIterations
     - int
 *   - DualObjectiveValue

diff --git a/_sources/variable.md.txt b/_sources/variable.md.txt
@@ -22,6 +22,7 @@ After a variable is created, we can query or modify its attributes. The followin
 
 :::{list-table} **Standard [variable attributes](#pyoptinterface.VariableAttribute)**
 :header-rows: 1
+:widths: 20 20
 
 *   - Attribute name
     - Type
@@ -32,7 +33,7 @@ After a variable is created, we can query or modify its attributes. The followin
 *   - UpperBound
     - float
 *   - Domain
-    - <project:#pyoptinterface.VariableDomain>
+    - [VariableDomain](project:#pyoptinterface.VariableDomain)
 *   - PrimalStart
     - float
 *   - Value

diff --git a/api/pyoptinterface.copt.html b/api/pyoptinterface.copt.html
@@ -244,6 +244,11 @@
 <span class="sig-name descname"><span class="pre">add_quadratic_constraint</span></span><a class="headerlink" href="#pyoptinterface.copt.Model.add_quadratic_constraint" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyoptinterface.copt.Model.add_second_order_cone_constraint">
+<span class="sig-name descname"><span class="pre">add_second_order_cone_constraint</span></span><a class="headerlink" href="#pyoptinterface.copt.Model.add_second_order_cone_constraint" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pyoptinterface.copt.Model.add_sos1_constraint">
 <span class="sig-name descname"><span class="pre">add_sos1_constraint</span></span><a class="headerlink" href="#pyoptinterface.copt.Model.add_sos1_constraint" title="Link to this definition">#</a></dt>
@@ -484,9 +489,19 @@
 <span class="sig-name descname"><span class="pre">set_variable_upper_bound</span></span><a class="headerlink" href="#pyoptinterface.copt.Model.set_variable_upper_bound" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="pyoptinterface.copt.Model.supports_constraint_attribute">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">supports_constraint_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.ConstraintAttribute" title="pyoptinterface._src.attributes.ConstraintAttribute"><span class="pre">ConstraintAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.copt.Model.supports_constraint_attribute" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pyoptinterface.copt.Model.supports_model_attribute">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">supports_model_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.ModelAttribute" title="pyoptinterface._src.attributes.ModelAttribute"><span class="pre">ModelAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.copt.Model.supports_model_attribute" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="pyoptinterface.copt.Model.supports_variable_attribute">
-<span class="sig-name descname"><span class="pre">supports_variable_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.VariableAttribute" title="pyoptinterface._src.attributes.VariableAttribute"><span class="pre">VariableAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.copt.Model.supports_variable_attribute" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">supports_variable_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.VariableAttribute" title="pyoptinterface._src.attributes.VariableAttribute"><span class="pre">VariableAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.copt.Model.supports_variable_attribute" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
@@ -563,6 +578,7 @@
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.add_linear_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_linear_constraint</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.add_mip_start"><code class="docutils literal notranslate"><span class="pre">Model.add_mip_start</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.add_quadratic_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_quadratic_constraint</span></code></a></li>
+<li><a class="reference internal" href="#pyoptinterface.copt.Model.add_second_order_cone_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_second_order_cone_constraint</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.add_sos1_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_sos1_constraint</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.add_sos2_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_sos2_constraint</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.add_variable"><code class="docutils literal notranslate"><span class="pre">Model.add_variable</span></code></a></li>
@@ -611,6 +627,8 @@
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.set_variable_name"><code class="docutils literal notranslate"><span class="pre">Model.set_variable_name</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.set_variable_type"><code class="docutils literal notranslate"><span class="pre">Model.set_variable_type</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.set_variable_upper_bound"><code class="docutils literal notranslate"><span class="pre">Model.set_variable_upper_bound</span></code></a></li>
+<li><a class="reference internal" href="#pyoptinterface.copt.Model.supports_constraint_attribute"><code class="docutils literal notranslate"><span class="pre">Model.supports_constraint_attribute()</span></code></a></li>
+<li><a class="reference internal" href="#pyoptinterface.copt.Model.supports_model_attribute"><code class="docutils literal notranslate"><span class="pre">Model.supports_model_attribute()</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.supports_variable_attribute"><code class="docutils literal notranslate"><span class="pre">Model.supports_variable_attribute()</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.copt.Model.version_string"><code class="docutils literal notranslate"><span class="pre">Model.version_string</span></code></a></li>
 </ul>

diff --git a/api/pyoptinterface.gurobi.html b/api/pyoptinterface.gurobi.html
@@ -253,6 +253,11 @@
 <span class="sig-name descname"><span class="pre">add_quadratic_constraint</span></span><a class="headerlink" href="#pyoptinterface.gurobi.Model.add_quadratic_constraint" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="pyoptinterface.gurobi.Model.add_second_order_cone_constraint">
+<span class="sig-name descname"><span class="pre">add_second_order_cone_constraint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cone_variables</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.gurobi.Model.add_second_order_cone_constraint" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pyoptinterface.gurobi.Model.add_sos1_constraint">
 <span class="sig-name descname"><span class="pre">add_sos1_constraint</span></span><a class="headerlink" href="#pyoptinterface.gurobi.Model.add_sos1_constraint" title="Link to this definition">#</a></dt>
@@ -568,9 +573,19 @@
 <span class="sig-name descname"><span class="pre">set_variable_raw_attribute_string</span></span><a class="headerlink" href="#pyoptinterface.gurobi.Model.set_variable_raw_attribute_string" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="pyoptinterface.gurobi.Model.supports_constraint_attribute">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">supports_constraint_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.ConstraintAttribute" title="pyoptinterface._src.attributes.ConstraintAttribute"><span class="pre">ConstraintAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.gurobi.Model.supports_constraint_attribute" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="pyoptinterface.gurobi.Model.supports_model_attribute">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">supports_model_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.ModelAttribute" title="pyoptinterface._src.attributes.ModelAttribute"><span class="pre">ModelAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.gurobi.Model.supports_model_attribute" title="Link to this definition">#</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="pyoptinterface.gurobi.Model.supports_variable_attribute">
-<span class="sig-name descname"><span class="pre">supports_variable_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.VariableAttribute" title="pyoptinterface._src.attributes.VariableAttribute"><span class="pre">VariableAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.gurobi.Model.supports_variable_attribute" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">supports_variable_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyoptinterface.html#pyoptinterface.VariableAttribute" title="pyoptinterface._src.attributes.VariableAttribute"><span class="pre">VariableAttribute</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyoptinterface.gurobi.Model.supports_variable_attribute" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
@@ -654,6 +669,7 @@
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model"><code class="docutils literal notranslate"><span class="pre">Model</span></code></a><ul>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.add_linear_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_linear_constraint</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.add_quadratic_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_quadratic_constraint</span></code></a></li>
+<li><a class="reference internal" href="#pyoptinterface.gurobi.Model.add_second_order_cone_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_second_order_cone_constraint()</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.add_sos1_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_sos1_constraint</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.add_sos2_constraint"><code class="docutils literal notranslate"><span class="pre">Model.add_sos2_constraint</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.add_variable"><code class="docutils literal notranslate"><span class="pre">Model.add_variable</span></code></a></li>
@@ -717,6 +733,8 @@
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.set_variable_raw_attribute_double"><code class="docutils literal notranslate"><span class="pre">Model.set_variable_raw_attribute_double</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.set_variable_raw_attribute_int"><code class="docutils literal notranslate"><span class="pre">Model.set_variable_raw_attribute_int</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.set_variable_raw_attribute_string"><code class="docutils literal notranslate"><span class="pre">Model.set_variable_raw_attribute_string</span></code></a></li>
+<li><a class="reference internal" href="#pyoptinterface.gurobi.Model.supports_constraint_attribute"><code class="docutils literal notranslate"><span class="pre">Model.supports_constraint_attribute()</span></code></a></li>
+<li><a class="reference internal" href="#pyoptinterface.gurobi.Model.supports_model_attribute"><code class="docutils literal notranslate"><span class="pre">Model.supports_model_attribute()</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.supports_variable_attribute"><code class="docutils literal notranslate"><span class="pre">Model.supports_variable_attribute()</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.update"><code class="docutils literal notranslate"><span class="pre">Model.update</span></code></a></li>
 <li><a class="reference internal" href="#pyoptinterface.gurobi.Model.version_string"><code class="docutils literal notranslate"><span class="pre">Model.version_string</span></code></a></li>