Initializing help system before first use

problem.chgtolset

problem.chgtolset

Purpose
Add or change a set of convergence tolerances used for SLP variables
Synopsis
problem.chgtolset(ntol, status, tols)
Arguments
ntol 
Tolerance set for which values are to be changed. A zero value for nSLPTol will create a new set.
status 
Address of an integer holding a bitmap describing which tolerances are active in this set. See below for the settings.
tols 
Array of 9 double precision values holding the values for the corresponding tolerances.
Example
The following example creates a new tolerance set with the default values for all tolerances except the relative delta tolerance, which is set to 0.005. It then changes the value of the absolute delta and absolute impact tolerances in tolerance set 6 to 0.015 
Tols = 9*[0]
Tols[2] = 0.005
Status = 1<<2

p.chgtolset(0, 1<<2, Tols)
Tols[1] = 0.015
Tols[5] = 0.015
Status = 1<<1 | 1<<5
p.chgtolset(6, Status, Tols)
Further information
The bits in status are set to indicate that the corresponding tolerance is to be changed in the tolerance set. The meaning of the bits is as follows:

Entry / Bit Tolerance XSLP constant XSLP bit constant
0 Closure tolerance (TC) xslp_TOLSET_TC xslp_TOLSETBIT_TC
1 Absolute delta tolerance (TA) xslp_TOLSET_TA xslp_TOLSETBIT_TA
2 Relative delta tolerance (RA) xslp_TOLSET_RA xslp_TOLSETBIT_RA
3 Absolute coefficient tolerance (TM) xslp_TOLSET_TM xslp_TOLSETBIT_TM
4 Relative coefficient tolerance (RM) xslp_TOLSET_RM xslp_TOLSETBIT_RM
5 Absolute impact tolerance (TI) xslp_TOLSET_TI xslp_TOLSETBIT_TI
6 Relative impact tolerance (RI) xslp_TOLSET_RI xslp_TOLSETBIT_RI
7 Absolute slack tolerance (TS) xslp_TOLSET_TS xslp_TOLSETBIT_TS
8 Relative slack tolerance (RS) xslp_TOLSET_RS xslp_TOLSETBIT_RS

The xslp_TOLSET constants can be used to access the corresponding entry in the value arrays, while the xslp_TOLSETBIT constants are used to set or retrieve which tolerance values are used for a given SLP variable.

The members of the Tols array corresponding to nonzero bit settings in Status will be used to change the tolerance set. So, for example, if bit 3 is set in Status, then Tols[3] will replace the current value of the absolute coefficient tolerance. If a bit is not set in Status, the value of the corresponding element of Tols is unimportant.
Related topics
problem.addtolsets, problem.deltolsets, problem.gettolset, problem.loadtolsets

Parent Topic Reference Manual

© 2001-2020 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.