Initializing help system before first use

problem.getControl

Purpose
Retrieves one or more controls of a problem. Can also be used to retrieve objective controls.
Synopsis
c = problem.getControl(ctrl1, ctrl2, ..., objidx=None)
Arguments
ctrl1,ctrl2,... 
Names or numeric ids of the controls whose values to retrieve. If the objidx argument is provided, the control must be one of the following objective controls:
priority 
the priority of the objective
weight 
the weight of the objective
reltol 
the relative tolerance of the objective
abstol 
the absolute tolerance of the objective
rhs 
the constant part of the objective
objidx 
(optional) Index of the objective whose control to retrieve.
Example 
p = xpress.problem()
[...]
print("tolerance for feasibility and optimality: ",
  p.getControl('feastol'), p.getControl('miprelstop'))
all_ctrls = p.getControl()
ctrl_subset = p.getControl(['presolve', 'miprelstop', 'feastol'])
Further information
This function can be passed either a single control name, whose value will be returned, or a list of control names, in which case the return value is a dictionary associating each key in the list with its value. If no argument is provided, a dictionary containing all controls of the problem will be returned. Controls can also be specified by id. In that case the keys for those controls in a returned dictionary will be their ids.
Related topics
problem.setControl.

Parent Topic Xpress problem methods

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.