Kinetica   C#   API  Version 7.2.3.1
SolveGraph.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 
26 {
31  public struct SolverType
32  {
36  public const string SHORTEST_PATH = "SHORTEST_PATH";
37 
42  public const string PAGE_RANK = "PAGE_RANK";
43 
47  public const string PROBABILITY_RANK = "PROBABILITY_RANK";
48 
53  public const string CENTRALITY = "CENTRALITY";
54 
60  public const string MULTIPLE_ROUTING = "MULTIPLE_ROUTING";
61 
66  public const string INVERSE_SHORTEST_PATH = "INVERSE_SHORTEST_PATH";
67 
70  public const string BACKHAUL_ROUTING = "BACKHAUL_ROUTING";
71 
77  public const string ALLPATHS = "ALLPATHS";
78 
82  public const string STATS_ALL = "STATS_ALL";
83 
87  public const string CLOSENESS = "CLOSENESS";
88  } // end struct SolverType
89 
93  public struct Options
94  {
104  public const string MAX_SOLUTION_RADIUS = "max_solution_radius";
105 
116  public const string MIN_SOLUTION_RADIUS = "min_solution_radius";
117 
127  public const string MAX_SOLUTION_TARGETS = "max_solution_targets";
128 
134  public const string UNIFORM_WEIGHTS = "uniform_weights";
135 
141  public const string LEFT_TURN_PENALTY = "left_turn_penalty";
142 
148  public const string RIGHT_TURN_PENALTY = "right_turn_penalty";
149 
155  public const string INTERSECTION_PENALTY = "intersection_penalty";
156 
163  public const string SHARP_TURN_PENALTY = "sharp_turn_penalty";
164 
173  public const string NUM_BEST_PATHS = "num_best_paths";
174 
182  public const string MAX_NUM_COMBINATIONS = "max_num_combinations";
183 
198  public const string OUTPUT_EDGE_PATH = "output_edge_path";
199 
202  public const string TRUE = "true";
203 
206  public const string FALSE = "false";
207 
222  public const string OUTPUT_WKT_PATH = "output_wkt_path";
223 
231  public const string SERVER_ID = "server_id";
232 
239  public const string CONVERGENCE_LIMIT = "convergence_limit";
240 
246  public const string MAX_ITERATIONS = "max_iterations";
247 
254  public const string MAX_RUNS = "max_runs";
255 
274  public const string OUTPUT_CLUSTERS = "output_clusters";
275 
292  public const string SOLVE_HEURISTIC = "solve_heuristic";
293 
296  public const string ASTAR = "astar";
297 
299  public const string NONE = "none";
300 
306  public const string ASTAR_RADIUS = "astar_radius";
307  } // end struct Options
308 
310  public string graph_name { get; set; }
311 
327  public IList<string> weights_on_edges { get; set; } = new List<string>();
328 
347  public IList<string> restrictions { get; set; } = new List<string>();
348 
429  public string solver_type { get; set; } = SolverType.SHORTEST_PATH;
430 
437  public IList<string> source_nodes { get; set; } = new List<string>();
438 
445  public IList<string> destination_nodes { get; set; } = new List<string>();
446 
452  public string solution_table { get; set; } = "graph_solutions";
453 
702  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
703 
706  public SolveGraphRequest() { }
707 
1085  IList<string> weights_on_edges = null,
1086  IList<string> restrictions = null,
1087  string solver_type = null,
1088  IList<string> source_nodes = null,
1089  IList<string> destination_nodes = null,
1090  string solution_table = null,
1091  IDictionary<string, string> options = null)
1092  {
1093  this.graph_name = graph_name ?? "";
1094  this.weights_on_edges = weights_on_edges ?? new List<string>();
1095  this.restrictions = restrictions ?? new List<string>();
1097  this.source_nodes = source_nodes ?? new List<string>();
1098  this.destination_nodes = destination_nodes ?? new List<string>();
1099  this.solution_table = solution_table ?? "graph_solutions";
1100  this.options = options ?? new Dictionary<string, string>();
1101  } // end constructor
1102 } // end class SolveGraphRequest
1103 
1108 {
1110  public bool result { get; set; }
1111 
1116  public IList<float> result_per_destination_node { get; set; } = new List<float>();
1117 
1119  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1120 } // end class SolveGraphResponse
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: SolveGraph.cs:148
const string MAX_ITERATIONS
For PAGE_RANK solvers only; Maximum number of page rank iterations for satisfying convergence.
Definition: SolveGraph.cs:246
IList< string > destination_nodes
It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes.
Definition: SolveGraph.cs:445
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
Definition: SolveGraph.cs:347
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: SolveGraph.cs:163
IList< float > result_per_destination_node
Cost or page rank (based on solver type) for each destination node requested.
Definition: SolveGraph.cs:1116
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: SolveGraph.cs:231
SolveGraphRequest(string graph_name, IList< string > weights_on_edges=null, IList< string > restrictions=null, string solver_type=null, IList< string > source_nodes=null, IList< string > destination_nodes=null, string solution_table=null, IDictionary< string, string > options=null)
Constructs a SolveGraphRequest object with the specified parameters.
Definition: SolveGraph.cs:1084
const string MAX_RUNS
For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible valu...
Definition: SolveGraph.cs:254
const string OUTPUT_CLUSTERS
For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column ...
Definition: SolveGraph.cs:274
const string STATS_ALL
Solves for graph statistics such as graph diameter, longest pairs, vertex valences,...
Definition: SolveGraph.cs:82
const string OUTPUT_EDGE_PATH
If true then concatenated edge IDs will be added as the EDGE path column of the solution table for ea...
Definition: SolveGraph.cs:198
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string ASTAR_RADIUS
For path solvers only when 'solve_heuristic' option is 'astar'.
Definition: SolveGraph.cs:306
const string PROBABILITY_RANK
Solves for the transitional probability (Hidden Markov) for each node based on the weights (probabili...
Definition: SolveGraph.cs:47
const string FALSE
No extra cluster info per node will be available in the output.
Definition: SolveGraph.cs:206
string solution_table
Name of the table to store the solution, in [schema_name.
Definition: SolveGraph.cs:452
A set of results returned by Kinetica.solveGraph.
Definition: SolveGraph.cs:1107
const string MAX_SOLUTION_RADIUS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:104
const string INVERSE_SHORTEST_PATH
Solves for finding the optimal path cost for each destination node to route to the source node.
Definition: SolveGraph.cs:66
IDictionary< string, string > info
Additional information.
Definition: SolveGraph.cs:1119
string solver_type
The type of solver to use for the graph.
Definition: SolveGraph.cs:429
const string NUM_BEST_PATHS
For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node.
Definition: SolveGraph.cs:173
IList< string > weights_on_edges
Additional weights to apply to the edges of an existing graph.
Definition: SolveGraph.cs:327
const string NONE
No heuristics are applied.
Definition: SolveGraph.cs:299
const string SOLVE_HEURISTIC
Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single ...
Definition: SolveGraph.cs:292
const string MULTIPLE_ROUTING
Solves for finding the minimum cost cumulative path for a round-trip starting from the given source a...
Definition: SolveGraph.cs:60
const string ALLPATHS
Solves for paths that would give costs between max and min solution radia - Make sure to limit by the...
Definition: SolveGraph.cs:77
const string TRUE
An additional column 'CLUSTER' will be added for each node.
Definition: SolveGraph.cs:202
const string BACKHAUL_ROUTING
Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes.
Definition: SolveGraph.cs:70
A set of string constants for the parameter solver_type.
Definition: SolveGraph.cs:31
const string SHORTEST_PATH
Solves for the optimal (shortest) path based on weights and restrictions from one source to destinati...
Definition: SolveGraph.cs:36
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: SolveGraph.cs:141
const string MAX_SOLUTION_TARGETS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:127
const string CENTRALITY
Solves for the degree of a node to depict how many pairs of individuals that would have to go through...
Definition: SolveGraph.cs:53
const string MIN_SOLUTION_RADIUS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:116
const string INTERSECTION_PENALTY
This will add an additional weight over the edges labeled as 'intersection' if the 'add_turn' option ...
Definition: SolveGraph.cs:155
A set of parameters for Kinetica.solveGraph.
Definition: SolveGraph.cs:25
A set of string constants for the parameter options.
Definition: SolveGraph.cs:93
const string UNIFORM_WEIGHTS
When specified, assigns the given value to all the edges in the graph.
Definition: SolveGraph.cs:134
const string MAX_NUM_COMBINATIONS
For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated.
Definition: SolveGraph.cs:182
const string CONVERGENCE_LIMIT
For PAGE_RANK solvers only; Maximum percent relative threshold on the page rank scores of each node b...
Definition: SolveGraph.cs:239
SolveGraphRequest()
Constructs a SolveGraphRequest object with default parameters.
Definition: SolveGraph.cs:706
bool result
Indicates a successful solution on all servers.
Definition: SolveGraph.cs:1110
string graph_name
Name of the graph resource to solve.
Definition: SolveGraph.cs:310
IList< string > source_nodes
It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes.
Definition: SolveGraph.cs:437
const string OUTPUT_WKT_PATH
If true then concatenated wkt line segments will be added as the Wktroute column of the solution tabl...
Definition: SolveGraph.cs:222
IDictionary< string, string > options
Additional parameters.
Definition: SolveGraph.cs:702
const string ASTAR
Employs A-STAR heuristics to speed up the shortest path traversal.
Definition: SolveGraph.cs:296
const string CLOSENESS
Solves for the centrality closeness score per node as the sum of the inverse shortest path costs to a...
Definition: SolveGraph.cs:87
const string PAGE_RANK
Solves for the probability of each destination node being visited based on the links of the graph top...
Definition: SolveGraph.cs:42