FRAMES NO FRAMES

Class IlcNeighborIdentifier

Definition file: ilsolver/iimnhood.h
Include file: <ilsolver/ilosolver.h>

This class communicates information between instances of local search goals. This class is used by IloScanNHood and IloScanDeltas to store information about the currently instantiated neighbor. This class is used by IloTest and IloNotify to find out the details of the currently instantiated neighbor. This information can be communicated by passing the same instance of IlcNeighborIdentifier to such goals in a composed goal.

See Also:

Constructor Summary
public IlcNeighborIdentifier()
public IlcNeighborIdentifier(IlcNeighborIdentifierI * impl)
public IlcNeighborIdentifier(IloSolver solver)
Method Summary
public IloSolutiongetAtDelta() const
public IloIntgetAtIndex() const
public IlcNeighborIdentifierI *getImpl() const
public voidoperator=(const IlcNeighborIdentifier & h)
public voidsetAtDelta(IloSolution delta)
public voidsetAtIndex(IloInt index)
Constructor Detail

IlcNeighborIdentifier

public IlcNeighborIdentifier()

This constructor creates an empty handle. You must initialize it before you use it.


IlcNeighborIdentifier

public IlcNeighborIdentifier(IlcNeighborIdentifierI * impl)

This constructor creates a handle object from a pointer to an implementation object.


IlcNeighborIdentifier

public IlcNeighborIdentifier(IloSolver solver)

This constructor creates an instance of IlcNeighborIdentifier allocated on solver.


Method Detail

getAtDelta

public IloSolution getAtDelta() const

This member function returns the solution passed in the previous call to IlcNeighborIdentifier::setAtDelta. This set is carried out automatically by IloScanNHood and IloScanDeltas before succeeding. The solution returned by this method represents the solution delta that was applied by IloScanNHood or IloScanDeltas to reach the current leaf node.


getAtIndex

public IloInt getAtIndex() const

This member function returns the index passed in the previous call to IlcNeighborIdentifier::setAtIndex. This set is carried out automatically by IloScanNHood and IloScanDeltas before succeeding. The index returned by this method represents the neighborhood index (for IloScanNHood) or the index in the array of deltas (for IloScanDeltas) that corresponds to the solution delta leading to the current leaf node.


getImpl

public IlcNeighborIdentifierI * getImpl() const
This constructor creates an object by copying another one.

This member function returns a pointer to the implementation object of the invoking handle.


operator=

public void operator=(const IlcNeighborIdentifier & h)

This operator assigns an address to the handle pointer of the invoking object. That address is the location of the implementation object of the provided argument.


setAtDelta

public void setAtDelta(IloSolution delta)

This member function sets the stored delta to delta. Normally this action is performed by IloScanNHood or IloScanDeltas. As a user, you should not normally need to use this member function.


setAtIndex

public void setAtIndex(IloInt index)

This member function sets the stored index to index. Normally this action is performed by IloScanNHood or IloScanDeltas. As a user, you should not normally need to use this member function.