15.2 Functions grouped by topic¶

Callback

Task.set_InfoCallback – Receive callbacks with solver status and information during optimization.
Task.set_Progress – Receive callbacks about current status of the solver during optimization.
Task.set_Stream – Directs all output from a task stream to a callback object.
Task.unset_Progress – Deactivates all user callback functions.
Infrequent: Task.set_ItgSolutionCallback, Env.set_Stream

Environment and task management

Env.Env – Constructor of a new environment.
Task.Task – Constructor of a new optimization task.
Task.dispose – Free the underlying native allocation.
Env.dispose – Free the underlying native allocation.
Task.puttaskname – Assigns a new name to the task.
Infrequent: Task.commitchanges, Task.deletesolution, Task.putmaxnumacc, Task.putmaxnumafe, Task.putmaxnumanz, Task.putmaxnumbarvar, Task.putmaxnumcon, Task.putmaxnumdjc, Task.putmaxnumdomain, Task.putmaxnumqnz, Task.putmaxnumvar, Task.resizetask
Deprecated: Task.putmaxnumcone

Infeasibility diagnostic

Task.getinfeasiblesubproblem – Obtains an infeasible subproblem.
Task.infeasibilityreport – Prints the infeasibility report to an output stream.
Task.primalrepair – Repairs a primal infeasible optimization problem by adjusting the bounds on the constraints and variables.

Information items and statistics

Task.getdouinf – Obtains a double information item.
Task.getintinf – Obtains an integer information item.
Task.getlintinf – Obtains a long integer information item.
Task.updatesolutioninfo – Update the information items related to the solution.
Infrequent: Task.getinfindex, Task.getinfmax, Task.getinfname

Input/Output

Task.writedata – Writes problem data to a file.
Task.writesolution – Write a solution to a file.
Infrequent: Task.readbsolution, Task.readdata, Task.readdataformat, Task.readjsonsol, Task.readjsonstring, Task.readlpstring, Task.readopfstring, Task.readparamfile, Task.readptfstring, Task.readsolution, Task.readsolutionfile, Task.readsummary, Task.readtask, Task.writebsolution, Task.writedatastream, Task.writejsonsol, Task.writeparamfile, Task.writesolutionfile, Task.writetask

Inspecting the task

License system

Env.checkoutlicense – Check out a license feature from the license server ahead of time.
Env.putlicensedebug – Enables debug information for the license system.
Env.putlicensepath – Set the path to the license file.
Env.putlicensewait – Control whether mosek should wait for an available license if no license is available.
Infrequent: Env.checkinall, Env.checkinlicense, Env.expirylicenses, Env.licensecleanup, Env.putlicensecode, Env.resetexpirylicenses

Linear algebra

Infrequent: Env.axpy, Env.computesparsecholesky, Env.dot, Env.gemm, Env.gemv, Env.potrf, Env.sparsetriangularsolvedense, Env.syeig, Env.syevd, Env.syrk

Logging

Task.linkfiletostream – Directs all output from a task stream to a file.
Task.onesolutionsummary – Prints a short summary of a specified solution.
Task.optimizersummary – Prints a short summary with optimizer statistics from last optimization.
Task.set_Stream – Directs all output from a task stream to a callback object.
Task.solutionsummary – Prints a short summary of the current solutions.
Infrequent: Env.echointro, Env.linkfiletostream, Env.set_Stream

Names

Env.getcodedesc – Obtains a short description of a response code.
Task.putaccname – Sets the name of an affine conic constraint.
Task.putbarvarname – Sets the name of a semidefinite variable.
Task.putconname – Sets the name of a constraint.
Task.putdjcname – Sets the name of a disjunctive constraint.
Task.putdomainname – Sets the name of a domain.
Task.putobjname – Assigns a new name to the objective.
Task.puttaskname – Assigns a new name to the task.
Task.putvarname – Sets the name of a variable.
Infrequent: Task.analyzenames, Task.generateaccnames, Task.generatebarvarnames, Task.generateconnames, Task.generatedjcnames, Task.generatevarnames, Task.getaccname, Task.getaccnamelen, Task.getbarvarname, Task.getbarvarnameindex, Task.getbarvarnamelen, Task.getconname, Task.getconnameindex, Task.getconnamelen, Task.getdjcname, Task.getdjcnamelen, Task.getdomainname, Task.getdomainnamelen, Task.getinfname, Task.getobjname, Task.getobjnamelen, Task.getparamname, Task.getstrparam, Task.getstrparamlen, Task.gettaskname, Task.gettasknamelen, Task.getvarname, Task.getvarnameindex, Task.getvarnamelen, Task.isdouparname, Task.isintparname, Task.isstrparname, Task.strtosk
Deprecated: Task.generateconenames, Task.getconename, Task.getconenameindex, Task.getconenamelen, Task.putconename, Task.strtoconetype

