Java Reference
Java Reference
Detailed Description
This is the base class for building an Lns operator.
An Lns fragment is a collection of variables which will be relaxed. Fragments are built with NextFragment(), which returns false if there are no more fragments to build. Optionally one can override InitFragments, which is called from LocalSearchOperator::Start to initialize fragment data. Here's a sample relaxing one variable at a time: class OneVarLns : public BaseLns { public: OneVarLns(const std::vector<IntVar*>& vars) : BaseLns(vars), index_(0) {} virtual ~OneVarLns() {} virtual void InitFragments() { index_ = 0; } virtual bool NextFragment() { const int size = Size(); if (index_ < size) { AppendToFragment(index_); ++index_; return true; } else { return false; } } private: int index_; };
Definition at line 14 of file BaseLns.java.
Public Member Functions | |
| synchronized void | delete () |
| void | swigReleaseOwnership () |
| void | swigTakeOwnership () |
| BaseLns (IntVar[] vars) | |
| void | initFragments () |
| boolean | nextFragment () |
| void | appendToFragment (int index) |
| int | fragmentSize () |
| boolean | HasFragments () |
| boolean | HoldsDelta () |
| boolean | isIncremental () |
| int | size () |
| long | value (long index) |
| Returns the value in the current assignment of the variable of given index. More... | |
| IntVar | var (long index) |
| Returns the variable of given index. More... | |
| long | oldValue (long index) |
| void | setValue (long index, long value) |
| boolean | activated (long index) |
| void | activate (long index) |
| void | deactivate (long index) |
| void | addVars (IntVar[] vars) |
| void | onStart () |
| Called by Start() after synchronizing the operator with the current assignment. More... | |
| boolean | nextNeighbor (Assignment delta, Assignment deltadelta) |
| void | start (Assignment assignment) |
| void | reset () |
| String | toString () |
Protected Member Functions | |
| BaseLns (long cPtr, boolean cMemoryOwn) | |
| void | swigDirectorDisconnect () |
| boolean | oneNeighbor () |
| Creates a new neighbor. More... | |
Constructor & Destructor Documentation
◆ BaseLns() [1/2]
|
inlineprotected |
Definition at line 17 of file BaseLns.java.
◆ BaseLns() [2/2]
Definition at line 57 of file BaseLns.java.
Member Function Documentation
◆ activate()
|
inlineinherited |
Definition at line 81 of file IntVarLocalSearchOperatorTemplate.java.
◆ activated()
|
inlineinherited |
Definition at line 77 of file IntVarLocalSearchOperatorTemplate.java.
◆ addVars()
|
inlineinherited |
Definition at line 89 of file IntVarLocalSearchOperatorTemplate.java.
◆ appendToFragment()
|
inline |
Definition at line 70 of file BaseLns.java.
◆ deactivate()
|
inlineinherited |
Definition at line 85 of file IntVarLocalSearchOperatorTemplate.java.
◆ delete()
|
inline |
Reimplemented from IntVarLocalSearchOperator.
Definition at line 31 of file BaseLns.java.
◆ fragmentSize()
|
inline |
Definition at line 74 of file BaseLns.java.
◆ HasFragments()
|
inline |
Reimplemented from LocalSearchOperator.
Definition at line 78 of file BaseLns.java.
◆ HoldsDelta()
|
inlineinherited |
Reimplemented from LocalSearchOperator.
Definition at line 42 of file IntVarLocalSearchOperatorTemplate.java.
◆ initFragments()
|
inline |
Definition at line 62 of file BaseLns.java.
◆ isIncremental()
|
inlineinherited |
Definition at line 46 of file IntVarLocalSearchOperatorTemplate.java.
◆ nextFragment()
|
inline |
Definition at line 66 of file BaseLns.java.
◆ nextNeighbor()
|
inlineinherited |
Definition at line 62 of file LocalSearchOperator.java.
◆ oldValue()
|
inlineinherited |
Definition at line 69 of file IntVarLocalSearchOperatorTemplate.java.
◆ oneNeighbor()
|
inlineprotectedinherited |
Creates a new neighbor.
It returns false when the neighborhood is completely explored. MakeNextNeighbor() in a subclass of IntVarLocalSearchOperator.
Reimplemented in PathOperator, and ChangeValue.
Definition at line 72 of file IntVarLocalSearchOperator.java.
◆ onStart()
|
inlineinherited |
Called by Start() after synchronizing the operator with the current assignment.
Should be overridden instead of Start() to avoid calling VarLocalSearchOperator::Start explicitly.
Definition at line 96 of file IntVarLocalSearchOperatorTemplate.java.
◆ reset()
|
inlineinherited |
Reimplemented in PathOperator.
Definition at line 70 of file LocalSearchOperator.java.
◆ setValue()
|
inlineinherited |
Definition at line 73 of file IntVarLocalSearchOperatorTemplate.java.
◆ size()
|
inlineinherited |
Definition at line 50 of file IntVarLocalSearchOperatorTemplate.java.
◆ start()
|
inlineinherited |
Definition at line 66 of file LocalSearchOperator.java.
◆ swigDirectorDisconnect()
|
inlineprotected |
Reimplemented from IntVarLocalSearchOperator.
Definition at line 42 of file BaseLns.java.
◆ swigReleaseOwnership()
|
inline |
Reimplemented from IntVarLocalSearchOperator.
Definition at line 47 of file BaseLns.java.
◆ swigTakeOwnership()
|
inline |
Reimplemented from IntVarLocalSearchOperator.
Definition at line 52 of file BaseLns.java.
◆ toString()
|
inlineinherited |
Reimplemented in Assignment, Pack, BooleanVar, RegularLimit, SearchLog, SearchLimit, OptimizeVar, Decision, IntVarIterator, DecisionBuilder, Constraint, Demon, SolutionCollector, CPFeasibilityFilter, GlobalVehicleBreaksConstraint, PropagationBaseObject, SequenceVar, LocalSearchMonitor, and PropagationMonitor.
Definition at line 46 of file BaseObject.java.
◆ value()
|
inlineinherited |
Returns the value in the current assignment of the variable of given index.
Definition at line 57 of file IntVarLocalSearchOperatorTemplate.java.
◆ var()
|
inlineinherited |
Returns the variable of given index.
Definition at line 64 of file IntVarLocalSearchOperatorTemplate.java.
The documentation for this class was generated from the following file: