15.2 Functions grouped by topic¶

Callback

MSK_linkfunctotaskstream – Connects a user-defined function to a task stream.
MSK_putcallbackfunc – Input the progress callback function.
Infrequent: MSK_getcallbackfunc, MSK_linkfunctoenvstream, MSK_putexitfunc, MSK_putresponsefunc, MSK_unlinkfuncfromenvstream, MSK_unlinkfuncfromtaskstream

Environment and task management

MSK_clonetask – Creates a clone of an existing task.
MSK_deleteenv – Delete a MOSEK environment.
MSK_deletetask – Deletes a task.
MSK_makeenv – Creates a new MOSEK environment.
MSK_maketask – Creates a new task.
MSK_puttaskname – Assigns a new name to the task.
Infrequent: MSK_commitchanges, MSK_deletesolution, MSK_getenv, MSK_makeemptytask, MSK_putmaxnumacc, MSK_putmaxnumafe, MSK_putmaxnumanz, MSK_putmaxnumbarvar, MSK_putmaxnumcon, MSK_putmaxnumdjc, MSK_putmaxnumdomain, MSK_putmaxnumqnz, MSK_putmaxnumvar, MSK_resizetask
Deprecated: MSK_putmaxnumcone

Infeasibility diagnostic

MSK_getinfeasiblesubproblem – Obtains an infeasible subproblem.
MSK_infeasibilityreport – Prints the infeasibility report to an output stream.
MSK_primalrepair – Repairs a primal infeasible optimization problem by adjusting the bounds on the constraints and variables.

Information items and statistics

MSK_getdouinf – Obtains a double information item.
MSK_getintinf – Obtains an integer information item.
MSK_getlintinf – Obtains a long integer information item.
MSK_updatesolutioninfo – Update the information items related to the solution.
Infrequent: MSK_getinfindex, MSK_getinfmax, MSK_getinfname, MSK_getnadouinf, MSK_getnaintinf

Input/Output

MSK_readdata – Reads problem data from a file.
MSK_writedata – Writes problem data to a file.
MSK_writesolution – Write a solution to a file.
Infrequent: MSK_echotask, MSK_readbsolution, MSK_readdataautoformat, MSK_readdatacb, MSK_readdataformat, MSK_readjsonsol, MSK_readjsonstring, MSK_readlpstring, MSK_readopfstring, MSK_readparamfile, MSK_readptfstring, MSK_readsolution, MSK_readsolutionfile, MSK_readsummary, MSK_readtask, MSK_writebsolution, MSK_writebsolutionhandle, MSK_writedatahandle, MSK_writejsonsol, MSK_writeparamfile, MSK_writesolutionfile, MSK_writetask

Inspecting the task

License system

MSK_checkoutlicense – Check out a license feature from the license server ahead of time.
MSK_putlicensedebug – Enables debug information for the license system.
MSK_putlicensepath – Set the path to the license file.
MSK_putlicensewait – Control whether mosek should wait for an available license if no license is available.
Infrequent: MSK_checkinall, MSK_checkinlicense, MSK_expirylicenses, MSK_licensecleanup, MSK_putlicensecode, MSK_resetexpirylicenses

Linear algebra

Infrequent: MSK_axpy, MSK_computesparsecholesky, MSK_dot, MSK_gemm, MSK_gemv, MSK_potrf, MSK_sparsetriangularsolvedense, MSK_syeig, MSK_syevd, MSK_syrk

Logging

MSK_linkfiletotaskstream – Directs all output from a task stream to a file.
MSK_linkfunctotaskstream – Connects a user-defined function to a task stream.
MSK_onesolutionsummary – Prints a short summary of a specified solution.
MSK_optimizersummary – Prints a short summary with optimizer statistics from last optimization.
MSK_solutionsummary – Prints a short summary of the current solutions.
Infrequent: MSK_echoenv, MSK_echointro, MSK_linkfiletoenvstream, MSK_linkfunctoenvstream, MSK_printparam, MSK_putexitfunc, MSK_putresponsefunc, MSK_unlinkfuncfromenvstream, MSK_unlinkfuncfromtaskstream

Names