Optimization

Task.optimize – Optimizes the problem.
Env.optimizebatch – Optimize a number of tasks in parallel using a specified number of threads.

Parameters

Task.putdouparam – Sets a double parameter.
Task.putintparam – Sets an integer parameter.
Task.putparam – Modifies the value of parameter.
Task.putstrparam – Sets a string parameter.
Task.setdefaults – Resets all parameter values.
Infrequent: Task.getatruncatetol, Task.getdouparam, Task.getintparam, Task.getnumparam, Task.getparammax, Task.getparamname, Task.getstrparam, Task.getstrparamlen, Task.isdouparname, Task.isintparname, Task.isstrparname, Task.putnadouparam, Task.putnaintparam, Task.putnastrparam, Task.readparamfile, Task.writeparamfile

Problem data - affine conic constraints

Task.appendacc – Appends an affine conic constraint to the task.
Task.getaccdoty – Obtains the doty vector for an affine conic constraint.
Task.putaccname – Sets the name of an affine conic constraint.
Infrequent: Task.appendaccs, Task.appendaccseq, Task.appendaccsseq, Task.evaluateacc, Task.evaluateaccs, Task.getaccafeidxlist, Task.getaccb, Task.getaccbarfnumblocktriplets, Task.getaccdomain, Task.getaccdotys, Task.getaccfnumnz, Task.getaccftrip, Task.getaccgvector, Task.getaccn, Task.getaccname, Task.getaccnamelen, Task.getaccntot, Task.getaccs, Task.getnumacc, Task.putacc, Task.putaccb, Task.putaccbj, Task.putaccdoty, Task.putacclist, Task.putmaxnumacc

Problem data - affine expressions

Task.appendafes – Appends a number of empty affine expressions to the optimization task.
Task.putafebarfentry – Inputs one entry in barF.
Task.putafebarfentrylist – Inputs a list of entries in barF.
Task.putafebarfrow – Inputs a row of barF.
Task.putafefcol – Replaces all elements in one column of the F matrix in the affine expressions.
Task.putafefentry – Replaces one entry in F.
Task.putafefentrylist – Replaces a list of entries in F.
Task.putafefrow – Replaces all elements in one row of the F matrix in the affine expressions.
Task.putafefrowlist – Replaces all elements in a number of rows of the F matrix in the affine expressions.
Task.putafeg – Replaces one element in the g vector in the affine expressions.
Task.putafegslice – Modifies a slice of the vector g.
Infrequent: Task.emptyafebarfrow, Task.emptyafebarfrowlist, Task.emptyafefcol, Task.emptyafefcollist, Task.emptyafefrow, Task.emptyafefrowlist, Task.getaccbarfblocktriplet, Task.getafebarfblocktriplet, Task.getafebarfnumrowentries, Task.getafebarfrow, Task.getafebarfrowinfo, Task.getafefnumnz, Task.getafefrow, Task.getafefrownumnz, Task.getafeftrip, Task.getafeg, Task.getafegslice, Task.getnumafe, Task.putafebarfblocktriplet, Task.putafeglist, Task.putmaxnumafe

Problem data - bounds

Task.putconbound – Changes the bound for one constraint.
Task.putconboundslice – Changes the bounds for a slice of the constraints.
Task.putvarbound – Changes the bounds for one variable.
Task.putvarboundslice – Changes the bounds for a slice of the variables.
Infrequent: Task.chgconbound, Task.chgvarbound, Task.getconbound, Task.getconboundslice, Task.getvarbound, Task.getvarboundslice, Task.inputdata, Task.putconboundlist, Task.putconboundlistconst, Task.putconboundsliceconst, Task.putvarboundlist, Task.putvarboundlistconst, Task.putvarboundsliceconst

Problem data - cones (deprecated)

Deprecated: Task.appendcone, Task.appendconeseq, Task.appendconesseq, Task.generateconenames, Task.getcone, Task.getconeinfo, Task.getconename, Task.getconenameindex, Task.getconenamelen, Task.getmaxnumcone, Task.getnumcone, Task.getnumconemem, Task.putcone, Task.putconename, Task.putmaxnumcone, Task.removecones

Problem data - constraints

