QGIS API Documentation  3.2.0-Bonn (bc43194)
Static Public Member Functions | List of all members
QgsGraphAnalyzer Class Reference

This class performs graph analysis, e.g. More...

#include <qgsgraphanalyzer.h>

Static Public Member Functions

static void dijkstra (const QgsGraph *source, int startVertexIdx, int criterionNum, QVector< int > *resultTree=nullptr, QVector< double > *resultCost=nullptr)
 Solve shortest path problem using Dijkstra algorithm. More...
 
static QgsGraphshortestTree (const QgsGraph *source, int startVertexIdx, int criterionNum)
 Returns shortest path tree with root-node in startVertexIdx. More...
 

Detailed Description

This class performs graph analysis, e.g.

calculates shortest path between two points using different strategies with Dijkstra algorithm

Definition at line 32 of file qgsgraphanalyzer.h.

Member Function Documentation

◆ dijkstra()

void QgsGraphAnalyzer::dijkstra ( const QgsGraph source,
int  startVertexIdx,
int  criterionNum,
QVector< int > *  resultTree = nullptr,
QVector< double > *  resultCost = nullptr 
)
static

Solve shortest path problem using Dijkstra algorithm.

Parameters
sourcesource graph
startVertexIdxindex of the start vertex
criterionNumindex of the optimization strategy
resultTreearray that represents shortest path tree. resultTree[ vertexIndex ] == inboundingArcIndex if vertex reachable, otherwise resultTree[ vertexIndex ] == -1. Note that the startVertexIdx will also have a value of -1 and may need special handling by callers.
resultCostarray of the paths costs

Definition at line 25 of file qgsgraphanalyzer.cpp.

◆ shortestTree()

QgsGraph * QgsGraphAnalyzer::shortestTree ( const QgsGraph source,
int  startVertexIdx,
int  criterionNum 
)
static

Returns shortest path tree with root-node in startVertexIdx.

Parameters
sourcesource graph
startVertexIdxindex of the start vertex
criterionNumindex of the optimization strategy

Definition at line 91 of file qgsgraphanalyzer.cpp.


The documentation for this class was generated from the following files: