GPUdb C++ API  Version 7.2.2.4
gpudb::MatchGraphRequest Struct Reference

A set of parameters for GPUdb::matchGraph. More...

#include <gpudb/protocol/match_graph.h>

Public Member Functions

 MatchGraphRequest ()
 Constructs a MatchGraphRequest object with default parameters. More...
 
 MatchGraphRequest (const std::string &graphName_, const std::vector< std::string > &samplePoints_, const std::string &solveMethod_, const std::string &solutionTable_, const std::map< std::string, std::string > &options_)
 Constructs a MatchGraphRequest object with the specified parameters. More...
 

Public Attributes

std::string graphName
 Name of the underlying geospatial graph resource to match to using samplePoints. More...
 
std::vector< std::string > samplePoints
 Sample points used to match to an underlying geospatial graph. More...
 
std::string solveMethod
 The type of solver to use for graph matching. More...
 
std::string solutionTable
 The name of the table used to store the results, in [ schema_name. More...
 
std::map< std::string, std::string > options
 Additional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::matchGraph.

Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.

IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Definition at line 26 of file match_graph.h.

Constructor & Destructor Documentation

◆ MatchGraphRequest() [1/2]

gpudb::MatchGraphRequest::MatchGraphRequest ( )
inline

Constructs a MatchGraphRequest object with default parameters.

Definition at line 31 of file match_graph.h.

◆ MatchGraphRequest() [2/2]

gpudb::MatchGraphRequest::MatchGraphRequest ( const std::string &  graphName_,
const std::vector< std::string > &  samplePoints_,
const std::string &  solveMethod_,
const std::string &  solutionTable_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a MatchGraphRequest object with the specified parameters.

Parameters
[in]graphName_Name of the underlying geospatial graph resource to match to using samplePoints_.
[in]samplePoints_Sample points used to match to an underlying geospatial graph. Sample points must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with: existing column names, e.g., 'table.column AS SAMPLE_X'; expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS SAMPLE_WKTPOINT'; or constant values, e.g., '{1, 2, 10} AS SAMPLE_TRIPID'.
[in]solveMethod_The type of solver to use for graph matching. Supported values: The default value is match_graph_markov_chain.
[in]solutionTable_The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table contains a track of geospatial points for the matched portion of the graph, a track ID, and a score value. Also outputs a details table containing a trip ID (that matches the track ID), the latitude/longitude pair, the timestamp the point was recorded at, and an edge ID corresponding to the matched road segment. Must not be an existing table of the same name. The default value is ''.
[in]options_Additional parameters. The default value is an empty map.

Definition at line 882 of file match_graph.h.

Member Data Documentation

◆ graphName

std::string gpudb::MatchGraphRequest::graphName

Name of the underlying geospatial graph resource to match to using samplePoints.

Definition at line 895 of file match_graph.h.

◆ options

std::map<std::string, std::string> gpudb::MatchGraphRequest::options

Additional parameters.

The default value is an empty map.

Definition at line 1457 of file match_graph.h.

◆ samplePoints

std::vector<std::string> gpudb::MatchGraphRequest::samplePoints

Sample points used to match to an underlying geospatial graph.

Sample points must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with: existing column names, e.g., 'table.column AS SAMPLE_X'; expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS SAMPLE_WKTPOINT'; or constant values, e.g., '{1, 2, 10} AS SAMPLE_TRIPID'.

Definition at line 909 of file match_graph.h.

◆ solutionTable

std::string gpudb::MatchGraphRequest::solutionTable

The name of the table used to store the results, in [ schema_name.

\ ]table_name format, using standard name resolution rules and meeting table naming criteria. This table contains a track of geospatial points for the matched portion of the graph, a track ID, and a score value. Also outputs a details table containing a trip ID (that matches the track ID), the latitude/longitude pair, the timestamp the point was recorded at, and an edge ID corresponding to the matched road segment. Must not be an existing table of the same name. The default value is ''.

Definition at line 991 of file match_graph.h.

◆ solveMethod

std::string gpudb::MatchGraphRequest::solveMethod

The type of solver to use for graph matching.

Supported values:

The default value is match_graph_markov_chain.

Definition at line 974 of file match_graph.h.


The documentation for this struct was generated from the following file: