Uses of Class
org.goplanit.gap.GapFunction

Packages that use GapFunction

Package	Description
org.goplanit.assignment	Traffic assignment classes
org.goplanit.assignment.ltm.sltm
org.goplanit.component.event
org.goplanit.gap	Gap functions and criteria used to test for convergence of the assignment algorithms

Uses of GapFunction in org.goplanit.assignment

Methods in org.goplanit.assignment that return GapFunction

Modifier and Type	Method	Description
protected GapFunction	TrafficAssignmentBuilder.createGapFunctionInstance(StopCriterion stopCriterion)	create a gap function instance based on configuration
GapFunction	TrafficAssignment.getGapFunction()	Collect the gap function which is to be set by a derived class of TrafficAssignment via the initialiseDefaults() right after construction

Methods in org.goplanit.assignment that return types with arguments of type GapFunction

Modifier and Type	Method	Description
GapFunctionConfigurator<? extends GapFunction>	TrafficAssignmentConfigurator.createAndRegisterGapFunction(String gapFunctionType)	Create and Register gapFunction component
GapFunctionConfigurator<? extends GapFunction>	TrafficAssignmentConfigurator.getGapFunction()	Collect the gap function of the trafficAssignment instance

Methods in org.goplanit.assignment with parameters of type GapFunction

Modifier and Type	Method	Description
void	TrafficAssignment.setGapFunction(GapFunction gapfunction)	Collect the gap function which is to be set by a derived class of TrafficAssignment via the initialiseDefaults() right after construction

Uses of GapFunction in org.goplanit.assignment.ltm.sltm

Methods in org.goplanit.assignment.ltm.sltm with parameters of type GapFunction

Modifier and Type	Method	Description
boolean	StaticLtmAssignmentStrategy.hasConverged(GapFunction gapFunction, int iterationIndex)	Verify if assignment has converged, which, means computing ths gap and determining if it has converged in this iteration in this default setup
boolean	StaticLtmBushStrategyBase.hasConverged(GapFunction gapFunction, int iterationIndex)	Unlike the default convergence check, we also see if the solution is proportional if relevant; in a bush setting with a triangular fundamental diagram we do not obtain a unique solution if a PAS has equal cost with an equal derivative but unequal flow distribution along its two segments, e.g.

Uses of GapFunction in org.goplanit.component.event

Methods in org.goplanit.component.event that return GapFunction

Modifier and Type	Method	Description
GapFunction	PopulateGapFunctionEvent.getGapFunctionToPopulate()	collect gap function to populate

Constructors in org.goplanit.component.event with parameters of type GapFunction

Constructor	Description
PopulateGapFunctionEvent(PlanitComponentFactory<?> source, GapFunction gapFunctionToPopulate)	Constructor

Uses of GapFunction in org.goplanit.gap

Classes in org.goplanit.gap with type parameters of type GapFunction

Modifier and Type	Class	Description
class	GapFunctionConfigurator<T extends GapFunction>	Base class for all vgap function configurator implementations

Subclasses of GapFunction in org.goplanit.gap

Modifier and Type	Class	Description
class	LinkBasedRelativeDualityGapFunction	Gap function based on the work of Bovy and Jansen (1983) who take the different between the current system travel time and the system travel time if all flow were to be assigned to the shortest paths, divided by the system travel time
class	NormBasedGapFunction	Gap function based on the norm, e.g.

Methods in org.goplanit.gap that return GapFunction

Modifier and Type	Method	Description
abstract GapFunction	GapFunction.deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
abstract GapFunction	GapFunction.shallowClone()	Create a shallow copy of this entity

Methods in org.goplanit.gap that return types with arguments of type GapFunction

Modifier and Type	Method	Description
static GapFunctionConfigurator<? extends GapFunction>	GapFunctionConfiguratorFactory.createConfigurator(String gapFunctionType)	Create a configurator for given gap function type

Methods in org.goplanit.gap with parameters of type GapFunction

Modifier and Type	Method	Description
void	GapFunctionConfigurator.configure(GapFunction gapFunction)	Needed to avoid issues with generics, although it should be obvious that T extends GapFunction

Constructors in org.goplanit.gap with parameters of type GapFunction

Constructor	Description
GapFunction(GapFunction other, boolean deepCopy)	Copy constructor