Skip to content

WaypointOptimizationClusteringOptions

Used by
Source code in docs_src/capo_geo_routes/types/waypoint_optimization_clustering_options.py 
14
15
16
17
18
19
20
class WaypointOptimizationClusteringOptions(TypedDict, closed=True):
    algorithm: "capo_geo_routes.types.waypoint_optimization_clustering_algorithm.WaypointOptimizationClusteringAlgorithm"
    """<p>The algorithm to be used. <code>DrivingDistance</code> assigns all the waypoints that are within driving distance of each other into a single cluster. <code>TopologySegment</code> assigns all the waypoints that are within the same topology segment into a single cluster. A Topology segment is a linear stretch of road between two junctions.</p>"""
    driving_distance_options: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_driving_distance_options.WaypointOptimizationDrivingDistanceOptions"
    ]
    """<p>Driving distance options to be used when the clustering algorithm is DrivingDistance.</p>"""

algorithm instance-attribute 

algorithm: WaypointOptimizationClusteringAlgorithm

The algorithm to be used. DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster. TopologySegment assigns all the waypoints that are within the same topology segment into a single cluster. A Topology segment is a linear stretch of road between two junctions.

driving_distance_options instance-attribute 

driving_distance_options: NotRequired[WaypointOptimizationDrivingDistanceOptions]

Driving distance options to be used when the clustering algorithm is DrivingDistance.