mp.set_manager_opt_model

class mp.set_manager_opt_model

Bases: mp.set_manager

mp.set_manager_opt_model - MP Set Manager base class for mp.opt_model fields.

sm = mp.set_manager_opt_model(label)

Implements functionality to handle parameters and solution data for set types used to implement properties of the mp.opt_model class.

mp.set_manager_opt_model Properties:

soln - struct for storing parsed solution values

mp.set_manager_opt_model Methods:

set_manager_opt_model() - constructor
params() - (abstract) return set-type-specific parameter data
set_params() - (abstract) modify set-type-specific parameter data
display_soln() - display solution values
has_parsed_soln() - return true if parsed solution is available
parse_soln() - parse solution

By convention, sm is the variable name used for mp.set_manager_opt_model objects.

Constructor Summary

set_manager_opt_model(varargin)

Constructor.

sm = mp.set_manager_opt_model(label)

Property Summary

soln: (struct) for storing parsed solution values

Method Summary

params(name, idx)

Return set-type-specific parameters.

[...] = sm.params()
[...] = sm.params(name)
[...] = sm.params(name, idx_list)

Note

This abstract method must be implemented by a subclass.

Returns set-type-specific parameters for the full set, if called without input arguments, or for a specific named or named and indexed subset.

Inputs:

name (char array) – (optional) name of subset
idx_list (cell array) – (optional) index list for subset

Outputs are determined by the implementing subclass.

set_params(name, idx, params, vals)

Modify parameter data.

sm.set_params(var, name, params, vals)
sm.set_params(var, name, idx_list, params, vals)

Note

This abstract method must be implemented by a subclass.

This method can be used to modify set-type-specific parameters for an existing subset.

Inputs:

var (mp.sm_variable) – set manager object for variables (this input is omitted for objects of subclass mp.sm_variable)
name (char array) – name of subset/block of entities to modify
idx_list (cell array) – (optional) index list for subset/block of entities modify (for an indexed subset)
params – can be one of three options:
- 'all' - indicates that vals is a cell array whose elements correspond to the input parameters of the add() method
- name of a parameter - val is the value of that parameter
- cell array of parameter names - vals is a cell array of corresponding values
vals – new value or cell array of new values corresponding to params

Valid parameter names are defined by the implementing subclass.

display_soln(var, soln, varargin)

Display solution values for generic set type.

sm.display_soln(var, soln)
sm.display_soln(var, soln, name)
sm.display_soln(var, soln, name, idx_list)
sm.display_soln(var, soln, fid)
sm.display_soln(var, soln, fid, name)
sm.display_soln(var, soln, fid, name, idx_list)

Displays the solution values for all elements (default) or an individual named or named/indexed subset.

Inputs:

var (mp.sm_variable) – corresponding mp.sm_variable object
soln (struct) – full solution struct with these fields (among others):
- eflag - exit flag, 1 = success, 0 or negative = solver-specific failure code
- x - variable values
- lambda - constraint shadow prices, struct with fields:
  eqnonlin - nonlinear equality constraints
  
  ineqnonlin - nonlinear inequality constraints
  
  mu_l - linear constraint lower bounds
  
  mu_u - linear constraint upper bounds
  
  lower - variable lower bounds
  
  upper - variable upper bounds
fid (fileID) – fileID of open file to write to (default is 1 for standard output)
name (char array) – (optional) name of individual subset
idx_list (cell array) – (optional) indices of individual subset

has_parsed_soln()

Return true if parsed solution is available.

TorF = sm.has_parsed_soln()

Output:: TorF (logical) – true if parsed solution is available in soln property; format of soln depends on implementing subclass

parse_soln(soln, stash)

Parse solution.

ps = sm.parse_soln(soln)

Parse a full solution struct into parts corresponding to individual subsets.

Input:

soln (struct) – full solution struct with these fields (among others):
- x - variable values
- lambda - constraint shadow prices, struct with fields:
  eqnonlin - nonlinear equality constraints
  
  ineqnonlin - nonlinear inequality constraints
  
  mu_l - linear constraint lower bounds
  
  mu_u - linear constraint upper bounds
  
  lower - variable lower bounds
  
  upper - variable upper bounds
stash (logical) – if true, store return value in soln property

Output:

ps (struct) – parsed solution, struct where each field is a struct whos names are the names of the relevant subsets and values are scalars for named sets, arrays for named/indexed sets; fields depend on implementing class