Skip to content

Commit 879b073

Browse files
committed
Add new api to docs
1 parent a22c9f6 commit 879b073

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

doc/api.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Creating a model
1717
model.Model
1818
model.Model.add_variables
1919
model.Model.add_constraints
20+
model.Model.add_quadratic_constraints
2021
model.Model.add_objective
2122
model.Model.linexpr
2223
model.Model.remove_constraints
@@ -109,6 +110,50 @@ Constraints
109110
constraints.Constraints.to_matrix
110111

111112

113+
QuadraticConstraint
114+
-------------------
115+
116+
``QuadraticConstraint`` stores quadratic constraints of the form x'Qx + a'x <= b (or >=, =).
117+
118+
.. autosummary::
119+
:toctree: generated/
120+
121+
constraints.QuadraticConstraint
122+
constraints.QuadraticConstraint.quad_coeffs
123+
constraints.QuadraticConstraint.quad_vars
124+
constraints.QuadraticConstraint.lin_coeffs
125+
constraints.QuadraticConstraint.lin_vars
126+
constraints.QuadraticConstraint.lhs
127+
constraints.QuadraticConstraint.sign
128+
constraints.QuadraticConstraint.rhs
129+
constraints.QuadraticConstraint.dual
130+
constraints.QuadraticConstraint.flat
131+
constraints.QuadraticConstraint.to_polars
132+
133+
134+
QuadraticConstraints
135+
--------------------
136+
137+
``QuadraticConstraints`` is a container for storing multiple quadratic constraint arrays.
138+
139+
.. autosummary::
140+
:toctree: generated/
141+
142+
constraints.QuadraticConstraints
143+
constraints.QuadraticConstraints.add
144+
constraints.QuadraticConstraints.remove
145+
constraints.QuadraticConstraints.inequalities
146+
constraints.QuadraticConstraints.equalities
147+
constraints.QuadraticConstraints.sanitize_zeros
148+
constraints.QuadraticConstraints.sanitize_missings
149+
constraints.QuadraticConstraints.flat
150+
constraints.QuadraticConstraints.ncons
151+
constraints.QuadraticConstraints.labels
152+
constraints.QuadraticConstraints.sign
153+
constraints.QuadraticConstraints.rhs
154+
constraints.QuadraticConstraints.dual
155+
156+
112157
IO functions
113158
============
114159

0 commit comments

Comments
 (0)