org.cpsolver.coursett.constraint

Class DiscouragedRoomConstraint

java.lang.Object

org.cpsolver.ifs.model.Constraint<V,T>

org.cpsolver.ifs.assignment.context.ConstraintWithContext<Lecture,Placement,RoomConstraint.RoomConstraintContext>

org.cpsolver.coursett.constraint.RoomConstraint

org.cpsolver.coursett.constraint.DiscouragedRoomConstraint

All Implemented Interfaces:

Comparable<Constraint<Lecture,Placement>>, CanHoldContext, HasAssignmentContext<Lecture,Placement,RoomConstraint.RoomConstraintContext>, WeakeningConstraint<Lecture,Placement>

public class DiscouragedRoomConstraint
extends RoomConstraint
implements WeakeningConstraint<Lecture,Placement>

Discouraged room constraint. This constraint is based on RoomConstraint, however, it tries to minimize the usage of the room as much as possible.

Version:

CourseTT 1.3 (University Course Timetabling)
Copyright (C) 2006 - 2014 Tomáš Müller
muller@unitime.org
http://muller.unitime.org

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 3 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 see http://www.gnu.org/licenses/.

Author:

Tomáš Müller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscouragedRoomConstraint.DiscouragedRoomConstraintContext

Nested classes/interfaces inherited from class org.cpsolver.coursett.constraint.RoomConstraint

RoomConstraint.RoomConstraintContext

Field Summary

Fields inherited from class org.cpsolver.ifs.model.Constraint

iConstraintListeners, iId

Fields inherited from interface org.cpsolver.ifs.assignment.context.CanHoldContext

sMaxSize

Constructor Summary

Constructors

Constructor and Description
DiscouragedRoomConstraint(DataProperties config, Long id, String name, Long buildingId, int capacity, RoomSharingModel roomSharingModel, Double x, Double y, boolean ignoreTooFar, boolean constraint)

Method Summary

Modifier and Type	Method and Description
void	computeConflicts(Assignment<Lecture,Placement> assignment, Placement value, Set<Placement> conflicts) The only method which has to be implemented by any constraint.
RoomConstraint.RoomConstraintContext	createAssignmentContext(Assignment<Lecture,Placement> assignment) Create a new assignment context for the given assignment.
String	getName() Room name
boolean	inConflict(Assignment<Lecture,Placement> assignment, Placement value) Returns true if the given assignment is inconsistent with the existing assignments respecting this constraint.
String	toString()
void	unassigned(Assignment<Lecture,Placement> assignment, long iteration, Placement placement) Given value is unassigned from its variable.
void	weaken(Assignment<Lecture,Placement> assignment) Weaken the constraint.
void	weaken(Assignment<Lecture,Placement> assignment, Placement value) Weaken the constraint enough so that it can assign the given value.

Methods inherited from class org.cpsolver.coursett.constraint.RoomConstraint

addPartition, assigned, checkRoomSize, checkRoomSize, getAvailableArray, getBuildingId, getCapacity, getConstraint, getIgnoreTooFar, getParentRoom, getPartitions, getPosX, getPosY, getResource, getResourceId, getResourceOfWeek, getRoomName, getSharingModel, getType, isAvailable, isAvailable, isConsistent, setCoordinates, setModel, setNotAvailable, setType

Methods inherited from class org.cpsolver.ifs.assignment.context.ConstraintWithContext

getAssignmentContextReference, getContext, getContext, setAssignmentContextReference

Methods inherited from class org.cpsolver.ifs.model.Constraint

addConstraintListener, addVariable, assignedVariables, compareTo, computeConflictsNoForwardCheck, constraintListeners, countAssignedVariables, countVariables, equals, getDescription, getId, getModel, hashCode, isHard, removeConstraintListener, removeVariable, variables

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DiscouragedRoomConstraint

public DiscouragedRoomConstraint(DataProperties config,
                                 Long id,
                                 String name,
                                 Long buildingId,
                                 int capacity,
                                 RoomSharingModel roomSharingModel,
                                 Double x,
                                 Double y,
                                 boolean ignoreTooFar,
                                 boolean constraint)

Method Detail

computeConflicts

public void computeConflicts(Assignment<Lecture,Placement> assignment,
                             Placement value,
                             Set<Placement> conflicts)

Description copied from class: Constraint

The only method which has to be implemented by any constraint. It returns the values which needs to be unassigned in order to make this constraint consistent with the given value if it is assigned to its variable. The computed list of conflicting values is added to the given set of conflicts.

Overrides:

computeConflicts in class RoomConstraint

Parameters:

assignment - current assignment

value - value to be assigned to its variable

conflicts - resultant set of conflicting values

inConflict

public boolean inConflict(Assignment<Lecture,Placement> assignment,
                          Placement value)

Description copied from class: Constraint

Returns true if the given assignment is inconsistent with the existing assignments respecting this constraint. This method is used by MAC (see MacPropagation).

Overrides:

inConflict in class RoomConstraint

Parameters:

assignment - current assignment

value - given value

Returns:

true if there is a conflict with other assigned variables of the constraint

getName

public String getName()

Description copied from class: RoomConstraint

Room name

Overrides:

getName in class RoomConstraint

Returns:

constraint name

toString

public String toString()

Overrides:

toString in class RoomConstraint

weaken

public void weaken(Assignment<Lecture,Placement> assignment)

Description copied from interface: WeakeningConstraint

Weaken the constraint. This method is called if the constraint participates in an unassigned of a variable.

Specified by:

weaken in interface WeakeningConstraint<Lecture,Placement>

Parameters:

assignment - current assignment

weaken

public void weaken(Assignment<Lecture,Placement> assignment,
                   Placement value)

Description copied from interface: WeakeningConstraint

Weaken the constraint enough so that it can assign the given value.

Specified by:

weaken in interface WeakeningConstraint<Lecture,Placement>

Parameters:

assignment - current assignment

value - a conflicting value to be assigned

createAssignmentContext

public RoomConstraint.RoomConstraintContext createAssignmentContext(Assignment<Lecture,Placement> assignment)

Description copied from interface: HasAssignmentContext

Create a new assignment context for the given assignment. If there are already some variables assigned in the value, the method should make sure that the context is appropriately initialized.

Specified by:

createAssignmentContext in interface HasAssignmentContext<Lecture,Placement,RoomConstraint.RoomConstraintContext>

Overrides:

createAssignmentContext in class RoomConstraint

Parameters:

assignment - an assignment for which there needs to be an assignment context

Returns:

a new instance of the assignment context, filled according to the given assignment

unassigned

public void unassigned(Assignment<Lecture,Placement> assignment,
                       long iteration,
                       Placement placement)

Description copied from class: Constraint

Given value is unassigned from its variable.

Overrides:

unassigned in class RoomConstraint

Parameters:

assignment - current assignment

iteration - current iteration

placement - unassigned value