Task.appendcons – Appends a number of constraints to the optimization task.
Task.getnumcon – Obtains the number of constraints.
Task.putconbound – Changes the bound for one constraint.
Task.putconboundslice – Changes the bounds for a slice of the constraints.
Task.putconname – Sets the name of a constraint.
Task.removecons – Removes a number of constraints.
Infrequent: Task.chgconbound, Task.generateconnames, Task.getconbound, Task.getconboundslice, Task.getconname, Task.getconnameindex, Task.getconnamelen, Task.getmaxnumcon, Task.getnumqconknz, Task.getqconk, Task.inputdata, Task.putconboundlist, Task.putconboundlistconst, Task.putconboundsliceconst, Task.putmaxnumcon

Problem data - disjunctive constraints

Task.appenddjcs – Appends a number of empty disjunctive constraints to the task.
Task.putdjc – Inputs a disjunctive constraint.
Task.putdjcname – Sets the name of a disjunctive constraint.
Task.putdjcslice – Inputs a slice of disjunctive constraints.
Infrequent: Task.getdjcafeidxlist, Task.getdjcb, Task.getdjcdomainidxlist, Task.getdjcname, Task.getdjcnamelen, Task.getdjcnumafe, Task.getdjcnumafetot, Task.getdjcnumdomain, Task.getdjcnumdomaintot, Task.getdjcnumterm, Task.getdjcnumtermtot, Task.getdjcs, Task.getdjctermsizelist, Task.getnumdjc, Task.putmaxnumdjc

Problem data - domain

Task.appenddualexpconedomain – Appends the dual exponential cone domain.
Task.appenddualgeomeanconedomain – Appends the dual geometric mean cone domain.
Task.appenddualpowerconedomain – Appends the dual power cone domain.
Task.appendprimalexpconedomain – Appends the primal exponential cone domain.
Task.appendprimalgeomeanconedomain – Appends the primal geometric mean cone domain.
Task.appendprimalpowerconedomain – Appends the primal power cone domain.
Task.appendquadraticconedomain – Appends the n dimensional quadratic cone domain.
Task.appendrdomain – Appends the n dimensional real number domain.
Task.appendrminusdomain – Appends the n dimensional negative orthant to the list of domains.
Task.appendrplusdomain – Appends the n dimensional positive orthant to the list of domains.
Task.appendrquadraticconedomain – Appends the n dimensional rotated quadratic cone domain.
Task.appendrzerodomain – Appends the n dimensional 0 domain.
Task.appendsvecpsdconedomain – Appends the vectorized SVEC PSD cone domain.
Task.putdomainname – Sets the name of a domain.
Infrequent: Task.getdomainn, Task.getdomainname, Task.getdomainnamelen, Task.getdomaintype, Task.getnumdomain, Task.getpowerdomainalpha, Task.getpowerdomaininfo, Task.putmaxnumdomain

Problem data - linear part

Task.appendcons – Appends a number of constraints to the optimization task.
Task.appendvars – Appends a number of variables to the optimization task.
Task.getnumcon – Obtains the number of constraints.
Task.putacol – Replaces all elements in one column of the linear constraint matrix.
Task.putacolslice – Replaces all elements in a sequence of columns the linear constraint matrix.
Task.putaij – Changes a single value in the linear coefficient matrix.
Task.putaijlist – Changes one or more coefficients in the linear constraint matrix.
Task.putarow – Replaces all elements in one row of the linear constraint matrix.
Task.putarowslice – Replaces all elements in several rows the linear constraint matrix.
Task.putcfix – Replaces the fixed term in the objective.
Task.putcj – Modifies one linear coefficient in the objective.
Task.putconbound – Changes the bound for one constraint.
Task.putconboundslice – Changes the bounds for a slice of the constraints.
Task.putconname – Sets the name of a constraint.
Task.putcslice – Modifies a slice of the linear objective coefficients.
Task.putobjname – Assigns a new name to the objective.
Task.putobjsense – Sets the objective sense.
Task.putvarbound – Changes the bounds for one variable.
Task.putvarboundslice – Changes the bounds for a slice of the variables.
Task.putvarname – Sets the name of a variable.
Task.removecons – Removes a number of constraints.
Task.removevars – Removes a number of variables.
Infrequent: Task.chgconbound, Task.chgvarbound, Task.generatebarvarnames, Task.generateconnames, Task.generatevarnames, Task.getacol, Task.getacolnumnz, Task.getacolslice, Task.getacolslicenumnz, Task.getacolslicetrip, Task.getaij, Task.getapiecenumnz, Task.getarow, Task.getarownumnz, Task.getarowslice, Task.getarowslicenumnz, Task.getarowslicetrip, Task.getatrip, Task.getatruncatetol, Task.getc, Task.getcfix, Task.getcj, Task.getclist, Task.getconbound, Task.getconboundslice, Task.getconname, Task.getconnameindex, Task.getconnamelen, Task.getcslice, Task.getmaxnumanz, Task.getmaxnumcon, Task.getmaxnumvar, Task.getnumanz, Task.getnumanz64, Task.getobjsense, Task.getvarbound, Task.getvarboundslice, Task.getvarname, Task.getvarnameindex, Task.getvarnamelen, Task.inputdata, Task.putacollist, Task.putarowlist, Task.putatruncatetol, Task.putclist, Task.putconboundlist, Task.putconboundlistconst, Task.putconboundsliceconst, Task.putmaxnumanz, Task.putvarboundlist, Task.putvarboundlistconst, Task.putvarboundsliceconst

