org.matsim.utils.leastcostpathtree.LeastCostPathTree Class Reference

Classes
class	ComparatorCost
class	NodeData

Public Member Functions
	LeastCostPathTree (TravelTime tt, TravelDisutility tc)
void	calculate (final Network network, final Node origin, final double time)
final IdMap< Node, NodeData >	getTree ()
final Node	getOrigin ()
final double	getDepartureTime ()

Static Public Member Functions
static void	main (String[] args)

Protected Member Functions
void	additionalComputationsHook (Link link, double currTime)

Private Member Functions
void	relaxNode (final Node n, PriorityQueue< Node > pendingNodes)

Private Attributes
Node	origin1 = null
double	dTime = Double.NaN
final TravelTime	ttFunction
final TravelDisutility	tcFunction
IdMap< Node, NodeData >	nodeData = null
final Vehicle	VEHICLE = VehicleUtils.getFactory().createVehicle(Id.create("theVehicle", Vehicle.class), VehicleUtils.createDefaultVehicleType())
final Person	PERSON = PopulationUtils.getFactory().createPerson(Id.create("thePerson", Person.class))

Detailed Description

Calculates a least-cost-path tree using Dijkstra's algorithm for calculating a shortest-path tree, given a node as root of the tree.

Author

balmermi, mrieser

Definition at line 53 of file LeastCostPathTree.java.

Constructor & Destructor Documentation

LeastCostPathTree()

org.matsim.utils.leastcostpathtree.LeastCostPathTree.LeastCostPathTree	(	TravelTime	tt,
		TravelDisutility	tc
	)

Definition at line 73 of file LeastCostPathTree.java.

Referenced by org.matsim.utils.leastcostpathtree.LeastCostPathTree.main().

                                                                 {
        this.ttFunction = tt;
        this.tcFunction = tc;
    }

Member Function Documentation

calculate()

void org.matsim.utils.leastcostpathtree.LeastCostPathTree.calculate	(	final Network	network,
		final Node	origin,
		final double	time
	)

Definition at line 78 of file LeastCostPathTree.java.

References org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.api.core.v01.IdMap< T, V >.put(), and org.matsim.utils.leastcostpathtree.LeastCostPathTree.relaxNode().

                                                                                       {
        this.origin1 = origin;
        this.dTime = time;
        
        this.nodeData = new IdMap<>(Node.class);
        NodeData d = new NodeData();
        d.time = time;
        d.cost = 0;
        this.nodeData.put(origin.getId(), d);

        ComparatorCost comparator = new ComparatorCost(this.nodeData);
        PriorityQueue<Node> pendingNodes = new PriorityQueue<>(500, comparator);
        relaxNode(origin, pendingNodes);
        while (!pendingNodes.isEmpty()) {
            Node n = pendingNodes.poll();
            relaxNode(n, pendingNodes);
        }
    }

Here is the call graph for this function:

getTree()

final IdMap<Node, NodeData> org.matsim.utils.leastcostpathtree.LeastCostPathTree.getTree

(

)

Definition at line 152 of file LeastCostPathTree.java.

References org.matsim.utils.leastcostpathtree.LeastCostPathTree.nodeData.

                                                 {
        return this.nodeData;
    }

getOrigin()

final Node org.matsim.utils.leastcostpathtree.LeastCostPathTree.getOrigin

(

)

Returns

Returns the root of the calculated tree, or null if no tree was calculated yet.

Definition at line 159 of file LeastCostPathTree.java.

References org.matsim.utils.leastcostpathtree.LeastCostPathTree.origin1.

                                  {
        return this.origin1;
    }

getDepartureTime()

final double org.matsim.utils.leastcostpathtree.LeastCostPathTree.getDepartureTime

(

)

Definition at line 163 of file LeastCostPathTree.java.

References org.matsim.utils.leastcostpathtree.LeastCostPathTree.dTime.

                                           {
        return this.dTime;
    }

relaxNode()

void org.matsim.utils.leastcostpathtree.LeastCostPathTree.relaxNode ( final Node  n, PriorityQueue< Node >  pendingNodes  )

private

Definition at line 171 of file LeastCostPathTree.java.

References org.matsim.utils.leastcostpathtree.LeastCostPathTree.additionalComputationsHook(), org.matsim.api.core.v01.IdMap< T, V >.get(), org.matsim.utils.leastcostpathtree.LeastCostPathTree.NodeData.getCost(), org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.core.router.util.TravelDisutility.getLinkTravelDisutility(), org.matsim.core.router.util.TravelTime.getLinkTravelTime(), org.matsim.api.core.v01.network.Node.getOutLinks(), org.matsim.utils.leastcostpathtree.LeastCostPathTree.NodeData.getTime(), and org.matsim.api.core.v01.IdMap< T, V >.put().

Referenced by org.matsim.utils.leastcostpathtree.LeastCostPathTree.calculate().

                                                                           {
        NodeData nData = nodeData.get(n.getId());
        double currTime = nData.getTime();
        double currCost = nData.getCost();
        for (Link l : n.getOutLinks().values()) {
            Node nn = l.getToNode();
            NodeData nnData = nodeData.get(nn.getId());
            if (nnData == null) {
                nnData = new NodeData();
                this.nodeData.put(nn.getId(), nnData);
            }
            double visitCost = currCost + tcFunction.getLinkTravelDisutility(l, currTime, PERSON, VEHICLE);
            double visitTime = currTime + ttFunction.getLinkTravelTime(l, currTime, PERSON, VEHICLE);
            
            
            if (visitCost < nnData.getCost()) {
                pendingNodes.remove(nn);
                nnData.visit(n.getId(), visitCost, visitTime);
                additionalComputationsHook( l, currTime ) ;
                pendingNodes.add(nn);
            }
        }
    }

