FastAStarLandmarksFactory.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * FastAStarLandmarksFactory.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2011 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.core.router;

import java.util.HashMap;
import java.util.Map;

import jakarta.inject.Inject;
import jakarta.inject.Singleton;

import org.matsim.api.core.v01.network.Network;
import org.matsim.core.config.groups.GlobalConfigGroup;
import org.matsim.core.router.util.ArrayRoutingNetworkFactory;
import org.matsim.core.router.util.LeastCostPathCalculator;
import org.matsim.core.router.util.LeastCostPathCalculatorFactory;
import org.matsim.core.router.util.PreProcessLandmarks;
import org.matsim.core.router.util.RoutingNetwork;
import org.matsim.core.router.util.RoutingNetworkFactory;
import org.matsim.core.router.util.RoutingNetworkNode;
import org.matsim.core.router.util.TravelDisutility;
import org.matsim.core.router.util.TravelTime;

@Singleton
public class FastAStarLandmarksFactory implements LeastCostPathCalculatorFactory {

    private final RoutingNetworkFactory routingNetworkFactory;
    private final Map<Network, RoutingNetwork> routingNetworks = new HashMap<>();
    private final Map<Network, PreProcessLandmarks> preProcessData = new HashMap<>();

    private final int nThreads;

    @Inject
    public FastAStarLandmarksFactory(final GlobalConfigGroup globalConfigGroup) {
        this(FastRouterType.ARRAY, globalConfigGroup.getNumberOfThreads());
    }

    public FastAStarLandmarksFactory(int nThreads) {
        this(FastRouterType.ARRAY, nThreads);
    }

    // hide this constructor, as only one router type is allowed anyway...
    private FastAStarLandmarksFactory(final FastRouterType fastRouterType, int numberOfThreads) {
        switch (fastRouterType) {
            case ARRAY:
                this.routingNetworkFactory = new ArrayRoutingNetworkFactory();
                break;
            case POINTER:
                throw new RuntimeException(
                        "PointerRoutingNetworks are no longer supported. Use ArrayRoutingNetworks instead. Aborting!");
            default:
                throw new RuntimeException("Undefined FastRouterType: " + fastRouterType);
        }

        this.nThreads = numberOfThreads;
    }

    @Override
    public synchronized LeastCostPathCalculator createPathCalculator(final Network network,
            final TravelDisutility travelCosts, final TravelTime travelTimes) {
        RoutingNetwork routingNetwork = this.routingNetworks.get(network);
        PreProcessLandmarks preProcessLandmarks = this.preProcessData.get(network);

        if (routingNetwork == null) {
            routingNetwork = this.routingNetworkFactory.createRoutingNetwork(network);

            preProcessLandmarks = new PreProcessLandmarks(travelCosts);
            preProcessLandmarks.setNumberOfThreads(nThreads);
            preProcessLandmarks.run(network);
            this.preProcessData.put(network, preProcessLandmarks);

            for (RoutingNetworkNode node : routingNetwork.getNodes().values()) {
                node.setDeadEndData(preProcessLandmarks.getNodeData(node.getNode()));
            }

            this.routingNetworks.put(network, routingNetwork);
        }
        FastRouterDelegateFactory fastRouterFactory = new ArrayFastRouterDelegateFactory();

        final double overdoFactor = 1.0;
        return new FastAStarLandmarks(routingNetwork, preProcessLandmarks, travelCosts, travelTimes, overdoFactor,
                fastRouterFactory);
    }
}