org.cpsolver.studentsct.online.expectations

Class FractionallyOverExpected

java.lang.Object

org.cpsolver.studentsct.online.expectations.PercentageOverExpected

org.cpsolver.studentsct.online.expectations.FractionallyOverExpected

All Implemented Interfaces:

OverExpectedCriterion

Direct Known Subclasses:

FractionallyUnbalancedWhenNoExpectations

public class FractionallyOverExpected
extends PercentageOverExpected

Over-expected space depends on how much is the class over-expected. It works like the PercentageOverExpected, however, the returned over-expected penalty is based on the over-expected space (enrollment + expectations - section limit), divided by the section limit. The over-expectations can be capped by the OverExpected.Maximum parameter (defaults to section limit).

Unlike the PercentageOverExpected, this criterion offers the ability to prefer less over-expected sections among the sections that are over-expected.

Version:

StudentSct 1.3 (Student Sectioning)
Copyright (C) 2014 Tomáš Müller
muller@unitime.org
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.

Author:

Tomáš Müller

Nested Class Summary

Nested classes/interfaces inherited from class org.cpsolver.studentsct.online.expectations.PercentageOverExpected

PercentageOverExpected.Rounding

Nested classes/interfaces inherited from interface org.cpsolver.studentsct.online.expectations.OverExpectedCriterion

OverExpectedCriterion.HasContext

Constructor Summary

Constructors

Constructor and Description
FractionallyOverExpected()
FractionallyOverExpected(DataProperties config)
FractionallyOverExpected(Double percentage)
FractionallyOverExpected(Double percentage, Double maximum)

Method Summary

Modifier and Type	Method and Description
Double	getMaximum() Maximum, null if not set
double	getMaximum(Section section) Maximum, section limit if not set
double	getOverExpected(Assignment<Request,Enrollment> assignment, Section section, Request request) Expectation penalty, to be minimized
String	toString()

Methods inherited from class org.cpsolver.studentsct.online.expectations.PercentageOverExpected

getEnrollment, getEnrollment, getExpected, getLimit, getLimit, getPercentage, hasExpectations, round, setPercentage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FractionallyOverExpected

public FractionallyOverExpected(DataProperties config)

FractionallyOverExpected

public FractionallyOverExpected(Double percentage,
                                Double maximum)

FractionallyOverExpected

public FractionallyOverExpected(Double percentage)

FractionallyOverExpected

public FractionallyOverExpected()

Method Detail

getMaximum

public Double getMaximum()

Maximum, null if not set

Returns:

maximum

getMaximum

public double getMaximum(Section section)

Maximum, section limit if not set

Parameters:

section - given section

Returns:

maximum

getOverExpected

public double getOverExpected(Assignment<Request,Enrollment> assignment,
                              Section section,
                              Request request)

Description copied from interface: OverExpectedCriterion

Expectation penalty, to be minimized

Specified by:

getOverExpected in interface OverExpectedCriterion

Overrides:

getOverExpected in class PercentageOverExpected

Parameters:

assignment - current assignment

section - section in question

request - student course request

Returns:

expectation penalty (typically 1.0 / number of subparts when over-expected, 0.0 otherwise)

toString

public String toString()

Overrides:

toString in class PercentageOverExpected