org.cpsolver.studentsct.constraint

Class RequiredRestrictions

java.lang.Object

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

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

org.cpsolver.studentsct.constraint.RequiredRestrictions

All Implemented Interfaces:

Comparable<Constraint<Request,Enrollment>>

public class RequiredRestrictions
extends GlobalConstraint<Request,Enrollment>

Required restrictions constraint. This global constraint ensures that no enrollment is violating a restriction. That is, for each student that has at least one restriction on the requested course, the given enrollment must match at least one of the restrictions.

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
RequiredRestrictions()

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 restriction that is not met.
boolean	inConflict(Assignment<Request,Enrollment> assignment, Enrollment enrollment) A given enrollment is conflicting, if there is restriction that is not met.
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

RequiredRestrictions

public RequiredRestrictions()

Method Detail

computeConflicts

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

A given enrollment is conflicting, if there is restriction that is not met.

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 restriction that is not met.

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>