Add ScoreStatsStatisitcs for LSPs

src/main/java/org/matsim/freight/logistics/LSPModule.java

@@ -45,6 +45,7 @@
 import org.matsim.freight.carriers.Carriers;
 import org.matsim.freight.carriers.FreightCarriersConfigGroup;
 import org.matsim.freight.carriers.controler.*;
+import org.matsim.freight.logistics.analysis.LspScoreStatsModule;
 
 public class LSPModule extends AbstractModule {
   private static final Logger log = LogManager.getLogger(LSPModule.class);
@@ -65,6 +66,8 @@ public void install() {
     bind(CarrierAgentTracker.class).in(Singleton.class);
     addEventHandlerBinding().to(CarrierAgentTracker.class);
 
+    install(new LspScoreStatsModule());
+
     // this switches on certain qsim components:
     QSimComponentsConfigGroup qsimComponents =
         ConfigUtils.addOrGetModule(getConfig(), QSimComponentsConfigGroup.class);

src/main/java/org/matsim/freight/logistics/LSPUtils.java

@@ -39,6 +39,17 @@ public static LSPPlan createLSPPlan() {
     return new LSPPlanImpl();
   }
 
+
+  /**
+  * Checks, is the plan the selcted plan.
+  * (This is adapted copy from PersonUtils.isSelected(plan) )
+  * @param lspPlan the plan to check
+  * @return true if the plan is the selected plan. false, if not.
+  */
+  public static boolean isPlanTheSelectedPlan(LSPPlan lspPlan) {
+    return lspPlan.getLSP().getSelectedPlan() == lspPlan;
+  }
+
   public static LogisticChainScheduler createForwardLogisiticChainScheduler() {
     return new ForwardLogisticChainSchedulerImpl();
   }

src/main/java/org/matsim/freight/logistics/analysis/LspScoreStats.java

@@ -0,0 +1,35 @@
+
+/*
+ *  *********************************************************************** *
+ *  * project: org.matsim.*
+ *  * ScoreStats.java
+ *  *                                                                         *
+ *  * *********************************************************************** *
+ *  *                                                                         *
+ *  * copyright       : (C) 2014 by the members listed in the COPYING, *
+ *  *                   LICENSE and WARRANTY file.                            *
+ *  * email           : info at matsim dot org                                *
+ *  *                                                                         *
+ *  * *********************************************************************** *
+ *  *                                                                         *
+ *  *   This program is free software; you can redistribute it and/or modify  *
+ *  *   it under the terms of the GNU General Public License as published by  *
+ *  *   the Free Software Foundation; either version 2 of the License, or     *
+ *  *   (at your option) any later version.                                   *
+ *  *   See also COPYING, LICENSE and WARRANTY file                           *
+ *  *                                                                         *
+ *  * ***********************************************************************
+ */
+
+package org.matsim.freight.logistics.analysis;
+
+import java.util.Map;
+
+public interface LspScoreStats {
+
+    /**
+     * @return the history of scores in last iterations
+     */
+    Map<LspScoreStatsControlerListener.ScoreItem, Map<Integer, Double>> getScoreHistory();
+
+}

src/main/java/org/matsim/freight/logistics/analysis/LspScoreStatsControlerListener.java

@@ -0,0 +1,286 @@
+/* *********************************************************************** *
+ * project: org.matsim.*
+ * ScoreStats.java
+ *                                                                         *
+ * *********************************************************************** *
+ *                                                                         *
+ * copyright       : (C) 2007 by the members listed in the COPYING,        *
+ *                   LICENSE and WARRANTY file.                            *
+ * email           : info at matsim dot org                                *
+ *                                                                         *
+ * *********************************************************************** *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *   See also COPYING, LICENSE and WARRANTY file                           *
+ *                                                                         *
+ * *********************************************************************** */
+
+package org.matsim.freight.logistics.analysis;
+
+import jakarta.inject.Inject;
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.util.*;
+import java.util.stream.Collectors;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.matsim.api.core.v01.Scenario;
+import org.matsim.core.config.groups.ControllerConfigGroup;
+import org.matsim.core.config.groups.GlobalConfigGroup;
+import org.matsim.core.controler.OutputDirectoryHierarchy;
+import org.matsim.core.controler.events.IterationEndsEvent;
+import org.matsim.core.controler.events.ShutdownEvent;
+import org.matsim.core.controler.events.StartupEvent;
+import org.matsim.core.controler.listener.IterationEndsListener;
+import org.matsim.core.controler.listener.ShutdownListener;
+import org.matsim.core.controler.listener.StartupListener;
+import org.matsim.core.population.PopulationUtils;
+import org.matsim.core.utils.charts.XYLineChart;
+import org.matsim.core.utils.io.IOUtils;
+import org.matsim.freight.logistics.LSP;
+import org.matsim.freight.logistics.LSPPlan;
+import org.matsim.freight.logistics.LSPUtils;
+import org.matsim.freight.logistics.LSPs;
+
+/**
+ * Calculates at the end of each iteration the following statistics:
+ * <ul>
+ * <li>average score of the selected plan</li>
+ * <li>average of the score of the worst plan of each agent</li>
+ * <li>average of the score of the best plan of each agent</li>
+ * <li>average of the average score of all plans of each agent</li>
+ * </ul>
+ * Plans with undefined scores
+ * are not included in the statistics. The calculated values are written to a file, each iteration on
+ * a separate line.
+ *
+ * @author mrieser
+ */
+public class LspScoreStatsControlerListener implements StartupListener, IterationEndsListener, ShutdownListener, LspScoreStats {
+
+	private static final String LSP_SCORESTATS = "lsp_scorestats";
+
+	public enum ScoreItem { worst, best, average, executed }
+
+	private final LSPs lsps;
+	private final OutputDirectoryHierarchy controllerIO;
+	private final String delimiter;
+	private final BufferedWriter out;
+
+	private final ControllerConfigGroup controllerConfigGroup;
+
+	private final Map<ScoreItem, Map< Integer, Double>> scoreHistory = new HashMap<>();
+
+	private final Map<String, ScoreHist> perLsp = new HashMap<>();
+
+	private int minIteration = 0;
+
+	private final static Logger log = LogManager.getLogger(LspScoreStatsControlerListener.class);
+
+	@Inject
+	LspScoreStatsControlerListener(ControllerConfigGroup controllerConfigGroup, Scenario scenario, OutputDirectoryHierarchy controllerIO,
+								   GlobalConfigGroup globalConfig ) {
+		this.controllerConfigGroup = controllerConfigGroup;
+		this.lsps = LSPUtils.getLSPs(scenario);
+		this.controllerIO = controllerIO;
+		this.delimiter = globalConfig.getDefaultDelimiter();
+		this.out = IOUtils.getBufferedWriter(controllerIO.getOutputFilename(LSP_SCORESTATS + ".csv"));
+
+		//TODO: Das hier dann mal ansehen, weil es ja nun nicht mehr via Subpobulations ist.. Vermutlich brauche ich nur die LSPIds...
+		Set<String> lspIds = lsps.getLSPs().values().stream()
+			.map(PopulationUtils::getSubpopulation)
+			.filter(Objects::nonNull)
+			.collect(Collectors.toSet());
+
+		for (String lspId : lspIds) {
+			this.perLsp.put(lspId, new ScoreHist(new HashMap<>(), IOUtils.getBufferedWriter(controllerIO.getOutputFilename(LSP_SCORESTATS + "_" + lspId + ".csv"))));
+		}
+
+		try {
+			this.out.write("iteration" + this.delimiter + "avg_executed" + this.delimiter
+				+ "avg_worst" + this.delimiter + "avg_average" + this.delimiter + "avg_best\n");
+			for (Map.Entry<String, ScoreHist> e : this.perLsp.entrySet()) {
+				e.getValue().out.write("iteration" + this.delimiter + "avg_executed" + this.delimiter
+					+ "avg_worst" + this.delimiter + "avg_average" + this.delimiter + "avg_best\n");
+			}
+
+		} catch (IOException e) {
+			throw new UncheckedIOException(e);
+		}
+	}
+
+	@Override
+	public void notifyStartup(final StartupEvent event) {
+		this.minIteration = this.controllerConfigGroup.getFirstIteration();
+		//		int maxIter = controlerConfigGroup.getLastIteration();
+		//		int iterations = maxIter - this.minIteration;
+		//		if (iterations > 5000) iterations = 5000; // limit the history size
+		for ( ScoreItem item : ScoreItem.values() ) {
+			this.scoreHistory.put( item, new TreeMap<>() ) ;
+			this.perLsp.forEach((s, data) -> data.hist.put(item, new TreeMap<>()));
+		}
+	}
+
+	@Override
+	public void notifyIterationEnds(final IterationEndsEvent event) {
+		collectScoreInfo(event);
+		if (isWriteGraph(event)) {
+			writePng();
+		}
+	}
+
+	private boolean isWriteGraph(IterationEndsEvent event) {
+		// create chart when data of more than one iteration is available.
+		return this.controllerConfigGroup.getCreateGraphsInterval() > 0 &&
+			event.getIteration() % this.controllerConfigGroup.getCreateGraphsInterval() == 0 &&
+			event.getIteration() > this.minIteration;
+	}
+
+	private void collectScoreInfo(final IterationEndsEvent event) {
+		ScoreInfo info = new ScoreInfo();
+
+		Map<String, ScoreInfo> perLsp = new HashMap<>();
+		this.perLsp.forEach((subpop, d) -> perLsp.put(subpop, new ScoreInfo()));
+
+		for (LSP lsp : this.lsps.getLSPs().values()) {
+			info.update(lsp);
+			String subpop = PopulationUtils.getSubpopulation(lsp);
+			if (subpop != null)
+				perLsp.get(subpop).update(lsp);
+		}
+
+
+		log.info("-- avg. score of the executed plan of each agent: " + (info.sumExecutedScores / info.nofExecutedScores));
+		log.info("-- avg. score of the worst plan of each agent: " + (info.sumScoreWorst / info.nofScoreWorst));
+		log.info("-- avg. of the avg. plan score per agent: " + (info.sumAvgScores / info.nofAvgScores));
+		log.info("-- avg. score of the best plan of each agent: " + (info.sumScoreBest / info.nofScoreBest));
+
+		try {
+			info.write(event.getIteration(), this.out, this.delimiter);
+			for (Map.Entry<String, ScoreHist> e : this.perLsp.entrySet()) {
+				perLsp.get(e.getKey()).write(event.getIteration(), e.getValue().out, this.delimiter);
+			}
+
+		} catch (IOException e) {
+			e.printStackTrace();
+		}
+
+//		int index = event.getIteration() - this.minIteration;
+
+		this.scoreHistory.get( ScoreItem.worst ).put( event.getIteration(), info.sumScoreWorst / info.nofScoreWorst ) ;
+		this.scoreHistory.get( ScoreItem.best ).put( event.getIteration(), info.sumScoreBest / info.nofScoreBest ) ;
+		this.scoreHistory.get( ScoreItem.average ).put( event.getIteration(), info.sumAvgScores / info.nofAvgScores ) ;
+		this.scoreHistory.get( ScoreItem.executed ).put( event.getIteration(), info.sumExecutedScores / info.nofExecutedScores ) ;
+	}
+
+	private void writePng() {
+		XYLineChart chart = new XYLineChart("Score Statistics", "iteration", "score");
+		chart.addSeries("avg. worst score", this.scoreHistory.get( ScoreItem.worst ) ) ;
+		chart.addSeries("avg. best score", this.scoreHistory.get( ScoreItem.best) );
+		chart.addSeries("avg. of plans' average score", this.scoreHistory.get( ScoreItem.average) );
+		chart.addSeries("avg. executed score", this.scoreHistory.get( ScoreItem.executed ) );
+		chart.addMatsimLogo();
+		chart.saveAsPng(this.controllerIO.getOutputFilename(LSP_SCORESTATS + ".png"), 800, 600);
+	}
+
+	@Override
+	public void notifyShutdown(final ShutdownEvent controlerShudownEvent) {
+		try {
+			this.out.close();
+			for (ScoreHist data : this.perLsp.values()) {
+				data.out.close();
+			}
+		} catch (IOException e) {
+			log.error(e.getMessage(), e);
+		}
+	}
+
+	@Override
+	public Map<ScoreItem, Map<Integer, Double>> getScoreHistory() {
+		return Collections.unmodifiableMap( this.scoreHistory ) ;
+	}
+
+	private record ScoreHist(Map<ScoreItem, Map< Integer, Double>> hist, BufferedWriter out) {}
+
+	private static final class ScoreInfo {
+		double sumScoreWorst = 0.0;
+		double sumScoreBest = 0.0;
+		double sumAvgScores = 0.0;
+		double sumExecutedScores = 0.0;
+		int nofScoreWorst = 0;
+		int nofScoreBest = 0;
+		int nofAvgScores = 0;
+		int nofExecutedScores = 0;
+
+		private void update(LSP lsp) {
+			LSPPlan worstPlan = null;
+			LSPPlan bestPlan = null;
+			double worstScore = Double.POSITIVE_INFINITY;
+			double bestScore = Double.NEGATIVE_INFINITY;
+			double sumScores = 0.0;
+			double cntScores = 0;
+			for (LSPPlan plan : lsp.getPlans()) {
+
+				if (plan.getScore() == null) {
+					continue;
+				}
+				double score = plan.getScore();
+
+				// worst plan
+				if (worstPlan == null) {
+					worstPlan = plan;
+					worstScore = score;
+				} else if (score < worstScore) {
+					worstPlan = plan;
+					worstScore = score;
+				}
+
+				// best plan
+				if (bestPlan == null) {
+					bestPlan = plan;
+					bestScore = score;
+				} else if (score > bestScore) {
+					bestPlan = plan;
+					bestScore = score;
+				}
+
+				// avg. score
+				sumScores += score;
+				cntScores++;
+
+				// executed plan?
+				if (LSPUtils.isPlanTheSelectedPlan(plan)) {
+					this.sumExecutedScores += score;
+					this.nofExecutedScores++;
+				}
+			}
+
+			if (worstPlan != null) {
+				this.nofScoreWorst++;
+				this.sumScoreWorst += worstScore;
+			}
+			if (bestPlan != null) {
+				this.nofScoreBest++;
+				this.sumScoreBest += bestScore;
+			}
+			if (cntScores > 0) {
+				this.sumAvgScores += (sumScores / cntScores);
+				this.nofAvgScores++;
+			}
+		}
+
+		private void write(int iteration, BufferedWriter out, String delimiter) throws IOException {
+			out.write(iteration + delimiter
+				+ (this.sumExecutedScores / this.nofExecutedScores) + delimiter
+				+ (this.sumScoreWorst / this.nofScoreWorst) + delimiter
+				+ (this.sumAvgScores / this.nofAvgScores) + delimiter
+				+ (this.sumScoreBest / this.nofScoreBest) + "\n");
+			out.flush();
+		}
+
+	}
+}

src/main/java/org/matsim/freight/logistics/analysis/LspScoreStatsModule.java

@@ -0,0 +1,35 @@
+/*
+ *  *********************************************************************** *
+ *  * project: org.matsim.*
+ *  * ScoreStatsModule.java
+ *  *                                                                         *
+ *  * *********************************************************************** *
+ *  *                                                                         *
+ *  * copyright       : (C) 2014 by the members listed in the COPYING, *
+ *  *                   LICENSE and WARRANTY file.                            *
+ *  * email           : info at matsim dot org                                *
+ *  *                                                                         *
+ *  * *********************************************************************** *
+ *  *                                                                         *
+ *  *   This program is free software; you can redistribute it and/or modify  *
+ *  *   it under the terms of the GNU General Public License as published by  *
+ *  *   the Free Software Foundation; either version 2 of the License, or     *
+ *  *   (at your option) any later version.                                   *
+ *  *   See also COPYING, LICENSE and WARRANTY file                           *
+ *  *                                                                         *
+ *  * ***********************************************************************
+ */
+
+package org.matsim.freight.logistics.analysis;
+
+import com.google.inject.Singleton;
+import org.matsim.core.controler.AbstractModule;
+
+public class LspScoreStatsModule extends AbstractModule {
+    @Override
+    public void install() {
+        bind(LspScoreStatsControlerListener.class).in(Singleton.class);
+        addControlerListenerBinding().to(LspScoreStatsControlerListener.class);
+        bind(LspScoreStats.class).to(LspScoreStatsControlerListener.class);
+    }
+}