15.2 Functions grouped by topic¶

Callback

Task.clear_callback – Clears callbacks.
Task.clear_stream_callback – Clears a stream callback.
Task.put_callback – Receive callbacks with solver status and information during optimization.
Task.put_stream_callback – Directs all output from a task stream to a callback object.
Task.with_callbacks – Converts a task into a task with callbacks.
Task.without_callbacks – Converts a task with callbacks into a task without.
Infrequent: Task.unlink_func_from_stream

Environment and task management

Env.Env – Constructor of a new environment.
Task.Task – Constructor of a new optimization task.
Task.clone – Clones a task.
Task.put_task_name – Assigns a new name to the task.
Env.task – Creates a new task.
Task.with_callbacks – Converts a task into a task with callbacks.
Task.without_callbacks – Converts a task with callbacks into a task without.
Infrequent: Task.commit_changes, Task.delete_solution, Task.put_max_num_a_nz, Task.put_max_num_acc, Task.put_max_num_afe, Task.put_max_num_barvar, Task.put_max_num_con, Task.put_max_num_djc, Task.put_max_num_domain, Task.put_max_num_q_nz, Task.put_max_num_var, Task.resize_task
Deprecated: Task.put_max_num_cone

Infeasibility diagnostic

Task.infeasibility_report – Prints the infeasibility report to an output stream.
Task.primal_repair – Repairs a primal infeasible optimization problem by adjusting the bounds on the constraints and variables.

Information items and statistics

Task.get_dou_inf – Obtains a double information item.
Task.get_int_inf – Obtains an integer information item.
Task.get_lint_inf – Obtains a long integer information item.
Task.update_solution_info – Update the information items related to the solution.
Infrequent: Task.get_inf_index, Task.get_inf_max, Task.get_inf_name, Task.get_na_dou_inf, Task.get_na_int_inf

Input/Output

Task.write_data – Writes problem data to a file.
Task.write_solution – Write a solution to a file.
Infrequent: Task.read_b_solution, Task.read_data, Task.read_data_format, Task.read_json_sol, Task.read_json_string, Task.read_lp_string, Task.read_opf_string, Task.read_param_file, Task.read_ptf_string, Task.read_solution, Task.read_solution_file, Task.read_summary, Task.read_task, Task.write_b_solution, Task.write_data_stream, Task.write_json_sol, Task.write_param_file, Task.write_solution_file, Task.write_task

Inspecting the task

License system

Env.check_out_license – Check out a license feature from the license server ahead of time.
Env.put_license_debug – Enables debug information for the license system.
Env.put_license_path – Set the path to the license file.
Env.put_license_wait – Control whether mosek should wait for an available license if no license is available.
Infrequent: Env.check_in_all, Env.check_in_license, Env.expirylicenses, Env.license_cleanup, Env.put_license_code, Env.reset_expiry_licenses

Linear algebra

Infrequent: Env.axpy, Env.compute_sparse_cholesky, Env.dot, Env.gemm, Env.gemv, Env.potrf, Env.sparse_triangular_solve_dense, Env.syeig, Env.syevd, Env.syrk

Logging

Task.clear_stream_callback – Clears a stream callback.
Task.link_file_to_stream – Directs all output from a task stream to a file.
Task.one_solution_summary – Prints a short summary of a specified solution.
Task.optimizer_summary – Prints a short summary with optimizer statistics from last optimization.
Task.put_stream_callback – Directs all output from a task stream to a callback object.
Task.solution_summary – Prints a short summary of the current solutions.
Infrequent: Env.echo_intro, Env.link_file_to_stream, Task.print_param, Task.unlink_func_from_stream

Names

