File tree Expand file tree Collapse file tree 11 files changed +4767
-1159
lines changed Expand file tree Collapse file tree 11 files changed +4767
-1159
lines changed Original file line number Diff line number Diff line change 2121- Fixed too strict getObjVal, getVal check
2222### Changed
2323- Changed createSol to now have an option of initialising at the current LP solution
24+ - Unified documentation style of scip.pxi to numpydocs
2425### Removed
2526
2627## 5.1.1 - 2024-06-22
Original file line number Diff line number Diff line change 11#############
2- API reference
2+ API Reference
33#############
44
55This page provides an auto-generated summary of PySCIPOpt's API.
66
7+ .. automodule :: pyscipopt
8+
79SCIP Model
810==========
911
10- .. autosummary ::
11- :toctree: _autosummary
12- :recursive:
12+ This is the main class of PySCIPOpt. Most functionality is accessible through functions
13+ of this class. All functions that require the SCIP object belong to this class.
14+
15+ .. toctree ::
16+ :maxdepth: 1
1317
14- pyscipopt.Model
18+ api/model
1519
1620SCIP Constraint
1721===============
1822
19- .. autosummary ::
20- :toctree: _autosummary
21- :recursive:
23+ This class wraps a SCIP constraint object. It contains functions that can retrieve basic information
24+ that is entirely contained within the constraint object.
25+
26+ .. toctree ::
27+ :maxdepth: 1
2228
23- pyscipopt.Constraint
29+ api/constraint
2430
2531SCIP Variable
2632=============
2733
28- .. autosummary ::
29- :toctree: _autosummary
30- :recursive:
34+ This class wraps a SCIP variable object. It contains functions that can retrieve basic information
35+ that is entirely contained within the variable object.
3136
32- pyscipopt.Variable
37+ .. toctree ::
38+ :maxdepth: 1
39+
40+ api/variable
3341
3442SCIP Row
3543========
3644
37- .. autosummary ::
38- :toctree: _autosummary
39- :recursive:
45+ This class wraps a SCIP row object. It contains functions that can retrieve basic information
46+ that is entirely contained within the row object.
47+
48+ .. toctree ::
49+ :maxdepth: 1
4050
41- pyscipopt.scip.Row
51+ api/row
4252
4353SCIP Column
4454===========
4555
46- .. autosummary ::
47- :toctree: _autosummary
48- :recursive:
56+ This class wraps a SCIP column object. It contains functions that can retrieve basic information
57+ that is entirely contained within the column object.
58+
59+ .. toctree ::
60+ :maxdepth: 1
4961
50- pyscipopt.scip.Column
62+ api/column
5163
5264SCIP Node
5365=========
5466
55- .. autosummary ::
56- :toctree: _autosummary
57- :recursive:
67+ This class wraps a SCIP node object. It contains functions that can retrieve basic information
68+ that is entirely contained within the node object.
5869
59- pyscipopt.scip.Node
70+ .. toctree ::
71+ :maxdepth: 1
6072
61- SCIP Solution
62- =============
63-
64- .. autosummary ::
65- :toctree: _autosummary
66- :recursive:
67-
68- pyscipopt.scip.Solution
73+ api/node
6974
7075SCIP Event
71- ===========
76+ ==========
77+
78+ This class wraps a SCIP event object. It contains functions that can retrieve basic information
79+ that is entirely contained within the event object.
7280
73- .. autosummary ::
74- :toctree: _autosummary
75- :recursive:
81+ .. toctree ::
82+ :maxdepth: 1
7683
77- pyscipopt.scip.Event
84+ api/event
7885
7986
Original file line number Diff line number Diff line change 1+ ##########
2+ Column API
3+ ##########
4+
5+ .. autoclass :: pyscipopt.scip.Column
6+ :members:
Original file line number Diff line number Diff line change 1+ ##############
2+ Constraint API
3+ ##############
4+
5+ .. autoclass :: pyscipopt.Constraint
6+ :members:
Original file line number Diff line number Diff line change 1+ ##########
2+ Event API
3+ ##########
4+
5+ .. autoclass :: pyscipopt.scip.Event
6+ :members:
Original file line number Diff line number Diff line change 1+ #########
2+ Model API
3+ #########
4+
5+ .. autoclass :: pyscipopt.Model
6+ :members:
Original file line number Diff line number Diff line change 1+ ########
2+ Node API
3+ ########
4+
5+ .. autoclass :: pyscipopt.scip.Node
6+ :members:
Original file line number Diff line number Diff line change 1+ #######
2+ Row API
3+ #######
4+
5+ .. autoclass :: pyscipopt.scip.Row
6+ :members:
Original file line number Diff line number Diff line change 1+ ############
2+ Variable API
3+ ############
4+
5+ .. autoclass :: pyscipopt.Variable
6+ :members:
Original file line number Diff line number Diff line change 8282# so a file named "default.css" will overwrite the builtin "default.css".
8383html_static_path = ["_static" ]
8484
85- autosummary_generate = True
86- autoclass_content = "class"
85+ autosummary_generate = False
86+ napoleon_numpy_docstring = True
87+ napoleon_google_docstring = False
8788
8889pygments_style = "sphinx"
8990
You can’t perform that action at this time.
0 commit comments