Kinetica   C#   API  Version 7.2.3.0
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  {
38  public const string SHORTEST_PATH = "SHORTEST_PATH";
39 
45  public const string PAGE_RANK = "PAGE_RANK";
46 
50  public const string PROBABILITY_RANK = "PROBABILITY_RANK";
51 
56  public const string CENTRALITY = "CENTRALITY";
57 
64  public const string MULTIPLE_ROUTING = "MULTIPLE_ROUTING";
65 
70  public const string INVERSE_SHORTEST_PATH = "INVERSE_SHORTEST_PATH";
71 
74  public const string BACKHAUL_ROUTING = "BACKHAUL_ROUTING";
75 
81  public const string ALLPATHS = "ALLPATHS";
82 
86  public const string STATS_ALL = "STATS_ALL";
87 
91  public const string CLOSENESS = "CLOSENESS";
92  } // end struct SolverType
93 
97  public struct Options
98  {
109  public const string MAX_SOLUTION_RADIUS = "max_solution_radius";
110 
123  public const string MIN_SOLUTION_RADIUS = "min_solution_radius";
124 
136  public const string MAX_SOLUTION_TARGETS = "max_solution_targets";
137 
143  public const string UNIFORM_WEIGHTS = "uniform_weights";
144 
151  public const string LEFT_TURN_PENALTY = "left_turn_penalty";
152 
159  public const string RIGHT_TURN_PENALTY = "right_turn_penalty";
160 
167  public const string INTERSECTION_PENALTY = "intersection_penalty";
168 
175  public const string SHARP_TURN_PENALTY = "sharp_turn_penalty";
176 
185  public const string NUM_BEST_PATHS = "num_best_paths";
186 
194  public const string MAX_NUM_COMBINATIONS = "max_num_combinations";
195 
210  public const string OUTPUT_EDGE_PATH = "output_edge_path";
211 
214  public const string TRUE = "true";
215 
218  public const string FALSE = "false";
219 
234  public const string OUTPUT_WKT_PATH = "output_wkt_path";
235 
243  public const string SERVER_ID = "server_id";
244 
251  public const string CONVERGENCE_LIMIT = "convergence_limit";
252 
258  public const string MAX_ITERATIONS = "max_iterations";
259 
267  public const string MAX_RUNS = "max_runs";
268 
287  public const string OUTPUT_CLUSTERS = "output_clusters";
288 
306  public const string SOLVE_HEURISTIC = "solve_heuristic";
307 
310  public const string ASTAR = "astar";
311 
313  public const string NONE = "none";
314 
320  public const string ASTAR_RADIUS = "astar_radius";
321  } // end struct Options
322 
324  public string graph_name { get; set; }
325 
342  public IList<string> weights_on_edges { get; set; } = new List<string>();
343 
362  public IList<string> restrictions { get; set; } = new List<string>();
363 
451  public string solver_type { get; set; } = SolverType.SHORTEST_PATH;
452 
459  public IList<string> source_nodes { get; set; } = new List<string>();
460 
467  public IList<string> destination_nodes { get; set; } = new List<string>();
468 
475  public string solution_table { get; set; } = "graph_solutions";
476 
737  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
738 
741  public SolveGraphRequest() { }
742 
1143  IList<string> weights_on_edges = null,
1144  IList<string> restrictions = null,
1145  string solver_type = null,
1146  IList<string> source_nodes = null,
1147  IList<string> destination_nodes = null,
1148  string solution_table = null,
1149  IDictionary<string, string> options = null)
1150  {
1151  this.graph_name = graph_name ?? "";
1152  this.weights_on_edges = weights_on_edges ?? new List<string>();
1153  this.restrictions = restrictions ?? new List<string>();
1155  this.source_nodes = source_nodes ?? new List<string>();
1156  this.destination_nodes = destination_nodes ?? new List<string>();
1157  this.solution_table = solution_table ?? "graph_solutions";
1158  this.options = options ?? new Dictionary<string, string>();
1159  } // end constructor
1160  } // end class SolveGraphRequest
1161 
1166  {
1168  public bool result { get; set; }
1169 
1174  public IList<float> result_per_destination_node { get; set; } = new List<float>();
1175 
1177  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1178  } // end class SolveGraphResponse
1179 } // end namespace kinetica
const string SOLVE_HEURISTIC
Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single ...
Definition: SolveGraph.cs:306
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
Definition: SolveGraph.cs:362
const string PROBABILITY_RANK
Solves for the transitional probability (Hidden Markov) for each node based on the weights (probabili...
Definition: SolveGraph.cs:50
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: SolveGraph.cs:175
IList< string > source_nodes
It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes.
Definition: SolveGraph.cs:459
bool result
Indicates a successful solution on all servers.
Definition: SolveGraph.cs:1168
const string SHORTEST_PATH
Solves for the optimal (shortest) path based on weights and restrictions from one source to destinati...
Definition: SolveGraph.cs:38
string solution_table
Name of the table to store the solution, in [schema_name.
Definition: SolveGraph.cs:475
const string STATS_ALL
Solves for graph statistics such as graph diameter, longest pairs, vertex valences,...
Definition: SolveGraph.cs:86
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:91
const string MIN_SOLUTION_RADIUS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:123
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:70
IDictionary< string, string > info
Additional information.
Definition: SolveGraph.cs:1177
const string CONVERGENCE_LIMIT
For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node be...
Definition: SolveGraph.cs:251
const string FALSE
No extra cluster info per node will be available in the output
Definition: SolveGraph.cs:218
string graph_name
Name of the graph resource to solve.
Definition: SolveGraph.cs:324
const string MAX_NUM_COMBINATIONS
For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated.
Definition: SolveGraph.cs:194
SolveGraphRequest()
Constructs a SolveGraphRequest object with default parameters.
Definition: SolveGraph.cs:741
const string BACKHAUL_ROUTING
Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes.
Definition: SolveGraph.cs:74
const string ASTAR
Employs A-STAR heuristics to speed up the shortest path traversal
Definition: SolveGraph.cs:310
A set of parameters for Kinetica.solveGraph.
Definition: SolveGraph.cs:25
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: SolveGraph.cs:243
const string MAX_ITERATIONS
For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence.
Definition: SolveGraph.cs:258
const string MAX_RUNS
For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible valu...
Definition: SolveGraph.cs:267
const string NONE
No heuristics are applied
Definition: SolveGraph.cs:313
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:1142
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:45
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:210
const string UNIFORM_WEIGHTS
When specified, assigns the given value to all the edges in the graph.
Definition: SolveGraph.cs:143
const string MAX_SOLUTION_TARGETS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:136
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:287
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: SolveGraph.cs:159
const string INTERSECTION_PENALTY
This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option ...
Definition: SolveGraph.cs:167
IList< string > weights_on_edges
Additional weights to apply to the edges of an existing graph.
Definition: SolveGraph.cs:342
string solver_type
The type of solver to use for the graph.
Definition: SolveGraph.cs:451
IList< float > result_per_destination_node
Cost or Pagerank (based on solver type) for each destination node requested.
Definition: SolveGraph.cs:1174
IDictionary< string, string > options
Additional parameters.
Definition: SolveGraph.cs:737
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:234
A set of results returned by Kinetica.solveGraph.
Definition: SolveGraph.cs:1165
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: SolveGraph.cs:151
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:56
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:81
const string NUM_BEST_PATHS
For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node.
Definition: SolveGraph.cs:185
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:64
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of string constants for the parameter solver_type.
Definition: SolveGraph.cs:31
const string ASTAR_RADIUS
For path solvers only when 'solve_heuristic' option is 'astar'.
Definition: SolveGraph.cs:320
const string MAX_SOLUTION_RADIUS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:109
const string TRUE
An additional column 'CLUSTER' will be added for each node
Definition: SolveGraph.cs:214
IList< string > destination_nodes
It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes.
Definition: SolveGraph.cs:467
A set of string constants for the parameter options.
Definition: SolveGraph.cs:97