/*
* Copyright 2010 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.optaplanner.benchmark.impl.ranking;
import java.io.Serializable;
import java.util.Comparator;
import org.apache.commons.lang.builder.CompareToBuilder;
import org.optaplanner.benchmark.impl.result.SolverBenchmarkResult;
import org.optaplanner.core.api.domain.solution.Solution;
import org.optaplanner.core.api.score.Score;
/**
* This ranking {@link Comparator} orders a {@link SolverBenchmarkResult} by its total {@link Score}.
* It maximize the overall score, so it minimizes the overall cost if all {@link Solution}s would be executed.
* <p/>
* When the inputSolutions differ greatly in size or difficulty, this often results in a big difference in
* {@link Score} magnitude between each {@link Solution}. For example: score 10 for dataset A versus 1000 for dataset B.
* In such cases, dataset B would marginalize dataset A.
* To avoid that, use {@link TotalRankSolverRankingWeightFactory}.
*/
public class TotalScoreSolverRankingComparator implements Comparator<SolverBenchmarkResult>, Serializable {
private final ResilientScoreComparator resilientScoreComparator
= new ResilientScoreComparator();
private final WorstScoreSolverRankingComparator worstScoreSolverRankingComparator
= new WorstScoreSolverRankingComparator();
public int compare(SolverBenchmarkResult a, SolverBenchmarkResult b) {
return new CompareToBuilder()
.append(a.getTotalScore(), b.getTotalScore(), resilientScoreComparator)
.append(a, b, worstScoreSolverRankingComparator)
.toComparison();
}
}