001package org.cpsolver.coursett.preference;
002
003/**
004 * Average preference combination. <br>
005 * <ul>
006 * <li>If at least one preference is required &rarr; required
007 * <li>If at least one preference is prohibited &rarr; prohibited
008 * <li>Otherwise, mean value from the given preferences is returned
009 * </ul>
010 * 
011 * @author  Tomáš Müller
012 * @version CourseTT 1.3 (University Course Timetabling)<br>
013 *          Copyright (C) 2006 - 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
029 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
030 */
031public class AveragePreferenceCombination extends PreferenceCombination {
032    int iPreference = 0;
033    int iCnt = 0;
034    
035    public AveragePreferenceCombination() {}
036    
037    public AveragePreferenceCombination(AveragePreferenceCombination c) {
038        super(c);
039        iPreference = c.iPreference;
040        iCnt = c.iCnt;
041    }
042
043    @Override
044    public void addPreferenceInt(int intPref) {
045        super.addPreferenceInt(intPref);
046        iPreference += intPref;
047        iCnt++;
048    }
049
050    @Override
051    public int getPreferenceInt() {
052        return Math.round(((float) iPreference) / ((float) iCnt));
053    }
054
055    @Override
056    public PreferenceCombination clonePreferenceCombination() { return new AveragePreferenceCombination(this); }
057}