Env.get_code_desc – Obtains a short description of a response code.
Task.put_acc_name – Sets the name of an affine conic constraint.
Task.put_barvar_name – Sets the name of a semidefinite variable.
Task.put_con_name – Sets the name of a constraint.
Task.put_djc_name – Sets the name of a disjunctive constraint.
Task.put_domain_name – Sets the name of a domain.
Task.put_obj_name – Assigns a new name to the objective.
Task.put_task_name – Assigns a new name to the task.
Task.put_var_name – Sets the name of a variable.
Infrequent: Task.analyze_names, Task.generate_acc_names, Task.generate_barvar_names, Task.generate_con_names, Task.generate_djc_names, Task.generate_var_names, Task.get_acc_name, Task.get_acc_name_len, Task.get_barvar_name, Task.get_barvar_name_index, Task.get_barvar_name_len, Task.get_con_name, Task.get_con_name_index, Task.get_con_name_len, Task.get_djc_name, Task.get_djc_name_len, Task.get_domain_name, Task.get_domain_name_len, Task.get_inf_name, Task.get_max_name_len, Task.get_na_str_param, Task.get_obj_name, Task.get_obj_name_len, Task.get_param_name, Task.get_str_param, Task.get_str_param_len, Task.get_symb_con, Task.get_task_name, Task.get_task_name_len, Task.get_var_name, Task.get_var_name_index, Task.get_var_name_len, Task.is_dou_par_name, Task.is_int_par_name, Task.is_str_par_name, Task.str_to_sk, Task.which_param
Deprecated: Task.generate_cone_names, Task.get_cone_name, Task.get_cone_name_index, Task.get_cone_name_len, Task.put_cone_name, Task.str_to_cone_type

Optimization

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

Parameters

Task.put_dou_param – Sets a double parameter.
Task.put_int_param – Sets an integer parameter.
Task.put_param – Modifies the value of parameter.
Task.put_str_param – Sets a string parameter.
Task.set_defaults – Resets all parameter values.
Infrequent: Task.get_a_truncate_tol, Task.get_dou_param, Task.get_int_param, Task.get_na_dou_param, Task.get_na_int_param, Task.get_na_str_param, Task.get_num_param, Task.get_param_max, Task.get_param_name, Task.get_str_param, Task.get_str_param_len, Task.is_dou_par_name, Task.is_int_par_name, Task.is_str_par_name, Task.put_na_dou_param, Task.put_na_int_param, Task.put_na_str_param, Task.read_param_file, Env.sym_nam_to_value, Task.which_param, Task.write_param_file

Problem data - affine conic constraints

Task.append_acc – Appends an affine conic constraint to the task.
Task.get_acc_dot_y – Obtains the doty vector for an affine conic constraint.
Task.put_acc_name – Sets the name of an affine conic constraint.
Infrequent: Task.append_acc_seq, Task.append_accs, Task.append_accs_seq, Task.evaluate_acc, Task.evaluate_accs, Task.get_acc_afe_idx_list, Task.get_acc_b, Task.get_acc_barf_num_block_triplets, Task.get_acc_domain, Task.get_acc_dot_y_s, Task.get_acc_f_numnz, Task.get_acc_f_trip, Task.get_acc_g_vector, Task.get_acc_n, Task.get_acc_n_tot, Task.get_acc_name, Task.get_acc_name_len, Task.get_accs, Task.get_num_acc, Task.put_acc, Task.put_acc_b, Task.put_acc_b_j, Task.put_acc_dot_y, Task.put_acc_list, Task.put_max_num_acc

Problem data - affine expressions

