net.sf.cpsolver.ifs.model
Class SimpleNeighbour

java.lang.Object
  extended by net.sf.cpsolver.ifs.model.Neighbour
      extended by net.sf.cpsolver.ifs.model.SimpleNeighbour
Direct Known Subclasses:
ExamSimpleNeighbour

public class SimpleNeighbour
extends Neighbour

A neighbour consisting of a change (either assignment or unassignment) of a single variable.

Version:
IFS 1.1 (Iterative Forward Search)
Copyright (C) 2006 Tomáš Müller
muller@unitime.org
Lazenska 391, 76314 Zlin, Czech Republic

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
See Also:
NeighbourSelection

Constructor Summary
SimpleNeighbour(Variable variable, Value value)
          Model
 
Method Summary
 void assign(long iteration)
          Perform assignment
 Value getValue()
          Selected value
 Variable getVariable()
          Selected variable
 String toString()
           
 double value()
          Improvement in the solution value if this neighbour is accepted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SimpleNeighbour

public SimpleNeighbour(Variable variable,
                       Value value)
Model

Parameters:
variable - variable to be assigned
value - value to be assigned to the given variable, null if the variable should be unassigned
Method Detail

getVariable

public Variable getVariable()
Selected variable


getValue

public Value getValue()
Selected value


assign

public void assign(long iteration)
Perform assignment

Specified by:
assign in class Neighbour

value

public double value()
Improvement in the solution value if this neighbour is accepted.

Specified by:
value in class Neighbour

toString

public String toString()
Overrides:
toString in class Object