org.cpsolver.studentsct.heuristics.selection.CriticalStandardSelection Maven / Gradle / Ivy

Go to download
package org.cpsolver.studentsct.heuristics.selection;

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Queue;

import org.cpsolver.ifs.assignment.Assignment;
import org.cpsolver.ifs.heuristics.ValueSelection;
import org.cpsolver.ifs.heuristics.VariableSelection;
import org.cpsolver.ifs.solution.Solution;
import org.cpsolver.ifs.solver.Solver;
import org.cpsolver.ifs.util.DataProperties;
import org.cpsolver.studentsct.filter.StudentFilter;
import org.cpsolver.studentsct.model.Enrollment;
import org.cpsolver.studentsct.model.Request;
import org.cpsolver.studentsct.model.Request.RequestPriority;

/**
 * Use the standard IFS search for the unassigned critical course requests.
 * This selection is based on {@link StandardSelection} using
 * {@link UnassignedCriticalCourseRequestSelection} as variable selection.
 * Unlike {@link StandardSelection}, it allows for a critical course request to be
 * unassigned.
 * 
 * @author  Tomas Muller
 * @version StudentSct 1.3 (Student Sectioning)

 *          Copyright (C) 2007 - 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 CriticalStandardSelection extends StandardSelection {
    private RequestPriority iPriority;
    private boolean iAllowCriticalUnassignment = false;
    
    public CriticalStandardSelection(DataProperties properties, VariableSelection variableSelection, ValueSelection valueSelection, RequestPriority priority) {
        super(properties, variableSelection, valueSelection);
        iPriority = priority;
        iAllowCriticalUnassignment = properties.getPropertyBoolean("Neighbour.AllowCriticalUnassignment", iAllowCriticalUnassignment);
        iCanWorsen = properties.getPropertyBoolean("Neighbour.CriticalStandardCanWorsen", false);
    }
    
    public CriticalStandardSelection(DataProperties properties, ValueSelection valueSelection, RequestPriority priority) {
        this(properties, new UnassignedCriticalCourseRequestSelection(priority), valueSelection, priority);
    }
    
    public CriticalStandardSelection(DataProperties properties, ValueSelection valueSelection) {
        this(properties, valueSelection, RequestPriority.Critical);
    }
    
    @Override
    public void init(Solver solver) {
        StudentFilter filter = null;
        if (iVariableSelection instanceof UnassignedRequestSelection)
            filter = ((UnassignedRequestSelection)iVariableSelection).getFilter();
        init(solver, iPriority.name() + " Ifs" + (filter == null ? "" : " (" + filter.getName().toLowerCase() + " students)") + "...");
    }
    
    @Override
    public boolean canUnassign(Enrollment enrollment, Enrollment conflict, Assignment assignment) {
        if (!iAllowCriticalUnassignment) return super.canUnassign(enrollment, conflict, assignment);
        if (!iCanConflict) return false;
        if (!iCanHigherPriorityConflict && conflict.getRequest().getPriority() < enrollment.getRequest().getPriority()) return false;
        if (conflict.getRequest().isMPP() && conflict.equals(conflict.getRequest().getInitialAssignment())) return false;
        if (iPreferPriorityStudents || conflict.getRequest().getRequestPriority().isSame(enrollment.getRequest())) {
            if (conflict.getStudent().getPriority().isHigher(enrollment.getStudent())) return false;
        }
        // Override to allow unassignment of critical course requests
        return true;
    }
    
    /**
     * Returns the unassigned critical course requests in a random order.
     */
    static class UnassignedCriticalCourseRequestSelection implements VariableSelection{
        protected int iNrRounds = 0;
        protected Queue iRequests = null;
        private RequestPriority iPriority;
        
        public UnassignedCriticalCourseRequestSelection(RequestPriority priority) {
            iPriority = priority;
        }
        
        @Override
        public void init(Solver solver) {
            iRequests = new LinkedList();
            iNrRounds = solver.getProperties().getPropertyInt("Neighbour.CriticalRounds", 10);
        }

        @Override
        public Request selectVariable(Solution solution) {
            return nextRequest(solution);
        }
        
        protected synchronized Request nextRequest(Solution solution) {
            if (iRequests.isEmpty() && iNrRounds > 0) {
                iNrRounds --;
                List variables = new ArrayList();
                for (Request r: solution.getModel().unassignedVariables(solution.getAssignment()))
                    if (iPriority.isCritical(r)) variables.add(r);
                Collections.shuffle(variables);
                iRequests.addAll(variables);
            }
            return iRequests.poll();
        }
    }
}