Initializing help system before first use

problem.msAddCustomPreset

Purpose
A combined version of problem.msAddJob and problem.msAddPreset. The preset described is loaded, topped up with the specific settings supplied
Topic areas
Multistart, Data Input, Nonlinear
Synopsis
problem.msAddCustomPreset(preset, maxjobs, description=None, colind=None, initial=None, control=None, data=None)
Arguments
preset: int 
Which preset to load.
maxjobs: int 
Maximum number of jobs to be added to the multistart pool.
description: str 
Text description of the job. Used for messaging, may be None if not required.
colind: list[var] 
Indices of the variables for which to set an initial value. May be None if no initial values are provided.
initial: list[float] 
Initial values for the variables for which to set an initial value. May be None if no initial values are provided.
control: dict 
Python dictionary with control strings as keys and numbers as values. Note that only numerical controls are allowed.
data: Any 
Job-specific user context object to be passed to the multistart callbacks.
Further information
1. This function allows for repeatedly calling the same multistart preset (e.g. initial values) using different basic controls.
2. The following presets are defined:
xpress.constants.MSSET_INITIALVALUES
generate maxjobs number of random base points.
xpress.constants.MSSET_SOLVERS
load all solvers.
xpress.constants.MSSET_SLP_BASIC
load the most typical SLP tuning settings. A maximum of maxjobs jobs are loaded.
xpress.constants.MSSET_SLP_EXTENDED
load a comprehensive set of SLP tuning settings. A maximum of maxjobs jobs are loaded.
xpress.constants.MSSET_KNITRO_BASIC
load the most typical Knitro tuning settings. A maximum of maxjobs jobs are loaded.
xpress.constants.MSSET_KNITRO_EXTENDED
load a comprehensive set of Knitro tuning settings. A maximum of maxjobs jobs are loaded.
xpress.constants.MSSET_INITIALFILTERED
generate maxjobs number of random base points, filtered by a merit function centred on initial feasibility.
3. See MSMAXBOUNDRANGE for controlling the range in which initial values are generated.
4. Argument colind may contain either xpress.var objects or integer indices.
Related topics
problem.msAddPreset, problem.msAddJob, problem.msClear

Parent Topic Xpress problem object methods

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