org.cpsolver.exam.neighbours.ExamRoomMove Maven / Gradle / Ivy

Go to download
package org.cpsolver.exam.neighbours;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import org.cpsolver.exam.model.Exam;
import org.cpsolver.exam.model.ExamModel;
import org.cpsolver.exam.model.ExamPeriodPlacement;
import org.cpsolver.exam.model.ExamPlacement;
import org.cpsolver.exam.model.ExamRoomPlacement;
import org.cpsolver.ifs.assignment.Assignment;
import org.cpsolver.ifs.heuristics.NeighbourSelection;
import org.cpsolver.ifs.model.Neighbour;
import org.cpsolver.ifs.solution.Solution;
import org.cpsolver.ifs.solver.Solver;
import org.cpsolver.ifs.util.DataProperties;
import org.cpsolver.ifs.util.ToolBox;


/**
 * Try to swap a room between two exams. An exam is selected randomly, a
 * different (available) room is randomly selected for the exam -- the exam is
 * assigned into the new room (if the room is used, it tries to swap the rooms
 * between the selected exam and the one that is using it). If an exam is
 * assigned into two or more rooms, only one room is swapped at a time. 

 * 

 * 
 * @author  Tomas Muller
 * @version ExamTT 1.3 (Examination Timetabling)

 *          Copyright (C) 2008 - 2014 Tomas Muller

 *          [email protected]

 *          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/.
 */
public class ExamRoomMove implements NeighbourSelection {
    private boolean iCheckStudentConflicts = false;
    private boolean iCheckDistributionConstraints = true;

    /**
     * Constructor
     * 
     * @param properties
     *            problem properties
     */
    public ExamRoomMove(DataProperties properties) {
        iCheckStudentConflicts = properties.getPropertyBoolean("ExamRoomMove.CheckStudentConflicts", iCheckStudentConflicts);
        iCheckDistributionConstraints = properties.getPropertyBoolean("ExamRoomMove.CheckDistributionConstraints", iCheckDistributionConstraints);
    }

    /**
     * Initialization
     */
    @Override
    public void init(Solver solver) {
    }

    /**
     * Select an exam randomly, select an available period randomly (if it is
     * not assigned, from {@link Exam#getPeriodPlacements()}), select rooms
     * using {@link Exam#findRoomsRandom(Assignment, ExamPeriodPlacement)}
     */
    @Override
    public Neighbour selectNeighbour(Solution solution) {
        ExamModel model = (ExamModel) solution.getModel();
        Assignment assignment = solution.getAssignment();
        Exam exam = ToolBox.random(model.variables());
        if (exam.getMaxRooms() <= 0)
            return null;
        ExamPlacement placement = assignment.getValue(exam);
        ExamPeriodPlacement period = (placement != null ? placement.getPeriodPlacement()
                : (ExamPeriodPlacement) ToolBox.random(exam.getPeriodPlacements()));
        if (iCheckStudentConflicts && placement == null && exam.countStudentConflicts(assignment, period) > 0)
            return null;
        if (iCheckDistributionConstraints && placement == null && !exam.checkDistributionConstraints(assignment, period))
            return null;
        Set rooms = (placement != null ? placement.getRoomPlacements() : exam.findBestAvailableRooms(assignment, period));
        if (rooms == null || rooms.isEmpty())
            return null;
        if (placement == null)
            placement = new ExamPlacement(exam, period, rooms);
        List roomVect = new ArrayList(rooms);
        int rx = ToolBox.random(roomVect.size());
        for (int r = 0; r < roomVect.size(); r++) {
            ExamRoomPlacement current = roomVect.get((r + rx) % roomVect.size());
            int mx = ToolBox.random(exam.getRoomPlacements().size());
            for (int m = 0; m < exam.getRoomPlacements().size(); m++) {
                ExamRoomPlacement swap = exam.getRoomPlacements().get((m + mx) % exam.getRoomPlacements().size());
                ExamRoomSwapNeighbour n = new ExamRoomSwapNeighbour(assignment, placement, current, swap);
                if (n.canDo())
                    return n;
            }
        }
        rooms = exam.findRoomsRandom(assignment, period);
        if (rooms == null)
            return null;
        return new ExamSimpleNeighbour(assignment, new ExamPlacement(exam, period, rooms));
    }
}