org.opentrafficsim.core.network.route

Class ProbabilisticFixedRouteGenerator

java.lang.Object

org.opentrafficsim.core.network.route.ProbabilisticFixedRouteGenerator

All Implemented Interfaces:

RouteGenerator

public class ProbabilisticFixedRouteGenerator
extends Object
implements RouteGenerator

Copyright (c) 2013-2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

20 mrt. 2015

Author:

Alexander Verbraeck, Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
ProbabilisticFixedRouteGenerator(SortedMap<RouteGenerator,Double> routeProbabilities) Construct a new ProbabilisticFixedRouteGenerator using System.currentTimeMillis() to seed the random number generator.
ProbabilisticFixedRouteGenerator(SortedMap<RouteGenerator,Double> routeProbabilities, long seed) Construct a new ProbabilisticFixedRouteGenerator.

Method Summary

Modifier and Type	Method and Description
Route	generateRoute() Generate a Route.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProbabilisticFixedRouteGenerator

public ProbabilisticFixedRouteGenerator(SortedMap<RouteGenerator,Double> routeProbabilities)
                                 throws NetworkException

Construct a new ProbabilisticFixedRouteGenerator using System.currentTimeMillis() to seed the random number generator.

Parameters:

routeProbabilities - SortedMap<RouteGenerator, Double>; the RouteGenerators with the probabilities for each one. In stead of probabilities, (observed) counts may be used; i.e. the provided values are internally scaled to add up to 1.0.

Throws:

NetworkException - when the probabilities or frequencies are invalid (negative, or all zero)

ProbabilisticFixedRouteGenerator

public ProbabilisticFixedRouteGenerator(SortedMap<RouteGenerator,Double> routeProbabilities,
                                        long seed)
                                 throws NetworkException

Construct a new ProbabilisticFixedRouteGenerator.

Parameters:

routeProbabilities - SortedMap<RouteGenerator, Double>; the RouteGenerators with the probabilities for each one. In stead of probabilities, (observed) counts may be used; i.e. the provided values are internally scaled to add up to 1.0.

seed - long; the seed for the random number generator that will be used

Throws:

NetworkException - when the probabilities or frequencies are invalid (negative, or all zero)

Method Detail

generateRoute

public final Route generateRoute()

Generate a Route.

Specified by:

generateRoute in interface RouteGenerator

Returns:

Route; the generated Route