/*
* Copyright 2013 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.statistic.bestsolutionmutation;
import java.awt.BasicStroke;
import java.io.File;
import java.text.NumberFormat;
import java.util.Locale;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.axis.NumberAxis;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.chart.plot.XYPlot;
import org.jfree.chart.renderer.xy.XYItemRenderer;
import org.jfree.chart.renderer.xy.YIntervalRenderer;
import org.jfree.data.xy.XYIntervalSeries;
import org.jfree.data.xy.XYIntervalSeriesCollection;
import org.optaplanner.benchmark.config.statistic.ProblemStatisticType;
import org.optaplanner.benchmark.impl.report.BenchmarkReport;
import org.optaplanner.benchmark.impl.result.ProblemBenchmarkResult;
import org.optaplanner.benchmark.impl.result.SingleBenchmarkResult;
import org.optaplanner.benchmark.impl.statistic.ProblemStatistic;
import org.optaplanner.benchmark.impl.statistic.SingleStatistic;
import org.optaplanner.benchmark.impl.statistic.common.MillisecondsSpentNumberFormat;
@XStreamAlias("bestSolutionMutationProblemStatistic")
public class BestSolutionMutationProblemStatistic extends ProblemStatistic {
protected File graphFile = null;
public BestSolutionMutationProblemStatistic(ProblemBenchmarkResult problemBenchmarkResult) {
super(problemBenchmarkResult, ProblemStatisticType.BEST_SOLUTION_MUTATION);
}
@Override
public SingleStatistic createSingleStatistic(SingleBenchmarkResult singleBenchmarkResult) {
return new BestSolutionMutationSingleStatistic(singleBenchmarkResult);
}
/**
* @return never null
*/
public File getGraphFile() {
return graphFile;
}
// ************************************************************************
// Write methods
// ************************************************************************
@Override
public void writeGraphFiles(BenchmarkReport benchmarkReport) {
XYPlot plot = createPlot(benchmarkReport);
int seriesIndex = 0;
for (SingleBenchmarkResult singleBenchmarkResult : problemBenchmarkResult.getSingleBenchmarkResultList()) {
XYIntervalSeries series = new XYIntervalSeries(singleBenchmarkResult.getSolverBenchmarkResult().getNameWithFavoriteSuffix());
XYItemRenderer renderer = new YIntervalRenderer();
if (singleBenchmarkResult.isSuccess()) {
BestSolutionMutationSingleStatistic singleStatistic = (BestSolutionMutationSingleStatistic)
singleBenchmarkResult.getSingleStatistic(problemStatisticType);
for (BestSolutionMutationStatisticPoint point : singleStatistic.getPointList()) {
long timeMillisSpent = point.getTimeMillisSpent();
long mutationCount = point.getMutationCount();
double yValue = mutationCount;
// In an XYInterval the yLow must be lower than yHigh
series.add(timeMillisSpent, timeMillisSpent, timeMillisSpent,
yValue, (yValue > 0.0) ? 0.0 : yValue, (yValue > 0.0) ? yValue : 0.0);
}
}
XYIntervalSeriesCollection dataset = new XYIntervalSeriesCollection();
dataset.addSeries(series);
plot.setDataset(seriesIndex, dataset);
if (singleBenchmarkResult.getSolverBenchmarkResult().isFavorite()) {
// Make the favorite more obvious
renderer.setSeriesStroke(0, new BasicStroke(2.0f));
}
plot.setRenderer(seriesIndex, renderer);
seriesIndex++;
}
JFreeChart chart = new JFreeChart(problemBenchmarkResult.getName() + " best solution mutation statistic",
JFreeChart.DEFAULT_TITLE_FONT, plot, true);
graphFile = writeChartToImageFile(chart, problemBenchmarkResult.getName() + "BestSolutionMutationStatistic");
}
private XYPlot createPlot(BenchmarkReport benchmarkReport) {
Locale locale = benchmarkReport.getLocale();
NumberAxis xAxis = new NumberAxis("Time spent");
xAxis.setNumberFormatOverride(new MillisecondsSpentNumberFormat(locale));
NumberAxis yAxis = new NumberAxis("Best solution mutation count");
yAxis.setNumberFormatOverride(NumberFormat.getInstance(locale));
yAxis.setAutoRangeIncludesZero(true);
XYPlot plot = new XYPlot(null, xAxis, yAxis, null);
plot.setOrientation(PlotOrientation.VERTICAL);
return plot;
}
}