Kinetica   C#   API  Version 7.2.3.1
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 
59  public const string MATCH_SUPPLY_DEMAND = "match_supply_demand";
60 
64  public const string MATCH_BATCH_SOLVES = "match_batch_solves";
65 
69  public const string MATCH_LOOPS = "match_loops";
70 
73  public const string MATCH_CHARGING_STATIONS = "match_charging_stations";
74 
77  public const string MATCH_SIMILARITY = "match_similarity";
78 
81  public const string MATCH_PICKUP_DROPOFF = "match_pickup_dropoff";
82 
85  public const string MATCH_CLUSTERS = "match_clusters";
86 
88  public const string MATCH_PATTERN = "match_pattern";
89 
91  public const string MATCH_EMBEDDING = "match_embedding";
92 
95  public const string MATCH_ISOCHRONE = "match_isochrone";
96 
99  public const string MATCH_ROUTE_DETOUR = "match_route_detour";
100  } // end struct SolveMethod
101 
105  public struct Options
106  {
112  public const string GPS_NOISE = "gps_noise";
113 
119  public const string NUM_SEGMENTS = "num_segments";
120 
125  public const string SEARCH_RADIUS = "search_radius";
126 
133  public const string CHAIN_WIDTH = "chain_width";
134 
140  public const string SOURCE = "source";
141 
147  public const string DESTINATION = "destination";
148 
167  public const string PARTIAL_LOADING = "partial_loading";
168 
169  public const string TRUE = "true";
170  public const string FALSE = "false";
171 
178  public const string MAX_COMBINATIONS = "max_combinations";
179 
187  public const string MAX_SUPPLY_COMBINATIONS = "max_supply_combinations";
188 
194  public const string LEFT_TURN_PENALTY = "left_turn_penalty";
195 
201  public const string RIGHT_TURN_PENALTY = "right_turn_penalty";
202 
208  public const string INTERSECTION_PENALTY = "intersection_penalty";
209 
216  public const string SHARP_TURN_PENALTY = "sharp_turn_penalty";
217 
228  public const string AGGREGATED_OUTPUT = "aggregated_output";
229 
238  public const string OUTPUT_TRACKS = "output_tracks";
239 
250  public const string MAX_TRIP_COST = "max_trip_cost";
251 
269  public const string FILTER_FOLDING_PATHS = "filter_folding_paths";
270 
279  public const string UNIT_UNLOADING_COST = "unit_unloading_cost";
280 
290  public const string MAX_NUM_THREADS = "max_num_threads";
291 
299  public const string SERVICE_LIMIT = "service_limit";
300 
319  public const string ENABLE_REUSE = "enable_reuse";
320 
329  public const string MAX_STOPS = "max_stops";
330 
340  public const string SERVICE_RADIUS = "service_radius";
341 
362  public const string PERMUTE_SUPPLIES = "permute_supplies";
363 
382  public const string BATCH_TSM_MODE = "batch_tsm_mode";
383 
404  public const string ROUND_TRIP = "round_trip";
405 
412  public const string NUM_CYCLES = "num_cycles";
413 
421  public const string NUM_LOOPS_PER_CYCLE = "num_loops_per_cycle";
422 
429  public const string NUM_OUTPUT_CLUSTERS = "num_output_clusters";
430 
438  public const string MAX_NUM_CLUSTERS = "max_num_clusters";
439 
458  public const string CLUSTER_QUALITY_METRIC = "cluster_quality_metric";
459 
462  public const string GIRVAN = "girvan";
463 
466  public const string SPECTRAL = "spectral";
467 
491  public const string RESTRICTED_TYPE = "restricted_type";
492 
495  public const string ODD = "odd";
496 
499  public const string EVEN = "even";
500 
503  public const string NONE = "none";
504 
510  public const string SERVER_ID = "server_id";
511 
530  public const string INVERSE_SOLVE = "inverse_solve";
531 
538  public const string MIN_LOOP_LEVEL = "min_loop_level";
539 
546  public const string MAX_LOOP_LEVEL = "max_loop_level";
547 
554  public const string SEARCH_LIMIT = "search_limit";
555 
562  public const string OUTPUT_BATCH_SIZE = "output_batch_size";
563 
578  public const string MULTI_STEP = "multi_step";
579 
587  public const string CHARGING_CAPACITY = "charging_capacity";
588 
595  public const string CHARGING_CANDIDATES = "charging_candidates";
596 
602  public const string CHARGING_PENALTY = "charging_penalty";
603 
611  public const string DETOUR_MARK_COST = "detour_mark_cost";
612 
619  public const string DETOUR_REENTRY_FACTOR = "detour_reentry_factor";
620 
627  public const string DETOUR_SEARCH_RADIUS = "detour_search_radius";
628 
635  public const string DETOUR_SEARCH_LIMIT = "detour_search_limit";
636 
644  public const string MAX_HOPS = "max_hops";
645 
651  public const string TRAVERSAL_NODE_LIMIT = "traversal_node_limit";
652 
667  public const string PAIRED_SIMILARITY = "paired_similarity";
668 
684  public const string FORCE_UNDIRECTED = "force_undirected";
685 
691  public const string MAX_VECTOR_DIMENSION = "max_vector_dimension";
692 
707  public const string OPTIMIZE_EMBEDDING_WEIGHTS = "optimize_embedding_weights";
708 
717  public const string EMBEDDING_WEIGHTS = "embedding_weights";
718 
725  public const string OPTIMIZATION_SAMPLING_SIZE = "optimization_sampling_size";
726 
735  public const string OPTIMIZATION_MAX_ITERATIONS = "optimization_max_iterations";
736 
745  public const string OPTIMIZATION_ERROR_TOLERANCE = "optimization_error_tolerance";
746 
753  public const string OPTIMIZATION_ITERATION_RATE = "optimization_iteration_rate";
754 
761  public const string MAX_RADIUS = "max_radius";
762  } // end struct Options
763 
766  public string graph_name { get; set; }
767 
778  public IList<string> sample_points { get; set; } = new List<string>();
779 
890  public string solve_method { get; set; } = SolveMethod.MARKOV_CHAIN;
891 
907  public string solution_table { get; set; } = "";
908 
1668  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1669 
1672  public MatchGraphRequest() { }
1673 
2572  IList<string> sample_points,
2573  string solve_method = null,
2574  string solution_table = null,
2575  IDictionary<string, string> options = null)
2576  {
2577  this.graph_name = graph_name ?? "";
2578  this.sample_points = sample_points ?? new List<string>();
2580  this.solution_table = solution_table ?? "";
2581  this.options = options ?? new Dictionary<string, string>();
2582  } // end constructor
2583 } // end class MatchGraphRequest
2584 
2589 {
2591  public bool result { get; set; }
2592 
2596  public float match_score { get; set; }
2597 
2599  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2600 } // end class MatchGraphResponse
const string MATCH_ISOCHRONE
Solves for isochrones for a set of input sources.
Definition: MatchGraph.cs:95
const string EVEN
Applies odd/even rule restrictions to even tagged vehicles.
Definition: MatchGraph.cs:499
const string RESTRICTED_TYPE
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:491
A set of string constants for the parameter options.
Definition: MatchGraph.cs:105
const string SEARCH_LIMIT
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:554
MatchGraphRequest()
Constructs a MatchGraphRequest object with default parameters.
Definition: MatchGraph.cs:1672
const string RIGHT_TURN_PENALTY
This will add an additional weight over the edges labeled as' right turn' if the 'add_turn' option pa...
Definition: MatchGraph.cs:201
const string MATCH_SIMILARITY
Matches the intersection set(s) by computing the Jaccard similarity score between node pairs.
Definition: MatchGraph.cs:77
bool result
Indicates a successful solution.
Definition: MatchGraph.cs:2591
const string MAX_STOPS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:329
const string MATCH_ROUTE_DETOUR
Computes detour costs for nearby stations at a mark point along each source-target route.
Definition: MatchGraph.cs:99
float match_score
The mean square error calculation representing the map matching score.
Definition: MatchGraph.cs:2596
const string MAX_HOPS
For the MATCH_SIMILARITY and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:644
const string GIRVAN
Uses the Newman Girvan quality metric for cluster solver.
Definition: MatchGraph.cs:462
const string MIN_LOOP_LEVEL
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:538
const string GPS_NOISE
GPS noise value (in meters) to remove redundant sample points.
Definition: MatchGraph.cs:112
const string MULTI_STEP
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:578
const string MAX_VECTOR_DIMENSION
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:691
const string OUTPUT_TRACKS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:238
const string SERVICE_RADIUS
For the MATCH_SUPPLY_DEMAND and MATCH_PICKUP_DROPOFF solvers only.
Definition: MatchGraph.cs:340
const string MAX_LOOP_LEVEL
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:546
const string TRAVERSAL_NODE_LIMIT
For the MATCH_SIMILARITY solver only.
Definition: MatchGraph.cs:651
A set of parameters for Kinetica.matchGraph.
Definition: MatchGraph.cs:24
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string DETOUR_SEARCH_LIMIT
For the MATCH_ROUTE_DETOUR solver only.
Definition: MatchGraph.cs:635
string solve_method
The type of solver to use for graph matching.
Definition: MatchGraph.cs:890
const string MAX_TRIP_COST
For the MATCH_SUPPLY_DEMAND and MATCH_PICKUP_DROPOFF solvers only.
Definition: MatchGraph.cs:250
IList< string > sample_points
Sample points used to match to an underlying geospatial graph.
Definition: MatchGraph.cs:778
const string MAX_NUM_CLUSTERS
For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:438
const string ROUND_TRIP
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:404
const string BATCH_TSM_MODE
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:382
const string OPTIMIZATION_MAX_ITERATIONS
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:735
const string SOURCE
WKT starting point from sample_points for the solver.
Definition: MatchGraph.cs:140
const string MAX_NUM_THREADS
For the MARKOV_CHAIN solver only.
Definition: MatchGraph.cs:290
const string SPECTRAL
Applies recursive spectral bisection (RSB) partitioning solver.
Definition: MatchGraph.cs:466
const string MAX_COMBINATIONS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:178
const string INTERSECTION_PENALTY
This will add an additional weight over the edges labeled as 'intersection' if the 'add_turn' option ...
Definition: MatchGraph.cs:208
const string LEFT_TURN_PENALTY
This will add an additional weight over the edges labeled as 'left turn' if the 'add_turn' option par...
Definition: MatchGraph.cs:194
const string PARTIAL_LOADING
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:167
const string PAIRED_SIMILARITY
For the MATCH_SIMILARITY solver only.
Definition: MatchGraph.cs:667
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_OD_PAIRS
Matches sample_points to find the most probable path between origin and destination pairs with cost c...
Definition: MatchGraph.cs:50
const string MATCH_BATCH_SOLVES
Matches sample_points source and destination pairs for the shortest path solves in batch mode.
Definition: MatchGraph.cs:64
const string CHARGING_CAPACITY
For the MATCH_CHARGING_STATIONS solver only.
Definition: MatchGraph.cs:587
const string UNIT_UNLOADING_COST
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:279
const string NUM_CYCLES
For the MATCH_CLUSTERS solver only.
Definition: MatchGraph.cs:412
IDictionary< string, string > options
Additional parameters.
Definition: MatchGraph.cs:1668
const string DETOUR_SEARCH_RADIUS
For the MATCH_ROUTE_DETOUR solver only.
Definition: MatchGraph.cs:627
const string MATCH_PICKUP_DROPOFF
Matches the pickups and dropoffs by optimizing the total trip costs.
Definition: MatchGraph.cs:81
A set of string constants for the parameter solve_method.
Definition: MatchGraph.cs:30
const string FORCE_UNDIRECTED
For the MATCH_PATTERN and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:684
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:2571
const string SEARCH_RADIUS
Maximum search radius used when snapping sample points onto potentially matching surrounding segments...
Definition: MatchGraph.cs:125
const string MATCH_SUPPLY_DEMAND
Matches sample_points to optimize scheduling multiple supplies (trucks) with varying sizes to varying...
Definition: MatchGraph.cs:59
string solution_table
The name of the table used to store the results, in [schema_name.
Definition: MatchGraph.cs:907
const string ENABLE_REUSE
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:319
const string FILTER_FOLDING_PATHS
For the MARKOV_CHAIN solver only.
Definition: MatchGraph.cs:269
const string NUM_SEGMENTS
Maximum number of potentially matching road segments for each sample point.
Definition: MatchGraph.cs:119
IDictionary< string, string > info
Additional information.
Definition: MatchGraph.cs:2599
const string MATCH_CHARGING_STATIONS
Matches an optimal path across a number of ev-charging stations between source and target locations.
Definition: MatchGraph.cs:73
const string MAX_SUPPLY_COMBINATIONS
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:187
const string INVERSE_SOLVE
For the MATCH_BATCH_SOLVES solver only.
Definition: MatchGraph.cs:530
const string NUM_LOOPS_PER_CYCLE
For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:421
const string MAX_RADIUS
For the MATCH_ISOCHRONE solver only.
Definition: MatchGraph.cs:761
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: MatchGraph.cs:510
const string MATCH_PATTERN
Matches a pattern in the graph.
Definition: MatchGraph.cs:88
const string SERVICE_LIMIT
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:299
const string SHARP_TURN_PENALTY
This will add an additional weight over the edges labeled as 'sharp turn' or 'u-turn' if the 'add_tur...
Definition: MatchGraph.cs:216
const string CHARGING_PENALTY
For the MATCH_CHARGING_STATIONS solver only.
Definition: MatchGraph.cs:602
const string CLUSTER_QUALITY_METRIC
For the MATCH_CLUSTERS solver only.
Definition: MatchGraph.cs:458
string graph_name
Name of the underlying geospatial graph resource to match to using sample_points.
Definition: MatchGraph.cs:766
const string EMBEDDING_WEIGHTS
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:717
const string PERMUTE_SUPPLIES
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:362
A set of results returned by Kinetica.matchGraph.
Definition: MatchGraph.cs:2588
const string MATCH_EMBEDDING
Creates vector node embeddings.
Definition: MatchGraph.cs:91
const string OUTPUT_BATCH_SIZE
For the MATCH_LOOPS solver only.
Definition: MatchGraph.cs:562
const string MATCH_LOOPS
Matches closed loops (Eulerian paths) originating and ending at each graph node within min and max ho...
Definition: MatchGraph.cs:69
const string OPTIMIZATION_SAMPLING_SIZE
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:725
const string OPTIMIZATION_ITERATION_RATE
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:753
const string CHAIN_WIDTH
For the MARKOV_CHAIN solver only.
Definition: MatchGraph.cs:133
const string DETOUR_MARK_COST
For the MATCH_ROUTE_DETOUR solver only.
Definition: MatchGraph.cs:611
const string OPTIMIZATION_ERROR_TOLERANCE
For the MATCH_EMBEDDING solver only.
Definition: MatchGraph.cs:745
const string AGGREGATED_OUTPUT
For the MATCH_SUPPLY_DEMAND solver only.
Definition: MatchGraph.cs:228
const string NONE
Does not apply odd/even rule restrictions to any vehicles.
Definition: MatchGraph.cs:503
const string MATCH_CLUSTERS
Matches the graph nodes with a cluster index using Louvain clustering algorithm.
Definition: MatchGraph.cs:85
const string ODD
Applies odd/even rule restrictions to odd tagged vehicles.
Definition: MatchGraph.cs:495
const string DETOUR_REENTRY_FACTOR
For the MATCH_ROUTE_DETOUR solver only.
Definition: MatchGraph.cs:619
const string DESTINATION
WKT ending point from sample_points for the solver.
Definition: MatchGraph.cs:147
const string OPTIMIZE_EMBEDDING_WEIGHTS
For the MATCH_EMBEDDING solvers only.
Definition: MatchGraph.cs:707
const string CHARGING_CANDIDATES
For the MATCH_CHARGING_STATIONS solver only.
Definition: MatchGraph.cs:595
const string NUM_OUTPUT_CLUSTERS
For the MATCH_CLUSTERS solver only.
Definition: MatchGraph.cs:429