Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
34  {
35 
116  public struct SolverType
117  {
118 
122  public const string SHORTEST_PATH = "SHORTEST_PATH";
123 
127  public const string PAGE_RANK = "PAGE_RANK";
128 
132  public const string PROBABILITY_RANK = "PROBABILITY_RANK";
133 
138  public const string CENTRALITY = "CENTRALITY";
139 
144  public const string MULTIPLE_ROUTING = "MULTIPLE_ROUTING";
145 
149  public const string INVERSE_SHORTEST_PATH = "INVERSE_SHORTEST_PATH";
150 
153  public const string BACKHAUL_ROUTING = "BACKHAUL_ROUTING";
154 
159  public const string ALLPATHS = "ALLPATHS";
160 
164  public const string STATS_ALL = "STATS_ALL";
165 
169  public const string CLOSENESS = "CLOSENESS";
170  } // end struct SolverType
171 
172 
401  public struct Options
402  {
403 
410  public const string MAX_SOLUTION_RADIUS = "max_solution_radius";
411 
419  public const string MIN_SOLUTION_RADIUS = "min_solution_radius";
420 
428  public const string MAX_SOLUTION_TARGETS = "max_solution_targets";
429 
433  public const string UNIFORM_WEIGHTS = "uniform_weights";
434 
441  public const string LEFT_TURN_PENALTY = "left_turn_penalty";
442 
449  public const string RIGHT_TURN_PENALTY = "right_turn_penalty";
450 
457  public const string INTERSECTION_PENALTY = "intersection_penalty";
458 
465  public const string SHARP_TURN_PENALTY = "sharp_turn_penalty";
466 
473  public const string NUM_BEST_PATHS = "num_best_paths";
474 
480  public const string MAX_NUM_COMBINATIONS = "max_num_combinations";
481 
498  public const string OUTPUT_EDGE_PATH = "output_edge_path";
499 
502  public const string TRUE = "true";
503 
506  public const string FALSE = "false";
507 
524  public const string OUTPUT_WKT_PATH = "output_wkt_path";
525 
532  public const string SERVER_ID = "server_id";
533 
538  public const string CONVERGENCE_LIMIT = "convergence_limit";
539 
543  public const string MAX_ITERATIONS = "max_iterations";
544 
550  public const string MAX_RUNS = "max_runs";
551 
572  public const string OUTPUT_CLUSTERS = "output_clusters";
573 
592  public const string SOLVE_HEURISTIC = "solve_heuristic";
593 
596  public const string ASTAR = "astar";
597 
599  public const string NONE = "none";
600 
605  public const string ASTAR_RADIUS = "astar_radius";
606  } // end struct Options
607 
608 
610  public string graph_name { get; set; }
611 
632  public IList<string> weights_on_edges { get; set; } = new List<string>();
633 
656  public IList<string> restrictions { get; set; } = new List<string>();
657 
737  public string solver_type { get; set; } = SolverType.SHORTEST_PATH;
738 
743  public IList<string> source_nodes { get; set; } = new List<string>();
744 
749  public IList<string> destination_nodes { get; set; } = new List<string>();
750 
756  public string solution_table { get; set; } = "graph_solutions";
757 
984  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
985 
986 
989  public SolveGraphRequest() { }
990 
1360  IList<string> weights_on_edges = null,
1361  IList<string> restrictions = null,
1362  string solver_type = null,
1363  IList<string> source_nodes = null,
1364  IList<string> destination_nodes = null,
1365  string solution_table = null,
1366  IDictionary<string, string> options = null)
1367  {
1368  this.graph_name = graph_name ?? "";
1369  this.weights_on_edges = weights_on_edges ?? new List<string>();
1370  this.restrictions = restrictions ?? new List<string>();
1371  this.solver_type = solver_type ?? SolverType.SHORTEST_PATH;
1372  this.source_nodes = source_nodes ?? new List<string>();
1373  this.destination_nodes = destination_nodes ?? new List<string>();
1374  this.solution_table = solution_table ?? "graph_solutions";
1375  this.options = options ?? new Dictionary<string, string>();
1376  } // end constructor
1377 
1378  } // end class SolveGraphRequest
1379 
1380 
1381 
1386  {
1387 
1390  public bool result { get; set; }
1391 
1395  public IList<float> result_per_destination_node { get; set; } = new List<float>();
1396 
1398  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1399 
1400  } // end class SolveGraphResponse
1401 
1402 
1403 
1404 
1405 } // 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:592
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
Definition: SolveGraph.cs:656
const string PROBABILITY_RANK
Solves for the transitional probability (Hidden Markov) for each node based on the weights (probabili...
Definition: SolveGraph.cs:132
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: SolveGraph.cs:465
IList< string > source_nodes
It can be one of the nodal identifiers - e.g: &#39;NODE_WKTPOINT&#39; for source nodes.
Definition: SolveGraph.cs:743
bool result
Indicates a successful solution on all servers.
Definition: SolveGraph.cs:1390
const string SHORTEST_PATH
Solves for the optimal (shortest) path based on weights and restrictions from one source to destinati...
Definition: SolveGraph.cs:122
string solution_table
Name of the table to store the solution, in [schema_name.
Definition: SolveGraph.cs:756
const string STATS_ALL
Solves for graph statistics such as graph diameter, longest pairs, vertex valences, topology numbers, average and max cluster sizes, etc.
Definition: SolveGraph.cs:164
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:169
const string MIN_SOLUTION_RADIUS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:419
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:149
IDictionary< string, string > info
Additional information.
Definition: SolveGraph.cs:1398
const string CONVERGENCE_LIMIT
For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node be...
Definition: SolveGraph.cs:538
const string FALSE
No extra cluster info per node will be available in the output
Definition: SolveGraph.cs:506
string graph_name
Name of the graph resource to solve.
Definition: SolveGraph.cs:610
const string MAX_NUM_COMBINATIONS
For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated.
Definition: SolveGraph.cs:480
SolveGraphRequest()
Constructs a SolveGraphRequest object with default parameters.
Definition: SolveGraph.cs:989
const string BACKHAUL_ROUTING
Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes...
Definition: SolveGraph.cs:153
const string ASTAR
Employs A-STAR heuristics to speed up the shortest path traversal
Definition: SolveGraph.cs:596
A set of parameters for Kinetica.solveGraph(string,IList{string},IList{string},string,IList{string},IList{string},string,IDictionary{string, string}).
Definition: SolveGraph.cs:33
const string SERVER_ID
Indicates which graph server(s) to send the request to.
Definition: SolveGraph.cs:532
const string MAX_ITERATIONS
For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence.
Definition: SolveGraph.cs:543
const string MAX_RUNS
For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible valu...
Definition: SolveGraph.cs:550
const string NONE
No heuristics are applied
Definition: SolveGraph.cs:599
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:1359
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:127
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:498
const string UNIFORM_WEIGHTS
When specified, assigns the given value to all the edges in the graph.
Definition: SolveGraph.cs:433
const string MAX_SOLUTION_TARGETS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:428
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:572
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: SolveGraph.cs:449
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: SolveGraph.cs:457
IList< string > weights_on_edges
Additional weights to apply to the edges of an existing graph.
Definition: SolveGraph.cs:632
string solver_type
The type of solver to use for the graph.
Definition: SolveGraph.cs:737
IList< float > result_per_destination_node
Cost or Pagerank (based on solver type) for each destination node requested.
Definition: SolveGraph.cs:1395
IDictionary< string, string > options
Additional parameters MAX_SOLUTION_RADIUS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solv...
Definition: SolveGraph.cs:984
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:524
A set of results returned by Kinetica.solveGraph(string,IList{string},IList{string},string,IList{string},IList{string},string,IDictionary{string, string}).
Definition: SolveGraph.cs:1385
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: SolveGraph.cs:441
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:138
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:159
const string NUM_BEST_PATHS
For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node...
Definition: SolveGraph.cs:473
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:144
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
The type of solver to use for the graph.
Definition: SolveGraph.cs:116
const string ASTAR_RADIUS
For path solvers only when &#39;solve_heuristic&#39; option is &#39;astar&#39;.
Definition: SolveGraph.cs:605
const string MAX_SOLUTION_RADIUS
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:410
const string TRUE
An additional column &#39;CLUSTER&#39; will be added for each node
Definition: SolveGraph.cs:502
IList< string > destination_nodes
It can be one of the nodal identifiers - e.g: &#39;NODE_WKTPOINT&#39; for destination (target) nodes...
Definition: SolveGraph.cs:749
Additional parameters MAX_SOLUTION_RADIUS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solv...
Definition: SolveGraph.cs:401