MSK_getcodedesc – Obtains a short description of a response code.
MSK_putaccname – Sets the name of an affine conic constraint.
MSK_putbarvarname – Sets the name of a semidefinite variable.
MSK_putconname – Sets the name of a constraint.
MSK_putdjcname – Sets the name of a disjunctive constraint.
MSK_putdomainname – Sets the name of a domain.
MSK_putobjname – Assigns a new name to the objective.
MSK_puttaskname – Assigns a new name to the task.
MSK_putvarname – Sets the name of a variable.
Infrequent: MSK_analyzenames, MSK_bktostr, MSK_callbackcodetostr, MSK_dinfitemtostr, MSK_generateaccnames, MSK_generatebarvarnames, MSK_generateconnames, MSK_generatedjcnames, MSK_generatevarnames, MSK_getaccname, MSK_getaccnamelen, MSK_getbarvarname, MSK_getbarvarnameindex, MSK_getbarvarnamelen, MSK_getconname, MSK_getconnameindex, MSK_getconnamelen, MSK_getdjcname, MSK_getdjcnamelen, MSK_getdomainname, MSK_getdomainnamelen, MSK_getinfname, MSK_getmaxnamelen, MSK_getnastrparam, MSK_getobjname, MSK_getobjnamelen, MSK_getparamname, MSK_getstrparam, MSK_getstrparamlen, MSK_getsymbcon, MSK_gettaskname, MSK_gettasknamelen, MSK_getvarname, MSK_getvarnameindex, MSK_getvarnamelen, MSK_iinfitemtostr, MSK_iparvaltosymnam, MSK_isdouparname, MSK_isintparname, MSK_isstrparname, MSK_liinfitemtostr, MSK_probtypetostr, MSK_prostatostr, MSK_rescodetostr, MSK_sktostr, MSK_solstatostr, MSK_strtosk, MSK_whichparam
Deprecated: MSK_conetypetostr, MSK_generateconenames, MSK_getconename, MSK_getconenameindex, MSK_getconenamelen, MSK_putconename, MSK_strtoconetype

Optimization

MSK_optimize – Optimizes the problem.
MSK_optimizebatch – Optimize a number of tasks in parallel using a specified number of threads.
MSK_optimizetrm – Optimizes the problem.

Parameters

MSK_putdouparam – Sets a double parameter.
MSK_putintparam – Sets an integer parameter.
MSK_putparam – Modifies the value of parameter.
MSK_putstrparam – Sets a string parameter.
MSK_setdefaults – Resets all parameter values.
Infrequent: MSK_getatruncatetol, MSK_getdouparam, MSK_getintparam, MSK_getnadouparam, MSK_getnaintparam, MSK_getnastrparam, MSK_getnastrparamal, MSK_getnumparam, MSK_getparammax, MSK_getparamname, MSK_getstrparam, MSK_getstrparamal, MSK_getstrparamlen, MSK_getsymbcondim, MSK_iparvaltosymnam, MSK_isdouparname, MSK_isintparname, MSK_isstrparname, MSK_putnadouparam, MSK_putnaintparam, MSK_putnastrparam, MSK_readparamfile, MSK_symnamtovalue, MSK_whichparam, MSK_writeparamfile

Problem data - affine conic constraints

MSK_appendacc – Appends an affine conic constraint to the task.
MSK_getaccdoty – Obtains the doty vector for an affine conic constraint.
MSK_putaccname – Sets the name of an affine conic constraint.
Infrequent: MSK_appendaccs, MSK_appendaccseq, MSK_appendaccsseq, MSK_evaluateacc, MSK_evaluateaccs, MSK_getaccafeidxlist, MSK_getaccb, MSK_getaccbarfnumblocktriplets, MSK_getaccdomain, MSK_getaccdotys, MSK_getaccfnumnz, MSK_getaccftrip, MSK_getaccgvector, MSK_getaccn, MSK_getaccname, MSK_getaccnamelen, MSK_getaccntot, MSK_getaccs, MSK_getnumacc, MSK_putacc, MSK_putaccb, MSK_putaccbj, MSK_putaccdoty, MSK_putacclist, MSK_putmaxnumacc

Problem data - affine expressions