Problem data - objective

Task.putbarcj – Changes one element in barc.
Task.putcfix – Replaces the fixed term in the objective.
Task.putcj – Modifies one linear coefficient in the objective.
Task.putcslice – Modifies a slice of the linear objective coefficients.
Task.putobjname – Assigns a new name to the objective.
Task.putobjsense – Sets the objective sense.
Task.putqobj – Replaces all quadratic terms in the objective.
Task.putqobjij – Replaces one coefficient in the quadratic term in the objective.
Infrequent: Task.putclist

Problem data - quadratic part

Task.putqcon – Replaces all quadratic terms in constraints.
Task.putqconk – Replaces all quadratic terms in a single constraint.
Task.putqobj – Replaces all quadratic terms in the objective.
Task.putqobjij – Replaces one coefficient in the quadratic term in the objective.
Infrequent: Task.getmaxnumqnz, Task.getnumqconknz, Task.getnumqobjnz, Task.getqconk, Task.getqobj, Task.getqobjij, Task.putmaxnumqnz
Deprecated: Task.toconic

Problem data - semidefinite

Task.appendbarvars – Appends semidefinite variables to the problem.
Task.appendsparsesymmat – Appends a general sparse symmetric matrix to the storage of symmetric matrices.
Task.appendsparsesymmatlist – Appends a general sparse symmetric matrix to the storage of symmetric matrices.
Task.putafebarfentry – Inputs one entry in barF.
Task.putafebarfentrylist – Inputs a list of entries in barF.
Task.putafebarfrow – Inputs a row of barF.
Task.putbaraij – Inputs an element of barA.
Task.putbaraijlist – Inputs list of elements of barA.
Task.putbararowlist – Replace a set of rows of barA
Task.putbarcj – Changes one element in barc.
Task.putbarvarname – Sets the name of a semidefinite variable.
Infrequent: Task.emptyafebarfrow, Task.emptyafebarfrowlist, Task.getaccbarfblocktriplet, Task.getaccbarfnumblocktriplets, Task.getafebarfblocktriplet, Task.getafebarfnumblocktriplets, Task.getafebarfnumrowentries, Task.getafebarfrow, Task.getafebarfrowinfo, Task.getbarablocktriplet, Task.getbaraidx, Task.getbaraidxij, Task.getbaraidxinfo, Task.getbarasparsity, Task.getbarcblocktriplet, Task.getbarcidx, Task.getbarcidxinfo, Task.getbarcidxj, Task.getbarcsparsity, Task.getdimbarvarj, Task.getlenbarvarj, Task.getmaxnumbarvar, Task.getnumbarablocktriplets, Task.getnumbaranz, Task.getnumbarcblocktriplets, Task.getnumbarcnz, Task.getnumbarvar, Task.getnumsymmat, Task.getsparsesymmat, Task.getsymmatinfo, Task.putafebarfblocktriplet, Task.putbarablocktriplet, Task.putbarcblocktriplet, Task.putmaxnumbarvar, Task.removebarvars

Problem data - variables

Task.appendvars – Appends a number of variables to the optimization task.
Task.getnumvar – Obtains the number of variables.
Task.putvarbound – Changes the bounds for one variable.
Task.putvarboundslice – Changes the bounds for a slice of the variables.
Task.putvarname – Sets the name of a variable.
Task.putvartype – Sets the variable type of one variable.
Task.removevars – Removes a number of variables.
Infrequent: Task.chgvarbound, Task.generatebarvarnames, Task.generatevarnames, Task.getc, Task.getcj, Task.getmaxnumvar, Task.getnumintvar, Task.getvarbound, Task.getvarboundslice, Task.getvarname, Task.getvarnameindex, Task.getvarnamelen, Task.getvartype, Task.getvartypelist, Task.putclist, Task.putmaxnumvar, Task.putvarboundlist, Task.putvarboundlistconst, Task.putvarboundsliceconst, Task.putvartypelist

Remote optimization

