Class ParameterSet

Constructor of the ParameterSet class.

This class is not meant to be instantiated directly nor used externally.

Releases the ParameterSet object.

Frees all data structures associated with a ParameterSet. After a call of the method end(), the invoking object can no longer be used. Attempts to use them subsequently raise a ValueError.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> ps.end()

Destructor of the ParameterSet class.

When a ParameterSet object is destoyed, the end() method is called.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> del ps

Enter the runtime context related to this object.

The with statement will bind this method's return value to the target specified in the as clause of the statement, if any.

ParameterSet objects return themselves.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> with c.create_parameter_set():
...     pass  # do something here

Exit the runtime context.

When we exit the with block, the end() method is called.

Add a parameter ID and value to a parameter set.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> ps.add(c.parameters.advance,
...        c.parameters.advance.values.none)

Gets a parameter value.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> ps.add(c.parameters.advance,
...        c.parameters.advance.values.none)
>>> val = ps.get(c.parameters.advance)
>>> val == c.parameters.advance.values.none
True

Gets the parameter IDs contained in a parameter set.

Returns an iterator containing the parameter IDs in a parameter set.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> ps.add(c.parameters.advance,
...        c.parameters.advance.values.none)
>>> list(ps.get_ids())
[1001]

Deletes a parameter from a parameter set.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> ps.add(c.parameters.advance,
...        c.parameters.advance.values.none)
>>> len(ps)
1
>>> ps.delete(c.parameters.advance)
>>> len(ps)
0

Clears all items from the parameter set.

Example Usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> ps.add(c.parameters.advance,
...        c.parameters.advance.values.none)
>>> ps.clear()
>>> len(ps)
0

Return the number of items in the parameter set.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> len(ps)
0

Reads parameter names and settings from the file specified by filename and copies them into the parameter set.

Note that the content of the parameter set is not cleared out before the parameters in the file are copied into the parameter set. The parameters are read from the file one by one and are added to the parameter set, or, if the parameter was already present in the set, then its value is updated.

This routine reads and copies files in the PRM format, as created by Cplex.parameters.write. The PRM format is documented in the CPLEX File Formats Reference Manual.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> c.parameters.advance.set(c.parameters.advance.values.none)
>>> c.parameters.write_file('example.prm')
>>> ps = c.create_parameter_set()
>>> ps.read('example.prm')
>>> value = ps.get(c.parameters.advance)
>>> value == c.parameters.advance.values.none
True

Writes a parameter file that contains the parameters in the parameter set.

This routine writes a file in a format suitable for reading by ParameterSet.read or by Cplex.parameters.read.

The file is written in the PRM format which is documented in the CPLEX File Formats Reference Manual.

Example usage:

>>> import cplex
>>> c = cplex.Cplex()
>>> ps = c.create_parameter_set()
>>> ps.add(c.parameters.advance,
...        c.parameters.advance.values.none)
>>> ps.write('example.prm')
>>> c.parameters.read_file('example.prm')
>>> value = c.parameters.advance.get()
>>> value == c.parameters.advance.values.none
True