Task.append_afes – Appends a number of empty affine expressions to the optimization task.
Task.put_afe_barf_entry – Inputs one entry in barF.
Task.put_afe_barf_entry_list – Inputs a list of entries in barF.
Task.put_afe_barf_row – Inputs a row of barF.
Task.put_afe_f_col – Replaces all elements in one column of the F matrix in the affine expressions.
Task.put_afe_f_entry – Replaces one entry in F.
Task.put_afe_f_entry_list – Replaces a list of entries in F.
Task.put_afe_f_row – Replaces all elements in one row of the F matrix in the affine expressions.
Task.put_afe_f_row_list – Replaces all elements in a number of rows of the F matrix in the affine expressions.
Task.put_afe_g – Replaces one element in the g vector in the affine expressions.
Task.put_afe_g_slice – Modifies a slice of the vector g.
Infrequent: Task.empty_afe_barf_row, Task.empty_afe_barf_row_list, Task.empty_afe_f_col, Task.empty_afe_f_col_list, Task.empty_afe_f_row, Task.empty_afe_f_row_list, Task.get_acc_barf_block_triplet, Task.get_afe_barf_block_triplet, Task.get_afe_barf_num_row_entries, Task.get_afe_barf_row, Task.get_afe_barf_row_info, Task.get_afe_f_num_nz, Task.get_afe_f_row, Task.get_afe_f_row_num_nz, Task.get_afe_f_trip, Task.get_afe_g, Task.get_afe_g_slice, Task.get_num_afe, Task.put_afe_barf_block_triplet, Task.put_afe_g_list, Task.put_max_num_afe

Problem data - bounds

Task.put_con_bound – Changes the bound for one constraint.
Task.put_con_bound_slice – Changes the bounds for a slice of the constraints.
Task.put_var_bound – Changes the bounds for one variable.
Task.put_var_bound_slice – Changes the bounds for a slice of the variables.
Infrequent: Task.chg_con_bound, Task.chg_var_bound, Task.get_con_bound, Task.get_con_bound_slice, Task.get_var_bound, Task.get_var_bound_slice, Task.input_data, Task.put_con_bound_list, Task.put_con_bound_list_const, Task.put_con_bound_slice_const, Task.put_var_bound_list, Task.put_var_bound_list_const, Task.put_var_bound_slice_const

Problem data - cones (deprecated)

Deprecated: Task.append_cone, Task.append_cone_seq, Task.append_cones_seq, Task.generate_cone_names, Task.get_cone, Task.get_cone_info, Task.get_cone_name, Task.get_cone_name_index, Task.get_cone_name_len, Task.get_max_num_cone, Task.get_num_cone, Task.get_num_cone_mem, Task.put_cone, Task.put_cone_name, Task.put_max_num_cone, Task.remove_cones

Problem data - constraints

Task.append_cons – Appends a number of constraints to the optimization task.
Task.get_num_con – Obtains the number of constraints.
Task.put_con_bound – Changes the bound for one constraint.
Task.put_con_bound_slice – Changes the bounds for a slice of the constraints.
Task.put_con_name – Sets the name of a constraint.
Task.remove_cons – Removes a number of constraints.
Infrequent: Task.chg_con_bound, Task.generate_con_names, Task.get_con_bound, Task.get_con_bound_slice, Task.get_con_name, Task.get_con_name_index, Task.get_con_name_len, Task.get_max_num_con, Task.get_num_q_con_k_nz, Task.get_q_con_k, Task.input_data, Task.put_con_bound_list, Task.put_con_bound_list_const, Task.put_con_bound_slice_const, Task.put_max_num_con

Problem data - disjunctive constraints

Task.append_djcs – Appends a number of empty disjunctive constraints to the task.
Task.put_djc – Inputs a disjunctive constraint.
Task.put_djc_name – Sets the name of a disjunctive constraint.
Task.put_djc_slice – Inputs a slice of disjunctive constraints.
Infrequent: Task.get_djc_afe_idx_list, Task.get_djc_b, Task.get_djc_domain_idx_list, Task.get_djc_name, Task.get_djc_name_len, Task.get_djc_num_afe, Task.get_djc_num_afe_tot, Task.get_djc_num_domain, Task.get_djc_num_domain_tot, Task.get_djc_num_term, Task.get_djc_num_term_tot, Task.get_djc_term_size_list, Task.get_djcs, Task.get_num_djc, Task.put_max_num_djc

Problem data - domain

