Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
MatchGraph.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 
10 
11 namespace kinetica
12 {
13 
34  {
35 
119  public struct SolveMethod
120  {
121 
132  public const string MARKOV_CHAIN = "markov_chain";
133 
137  public const string MATCH_OD_PAIRS = "match_od_pairs";
138 
144  public const string MATCH_SUPPLY_DEMAND = "match_supply_demand";
145 
149  public const string MATCH_BATCH_SOLVES = "match_batch_solves";
150 
154  public const string MATCH_LOOPS = "match_loops";
155 
158  public const string MATCH_CHARGING_STATIONS = "match_charging_stations";
159 
162  public const string MATCH_SIMILARITY = "match_similarity";
163 
166  public const string MATCH_PICKUP_DROPOFF = "match_pickup_dropoff";
167 
170  public const string MATCH_CLUSTERS = "match_clusters";
171 
173  public const string MATCH_PATTERN = "match_pattern";
174  } // end struct SolveMethod
175 
176 
736  public struct Options
737  {
738 
743  public const string GPS_NOISE = "gps_noise";
744 
748  public const string NUM_SEGMENTS = "num_segments";
749 
754  public const string SEARCH_RADIUS = "search_radius";
755 
760  public const string CHAIN_WIDTH = "chain_width";
761 
766  public const string SOURCE = "source";
767 
772  public const string DESTINATION = "destination";
773 
794  public const string PARTIAL_LOADING = "partial_loading";
795  public const string TRUE = "true";
796  public const string FALSE = "false";
797 
802  public const string MAX_COMBINATIONS = "max_combinations";
803 
808  public const string MAX_SUPPLY_COMBINATIONS = "max_supply_combinations";
809 
816  public const string LEFT_TURN_PENALTY = "left_turn_penalty";
817 
824  public const string RIGHT_TURN_PENALTY = "right_turn_penalty";
825 
832  public const string INTERSECTION_PENALTY = "intersection_penalty";
833 
840  public const string SHARP_TURN_PENALTY = "sharp_turn_penalty";
841 
850  public const string AGGREGATED_OUTPUT = "aggregated_output";
851 
858  public const string OUTPUT_TRACKS = "output_tracks";
859 
867  public const string MAX_TRIP_COST = "max_trip_cost";
868 
890  public const string FILTER_FOLDING_PATHS = "filter_folding_paths";
891 
898  public const string UNIT_UNLOADING_COST = "unit_unloading_cost";
899 
906  public const string MAX_NUM_THREADS = "max_num_threads";
907 
913  public const string SERVICE_LIMIT = "service_limit";
914 
935  public const string ENABLE_REUSE = "enable_reuse";
936 
943  public const string MAX_STOPS = "max_stops";
944 
950  public const string SERVICE_RADIUS = "service_radius";
951 
977  public const string PERMUTE_SUPPLIES = "permute_supplies";
978 
1000  public const string BATCH_TSM_MODE = "batch_tsm_mode";
1001 
1024  public const string ROUND_TRIP = "round_trip";
1025 
1030  public const string NUM_CYCLES = "num_cycles";
1031 
1036  public const string NUM_LOOPS_PER_CYCLE = "num_loops_per_cycle";
1037 
1042  public const string NUM_OUTPUT_CLUSTERS = "num_output_clusters";
1043 
1048  public const string MAX_NUM_CLUSTERS = "max_num_clusters";
1049 
1069  public const string CLUSTER_QUALITY_METRIC = "cluster_quality_metric";
1070 
1073  public const string GIRVAN = "girvan";
1074 
1077  public const string SPECTRAL = "spectral";
1078 
1106  public const string RESTRICTED_TYPE = "restricted_type";
1107 
1110  public const string ODD = "odd";
1111 
1114  public const string EVEN = "even";
1115 
1118  public const string NONE = "none";
1119 
1124  public const string SERVER_ID = "server_id";
1125 
1145  public const string INVERSE_SOLVE = "inverse_solve";
1146 
1150  public const string MIN_LOOP_LEVEL = "min_loop_level";
1151 
1155  public const string MAX_LOOP_LEVEL = "max_loop_level";
1156 
1161  public const string SEARCH_LIMIT = "search_limit";
1162 
1167  public const string OUTPUT_BATCH_SIZE = "output_batch_size";
1168 
1173  public const string CHARGING_CAPACITY = "charging_capacity";
1174 
1179  public const string CHARGING_CANDIDATES = "charging_candidates";
1180 
1184  public const string CHARGING_PENALTY = "charging_penalty";
1185 
1190  public const string MAX_HOPS = "max_hops";
1191 
1195  public const string TRAVERSAL_NODE_LIMIT = "traversal_node_limit";
1196 
1214  public const string PAIRED_SIMILARITY = "paired_similarity";
1215 
1232  public const string FORCE_UNDIRECTED = "force_undirected";
1233  } // end struct Options
1234 
1235 
1239  public string graph_name { get; set; }
1240 
1255  public IList<string> sample_points { get; set; } = new List<string>();
1256 
1339  public string solve_method { get; set; } = SolveMethod.MARKOV_CHAIN;
1340 
1355  public string solution_table { get; set; } = "";
1356 
1914  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1915 
1916 
1919  public MatchGraphRequest() { }
1920 
2598  IList<string> sample_points,
2599  string solve_method = null,
2600  string solution_table = null,
2601  IDictionary<string, string> options = null)
2602  {
2603  this.graph_name = graph_name ?? "";
2604  this.sample_points = sample_points ?? new List<string>();
2605  this.solve_method = solve_method ?? SolveMethod.MARKOV_CHAIN;
2606  this.solution_table = solution_table ?? "";
2607  this.options = options ?? new Dictionary<string, string>();
2608  } // end constructor
2609 
2610  } // end class MatchGraphRequest
2611 
2612 
2613 
2618  {
2619 
2621  public bool result { get; set; }
2622 
2625  public float match_score { get; set; }
2626 
2628  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2629 
2630  } // end class MatchGraphResponse
2631 
2632 
2633 
2634 
2635 } // end namespace kinetica
Additional parameters GPS_NOISE: GPS noise value (in meters) to remove redundant sample points...
Definition: MatchGraph.cs:736
const string SOURCE
Optional WKT starting point from sample_points for the solver.
Definition: MatchGraph.cs:766
const string CHARGING_PENALTY
For the match_charging_stations solver only.
Definition: MatchGraph.cs:1184
const string MAX_HOPS
For the match_similarity solver only.
Definition: MatchGraph.cs:1190
const string AGGREGATED_OUTPUT
For the match_supply_demand solver only.
Definition: MatchGraph.cs:850
const string SEARCH_RADIUS
Maximum search radius used when snapping sample points onto potentially matching surrounding segments...
Definition: MatchGraph.cs:754
const string MAX_SUPPLY_COMBINATIONS
For the match_supply_demand solver only.
Definition: MatchGraph.cs:808
const string PARTIAL_LOADING
For the match_supply_demand solver only.
Definition: MatchGraph.cs:794
string solution_table
The name of the table used to store the results, in [schema_name.
Definition: MatchGraph.cs:1355
const string MAX_STOPS
For the match_supply_demand solver only.
Definition: MatchGraph.cs:943
const string ODD
Applies odd/even rule restrictions to odd tagged vehicles.
Definition: MatchGraph.cs:1110
const string SHARP_TURN_PENALTY
This will add an additonal weight over the edges labelled as &#39;sharp turn&#39; or &#39;u-turn&#39; if the &#39;add_tur...
Definition: MatchGraph.cs:840
const string MATCH_PICKUP_DROPOFF
Matches the pickups and dropoffs by optimizing the total trip costs
Definition: MatchGraph.cs:166
const string OUTPUT_TRACKS
For the match_supply_demand solver only.
Definition: MatchGraph.cs:858
const string NUM_SEGMENTS
Maximum number of potentially matching road segments for each sample point.
Definition: MatchGraph.cs:748
const string INTERSECTION_PENALTY
This will add an additonal weight over the edges labelled as &#39;intersection&#39; if the &#39;add_turn&#39; option ...
Definition: MatchGraph.cs:832
const string CHAIN_WIDTH
For the markov_chain solver only.
Definition: MatchGraph.cs:760
const string NUM_CYCLES
For the match_clusters solver only.
Definition: MatchGraph.cs:1030
const string CHARGING_CAPACITY
For the match_charging_stations solver only.
Definition: MatchGraph.cs:1173
const string MARKOV_CHAIN
Matches sample_points to the graph using the Hidden Markov Model (HMM)-based method, which conducts a range-tree closest-edge search to find the best combinations of possible road segments (num_segments) for each sample point to create the best route.
Definition: MatchGraph.cs:132
const string MATCH_CLUSTERS
Matches the graph nodes with a cluster index using Louvain clustering algorithm
Definition: MatchGraph.cs:170
const string ROUND_TRIP
For the match_supply_demand solver only.
Definition: MatchGraph.cs:1024
const string RIGHT_TURN_PENALTY
This will add an additonal weight over the edges labelled as&#39; right turn&#39; if the &#39;add_turn&#39; option pa...
Definition: MatchGraph.cs:824
const string SERVICE_LIMIT
For the match_supply_demand solver only.
Definition: MatchGraph.cs:913
const string MIN_LOOP_LEVEL
For the match_loops solver only.
Definition: MatchGraph.cs:1150
const string EVEN
Applies odd/even rule restrictions to even tagged vehicles.
Definition: MatchGraph.cs:1114
const string MAX_NUM_CLUSTERS
For the match_clusters solver only.
Definition: MatchGraph.cs:1048
const string TRAVERSAL_NODE_LIMIT
For the match_similarity solver only.
Definition: MatchGraph.cs:1195
const string MATCH_OD_PAIRS
Matches sample_points to find the most probable path between origin and destination pairs with cost c...
Definition: MatchGraph.cs:137
IDictionary< string, string > info
Additional information.
Definition: MatchGraph.cs:2628
const string MATCH_LOOPS
Matches closed loops (Eulerian paths) originating and ending at each graph node within min and max ho...
Definition: MatchGraph.cs:154
const string NUM_LOOPS_PER_CYCLE
For the match_clusters solver only.
Definition: MatchGraph.cs:1036
const string MATCH_PATTERN
Matches a pattern in the graph
Definition: MatchGraph.cs:173
const string SPECTRAL
Applies recursive spectral bisection (RSB) partitioning solver
Definition: MatchGraph.cs:1077
IDictionary< string, string > options
Additional parameters GPS_NOISE: GPS noise value (in meters) to remove redundant sample points...
Definition: MatchGraph.cs:1914
const string OUTPUT_BATCH_SIZE
For the match_loops solver only.
Definition: MatchGraph.cs:1167
const string SERVICE_RADIUS
For the match_supply_demand and match_pickup_dropoff solvers only.
Definition: MatchGraph.cs:950
const string PAIRED_SIMILARITY
For the match_similarity solver only.
Definition: MatchGraph.cs:1214
A set of results returned by Kinetica.matchGraph(string,IList{string},string,string,IDictionary{string, string}).
Definition: MatchGraph.cs:2617
const string MAX_NUM_THREADS
For the markov_chain solver only.
Definition: MatchGraph.cs:906
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: MatchGraph.cs:1124
const string SEARCH_LIMIT
For the match_loops solver only.
Definition: MatchGraph.cs:1161
const string MAX_COMBINATIONS
For the match_supply_demand solver only.
Definition: MatchGraph.cs:802
float match_score
The mean square error calculation representing the map matching score.
Definition: MatchGraph.cs:2625
const string FILTER_FOLDING_PATHS
For the markov_chain solver only.
Definition: MatchGraph.cs:890
const string INVERSE_SOLVE
For the match_batch_solves solver only.
Definition: MatchGraph.cs:1145
const string MATCH_BATCH_SOLVES
Matches sample_points source and destination pairs for the shortest path solves in batch mode...
Definition: MatchGraph.cs:149
The type of solver to use for graph matching.
Definition: MatchGraph.cs:119
const string CLUSTER_QUALITY_METRIC
For the match_clusters solver only.
Definition: MatchGraph.cs:1069
const string BATCH_TSM_MODE
For the match_supply_demand solver only.
Definition: MatchGraph.cs:1000
const string UNIT_UNLOADING_COST
For the match_supply_demand solver only.
Definition: MatchGraph.cs:898
const string PERMUTE_SUPPLIES
For the match_supply_demand solver only.
Definition: MatchGraph.cs:977
const string RESTRICTED_TYPE
For the match_supply_demand solver only.
Definition: MatchGraph.cs:1106
bool result
Indicates a successful solution.
Definition: MatchGraph.cs:2621
const string MATCH_SUPPLY_DEMAND
Matches sample_points to optimize scheduling multiple supplies (trucks) with varying sizes to varying...
Definition: MatchGraph.cs:144
const string FORCE_UNDIRECTED
For the match_pattern solver only.
Definition: MatchGraph.cs:1232
string solve_method
The type of solver to use for graph matching.
Definition: MatchGraph.cs:1339
const string MATCH_SIMILARITY
Matches the intersection set(s) by computing the Jaccard similarity score between node pairs...
Definition: MatchGraph.cs:162
const string MAX_TRIP_COST
For the match_supply_demand and match_pickup_dropoff solvers only.
Definition: MatchGraph.cs:867
A set of parameters for Kinetica.matchGraph(string,IList{string},string,string,IDictionary{string, string}).
Definition: MatchGraph.cs:33
const string MATCH_CHARGING_STATIONS
Matches an optimal path across a number of ev-charging stations between source and target locations...
Definition: MatchGraph.cs:158
const string NONE
Does not apply odd/even rule restrictions to any vehicles.
Definition: MatchGraph.cs:1118
const string DESTINATION
Optional WKT ending point from sample_points for the solver.
Definition: MatchGraph.cs:772
const string CHARGING_CANDIDATES
For the match_charging_stations solver only.
Definition: MatchGraph.cs:1179
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string LEFT_TURN_PENALTY
This will add an additonal weight over the edges labelled as &#39;left turn&#39; if the &#39;add_turn&#39; option par...
Definition: MatchGraph.cs:816
const string GPS_NOISE
GPS noise value (in meters) to remove redundant sample points.
Definition: MatchGraph.cs:743
const string MAX_LOOP_LEVEL
For the match_loops solver only.
Definition: MatchGraph.cs:1155
string graph_name
Name of the underlying geospatial graph resource to match to using .
Definition: MatchGraph.cs:1239
IList< string > sample_points
Sample points used to match to an underlying geospatial graph.
Definition: MatchGraph.cs:1255
const string NUM_OUTPUT_CLUSTERS
For the match_clusters solver only.
Definition: MatchGraph.cs:1042
const string ENABLE_REUSE
For the match_supply_demand solver only.
Definition: MatchGraph.cs:935
const string GIRVAN
Uses the Newman Girvan quality metric for cluster solver
Definition: MatchGraph.cs:1073
MatchGraphRequest()
Constructs a MatchGraphRequest object with default parameters.
Definition: MatchGraph.cs:1919
MatchGraphRequest(string graph_name, IList< string > sample_points, string solve_method=null, string solution_table=null, IDictionary< string, string > options=null)
Constructs a MatchGraphRequest object with the specified parameters.
Definition: MatchGraph.cs:2597