org.cpsolver.studentsct.online.selection

## Class StudentSchedulingAssistantWeights

- java.lang.Object
- - org.cpsolver.studentsct.online.selection.StudentSchedulingAssistantWeights

- All Implemented Interfaces:
    SolutionComparator<Request,Enrollment>, StudentWeights
  Direct Known Subclasses:
    ResectioningWeights

      public class StudentSchedulingAssistantWeights
      extends Object
      implements StudentWeights

  Online variant of `StudentWeights` model. It is either based on `PriorityStudentWeights` (when StudentWeights.PriorityWeighting=true) or on `EqualStudentWeights`. Following criteria are included:
  - StudentWeights.NoTimeFactor .. penalization of sections with no time assigned (arrange hours)
  - StudentWeights.SelectionFactor .. penalization of sections that are not selected (if there are selected sections given for a course request, see `CourseRequest.getSelectedChoices()`)
  - StudentWeights.PenaltyFactor .. penalization for over-expected sections (using `OverExpectedCriterion.getOverExpected(Assignment, Section, Request)`
  - StudentWeights.AvgPenaltyFactor .. penalization of section penalties (see `Section.getPenalty()`), using average penalty per request
  - StudentWeights.AvailabilityFactor .. penalization of unbalanced sections (portion of the section over the target fill, averaged per request)
  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 interface org.cpsolver.studentsct.weights.StudentWeights

      `StudentWeights.Implementation`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StudentSchedulingAssistantWeights(DataProperties properties)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `clearBestCache()`
    `double` | `getBaseWeight(Assignment<Request,Enrollment> assignment, Enrollment enrollment)`
    `double` | `getBound(Request request)` Return lower bound for the given request
    `double` | `getDistanceConflictWeight(Assignment<Request,Enrollment> assignment, DistanceConflict.Conflict distanceConflict)` Deprecated.
    `double` | `getStudentQualityConflictWeight(Assignment<Request,Enrollment> assignment, Enrollment enrollment, StudentQuality.Conflict conflict)` Return weight of a student quality conflict
    `double` | `getTimeOverlapConflictWeight(Assignment<Request,Enrollment> assignment, Enrollment enrollment, TimeOverlapsCounter.Conflict timeOverlap)` Deprecated.
    `double` | `getWeight(Assignment<Request,Enrollment> assignment, Enrollment enrollment)` Return base weight of the given enrollment
    `double` | `getWeight(Assignment<Request,Enrollment> assignment, Enrollment enrollment, Set<DistanceConflict.Conflict> distanceConflicts, Set<TimeOverlapsCounter.Conflict> timeOverlappingConflicts)` Return weight of the given enrollment
    `double` | `getWeight(Assignment<Request,Enrollment> assignment, Enrollment enrollment, Set<StudentQuality.Conflict> qualityConflicts)` Return weight of the given enrollment
    `boolean` | `isBetterThanBestSolution(Solution<Request,Enrollment> currentSolution)` Compares two solutions.
    `boolean` | `isFreeTimeAllowOverlaps()` Return true if free time requests allow overlaps
    `protected double` | `round(double value)`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### StudentSchedulingAssistantWeights

          public StudentSchedulingAssistantWeights(DataProperties properties)

  - ### Method Detail

    - #### clearBestCache

          public void clearBestCache()

    - #### getBaseWeight

          public double getBaseWeight(Assignment<Request,Enrollment> assignment,
                                      Enrollment enrollment)

    - #### getWeight

          public double getWeight(Assignment<Request,Enrollment> assignment,
                                  Enrollment enrollment)

      Description copied from interface: `StudentWeights`
      Return base weight of the given enrollment
      Specified by:
        `getWeight` in interface `StudentWeights`
      Parameters:
        `assignment` - current assignment
        `enrollment` - given enrollment
      Returns:
        weight (higher weight means better value)

    - #### getWeight

          public double getWeight(Assignment<Request,Enrollment> assignment,
                                  Enrollment enrollment,
                                  Set<DistanceConflict.Conflict> distanceConflicts,
                                  Set<TimeOverlapsCounter.Conflict> timeOverlappingConflicts)

      Description copied from interface: `StudentWeights`
      Return weight of the given enrollment
      Specified by:
        `getWeight` in interface `StudentWeights`
      Parameters:
        `assignment` - current assignment
        `enrollment` - given enrollment
        `distanceConflicts` - distance conflicts
        `timeOverlappingConflicts` - time overlapping conflicts
      Returns:
        weight (higher weight means better value)

    - #### round

          protected double round(double value)

    - #### isBetterThanBestSolution

          public boolean isBetterThanBestSolution(Solution<Request,Enrollment> currentSolution)

      Description copied from interface: `SolutionComparator`
      Compares two solutions. Returns true if the given solution is better than its best ever found solution (see `Solution.saveBest()` and `Solution.restoreBest()`).
      Specified by:
        `isBetterThanBestSolution` in interface `SolutionComparator<Request,Enrollment>`
      Parameters:
        `currentSolution` - given solution
      Returns:
        true if the given solution is better than the best ever found solution

    - #### getBound

          public double getBound(Request request)

      Description copied from interface: `StudentWeights`
      Return lower bound for the given request
      Specified by:
        `getBound` in interface `StudentWeights`
      Parameters:
        `request` - given request
      Returns:
        weight of the best value

    - #### getDistanceConflictWeight

          @Deprecated
          public double getDistanceConflictWeight(Assignment<Request,Enrollment> assignment,
                                                              DistanceConflict.Conflict distanceConflict)

      Deprecated.
      Description copied from interface: `StudentWeights`
      Return weight of a distance conflict
      Specified by:
        `getDistanceConflictWeight` in interface `StudentWeights`
      Parameters:
        `assignment` - current assignment
        `distanceConflict` - distance conflict
      Returns:
        weight of the conflict

    - #### getTimeOverlapConflictWeight

          @Deprecated
          public double getTimeOverlapConflictWeight(Assignment<Request,Enrollment> assignment,
                                                                 Enrollment enrollment,
                                                                 TimeOverlapsCounter.Conflict timeOverlap)

      Deprecated.
      Description copied from interface: `StudentWeights`
      Return weight of a time overlapping conflict
      Specified by:
        `getTimeOverlapConflictWeight` in interface `StudentWeights`
      Parameters:
        `assignment` - current assignment
        `enrollment` - enrollment in question
        `timeOverlap` - time overlapping conflict
      Returns:
        weight of the conflict

    - #### isFreeTimeAllowOverlaps

          public boolean isFreeTimeAllowOverlaps()

      Description copied from interface: `StudentWeights`
      Return true if free time requests allow overlaps
      Specified by:
        `isFreeTimeAllowOverlaps` in interface `StudentWeights`
      Returns:
        true if free time overlaps are allowed, but the overlapping time is minimized

    - #### getWeight

          public double getWeight(Assignment<Request,Enrollment> assignment,
                                  Enrollment enrollment,
                                  Set<StudentQuality.Conflict> qualityConflicts)

      Description copied from interface: `StudentWeights`
      Return weight of the given enrollment
      Specified by:
        `getWeight` in interface `StudentWeights`
      Parameters:
        `assignment` - current assignment
        `enrollment` - given enrollment
        `qualityConflicts` - student quality conflicts
      Returns:
        weight (higher weight means better value)

    - #### getStudentQualityConflictWeight

          public double getStudentQualityConflictWeight(Assignment<Request,Enrollment> assignment,
                                                        Enrollment enrollment,
                                                        StudentQuality.Conflict conflict)

      Description copied from interface: `StudentWeights`
      Return weight of a student quality conflict
      Specified by:
        `getStudentQualityConflictWeight` in interface `StudentWeights`
      Parameters:
        `assignment` - current assignment
        `enrollment` - enrollment in question
        `conflict` - student quality conflict
      Returns:
        weight of the conflict