net.sf.cpsolver.coursett.constraint
Class MinimizeNumberOfUsedGroupsOfTime

java.lang.Object
  net.sf.cpsolver.ifs.model.Constraint
      net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime

All Implemented Interfaces:

WeakeningConstraint

public class MinimizeNumberOfUsedGroupsOfTime
extends Constraint
implements WeakeningConstraint

Minimize number of used groups of time within a set of classes.

This constraint implements the following distribution/group constraints:

MIN_GRUSE(10x1h) (Minimize Use Of 1h Groups)
Minimize number of groups of time that are used by the given classes. The time is spread into the following 10 groups of one hour: 7:30a-8:30a, 8:30a-9:30a, 9:30a-10:30a, ... 4:30p-5:30p.

MIN_GRUSE(5x2h) (Minimize Use Of 2h Groups)
Minimize number of groups of time that are used by the given classes. The time is spread into the following 5 groups of two hours: 7:30a-9:30a, 9:30a-11:30a, 11:30a-1:30p, 1:30p-3:30p, 3:30p-5:30p.

MIN_GRUSE(3x3h) (Minimize Use Of 3h Groups)
Minimize number of groups of time that are used by the given classes. The time is spread into the following 3 groups: 7:30a-10:30a, 10:30a-2:30p, 2:30p-5:30p.

MIN_GRUSE(2x5h) (Minimize Use Of 5h Groups)
Minimize number of groups of time that are used by the given classes. The time is spread into the following 2 groups: 7:30a-12:30a, 12:30a-5:30p.

Version:

CourseTT 1.1 (University Course Timetabling)
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

Field Summary

static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[]	sGroups10of1h
static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[]	sGroups2of5h
static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[]	sGroups3of3h
static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[]	sGroups5of2h

Fields inherited from class net.sf.cpsolver.ifs.model.Constraint

iAssignedVariables, iId

Constructor Summary

MinimizeNumberOfUsedGroupsOfTime(DataProperties config, String name, net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[] groupsOfTime)

Method Summary

void	assigned(long iteration, Value value) Given value is to be assigned to its varable.
void	computeConflicts(Value value, Set conflicts) The only method which has to be implemented by any constraint.
int	currentUsage()
int	estimateLimit()
String	getConstraintName()
String	getName() Constraint's name -- for printing purposes
int	getOverLimit(Value value)
boolean	inConflict(Value value) Returns true if the given assignment is inconsistent with the existing assignments respecting this constraint.
boolean	isConsistent(Value value1, Value value2) Returns true if the given assignments are consistent respecting this constraint.
boolean	isEnabled()
boolean	isOverLimit(Value value)
void	setEnabled(boolean enabled)
String	toString()
void	unassigned(long iteration, Value value) Given value is unassigned from its varable.
void	weaken() Weaken the constraint.

Methods inherited from class net.sf.cpsolver.ifs.model.Constraint

addConstraintListener, addVariable, assignedVariables, constraintListeners, countAssignedVariables, countVariables, getDescription, getId, getModel, hashCode, isHard, removeConstraintListener, removeVariable, setModel, variables

Methods inherited from class java.lang.Object

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

Field Detail

sGroups2of5h

public static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[] sGroups2of5h

sGroups3of3h

public static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[] sGroups3of3h

sGroups5of2h

public static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[] sGroups5of2h

sGroups10of1h

public static net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[] sGroups10of1h

Constructor Detail

MinimizeNumberOfUsedGroupsOfTime

public MinimizeNumberOfUsedGroupsOfTime(DataProperties config,
                                        String name,
                                        net.sf.cpsolver.coursett.constraint.MinimizeNumberOfUsedGroupsOfTime.GroupOfTime[] groupsOfTime)

Method Detail

currentUsage

public int currentUsage()

weaken

public void weaken()

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

isOverLimit

public boolean isOverLimit(Value value)

getOverLimit

public int getOverLimit(Value value)

estimateLimit

public int estimateLimit()

computeConflicts

public void computeConflicts(Value value,
                             Set 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.

Specified by:

computeConflicts in class Constraint

Parameters:

value - value to be assigned to its varaible

conflicts - resultant set of conflicting values

inConflict

public boolean inConflict(Value 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 Constraint

isConsistent

public boolean isConsistent(Value value1,
                            Value value2)

Description copied from class: Constraint

Returns true if the given assignments are consistent respecting this constraint. This method is used by MAC (see MacPropagation).

Overrides:

isConsistent in class Constraint

assigned

public void assigned(long iteration,
                     Value value)

Description copied from class: Constraint

Given value is to be assigned to its varable. In this method, the constraint should unassigns all varaibles which are in conflict with the given assignment because of this constraint.

Overrides:

assigned in class Constraint

unassigned

public void unassigned(long iteration,
                       Value value)

Description copied from class: Constraint

Given value is unassigned from its varable.

Overrides:

unassigned in class Constraint

getConstraintName

public String getConstraintName()

getName

public String getName()

Description copied from class: Constraint

Constraint's name -- for printing purposes

Overrides:

getName in class Constraint

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

toString

public String toString()

Overrides:

toString in class Object