Skip to main content
FRAMES NO FRAMES

Class IloCplex::ParameterSet

Definition file: ilcplex/ilocplexi.h
Map of IloCplex::ParameterSetIloCplex::ParameterSetIloCplex::ParameterSet

A parameter set for IloCplex, this class allows you to store and restore parameters that are not at their default value.

You can create empty IloCplex::ParameterSet objects with the constructor and then modify them. Alternatively, you can create such objects with the method IloCplex::getParameterSet.

A parameter set can be applied to an instance of IloCplex by means of the method IloCplex::setParameterSet(set).

See Also:

Method Summary
public voidclear()
public voidend()
public IloNumgetParam(IloCplex::NumParam which) const
public IloBoolgetParam(IloCplex::BoolParam which) const
public char *getParam(IloCplex::StringParam which) const
public CPXLONGgetParam(IloCplex::LongParam which) const
public CPXINTgetParam(IloCplex::IntParam which) const
public voidread(const char * filename)
public voidsetParam(IloCplex::NumParam which, IloNum val)
public voidsetParam(IloCplex::BoolParam which, IloBool val)
public voidsetParam(IloCplex::StringParam which, const char * val)
public voidsetParam(IloCplex::LongParam which, CPXLONG val)
public voidsetParam(IloCplex::IntParam which, CPXINT val)
public voidwrite(const char * filename) const
Inner Class
ParameterSet::Iterator
Method Detail

clear

public void clear()

Clears the parameter set.


end

public void end()

Ends the parameter set.


getParam

public IloNum getParam(IloCplex::NumParam which) const

Returns the current value of a numeric parameter.

If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which
The identifier of the num parameter to be queried.

Returns:

The current value of the num parameter.

getParam

public IloBool getParam(IloCplex::BoolParam which) const

Returns the current value of a Boolean parameter.

If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which
The identifier of the Boolean parameter to be queried.

Returns:

The current value of the Boolean parameter.

getParam

public char * getParam(IloCplex::StringParam which) const

Returns the current value of a string parameter.

If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which
The identifier of the string parameter to be queried.

Returns:

The current value of the string parameter.

getParam

public CPXLONG getParam(IloCplex::LongParam which) const

Returns the current value of an integer parameter.

If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which
The identifier of the integer parameter to be queried.

Returns:

The current value of the integer parameter.

getParam

public CPXINT getParam(IloCplex::IntParam which) const

Returns the current value of an integer parameter.

If the method fails, an exception of type IloException, or one of its derived classes, is thrown.

Parameters:

which
The identifier of the integer parameter to be queried.

Returns:

The current value of the integer parameter.

read

public void read(const char * filename)
proof-read

Reads the parameter set from the specified file.


setParam

public void setParam(IloCplex::NumParam which, IloNum val)

Sets a numeric parameter to the value val.

Parameters:

which
The identifier of the num parameter to be set.
val
The new value for the num parameter

setParam

public void setParam(IloCplex::BoolParam which, IloBool val)

Sets a Boolean parameter to the value val.

Parameters:

which
The identifier of the Boolean parameter to be set.
val
The new value for the Boolean parameter.

setParam

public void setParam(IloCplex::StringParam which, const char * val)

Sets a string parameter to the value val.

Parameters:

which
The identifier of the string parameter to set.
val
The new value for the string parameter.

setParam

public void setParam(IloCplex::LongParam which, CPXLONG val)

Sets an integer parameter to the value val.

Parameters:

which
The identifier of the parameter to set.
val
The new value for the integer parameter.

setParam

public void setParam(IloCplex::IntParam which, CPXINT val)

Sets an integer parameter to the value val.

Parameters:

which
The identifier of the parameter to set.
val
The new value for the integer parameter.

write

public void write(const char * filename) const
proof-read

Writes the parameter set to the specified file.