Update docs for ipopt

Author: metab0t

docs/source/attribute/ipopt.md

@@ -0,0 +1,114 @@
+### Supported [model attribute](#pyoptinterface.ModelAttribute)
+
+:::{list-table}
+:header-rows: 1
+
+*   - Attribute
+    - Get
+    - Set
+*   - Name
+    - ❌
+    - ❌
+*   - ObjectiveSense
+    - ❌
+    - ❌
+*   - DualStatus
+    - ✅
+    - ❌
+*   - PrimalStatus
+    - ✅
+    - ❌
+*   - RawStatusString
+    - ✅
+    - ❌
+*   - TerminationStatus
+    - ✅
+    - ❌
+*   - BarrierIterations
+    - ❌
+    - ❌
+*   - DualObjectiveValue
+    - ❌
+    - ❌
+*   - NodeCount
+    - ❌
+    - ❌
+*   - NumberOfThreads
+    - ❌
+    - ❌
+*   - ObjectiveBound
+    - ❌
+    - ❌
+*   - ObjectiveValue
+    - ✅
+    - ❌
+*   - RelativeGap
+    - ❌
+    - ❌
+*   - Silent
+    - ❌
+    - ✅
+*   - SimplexIterations
+    - ❌
+    - ❌
+*   - SolverName
+    - ✅
+    - ❌
+*   - SolverVersion
+    - ❌
+    - ❌
+*   - SolveTimeSec
+    - ❌
+    - ❌
+*   - TimeLimitSec
+    - ❌
+    - ✅
+:::
+
+### Supported [variable attribute](#pyoptinterface.VariableAttribute)
+
+:::{list-table}
+:header-rows: 1
+
+*   - Attribute
+    - Get
+    - Set
+*   - Value
+    - ✅
+    - ❌
+*   - LowerBound
+    - ✅
+    - ✅
+*   - UpperBound
+    - ✅
+    - ✅
+*   - Domain
+    - ❌
+    - ❌
+*   - PrimalStart
+    - ✅
+    - ✅
+*   - Name
+    - ✅
+    - ✅
+:::
+
+### Supported [constraint attribute](#pyoptinterface.ConstraintAttribute)
+
+:::{list-table}
+:header-rows: 1
+
+*   - Attribute
+    - Get
+    - Set
+*   - Name
+    - ❌
+    - ❌
+*   - Primal
+    - ✅
+    - ❌
+*   - Dual
+    - ✅
+    - ❌
+:::
+

docs/source/changelog.md

@@ -1,7 +1,12 @@
 # Changelog
 
 ## Unreleased
+
+## 0.3.0
 - Add `model.set_variable_bounds(variable, lb, ub)` to make it easier to change variable bounds
+- Introduce nonlinear programming support of Ipopt
+- Support new versions of optimizers
+- Various minor bug fixes
 
 ## 0.2.8
 - Fix bugs in HiGHS and MOSEK when the quadratic objective function contains nondiagonal terms

docs/source/index.md

@@ -23,6 +23,7 @@ gurobi.md
 copt.md
 mosek.md
 highs.md
+ipopt.md
 benchmark.md
 changelog.md
 ```

docs/source/ipopt.md

@@ -0,0 +1,67 @@
+# Ipopt
+
+## Initial setup
+
+```python
+from pyoptinterface import ipopt
+
+model = ipopt.Model()
+```
+
+You need to follow the instructions in [Getting Started](getting_started.md#ipopt) to set up the optimizer correctly.
+
+:::{attention}
+
+Due to the internal API design of Ipopt, the `ipopt.Model` lacks some features compared to other solvers. Some of these restrictions may be lifted in the future.
+
+- It does not support `delete_variable` and `delete_constraint` methods.
+- It does not support incremental modification of linear constraint like `set_normalized_rhs` and `set_normalized_coefficient`.
+- It only supports to minimize the objective function. If you want to maximize the objective function, you need to multiply the objective function by -1 manually.
+:::
+
+## The capability of `ipopt.Model`
+
+### Supported constraints
+
+:::{list-table}
+:header-rows: 1
+
+*   - Constraint
+    - Supported
+*   - <project:#model.add_linear_constraint>
+    - ✅
+*   - <project:#model.add_quadratic_constraint>
+    - ✅
+*   - <project:#model.add_second_order_cone_constraint>
+    - ❌
+*   - <project:#model.add_sos_constraint>
+    - ❌
+*   - <project:#model.add_nl_constraint>
+    - ✅
+
+:::
+
+```{include} attribute/ipopt.md
+```
+
+
+## Solver-specific operations
+
+### Parameter
+
+For [solver-specific parameters](https://coin-or.github.io/Ipopt/OPTIONS.html), we provide `set_raw_parameter` methods to get and set the parameters.
+
+```python
+model = ipopt.Model()
+
+# set the value of the parameter
+model.set_raw_parameter("tol", 1e-5)
+model.set_raw_parameter("max_iter", 200)
+
+# For HSL library
+model.set_raw_parameter("hsllib", "/path/to/libhsl.so")
+model.set_raw_parameter("linear_solver", "ma27")
+```
+
+## JIT compiler used by Ipopt interface
+

scripts/generate_attribute_table.py

@@ -3,9 +3,7 @@
 
 
 import pyoptinterface as poi
-from pyoptinterface import gurobi, copt, mosek, highs
-
-model = gurobi.Model
+from pyoptinterface import gurobi, copt, mosek, highs, ipopt
 
 
 def attribute_support_table(f, attribute_enum):
@@ -44,6 +42,7 @@ def print_table(io: IO[str], results):
     (copt.Model, "copt"),
     (mosek.Model, "mosek"),
     (highs.Model, "highs"),
+    (ipopt.Model, "ipopt"),
 ]
 
 rootdir = Path(__file__).parent.parent