org.cpsolver.studentsct.constraint

Class RequiredReservation

java.lang.Object

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

org.cpsolver.ifs.model.GlobalConstraint<Request,Enrollment>

org.cpsolver.studentsct.constraint.RequiredReservation

All Implemented Interfaces:

Comparable<Constraint<Request,Enrollment>>

public class RequiredReservation
extends GlobalConstraint<Request,Enrollment>

Required reservation constraint. This global constraint ensures that reservations with Reservation.mustBeUsed() flags are used. That is, an enrollment is conflicting when there is a reservation for the student that must be used, but the given enrollment does not use it.

Version:

StudentSct 1.3 (Student Sectioning)
Copyright (C) 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

Field Summary

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

iConstraintListeners, iId

Constructor Summary

Constructors

Constructor and Description
RequiredReservation()

Method Summary

Modifier and Type	Method and Description
void	computeConflicts(Assignment<Request,Enrollment> assignment, Enrollment enrollment, Set<Enrollment> conflicts) A given enrollment is conflicting, if there is a reservation that the student must use, but the given enrollment does not use it.
boolean	inConflict(Assignment<Request,Enrollment> assignment, Enrollment enrollment) A given enrollment is conflicting, if there is a reservation that the student must use, but the given enrollment does not use it.
String	toString()

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

addVariable, assigned, assignedVariables, countAssignedVariables, getName, removeVariable, unassigned, variables

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

addConstraintListener, compareTo, computeConflictsNoForwardCheck, constraintListeners, countVariables, equals, getDescription, getId, getModel, hashCode, isConsistent, isHard, removeConstraintListener, setModel

Methods inherited from class java.lang.Object

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

Constructor Detail

RequiredReservation

public RequiredReservation()

Method Detail

computeConflicts

public void computeConflicts(Assignment<Request,Enrollment> assignment,
                             Enrollment enrollment,
                             Set<Enrollment> conflicts)

A given enrollment is conflicting, if there is a reservation that the student must use, but the given enrollment does not use it.

Specified by:

computeConflicts in class Constraint<Request,Enrollment>

Parameters:

enrollment - Enrollment that is being considered

conflicts - all computed conflicting requests are added into this set

assignment - current assignment

inConflict

public boolean inConflict(Assignment<Request,Enrollment> assignment,
                          Enrollment enrollment)

A given enrollment is conflicting, if there is a reservation that the student must use, but the given enrollment does not use it.

Overrides:

inConflict in class Constraint<Request,Enrollment>

Parameters:

enrollment - Enrollment that is being considered

assignment - current assignment

Returns:

true, if the enrollment does not follow a reservation that must be used

toString

public String toString()

Overrides:

toString in class GlobalConstraint<Request,Enrollment>