MSK_appendafes – Appends a number of empty affine expressions to the optimization task.
MSK_putafebarfentry – Inputs one entry in barF.
MSK_putafebarfentrylist – Inputs a list of entries in barF.
MSK_putafebarfrow – Inputs a row of barF.
MSK_putafefcol – Replaces all elements in one column of the F matrix in the affine expressions.
MSK_putafefentry – Replaces one entry in F.
MSK_putafefentrylist – Replaces a list of entries in F.
MSK_putafefrow – Replaces all elements in one row of the F matrix in the affine expressions.
MSK_putafefrowlist – Replaces all elements in a number of rows of the F matrix in the affine expressions.
MSK_putafeg – Replaces one element in the g vector in the affine expressions.
MSK_putafegslice – Modifies a slice of the vector g.
Infrequent: MSK_emptyafebarfrow, MSK_emptyafebarfrowlist, MSK_emptyafefcol, MSK_emptyafefcollist, MSK_emptyafefrow, MSK_emptyafefrowlist, MSK_getaccbarfblocktriplet, MSK_getafebarfblocktriplet, MSK_getafebarfnumrowentries, MSK_getafebarfrow, MSK_getafebarfrowinfo, MSK_getafefnumnz, MSK_getafefrow, MSK_getafefrownumnz, MSK_getafeftrip, MSK_getafeg, MSK_getafegslice, MSK_getnumafe, MSK_putafebarfblocktriplet, MSK_putafeglist, MSK_putmaxnumafe

Problem data - bounds

MSK_putconbound – Changes the bound for one constraint.
MSK_putconboundslice – Changes the bounds for a slice of the constraints.
MSK_putvarbound – Changes the bounds for one variable.
MSK_putvarboundslice – Changes the bounds for a slice of the variables.
Infrequent: MSK_chgconbound, MSK_chgvarbound, MSK_getconbound, MSK_getconboundslice, MSK_getvarbound, MSK_getvarboundslice, MSK_inputdata, MSK_inputdata64, MSK_putconboundlist, MSK_putconboundlistconst, MSK_putconboundsliceconst, MSK_putvarboundlist, MSK_putvarboundlistconst, MSK_putvarboundsliceconst

Problem data - cones (deprecated)

Deprecated: MSK_appendcone, MSK_appendconeseq, MSK_appendconesseq, MSK_generateconenames, MSK_getcone, MSK_getconeinfo, MSK_getconename, MSK_getconenameindex, MSK_getconenamelen, MSK_getmaxnumcone, MSK_getnumcone, MSK_getnumconemem, MSK_putcone, MSK_putconename, MSK_putmaxnumcone, MSK_removecones

Problem data - constraints

MSK_appendcons – Appends a number of constraints to the optimization task.
MSK_getnumcon – Obtains the number of constraints.
MSK_putconbound – Changes the bound for one constraint.
MSK_putconboundslice – Changes the bounds for a slice of the constraints.
MSK_putconname – Sets the name of a constraint.
MSK_removecons – Removes a number of constraints.
Infrequent: MSK_chgconbound, MSK_generateconnames, MSK_getconbound, MSK_getconboundslice, MSK_getconname, MSK_getconnameindex, MSK_getconnamelen, MSK_getmaxnumcon, MSK_getnumqconknz, MSK_getnumqconknz64, MSK_getqconk, MSK_getqconk64, MSK_inputdata, MSK_inputdata64, MSK_putconboundlist, MSK_putconboundlistconst, MSK_putconboundsliceconst, MSK_putmaxnumcon

Problem data - disjunctive constraints

MSK_appenddjcs – Appends a number of empty disjunctive constraints to the task.
MSK_putdjc – Inputs a disjunctive constraint.
MSK_putdjcname – Sets the name of a disjunctive constraint.
MSK_putdjcslice – Inputs a slice of disjunctive constraints.
Infrequent: MSK_getdjcafeidxlist, MSK_getdjcb, MSK_getdjcdomainidxlist, MSK_getdjcname, MSK_getdjcnamelen, MSK_getdjcnumafe, MSK_getdjcnumafetot, MSK_getdjcnumdomain, MSK_getdjcnumdomaintot, MSK_getdjcnumterm, MSK_getdjcnumtermtot, MSK_getdjcs, MSK_getdjctermsizelist, MSK_getnumdjc, MSK_putmaxnumdjc

