org.cpsolver.instructor.constraints

Class InstructorConstraint

java.lang.Object

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

org.cpsolver.ifs.model.GlobalConstraint<TeachingRequest.Variable,TeachingAssignment>

org.cpsolver.instructor.constraints.InstructorConstraint

All Implemented Interfaces:

Comparable<Constraint<TeachingRequest.Variable,TeachingAssignment>>

public class InstructorConstraint
extends GlobalConstraint<TeachingRequest.Variable,TeachingAssignment>

Instructor Constraint. This is the main constraint of the problem, ensuring that an instructor gets a consistent list of assignments. It checks for instructor availability, maximal load, time conflicts, and whether the given assignments are of the same course (if desired).

Version:

IFS 1.3 (Instructor Sectioning)
Copyright (C) 2016 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
InstructorConstraint() Constructor

Method Summary

Modifier and Type	Method and Description
void	computeConflicts(Assignment<TeachingRequest.Variable,TeachingAssignment> assignment, TeachingAssignment value, Set<TeachingAssignment> conflicts) The only method which has to be implemented by any constraint.
String	getName() Constraint's name -- for printing purposes
String	toString()

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InstructorConstraint

public InstructorConstraint()

Constructor

Method Detail

computeConflicts

public void computeConflicts(Assignment<TeachingRequest.Variable,TeachingAssignment> assignment,
                             TeachingAssignment value,
                             Set<TeachingAssignment> 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<TeachingRequest.Variable,TeachingAssignment>

Parameters:

assignment - current assignment

value - value to be assigned to its variable

conflicts - resultant set of conflicting values

getName

public String getName()

Description copied from class: Constraint

Constraint's name -- for printing purposes

Overrides:

getName in class Constraint<TeachingRequest.Variable,TeachingAssignment>

Returns:

constraint name

toString

public String toString()

Overrides:

toString in class Object