API reference#
CVXlab is designed to be intuitive enough so that it may be used without diving into APIs structures. Reading User Guide, practicing with the tutorial notebook available in the Resources section, and looking at existing models in Models gallery will suffice in acquainting you with the package. Nonetheless, API reference are here included for those who are comfortable reading technical documentation.
The package structure is illustrated in the figure below, where the main classes
and their hierarchy are shown. At the top level, cvxlab.Model orchestrates
the workflow by coordinating Core, settings utilities, and support utilities.
Core groups modelling components (Index, Database, and Problem),
with Index organizing structural abstractions (SetTable, DataTable,
and Variable), while settings classes (ModelSettings and RunSettings)
centralize configuration, and support classes (FileManager, SQLManager,
and utility functions) provide shared operational services.
The classes and functions documented in this section are those imported into the CVXlab namespace. The documentation is grouped in the following sections:
Section |
Description |
|---|---|
Documents the main package class |
|
Documents various utility functions available in the package, including the
guided interactive interface ( |
|
Documents built-in symbolic operators available in CVXlab, including standard arithmetic operations, matrix operations, and various mathematical functions. Provides guidelines on how to create new or add built-in symbolic operators to the package. |
|
Documents the various built-in constant data types available in CVXlab, necessary to assign numerical values to constants in numerical problems. Provides guidelines on how to create new or add built-in constant data types to the package. |
|
Documents the template modules included in the CVXlab package, including user-defined symbolic operators and user-defined constants. |
|
Documents the |