Problem data - domain

MSK_appenddualexpconedomain – Appends the dual exponential cone domain.
MSK_appenddualgeomeanconedomain – Appends the dual geometric mean cone domain.
MSK_appenddualpowerconedomain – Appends the dual power cone domain.
MSK_appendprimalexpconedomain – Appends the primal exponential cone domain.
MSK_appendprimalgeomeanconedomain – Appends the primal geometric mean cone domain.
MSK_appendprimalpowerconedomain – Appends the primal power cone domain.
MSK_appendquadraticconedomain – Appends the n dimensional quadratic cone domain.
MSK_appendrdomain – Appends the n dimensional real number domain.
MSK_appendrminusdomain – Appends the n dimensional negative orthant to the list of domains.
MSK_appendrplusdomain – Appends the n dimensional positive orthant to the list of domains.
MSK_appendrquadraticconedomain – Appends the n dimensional rotated quadratic cone domain.
MSK_appendrzerodomain – Appends the n dimensional 0 domain.
MSK_appendsvecpsdconedomain – Appends the vectorized SVEC PSD cone domain.
MSK_putdomainname – Sets the name of a domain.
Infrequent: MSK_getdomainn, MSK_getdomainname, MSK_getdomainnamelen, MSK_getdomaintype, MSK_getnumdomain, MSK_getpowerdomainalpha, MSK_getpowerdomaininfo, MSK_putmaxnumdomain

Problem data - linear part

MSK_appendcons – Appends a number of constraints to the optimization task.
MSK_appendvars – Appends a number of variables to the optimization task.
MSK_getnumcon – Obtains the number of constraints.
MSK_putacol – Replaces all elements in one column of the linear constraint matrix.
MSK_putacolslice – Replaces all elements in a sequence of columns the linear constraint matrix.
MSK_putacolslice64 – Replaces all elements in a sequence of columns the linear constraint matrix.
MSK_putaij – Changes a single value in the linear coefficient matrix.
MSK_putaijlist – Changes one or more coefficients in the linear constraint matrix.
MSK_putaijlist64 – Changes one or more coefficients in the linear constraint matrix.
MSK_putarow – Replaces all elements in one row of the linear constraint matrix.
MSK_putarowslice – Replaces all elements in several rows the linear constraint matrix.
MSK_putarowslice64 – Replaces all elements in several rows the linear constraint matrix.
MSK_putcfix – Replaces the fixed term in the objective.
MSK_putcj – Modifies one linear coefficient in the objective.
MSK_putconbound – Changes the bound for one constraint.
MSK_putconboundslice – Changes the bounds for a slice of the constraints.
MSK_putconname – Sets the name of a constraint.
MSK_putcslice – Modifies a slice of the linear objective coefficients.
MSK_putobjname – Assigns a new name to the objective.
MSK_putobjsense – Sets the objective sense.
MSK_putvarbound – Changes the bounds for one variable.
MSK_putvarboundslice – Changes the bounds for a slice of the variables.
MSK_putvarname – Sets the name of a variable.
MSK_removecons – Removes a number of constraints.
MSK_removevars – Removes a number of variables.
Infrequent: MSK_chgconbound, MSK_chgvarbound, MSK_generatebarvarnames, MSK_generateconnames, MSK_generatevarnames, MSK_getacol, MSK_getacolnumnz, MSK_getacolslice, MSK_getacolslice64, MSK_getacolslicenumnz, MSK_getacolslicenumnz64, MSK_getacolslicetrip, MSK_getaij, MSK_getapiecenumnz, MSK_getarow, MSK_getarownumnz, MSK_getarowslice, MSK_getarowslice64, MSK_getarowslicenumnz, MSK_getarowslicenumnz64, MSK_getarowslicetrip, MSK_getatrip, MSK_getatruncatetol, MSK_getc, MSK_getcfix, MSK_getcj, MSK_getclist, MSK_getconbound, MSK_getconboundslice, MSK_getconname, MSK_getconnameindex, MSK_getconnamelen, MSK_getcslice, MSK_getmaxnumanz, MSK_getmaxnumanz64, MSK_getmaxnumcon, MSK_getmaxnumvar, MSK_getnumanz, MSK_getnumanz64, MSK_getobjsense, MSK_getvarbound, MSK_getvarboundslice, MSK_getvarname, MSK_getvarnameindex, MSK_getvarnamelen, MSK_inputdata, MSK_inputdata64, MSK_putacollist, MSK_putacollist64, MSK_putarowlist, MSK_putarowlist64, MSK_putatruncatetol, MSK_putclist, MSK_putconboundlist, MSK_putconboundlistconst, MSK_putconboundsliceconst, MSK_putmaxnumanz, MSK_putvarboundlist, MSK_putvarboundlistconst, MSK_putvarboundsliceconst

