Module org.arakhne.afc.core.mathgraph
Package org.arakhne.afc.math.graph

Class DepthGraphIterator<ST extends GraphSegment<ST,​PT>,​PT extends GraphPoint<PT,​ST>>

  • Type Parameters:
    PT - is the type of node in the graph
    ST - is the type of edge in the graph
    All Implemented Interfaces:
    Iterator<ST>
    Direct Known Subclasses:
    DistanceBasedRoadNetworkIterator
    public class DepthGraphIterator<ST extends GraphSegment<ST,​PT>,​PT extends GraphPoint<PT,​ST>>
extends GraphIterator<ST,​PT>
    This class is an iterator on the segments limited to a specified depth.

    The behaviour of the iterator is strongly influenced by the constructor's parameters. One of the most important parameter is assumeOrientedSegments. The assumeOrientedSegments parameter indicates how the segments are considered by the iterator. If assumeOrientedSegments is true it means that a segment reached by one of its end point is different than the same segment reached by the other end point. If assumeOrientedSegments is false it means that the end points of the segments are not take into account.

    Since:
    13.0
    Version:
    17.0 2020-01-04 14:41:42
    Author:
    Stéphane GALLAND
    Maven Group Id:
    org.arakhne.afc.core
    Maven Artifact Id:
    mathgraph

    • Constructor Detail

      • DepthGraphIterator

        @Deprecated(since="16.0",
            forRemoval=true)
public DepthGraphIterator​(Graph<ST,​PT> graph,
                          double depth,
                          double positionFromStartingPoint,
                          ST segment,
                          PT startingPoint,
                          boolean allowManyReplies,
                          boolean assumeOrientedSegments)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 16.0
        Constructor.
        Parameters:
        graph - is the graph associated to this iterator.
        depth - is the maximal depth to reach (in the metric coordiante system).
        positionFromStartingPoint - is the starting position from the starting_point (in meters).
        segment - is the segment from which to start.
        startingPoint - is the segment's point indicating the direction.
        allowManyReplies - may be true to allow to reply many times the same segment, otherwhise false.
        assumeOrientedSegments - may be true to assume that the same segment has two different instances for graph iteration: the first instance is associated the first point of the segment and the second instance is associated to the last point of the segment. If this parameter is false to assume that the end points of a segment are not distinguished.

      • DepthGraphIterator

        public DepthGraphIterator​(Graph<ST,​PT> graph,
                          double depth,
                          double positionFromStartingPoint,
                          ST segment,
                          PT startingPoint,
                          boolean allowManyReplies,
                          boolean assumeOrientedSegments,
                          DynamicDepthUpdater<ST,​PT> dynamicDepthUpdater)
        Constructor.
        Parameters:
        graph - is the graph associated to this iterator.
        depth - is the maximal depth to reach (in the metric coordiante system).
        positionFromStartingPoint - is the starting position from the starting_point (in meters).
        segment - is the segment from which to start.
        startingPoint - is the segment's point indicating the direction.
        allowManyReplies - may be true to allow to reply many times the same segment, otherwhise false.
        assumeOrientedSegments - may be true to assume that the same segment has two different instances for graph iteration: the first instance is associated the first point of the segment and the second instance is associated to the last point of the segment. If this parameter is false to assume that the end points of a segment are not distinguished.
        dynamicDepthUpdater - if not null, it is used to dynamically update the depth.

      • DepthGraphIterator

        @Deprecated(since="16.0",
            forRemoval=true)
public DepthGraphIterator​(Graph<ST,​PT> graph,
                          double depth,
                          ST segment,
                          PT startingPoint,
                          boolean allowManyReplies,
                          boolean assumeOrientedSegments)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 16.0
        Constructor.
        Parameters:
        graph - is the graph associated to this iterator.
        depth - is the maximal depth to reach (in the metric coordiante system).
        segment - is the segment from which to start.
        startingPoint - is the segment's point indicating the direction.
        allowManyReplies - may be true to allow to reply many times the same segment, otherwhise false.
        assumeOrientedSegments - may be true to assume that the same segment has two different instances for graph iteration: the first instance is associated the first point of the segment and the second instance is associated to the last point of the segment. If this parameter is false to assume that the end points of a segment are not distinguished.

      • DepthGraphIterator

        public DepthGraphIterator​(Graph<ST,​PT> graph,
                          double depth,
                          ST segment,
                          PT startingPoint,
                          boolean allowManyReplies,
                          boolean assumeOrientedSegments,
                          DynamicDepthUpdater<ST,​PT> dynamicDepthUpdater)
        Constructor.
        Parameters:
        graph - is the graph associated to this iterator.
        depth - is the maximal depth to reach (in the metric coordiante system).
        segment - is the segment from which to start.
        startingPoint - is the segment's point indicating the direction.
        allowManyReplies - may be true to allow to reply many times the same segment, otherwhise false.
        assumeOrientedSegments - may be true to assume that the same segment has two different instances for graph iteration: the first instance is associated the first point of the segment and the second instance is associated to the last point of the segment. If this parameter is false to assume that the end points of a segment are not distinguished.
        dynamicDepthUpdater - if not null, it is used to dynamically update the depth.