org.opentrafficsim.core.network.route

Class ProbabilisticRouteGenerator

java.lang.Object

org.opentrafficsim.core.network.route.ProbabilisticRouteGenerator

All Implemented Interfaces:

Generator<Route>, 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-04-05 01:45:04 +0200 (Tue, 05 Apr 2016) $, @version $Revision: 1874 $, by $Author: pknoppers $, initial version 20 Mar 2015

Author:

Alexander Verbraeck, Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
ProbabilisticRouteGenerator(List<Distribution.FrequencyAndObject<Route>> generators, StreamInterface stream) Create a new Probabilistic Route Generator.

Method Summary

Modifier and Type	Method and Description
Route	draw() Return the (next) 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<Distribution.FrequencyAndObject<Route>> generators,
                                   StreamInterface stream)
                            throws ProbabilityException

Create a new Probabilistic Route Generator.

Parameters:

generators - List<Distribution.FrequencyAndObject<Route>>; list of routes and frequencies

stream - StreamInterface; the entropy source

Throws:

ProbabilityException - when the probabilities are invalid

Method Detail

draw

public final Route draw()
                 throws ProbabilityException

Return the (next) Route.

Specified by:

draw in interface Generator<Route>

Specified by:

draw in interface RouteGenerator

Returns:

Route; the next Route

Throws:

ProbabilityException - when the an error was detected in the probabilities of the routes to choose from