Here is the call graph for this function:

additionalComputationsHook()

void org.matsim.utils.leastcostpathtree.LeastCostPathTree.additionalComputationsHook ( Link  link, double  currTime  )

protected

Definition at line 195 of file LeastCostPathTree.java.

Referenced by org.matsim.utils.leastcostpathtree.LeastCostPathTree.relaxNode().

                                                                            {
        // left empty for inheritance
    }

main()

static void org.matsim.utils.leastcostpathtree.LeastCostPathTree.main ( String []  args )

static

Definition at line 203 of file LeastCostPathTree.java.

References org.matsim.api.core.v01.TransportMode.car, org.matsim.api.core.v01.Id< T >.create(), org.matsim.core.config.ConfigUtils.createConfig(), org.matsim.core.scenario.ScenarioUtils.createScenario(), org.matsim.api.core.v01.IdMap< T, V >.entrySet(), org.matsim.core.scenario.MutableScenario.getConfig(), org.matsim.utils.leastcostpathtree.LeastCostPathTree.NodeData.getCost(), org.matsim.core.trafficmonitoring.TravelTimeCalculator.getLinkTravelTimes(), org.matsim.core.scenario.MutableScenario.getNetwork(), org.matsim.api.core.v01.network.Network.getNodes(), org.matsim.utils.leastcostpathtree.LeastCostPathTree.NodeData.getPrevNodeId(), org.matsim.utils.leastcostpathtree.LeastCostPathTree.NodeData.getTime(), org.matsim.utils.leastcostpathtree.LeastCostPathTree.LeastCostPathTree(), and org.matsim.core.config.Config.travelTimeCalculator().

                                           {
        MutableScenario scenario = (MutableScenario) ScenarioUtils.createScenario(ConfigUtils.createConfig());
        Network network = scenario.getNetwork();
        new MatsimNetworkReader(scenario.getNetwork()).readFile("../../input/network.xml");

        TravelTimeCalculator ttc = new TravelTimeCalculator(network, 60, 30 * 3600, scenario.getConfig().travelTimeCalculator());
        LeastCostPathTree st = new LeastCostPathTree(ttc.getLinkTravelTimes(), new RandomizingTimeDistanceTravelDisutilityFactory( TransportMode.car, scenario.getConfig() ).createTravelDisutility(ttc.getLinkTravelTimes()));
        Node origin = network.getNodes().get(Id.create(1, Node.class));
        st.calculate(network, origin, 8*3600);
        IdMap<Node, NodeData> tree = st.getTree();
        for (Map.Entry<Id<Node>, NodeData> e : tree.entrySet()) {
            Id<Node> id = e.getKey();
            NodeData d = e.getValue();
            if (d.getPrevNodeId() != null) {
                System.out.println(id + "\t" + d.getTime() + "\t" + d.getCost() + "\t" + d.getPrevNodeId());
            } else {
                System.out.println(id + "\t" + d.getTime() + "\t" + d.getCost() + "\t" + "0");
            }
        }
    }

Here is the call graph for this function:

Member Data Documentation

origin1

Node org.matsim.utils.leastcostpathtree.LeastCostPathTree.origin1 = null

private

Definition at line 59 of file LeastCostPathTree.java.

Referenced by org.matsim.utils.leastcostpathtree.LeastCostPathTree.getOrigin().

dTime

double org.matsim.utils.leastcostpathtree.LeastCostPathTree.dTime = Double.NaN

private

Definition at line 60 of file LeastCostPathTree.java.

Referenced by org.matsim.utils.leastcostpathtree.LeastCostPathTree.getDepartureTime().

ttFunction

final TravelTime org.matsim.utils.leastcostpathtree.LeastCostPathTree.ttFunction

private

Definition at line 62 of file LeastCostPathTree.java.

tcFunction

final TravelDisutility org.matsim.utils.leastcostpathtree.LeastCostPathTree.tcFunction

private

Definition at line 63 of file LeastCostPathTree.java.

nodeData

IdMap<Node, NodeData> org.matsim.utils.leastcostpathtree.LeastCostPathTree.nodeData = null

private

Definition at line 64 of file LeastCostPathTree.java.

Referenced by org.matsim.utils.leastcostpathtree.LeastCostPathTree.NodeData.getPrevNodeId(), and org.matsim.utils.leastcostpathtree.LeastCostPathTree.getTree().

VEHICLE

final Vehicle org.matsim.utils.leastcostpathtree.LeastCostPathTree.VEHICLE = VehicleUtils.getFactory().createVehicle(Id.create("theVehicle", Vehicle.class), VehicleUtils.createDefaultVehicleType())

private

Definition at line 66 of file LeastCostPathTree.java.

PERSON

final Person org.matsim.utils.leastcostpathtree.LeastCostPathTree.PERSON = PopulationUtils.getFactory().createPerson(Id.create("thePerson", Person.class))

private

Definition at line 67 of file LeastCostPathTree.java.

---

The documentation for this class was generated from the following file:

• utils/leastcostpathtree/LeastCostPathTree.java