Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
25  {
30  public struct SolveMethod
31  {
45  public const string MARKOV_CHAIN = "markov_chain";
46 
50  public const string MATCH_OD_PAIRS = "match_od_pairs";
51 
60  public const string MATCH_SUPPLY_DEMAND = "match_supply_demand";
61 
65  public const string MATCH_BATCH_SOLVES = "match_batch_solves";
66 
70  public const string MATCH_LOOPS = "match_loops";
71 
74  public const string MATCH_CHARGING_STATIONS = "match_charging_stations";
75 
78  public const string MATCH_SIMILARITY = "match_similarity";
79 
82  public const string MATCH_PICKUP_DROPOFF = "match_pickup_dropoff";
83 
86  public const string MATCH_CLUSTERS = "match_clusters";
87 
89  public const string MATCH_PATTERN = "match_pattern";
90 
92  public const string MATCH_EMBEDDING = "match_embedding";
93 
96  public const string MATCH_ISOCHRONE = "match_isochrone";
97  } // end struct SolveMethod
98 
102  public struct Options
103  {
109  public const string GPS_NOISE = "gps_noise";
110 
116  public const string NUM_SEGMENTS = "num_segments";
117 
122  public const string SEARCH_RADIUS = "search_radius";
123 
131  public const string CHAIN_WIDTH = "chain_width";
132 
138  public const string SOURCE = "source";
139 
145  public const string DESTINATION = "destination";
146 
165  public const string PARTIAL_LOADING = "partial_loading";
166 
167  public const string TRUE = "true";
168  public const string FALSE = "false";
169 
176  public const string MAX_COMBINATIONS = "max_combinations";
177 
185  public const string MAX_SUPPLY_COMBINATIONS = "max_supply_combinations";
186 
193  public const string LEFT_TURN_PENALTY = "left_turn_penalty";
194 
201  public const string RIGHT_TURN_PENALTY = "right_turn_penalty";
202 
209  public const string INTERSECTION_PENALTY = "intersection_penalty";
210 
217  public const string SHARP_TURN_PENALTY = "sharp_turn_penalty";
218 
229  public const string AGGREGATED_OUTPUT = "aggregated_output";
230 
239  public const string OUTPUT_TRACKS = "output_tracks";
240 
252  public const string MAX_TRIP_COST = "max_trip_cost";
253 
271  public const string FILTER_FOLDING_PATHS = "filter_folding_paths";
272 
281  public const string UNIT_UNLOADING_COST = "unit_unloading_cost";
282 
292  public const string MAX_NUM_THREADS = "max_num_threads";
293 
301  public const string SERVICE_LIMIT = "service_limit";
302 
321  public const string ENABLE_REUSE = "enable_reuse";
322 
332  public const string MAX_STOPS = "max_stops";
333 
343  public const string SERVICE_RADIUS = "service_radius";
344 
365  public const string PERMUTE_SUPPLIES = "permute_supplies";
366 
385  public const string BATCH_TSM_MODE = "batch_tsm_mode";
386 
407  public const string ROUND_TRIP = "round_trip";
408 
415  public const string NUM_CYCLES = "num_cycles";
416 
425  public const string NUM_LOOPS_PER_CYCLE = "num_loops_per_cycle";
426 
434  public const string NUM_OUTPUT_CLUSTERS = "num_output_clusters";
435 
444  public const string MAX_NUM_CLUSTERS = "max_num_clusters";
445 
465  public const string CLUSTER_QUALITY_METRIC = "cluster_quality_metric";
466 
469  public const string GIRVAN = "girvan";
470 
473  public const string SPECTRAL = "spectral";
474 
498  public const string RESTRICTED_TYPE = "restricted_type";
499 
502  public const string ODD = "odd";
503 
506  public const string EVEN = "even";
507 
510  public const string NONE = "none";
511 
518  public const string SERVER_ID = "server_id";
519 
538  public const string INVERSE_SOLVE = "inverse_solve";
539 
546  public const string MIN_LOOP_LEVEL = "min_loop_level";
547 
554  public const string MAX_LOOP_LEVEL = "max_loop_level";
555 
562  public const string SEARCH_LIMIT = "search_limit";
563 
570  public const string OUTPUT_BATCH_SIZE = "output_batch_size";
571 
579  public const string CHARGING_CAPACITY = "charging_capacity";
580 
587  public const string CHARGING_CANDIDATES = "charging_candidates";
588 
594  public const string CHARGING_PENALTY = "charging_penalty";
595 
603  public const string MAX_HOPS = "max_hops";
604 
611  public const string TRAVERSAL_NODE_LIMIT = "traversal_node_limit";
612 
627  public const string PAIRED_SIMILARITY = "paired_similarity";
628 
644  public const string FORCE_UNDIRECTED = "force_undirected";
645 
651  public const string MAX_VECTOR_DIMENSION = "max_vector_dimension";
652 
667  public const string OPTIMIZE_EMBEDDING_WEIGHTS = "optimize_embedding_weights";
668 
677  public const string EMBEDDING_WEIGHTS = "embedding_weights";
678 
685  public const string OPTIMIZATION_SAMPLING_SIZE = "optimization_sampling_size";
686 
695  public const string OPTIMIZATION_MAX_ITERATIONS = "optimization_max_iterations";
696 
706  public const string OPTIMIZATION_ERROR_TOLERANCE = "optimization_error_tolerance";
707 
715  public const string OPTIMIZATION_ITERATION_RATE = "optimization_iteration_rate";
716 
723  public const string MAX_RADIUS = "max_radius";
724  } // end struct Options
725 
728  public string graph_name { get; set; }
729 
741  public IList<string> sample_points { get; set; } = new List<string>();
742 
852  public string solve_method { get; set; } = SolveMethod.MARKOV_CHAIN;
853 
869  public string solution_table { get; set; } = "";
870 
1604  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1605 
1608  public MatchGraphRequest() { }
1609 
2484  IList<string> sample_points,
2485  string solve_method = null,
2486  string solution_table = null,
2487  IDictionary<string, string> options = null)
2488  {
2489  this.graph_name = graph_name ?? "";
2490  this.sample_points = sample_points ?? new List<string>();
2492  this.solution_table = solution_table ?? "";
2493  this.options = options ?? new Dictionary<string, string>();
2494  } // end constructor
2495  } // end class MatchGraphRequest
2496 
2501  {
2503  public bool result { get; set; }
2504 
2508  public float match_score { get; set; }
2509 
2511  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2512  } // end class MatchGraphResponse
2513 } // end namespace kinetica
A set of string constants for the parameter options.
Definition: MatchGraph.cs:102
const string EMBEDDING_WEIGHTS
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:677
const string SOURCE
Optional WKT starting point from sample_points for the solver.
Definition: MatchGraph.cs:138
const string CHARGING_PENALTY
For the MATCH_CHARGING_STATIONS solver only.
Definition: MatchGraph.cs:594
const string MAX_HOPS
For the MATCH_SIMILARITY and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:603
const string OPTIMIZE_EMBEDDING_WEIGHTS
For the MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:667
const string AGGREGATED_OUTPUT
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:229
const string SEARCH_RADIUS
Maximum search radius used when snapping sample points onto potentially matching surrounding segments...
Definition: MatchGraph.cs:122
const string MATCH_ISOCHRONE
Solves for isochrones for a set of input sources
Definition: MatchGraph.cs:96
const string OPTIMIZATION_ITERATION_RATE
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:715
const string MAX_SUPPLY_COMBINATIONS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:185
const string PARTIAL_LOADING
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:165
string solution_table
The name of the table used to store the results, in [schema_name.
Definition: MatchGraph.cs:869
const string MAX_STOPS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:332
const string ODD
Applies odd/even rule restrictions to odd tagged vehicles.
Definition: MatchGraph.cs:502
const string SHARP_TURN_PENALTY
This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_tur...
Definition: MatchGraph.cs:217
const string MATCH_PICKUP_DROPOFF
Matches the pickups and dropoffs by optimizing the total trip costs
Definition: MatchGraph.cs:82
const string OUTPUT_TRACKS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:239
const string NUM_SEGMENTS
Maximum number of potentially matching road segments for each sample point.
Definition: MatchGraph.cs:116
const string INTERSECTION_PENALTY
This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option ...
Definition: MatchGraph.cs:209
const string CHAIN_WIDTH
For the MARKOV_CHAIN solver only.
Definition: MatchGraph.cs:131
const string NUM_CYCLES
For the MATCH_CLUSTERS solver only.
Definition: MatchGraph.cs:415
const string CHARGING_CAPACITY
For the MATCH_CHARGING_STATIONS solver only.
Definition: MatchGraph.cs:579
const string MARKOV_CHAIN
Matches sample_points to the graph using the Hidden Markov Model (HMM)-based method,...
Definition: MatchGraph.cs:45
const string MATCH_CLUSTERS
Matches the graph nodes with a cluster index using Louvain clustering algorithm
Definition: MatchGraph.cs:86
const string ROUND_TRIP
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:407
const string RIGHT_TURN_PENALTY
This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option pa...
Definition: MatchGraph.cs:201
const string SERVICE_LIMIT
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:301
const string MIN_LOOP_LEVEL
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:546
const string EVEN
Applies odd/even rule restrictions to even tagged vehicles.
Definition: MatchGraph.cs:506
const string MAX_NUM_CLUSTERS
For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:444
const string TRAVERSAL_NODE_LIMIT
For the MATCH_SIMILARITY solver only.
Definition: MatchGraph.cs:611
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:50
IDictionary< string, string > info
Additional information.
Definition: MatchGraph.cs:2511
const string MATCH_LOOPS
Matches closed loops (Eulerian paths) originating and ending at each graph node within min and max ho...
Definition: MatchGraph.cs:70
const string NUM_LOOPS_PER_CYCLE
For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:425
const string MATCH_PATTERN
Matches a pattern in the graph
Definition: MatchGraph.cs:89
const string SPECTRAL
Applies recursive spectral bisection (RSB) partitioning solver
Definition: MatchGraph.cs:473
const string OPTIMIZATION_SAMPLING_SIZE
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:685
IDictionary< string, string > options
Additional parameters.
Definition: MatchGraph.cs:1604
const string OUTPUT_BATCH_SIZE
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:570
const string SERVICE_RADIUS
For the MATCH_SUPPLY_DEMAND and MATCH_PICKUP_DROPOFF solvers only.
Definition: MatchGraph.cs:343
const string PAIRED_SIMILARITY
For the MATCH_SIMILARITY solver only.
Definition: MatchGraph.cs:627
A set of results returned by Kinetica.matchGraph.
Definition: MatchGraph.cs:2500
const string MAX_NUM_THREADS
For the MARKOV_CHAIN solver only.
Definition: MatchGraph.cs:292
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: MatchGraph.cs:518
const string SEARCH_LIMIT
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:562
const string MAX_COMBINATIONS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:176
float match_score
The mean square error calculation representing the map matching score.
Definition: MatchGraph.cs:2508
const string FILTER_FOLDING_PATHS
For the MARKOV_CHAIN solver only.
Definition: MatchGraph.cs:271
const string MAX_VECTOR_DIMENSION
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:651
const string INVERSE_SOLVE
For the MATCH_BATCH_SOLVES solver only.
Definition: MatchGraph.cs:538
const string MATCH_BATCH_SOLVES
Matches sample_points source and destination pairs for the shortest path solves in batch mode.
Definition: MatchGraph.cs:65
A set of string constants for the parameter solve_method.
Definition: MatchGraph.cs:30
const string MAX_RADIUS
For the MATCH_ISOCHRONE solver only.
Definition: MatchGraph.cs:723
const string CLUSTER_QUALITY_METRIC
For the MATCH_CLUSTERS solver only.
Definition: MatchGraph.cs:465
const string BATCH_TSM_MODE
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:385
const string UNIT_UNLOADING_COST
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:281
const string OPTIMIZATION_MAX_ITERATIONS
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:695
const string PERMUTE_SUPPLIES
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:365
const string OPTIMIZATION_ERROR_TOLERANCE
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:706
const string RESTRICTED_TYPE
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:498
bool result
Indicates a successful solution.
Definition: MatchGraph.cs:2503
const string MATCH_SUPPLY_DEMAND
Matches sample_points to optimize scheduling multiple supplies (trucks) with varying sizes to varying...
Definition: MatchGraph.cs:60
const string FORCE_UNDIRECTED
For the MATCH_PATTERN and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:644
string solve_method
The type of solver to use for graph matching.
Definition: MatchGraph.cs:852
const string MATCH_SIMILARITY
Matches the intersection set(s) by computing the Jaccard similarity score between node pairs.
Definition: MatchGraph.cs:78
const string MAX_TRIP_COST
For the MATCH_SUPPLY_DEMAND and MATCH_PICKUP_DROPOFF solvers only.
Definition: MatchGraph.cs:252
A set of parameters for Kinetica.matchGraph.
Definition: MatchGraph.cs:24
const string MATCH_EMBEDDING
Creates vector node embeddings
Definition: MatchGraph.cs:92
const string MATCH_CHARGING_STATIONS
Matches an optimal path across a number of ev-charging stations between source and target locations.
Definition: MatchGraph.cs:74
const string NONE
Does not apply odd/even rule restrictions to any vehicles.
Definition: MatchGraph.cs:510
const string DESTINATION
Optional WKT ending point from sample_points for the solver.
Definition: MatchGraph.cs:145
const string CHARGING_CANDIDATES
For the MATCH_CHARGING_STATIONS solver only.
Definition: MatchGraph.cs:587
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 'left turn' if the 'add_turn' option par...
Definition: MatchGraph.cs:193
const string GPS_NOISE
GPS noise value (in meters) to remove redundant sample points.
Definition: MatchGraph.cs:109
const string MAX_LOOP_LEVEL
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:554
string graph_name
Name of the underlying geospatial graph resource to match to using sample_points.
Definition: MatchGraph.cs:728
IList< string > sample_points
Sample points used to match to an underlying geospatial graph.
Definition: MatchGraph.cs:741
const string NUM_OUTPUT_CLUSTERS
For the MATCH_CLUSTERS solver only.
Definition: MatchGraph.cs:434
const string ENABLE_REUSE
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:321
const string GIRVAN
Uses the Newman Girvan quality metric for cluster solver
Definition: MatchGraph.cs:469
MatchGraphRequest()
Constructs a MatchGraphRequest object with default parameters.
Definition: MatchGraph.cs:1608
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:2483