org.opentrafficsim.core.network.route

Class ProbabilisticRouteGenerator

java.lang.Object

org.opentrafficsim.core.network.route.ProbabilisticRouteGenerator

All Implemented Interfaces:

RouteGenerator

public class ProbabilisticRouteGenerator
extends Object
implements RouteGenerator

Generate one of a set of routes, based on a discrete probability density function.

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

$LastChangedDate: 2016-01-03 08:35:30 +0100 (Sun, 03 Jan 2016) $, @version $Revision: 1680 $, by $Author: averbraeck $, initial version 20 Mar 2015

Author:

Alexander Verbraeck, Peter Knoppers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProbabilisticRouteGenerator.RouteProbability Combination of route and probability or frequency, non-cumulative.

Constructor Summary

Constructors

Constructor and Description
ProbabilisticRouteGenerator(List<ProbabilisticRouteGenerator.RouteProbability> routeProbabilities, StreamInterface stream) Construct a new ProbabilistiRouteGenerator using the given random stream.

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

ProbabilisticRouteGenerator

public ProbabilisticRouteGenerator(List<ProbabilisticRouteGenerator.RouteProbability> routeProbabilities,
                                   StreamInterface stream)
                            throws NetworkException

Construct a new ProbabilistiRouteGenerator using the given random stream.

Parameters:

routeProbabilities - the Routes with the (non-cumulative) probabilities for each one. Instead of probabilities, (observed) frequencies may be used; The provided values are internally normalized to add up to 1.0.

stream - the random stream to use

Throws:

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

Method Detail

generateRoute

public final Route generateRoute()

Generate a Route. Generation can be based on GTU type, randomness, fixed, or otherwise.

Specified by:

generateRoute in interface RouteGenerator

Returns:

a Route, which can be complete or partial.