5 Design Overview

5.1 Modelling

Optimizer API for Python is an interface for specifying optimization problems directly in matrix form. It means that an optimization problem such as:

\[\begin{split}\begin{array}{ll} \minimize & c^Tx \\ \st & Ax\leq b,\\ & x\in \mathcal{K} \end{array}\end{split}\]

is specified by describing the matrix \(A\), vectors \(b,c\) and a list of cones \(\mathcal{K}\) directly.

The main characteristics of this interface are:

  • Simplicity: once the problem data is assembled in matrix form, it is straightforward to input it into the optimizer.
  • Exploiting sparsity: data is entered in sparse format, enabling huge, sparse problems to be defined and solved efficiently.
  • Efficiency: the Optimizer API incurs almost no overhead between the user’s representation of the problem and MOSEK‘s internal one.

Optimizer API for Python does not aid with modeling. It is the user’s responsibility to express the problem in MOSEK‘s standard form, introducing, if necessary, auxiliary variables and constraints. See Section 12 for the precise formulations of problems MOSEK solves.

5.2 “Hello World!” in MOSEK

Here we present the most basic workflow pattern when using Optimizer API for Python.

Creating an environment and task

Every interaction with MOSEK using Optimizer API for Python begins by creating a MOSEK environment. It coordinates the access to MOSEK from the current process.

In most cases the user does not interact directly with the environment, except for creating optimization tasks, which contain actual problem specifications and where optimization takes place. An environment can host multiple tasks.

Defining tasks

After a task is created, the input data can be specified. An optimization problem consists of several components; objective, objective sense, constraints, variable bounds etc. See Section Optimization Tutorials for basic tutorials on how to specify and solve various types of optimization problems.

Retrieving the solutions

When the model is set up, the optimizer is invoked with the call to Task.optimize. When the optimization is over, the user can check the results and retrieve numerical values. See further details in Section Solver Interaction Tutorials.

We refer also to Section Solver Interaction Tutorials. for information about more advanced mechanisms of interacting with the solver

Source code example

Below is the most basic code sample that defines and solves a trivial optimization problem

\[\begin{split}\begin{array}{ll} \minimize & x \\ \st & 2.0 \leq x \leq 3.0. \\ \end{array}\end{split}\]

For simplicity the example does not contain any error or status checks.

Listing 5.1 “Hello World!” in MOSEK
from mosek import *;

x = [ 0.0 ]

with Env() as env:                            # Create Environment
  with env.Task(0, 1) as task:                # Create Task
    task.appendvars(1)                          # 1 variable x
    task.putcj(0, 1.0)                          # c_0 = 1.0
    task.putvarbound(0, boundkey.ra, 2.0, 3.0)  # 2.0 <= x <= 3.0
    task.putobjsense(objsense.minimize)         # minimize

    task.optimize()                      # Optimize

    task.getxx(soltype.itr, x)                  # Get solution
    print("Solution x = {}".format(x[0]))       # Print solution