Problem data - objective

MSK_putbarcj – Changes one element in barc.
MSK_putcfix – Replaces the fixed term in the objective.
MSK_putcj – Modifies one linear coefficient in the objective.
MSK_putcslice – Modifies a slice of the linear objective coefficients.
MSK_putobjname – Assigns a new name to the objective.
MSK_putobjsense – Sets the objective sense.
MSK_putqobj – Replaces all quadratic terms in the objective.
MSK_putqobjij – Replaces one coefficient in the quadratic term in the objective.
Infrequent: MSK_putclist

Problem data - quadratic part

MSK_putqcon – Replaces all quadratic terms in constraints.
MSK_putqconk – Replaces all quadratic terms in a single constraint.
MSK_putqobj – Replaces all quadratic terms in the objective.
MSK_putqobjij – Replaces one coefficient in the quadratic term in the objective.
Infrequent: MSK_getmaxnumqnz, MSK_getmaxnumqnz64, MSK_getnumqconknz, MSK_getnumqconknz64, MSK_getnumqobjnz, MSK_getnumqobjnz64, MSK_getqconk, MSK_getqconk64, MSK_getqobj, MSK_getqobj64, MSK_getqobjij, MSK_putmaxnumqnz
Deprecated: MSK_toconic

Problem data - semidefinite

MSK_appendbarvars – Appends semidefinite variables to the problem.
MSK_appendsparsesymmat – Appends a general sparse symmetric matrix to the storage of symmetric matrices.
MSK_appendsparsesymmatlist – Appends a general sparse symmetric matrix to the storage of symmetric matrices.
MSK_putafebarfentry – Inputs one entry in barF.
MSK_putafebarfentrylist – Inputs a list of entries in barF.
MSK_putafebarfrow – Inputs a row of barF.
MSK_putbaraij – Inputs an element of barA.
MSK_putbaraijlist – Inputs list of elements of barA.
MSK_putbararowlist – Replace a set of rows of barA
MSK_putbarcj – Changes one element in barc.
MSK_putbarvarname – Sets the name of a semidefinite variable.
Infrequent: MSK_emptyafebarfrow, MSK_emptyafebarfrowlist, MSK_getaccbarfblocktriplet, MSK_getaccbarfnumblocktriplets, MSK_getafebarfblocktriplet, MSK_getafebarfnumblocktriplets, MSK_getafebarfnumrowentries, MSK_getafebarfrow, MSK_getafebarfrowinfo, MSK_getbarablocktriplet, MSK_getbaraidx, MSK_getbaraidxij, MSK_getbaraidxinfo, MSK_getbarasparsity, MSK_getbarcblocktriplet, MSK_getbarcidx, MSK_getbarcidxinfo, MSK_getbarcidxj, MSK_getbarcsparsity, MSK_getdimbarvarj, MSK_getlenbarvarj, MSK_getmaxnumbarvar, MSK_getnumbarablocktriplets, MSK_getnumbaranz, MSK_getnumbarcblocktriplets, MSK_getnumbarcnz, MSK_getnumbarvar, MSK_getnumsymmat, MSK_getsparsesymmat, MSK_getsymmatinfo, MSK_putafebarfblocktriplet, MSK_putbarablocktriplet, MSK_putbarcblocktriplet, MSK_putmaxnumbarvar, MSK_removebarvars

