001package org.cpsolver.coursett.sectioning;
002
003import java.util.List;
004
005import org.cpsolver.coursett.criteria.StudentConflict;
006import org.cpsolver.coursett.model.Lecture;
007import org.cpsolver.coursett.model.Placement;
008import org.cpsolver.ifs.assignment.Assignment;
009import org.cpsolver.ifs.model.Neighbour;
010
011/**
012 * A simple interface representing a student enrollment change.
013 * 
014 * @version CourseTT 1.3 (University Course Timetabling)<br>
015 *          Copyright (C) 2017 Tomáš Müller<br>
016 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
017 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
018 * <br>
019 *          This library is free software; you can redistribute it and/or modify
020 *          it under the terms of the GNU Lesser General Public License as
021 *          published by the Free Software Foundation; either version 3 of the
022 *          License, or (at your option) any later version. <br>
023 * <br>
024 *          This library is distributed in the hope that it will be useful, but
025 *          WITHOUT ANY WARRANTY; without even the implied warranty of
026 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
027 *          Lesser General Public License for more details. <br>
028 * <br>
029 *          You should have received a copy of the GNU Lesser General Public
030 *          License along with this library; if not see
031 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
032 */
033public interface StudentMove extends Neighbour<Lecture, Placement> {
034    public static double sEps = 0.0001;
035
036    /**
037     * Is the change valid / allowed?
038     */
039    public boolean isAllowed();
040    
041    /**
042     * Student conflict weight change
043     */
044    public double value(List<StudentConflict> criteria, Assignment<Lecture, Placement> assignment);
045    
046    /**
047     * Student group weight change
048     */
049    public double group(List<StudentConflict> criteria, Assignment<Lecture, Placement> assignment);
050}