001package org.cpsolver.studentsct.online.expectations;
002
003import org.cpsolver.ifs.assignment.Assignment;
004import org.cpsolver.ifs.util.DataProperties;
005import org.cpsolver.studentsct.model.Enrollment;
006import org.cpsolver.studentsct.model.Request;
007import org.cpsolver.studentsct.model.Section;
008
009/**
010 * Class is over-expected when {@link Section#getPenalty()} is not negative.
011 * 
012 * @version StudentSct 1.3 (Student Sectioning)<br>
013 *          Copyright (C) 2014 Tomáš Müller<br>
014 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
015 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
016 * <br>
017 *          This library is free software; you can redistribute it and/or modify
018 *          it under the terms of the GNU Lesser General Public License as
019 *          published by the Free Software Foundation; either version 3 of the
020 *          License, or (at your option) any later version. <br>
021 * <br>
022 *          This library is distributed in the hope that it will be useful, but
023 *          WITHOUT ANY WARRANTY; without even the implied warranty of
024 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
025 *          Lesser General Public License for more details. <br>
026 * <br>
027 *          You should have received a copy of the GNU Lesser General Public
028 *          License along with this library; if not see <a
029 *          href='http://www.gnu.org/licenses'>http://www.gnu.org/licenses</a>.
030 * 
031 */
032public class PenaltyNotNegative implements OverExpectedCriterion {
033
034    public PenaltyNotNegative(DataProperties config) {
035    }
036
037    @Override
038    public double getOverExpected(Assignment<Request, Enrollment> assignment, Section section, Request request) {
039        if (section.getPenalty() < 0 || section.getLimit() <= 0.0)
040            return 0.0;
041        int subparts = section.getSubpart().getConfig().getSubparts().size();
042        return 1.0 / subparts;
043    }
044
045    @Override
046    public String toString() {
047        return "not-negative";
048    }
049
050    @Override
051    public Integer getExpected(int sectionLimit, double expectedSpace) {
052        if (sectionLimit <= 0.0)
053            return null;
054
055        int expected = (int) Math.round(expectedSpace);
056        if (expected > 0)
057            return expected;
058
059        return null;
060    }
061}