Function: parseBenchmarkParameters()

parseBenchmarkParameters(params: BenchmarkParameters, args: string[]): BenchmarkParameters

Parse benchmark parameters from command line arguments.

Parameters

Parameter	Type	Description
params	BenchmarkParameters	Input/output argument containing default values of parameters that will be overridden by command line arguments. When not specified, empty object is used
args	string[]	Command line arguments to parse. When not specified, process.argv.slice(2) is used

Returns

BenchmarkParameters

Remarks

This function parses command line arguments. In case of an error, it prints an error message and terminates the program. The default parameters can be specified using the parameter params.

When --help or -h is specified, then the function prints the usage string followed by the description of supported benchmark and engine parameters, and then terminates the program.

The description of supported parameters looks like this:

WorkerParameters can be specified for individual worker(s) using the following prefixes:

• --workerN. or --workersN. for worker N
• --workerN-M. or --workersN-M. for workers in the range N to M

For example:

• --worker0.searchType FDS sets the search type to the first worker only.
• --workers4-8.noOverlapPropagationLevel 4 sets the propagation level of noOverlap constraint for workers 4, 5, 6, 7, and 8.

parsing only solver parameters.

See

• parseSomeBenchmarkParameters for a version that allows unrecognized arguments.
• parseParameters and parseKnownParameters for parsing only solver parameters.