Task.append_dual_exp_cone_domain – Appends the dual exponential cone domain.
Task.append_dual_geo_mean_cone_domain – Appends the dual geometric mean cone domain.
Task.append_dual_power_cone_domain – Appends the dual power cone domain.
Task.append_primal_exp_cone_domain – Appends the primal exponential cone domain.
Task.append_primal_geo_mean_cone_domain – Appends the primal geometric mean cone domain.
Task.append_primal_power_cone_domain – Appends the primal power cone domain.
Task.append_quadratic_cone_domain – Appends the n dimensional quadratic cone domain.
Task.append_r_domain – Appends the n dimensional real number domain.
Task.append_r_quadratic_cone_domain – Appends the n dimensional rotated quadratic cone domain.
Task.append_rminus_domain – Appends the n dimensional negative orthant to the list of domains.
Task.append_rplus_domain – Appends the n dimensional positive orthant to the list of domains.
Task.append_rzero_domain – Appends the n dimensional 0 domain.
Task.append_svec_psd_cone_domain – Appends the vectorized SVEC PSD cone domain.
Task.put_domain_name – Sets the name of a domain.
Infrequent: Task.get_domain_n, Task.get_domain_name, Task.get_domain_name_len, Task.get_domain_type, Task.get_num_domain, Task.get_power_domain_alpha, Task.get_power_domain_info, Task.put_max_num_domain

Problem data - linear part

Task.append_cons – Appends a number of constraints to the optimization task.
Task.append_vars – Appends a number of variables to the optimization task.
Task.get_num_con – Obtains the number of constraints.
Task.put_a_col – Replaces all elements in one column of the linear constraint matrix.
Task.put_a_col_slice – Replaces all elements in a sequence of columns the linear constraint matrix.
Task.put_a_row – Replaces all elements in one row of the linear constraint matrix.
Task.put_a_row_slice – Replaces all elements in several rows the linear constraint matrix.
Task.put_aij – Changes a single value in the linear coefficient matrix.
Task.put_aij_list – Changes one or more coefficients in the linear constraint matrix.
Task.put_c_j – Modifies one linear coefficient in the objective.
Task.put_c_slice – Modifies a slice of the linear objective coefficients.
Task.put_cfix – Replaces the fixed term in the objective.
Task.put_con_bound – Changes the bound for one constraint.
Task.put_con_bound_slice – Changes the bounds for a slice of the constraints.
Task.put_con_name – Sets the name of a constraint.
Task.put_obj_name – Assigns a new name to the objective.
Task.put_obj_sense – Sets the objective sense.
Task.put_var_bound – Changes the bounds for one variable.
Task.put_var_bound_slice – Changes the bounds for a slice of the variables.
Task.put_var_name – Sets the name of a variable.
Task.remove_cons – Removes a number of constraints.
Task.remove_vars – Removes a number of variables.
Infrequent: Task.chg_con_bound, Task.chg_var_bound, Task.generate_barvar_names, Task.generate_con_names, Task.generate_var_names, Task.get_a_col, Task.get_a_col_num_nz, Task.get_a_col_slice, Task.get_a_col_slice_num_nz, Task.get_a_col_slice_trip, Task.get_a_piece_num_nz, Task.get_a_row, Task.get_a_row_num_nz, Task.get_a_row_slice, Task.get_a_row_slice_num_nz, Task.get_a_row_slice_trip, Task.get_a_trip, Task.get_a_truncate_tol, Task.get_aij, Task.get_c, Task.get_c_j, Task.get_c_list, Task.get_c_slice, Task.get_cfix, Task.get_con_bound, Task.get_con_bound_slice, Task.get_con_name, Task.get_con_name_index, Task.get_con_name_len, Task.get_max_num_a_nz, Task.get_max_num_con, Task.get_max_num_var, Task.get_num_a_nz, Task.get_num_a_nz_64, Task.get_obj_sense, Task.get_var_bound, Task.get_var_bound_slice, Task.get_var_name, Task.get_var_name_index, Task.get_var_name_len, Task.input_data, Task.put_a_col_list, Task.put_a_row_list, Task.put_a_truncate_tol, Task.put_c_list, Task.put_con_bound_list, Task.put_con_bound_list_const, Task.put_con_bound_slice_const, Task.put_max_num_a_nz, Task.put_var_bound_list, Task.put_var_bound_list_const, Task.put_var_bound_slice_const

