Enum SearchAlgorithm 

pub enum SearchAlgorithm {
    SingleSourceShortestPath {
        termination_behavior: TerminationFailurePolicy,
        a_star: bool,
    },
    KspSingleVia {
        k: usize,
        underlying: Box<SearchAlgorithm>,
        similarity: Option<RouteSimilarityFunction>,
        termination: Option<KspTerminationCriteria>,
    },
    Yens {
        k: usize,
        underlying: Box<SearchAlgorithm>,
        similarity: Option<RouteSimilarityFunction>,
        termination: Option<KspTerminationCriteria>,
    },
}

Variants

SingleSourceShortestPath

algorithm to support classic SSSP algorithms such as Dijkstra’s and A*.

Fields

termination_behavior: TerminationFailurePolicy

if the termination model returns early, treat it as a search error. if false, the result is still returned. this option is not valid for searches without destinations (path searches).

a_star: bool

if true, use a cost estimate heuristic to guide the search towards destinations

KspSingleVia

KSP using the single via paths algorithm.

Fields

k: usize

number of alternative paths to attempt

underlying: Box<SearchAlgorithm>

path search algorithm to use

similarity: Option<RouteSimilarityFunction>

if provided, filters out potential solution paths based on their similarity to the paths in the stored result set

termination: Option<KspTerminationCriteria>

termination criteria for the inner path search function

Yens

KSP using Yen’s Algorithm

Fields

k: usize

number of alternative paths to attempt

underlying: Box<SearchAlgorithm>

path search algorithm to use

similarity: Option<RouteSimilarityFunction>

if provided, filters out potential solution paths based on their similarity to the paths in the stored result set

termination: Option<KspTerminationCriteria>

termination criteria for the inner path search function

Implementations

impl SearchAlgorithm

pub fn run_vertex_oriented( &self, src_id: VertexId, dst_id_opt: Option<VertexId>, query: &Value, direction: &Direction, si: &SearchInstance, ) -> Result<SearchAlgorithmResult, SearchError>

pub fn run_edge_oriented( &self, src: (EdgeListId, EdgeId), dst_opt: Option<(EdgeListId, EdgeId)>, query: &Value, direction: &Direction, si: &SearchInstance, ) -> Result<SearchAlgorithmResult, SearchError>

pub fn cost_constraint(&self) -> CostConstraint

constraint applied to cost values due to the type of algorithm run.

Trait Implementations

impl Clone for SearchAlgorithm

fn clone(&self) -> SearchAlgorithm

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchAlgorithm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&SearchAlgorithmConfig> for SearchAlgorithm

fn from(value: &SearchAlgorithmConfig) -> Self

Converts to this type from the input type.