Problem data - variables

MSK_appendvars – Appends a number of variables to the optimization task.
MSK_getnumvar – Obtains the number of variables.
MSK_putvarbound – Changes the bounds for one variable.
MSK_putvarboundslice – Changes the bounds for a slice of the variables.
MSK_putvarname – Sets the name of a variable.
MSK_putvartype – Sets the variable type of one variable.
MSK_removevars – Removes a number of variables.
Infrequent: MSK_chgvarbound, MSK_generatebarvarnames, MSK_generatevarnames, MSK_getc, MSK_getcj, MSK_getmaxnumvar, MSK_getnumintvar, MSK_getvarbound, MSK_getvarboundslice, MSK_getvarname, MSK_getvarnameindex, MSK_getvarnamelen, MSK_getvartype, MSK_getvartypelist, MSK_putclist, MSK_putmaxnumvar, MSK_putvarboundlist, MSK_putvarboundlistconst, MSK_putvarboundsliceconst, MSK_putvartypelist

Remote optimization

MSK_asyncgetresult – Request a solution from a remote job.
MSK_asyncoptimize – Offload the optimization task to a solver server in asynchronous mode.
MSK_asyncpoll – Requests information about the status of the remote job.
MSK_asyncstop – Request that the job identified by the token is terminated.
MSK_optimizermt – Offload the optimization task to a solver server and wait for the solution.
MSK_putoptserverhost – Specify an OptServer for remote calls.

Responses, errors and warnings

MSK_getcodedesc – Obtains a short description of a response code.
Infrequent: MSK_getlasterror, MSK_getlasterror64, MSK_getresponseclass

Sensitivity analysis

MSK_dualsensitivity – Performs sensitivity analysis on objective coefficients.
MSK_primalsensitivity – Perform sensitivity analysis on bounds.
MSK_sensitivityreport – Creates a sensitivity report.

Solution - dual

MSK_getaccdoty – Obtains the doty vector for an affine conic constraint.
MSK_getdualobj – Computes the dual objective value associated with the solution.
MSK_gety – Obtains the y vector for a solution.
MSK_getyslice – Obtains a slice of the y vector for a solution.
Infrequent: MSK_getaccdotys, MSK_getreducedcosts, MSK_getslc, MSK_getslcslice, MSK_getslx, MSK_getslxslice, MSK_getsnx, MSK_getsnxslice, MSK_getsolution, MSK_getsolutionnew, MSK_getsolutionslice, MSK_getsuc, MSK_getsucslice, MSK_getsux, MSK_getsuxslice, MSK_putaccdoty, MSK_putconsolutioni, MSK_putslc, MSK_putslcslice, MSK_putslx, MSK_putslxslice, MSK_putsnx, MSK_putsnxslice, MSK_putsolution, MSK_putsolutionnew, MSK_putsolutionyi, MSK_putsuc, MSK_putsucslice, MSK_putsux, MSK_putsuxslice, MSK_putvarsolutionj, MSK_putyslice

Solution - primal

MSK_getprimalobj – Computes the primal objective value for the desired solution.
MSK_getxx – Obtains the xx vector for a solution.
MSK_getxxslice – Obtains a slice of the xx vector for a solution.
MSK_putxx – Sets the xx vector for a solution.
MSK_putxxslice – Sets a slice of the xx vector for a solution.
Infrequent: MSK_evaluateacc, MSK_evaluateaccs, MSK_getsolution, MSK_getsolutionnew, MSK_getsolutionslice, MSK_getxc, MSK_getxcslice, MSK_putconsolutioni, MSK_putsolution, MSK_putsolutionnew, MSK_putvarsolutionj, MSK_putxc, MSK_putxcslice, MSK_puty

Solution - semidefinite

MSK_getbarsj – Obtains the dual solution for a semidefinite variable.
MSK_getbarsslice – Obtains the dual solution for a sequence of semidefinite variables.
MSK_getbarxj – Obtains the primal solution for a semidefinite variable.
MSK_getbarxslice – Obtains the primal solution for a sequence of semidefinite variables.
Infrequent: MSK_putbarsj, MSK_putbarxj