Problem data - objective

Task.put_barc_j – Changes one element in barc.
Task.put_c_j – Modifies one linear coefficient in the objective.
Task.put_c_slice – Modifies a slice of the linear objective coefficients.
Task.put_cfix – Replaces the fixed term in the objective.
Task.put_obj_name – Assigns a new name to the objective.
Task.put_obj_sense – Sets the objective sense.
Task.put_q_obj – Replaces all quadratic terms in the objective.
Task.put_q_obj_i_j – Replaces one coefficient in the quadratic term in the objective.
Infrequent: Task.put_c_list

Problem data - quadratic part

Task.put_q_con – Replaces all quadratic terms in constraints.
Task.put_q_con_k – Replaces all quadratic terms in a single constraint.
Task.put_q_obj – Replaces all quadratic terms in the objective.
Task.put_q_obj_i_j – Replaces one coefficient in the quadratic term in the objective.
Infrequent: Task.get_max_num_q_nz, Task.get_num_q_con_k_nz, Task.get_num_q_obj_nz, Task.get_q_con_k, Task.get_q_obj, Task.get_q_obj_i_j, Task.put_max_num_q_nz
Deprecated: Task.toconic

Problem data - semidefinite

Task.append_barvars – Appends semidefinite variables to the problem.
Task.append_sparse_sym_mat – Appends a general sparse symmetric matrix to the storage of symmetric matrices.
Task.append_sparse_sym_mat_list – Appends a general sparse symmetric matrix to the storage of symmetric matrices.
Task.put_afe_barf_entry – Inputs one entry in barF.
Task.put_afe_barf_entry_list – Inputs a list of entries in barF.
Task.put_afe_barf_row – Inputs a row of barF.
Task.put_bara_ij – Inputs an element of barA.
Task.put_bara_ij_list – Inputs list of elements of barA.
Task.put_bara_row_list – Replace a set of rows of barA
Task.put_barc_j – Changes one element in barc.
Task.put_barvar_name – Sets the name of a semidefinite variable.
Infrequent: Task.empty_afe_barf_row, Task.empty_afe_barf_row_list, Task.get_acc_barf_block_triplet, Task.get_acc_barf_num_block_triplets, Task.get_afe_barf_block_triplet, Task.get_afe_barf_num_block_triplets, Task.get_afe_barf_num_row_entries, Task.get_afe_barf_row, Task.get_afe_barf_row_info, Task.get_bara_block_triplet, Task.get_bara_idx, Task.get_bara_idx_i_j, Task.get_bara_idx_info, Task.get_bara_sparsity, Task.get_barc_block_triplet, Task.get_barc_idx, Task.get_barc_idx_info, Task.get_barc_idx_j, Task.get_barc_sparsity, Task.get_dim_barvar_j, Task.get_len_barvar_j, Task.get_max_num_barvar, Task.get_num_bara_block_triplets, Task.get_num_bara_nz, Task.get_num_barc_block_triplets, Task.get_num_barc_nz, Task.get_num_barvar, Task.get_num_sym_mat, Task.get_sparse_sym_mat, Task.get_sym_mat_info, Task.put_afe_barf_block_triplet, Task.put_bara_block_triplet, Task.put_barc_block_triplet, Task.put_max_num_barvar, Task.remove_barvars

Problem data - variables