Task.asyncgetresult – Request a solution from a remote job.
Task.asyncoptimize – Offload the optimization task to a solver server in asynchronous mode.
Task.asyncpoll – Requests information about the status of the remote job.
Task.asyncstop – Request that the job identified by the token is terminated.
Task.optimizermt – Offload the optimization task to a solver server and wait for the solution.
Task.putoptserverhost – Specify an OptServer for remote calls.

Responses, errors and warnings

Env.getcodedesc – Obtains a short description of a response code.

Sensitivity analysis

Task.dualsensitivity – Performs sensitivity analysis on objective coefficients.
Task.primalsensitivity – Perform sensitivity analysis on bounds.
Task.sensitivityreport – Creates a sensitivity report.

Solution - dual

Task.getaccdoty – Obtains the doty vector for an affine conic constraint.
Task.getdualobj – Computes the dual objective value associated with the solution.
Task.gety – Obtains the y vector for a solution.
Task.getyslice – Obtains a slice of the y vector for a solution.
Infrequent: Task.getaccdotys, Task.getreducedcosts, Task.getslc, Task.getslcslice, Task.getslx, Task.getslxslice, Task.getsnx, Task.getsnxslice, Task.getsolution, Task.getsolutionnew, Task.getsolutionslice, Task.getsuc, Task.getsucslice, Task.getsux, Task.getsuxslice, Task.putaccdoty, Task.putconsolutioni, Task.putslc, Task.putslcslice, Task.putslx, Task.putslxslice, Task.putsnx, Task.putsnxslice, Task.putsolution, Task.putsolutionnew, Task.putsolutionyi, Task.putsuc, Task.putsucslice, Task.putsux, Task.putsuxslice, Task.putvarsolutionj, Task.putyslice

Solution - primal

Task.getprimalobj – Computes the primal objective value for the desired solution.
Task.getxx – Obtains the xx vector for a solution.
Task.getxxslice – Obtains a slice of the xx vector for a solution.
Task.putxx – Sets the xx vector for a solution.
Task.putxxslice – Sets a slice of the xx vector for a solution.
Infrequent: Task.evaluateacc, Task.evaluateaccs, Task.getsolution, Task.getsolutionnew, Task.getsolutionslice, Task.getxc, Task.getxcslice, Task.putconsolutioni, Task.putsolution, Task.putsolutionnew, Task.putvarsolutionj, Task.putxc, Task.putxcslice, Task.puty

Solution - semidefinite

Task.getbarsj – Obtains the dual solution for a semidefinite variable.
Task.getbarsslice – Obtains the dual solution for a sequence of semidefinite variables.
Task.getbarxj – Obtains the primal solution for a semidefinite variable.
Task.getbarxslice – Obtains the primal solution for a sequence of semidefinite variables.
Infrequent: Task.putbarsj, Task.putbarxj

Solution information

Task.getdualobj – Computes the dual objective value associated with the solution.
Task.getprimalobj – Computes the primal objective value for the desired solution.
Task.getprosta – Obtains the problem status.
Task.getpviolcon – Computes the violation of a primal solution associated to a constraint.
Task.getpviolvar – Computes the violation of a primal solution for a list of scalar variables.
Task.getsolsta – Obtains the solution status.
Task.getsolutioninfo – Obtains information about of a solution.
Task.getsolutioninfonew – Obtains information about of a solution.
Task.onesolutionsummary – Prints a short summary of a specified solution.
Task.solutiondef – Checks whether a solution is defined.
Task.solutionsummary – Prints a short summary of the current solutions.
Infrequent: Task.analyzesolution, Task.deletesolution, Task.getdualsolutionnorms, Task.getdviolacc, Task.getdviolbarvar, Task.getdviolcon, Task.getdviolvar, Task.getprimalsolutionnorms, Task.getpviolacc, Task.getpviolbarvar, Task.getpvioldjc, Task.getskc, Task.getskcslice, Task.getskn, Task.getskx, Task.getskxslice, Task.getsolution, Task.getsolutionnew, Task.getsolutionslice, Task.putconsolutioni, Task.putskc, Task.putskcslice, Task.putskx, Task.putskxslice, Task.putsolution, Task.putsolutionnew, Task.putsolutionyi, Task.putvarsolutionj
Deprecated: Task.getdviolcones, Task.getpviolcones

Solving systems with basis matrix

Infrequent: Task.basiscond, Task.initbasissolve, Task.solvewithbasis

System, memory and debugging

Infrequent: Task.checkmem, Task.getmemusage

Versions

Env.getversion – Obtains MOSEK version information.

15.2 Functions grouped by topic¶

Table of Contents

Download PDF

Modeling Cookbook

Cheatsheet