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