Task.append_vars – Appends a number of variables to the optimization task.
Task.get_num_var – Obtains the number of variables.
Task.put_var_bound – Changes the bounds for one variable.
Task.put_var_bound_slice – Changes the bounds for a slice of the variables.
Task.put_var_name – Sets the name of a variable.
Task.put_var_type – Sets the variable type of one variable.
Task.remove_vars – Removes a number of variables.
Infrequent: Task.chg_var_bound, Task.generate_barvar_names, Task.generate_var_names, Task.get_c, Task.get_c_j, Task.get_max_num_var, Task.get_num_int_var, Task.get_var_bound, Task.get_var_bound_slice, Task.get_var_name, Task.get_var_name_index, Task.get_var_name_len, Task.get_var_type, Task.get_var_type_list, Task.put_c_list, Task.put_max_num_var, Task.put_var_bound_list, Task.put_var_bound_list_const, Task.put_var_bound_slice_const, Task.put_var_type_list

Remote optimization

Task.async_get_result – Request a solution from a remote job.
Task.async_optimize – Offload the optimization task to a solver server in asynchronous mode.
Task.async_poll – Requests information about the status of the remote job.
Task.async_stop – Request that the job identified by the token is terminated.
Task.optimize_rmt – Offload the optimization task to a solver server and wait for the solution.
Task.put_optserver_host – Specify an OptServer for remote calls.

Responses, errors and warnings

Env.get_code_desc – Obtains a short description of a response code.
Infrequent: Env.get_response_class

Sensitivity analysis

Task.dual_sensitivity – Performs sensitivity analysis on objective coefficients.
Task.primal_sensitivity – Perform sensitivity analysis on bounds.
Task.sensitivity_report – Creates a sensitivity report.

Solution - dual

Task.get_acc_dot_y – Obtains the doty vector for an affine conic constraint.
Task.get_dual_obj – Computes the dual objective value associated with the solution.
Task.get_y – Obtains the y vector for a solution.
Task.get_y_slice – Obtains a slice of the y vector for a solution.
Infrequent: Task.get_acc_dot_y_s, Task.get_reduced_costs, Task.get_slc, Task.get_slc_slice, Task.get_slx, Task.get_slx_slice, Task.get_snx, Task.get_snx_slice, Task.get_solution, Task.get_solution_new, Task.get_solution_slice, Task.get_suc, Task.get_suc_slice, Task.get_sux, Task.get_sux_slice, Task.put_acc_dot_y, Task.put_con_solution_i, Task.put_slc, Task.put_slc_slice, Task.put_slx, Task.put_slx_slice, Task.put_snx, Task.put_snx_slice, Task.put_solution, Task.put_solution_new, Task.put_solution_y_i, Task.put_suc, Task.put_suc_slice, Task.put_sux, Task.put_sux_slice, Task.put_var_solution_j, Task.put_y_slice

Solution - primal

Task.get_primal_obj – Computes the primal objective value for the desired solution.
Task.get_xx – Obtains the xx vector for a solution.
Task.get_xx_slice – Obtains a slice of the xx vector for a solution.
Task.put_xx – Sets the xx vector for a solution.
Task.put_xx_slice – Sets a slice of the xx vector for a solution.
Infrequent: Task.evaluate_acc, Task.evaluate_accs, Task.get_solution, Task.get_solution_new, Task.get_solution_slice, Task.get_xc, Task.get_xc_slice, Task.put_con_solution_i, Task.put_solution, Task.put_solution_new, Task.put_var_solution_j, Task.put_xc, Task.put_xc_slice, Task.put_y

Solution - semidefinite

Task.get_bars_j – Obtains the dual solution for a semidefinite variable.
Task.get_bars_slice – Obtains the dual solution for a sequence of semidefinite variables.
Task.get_barx_j – Obtains the primal solution for a semidefinite variable.
Task.get_barx_slice – Obtains the primal solution for a sequence of semidefinite variables.
Infrequent: Task.put_bars_j, Task.put_barx_j