Kinetica C# API  Version 7.0.19.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 
102  public struct SolverType
103  {
104 
108  public const string SHORTEST_PATH = "SHORTEST_PATH";
109 
113  public const string PAGE_RANK = "PAGE_RANK";
114 
118  public const string PROBABILITY_RANK = "PROBABILITY_RANK";
119 
124  public const string CENTRALITY = "CENTRALITY";
125 
130  public const string MULTIPLE_ROUTING = "MULTIPLE_ROUTING";
131 
135  public const string INVERSE_SHORTEST_PATH = "INVERSE_SHORTEST_PATH";
136 
139  public const string BACKHAUL_ROUTING = "BACKHAUL_ROUTING";
140 
145  public const string ALLPATHS = "ALLPATHS";
146  } // end struct SolverType
147 
148 
363  public struct Options
364  {
365 
372  public const string MAX_SOLUTION_RADIUS = "max_solution_radius";
373 
381  public const string MIN_SOLUTION_RADIUS = "min_solution_radius";
382 
390  public const string MAX_SOLUTION_TARGETS = "max_solution_targets";
391 
408  public const string EXPORT_SOLVE_RESULTS = "export_solve_results";
409  public const string TRUE = "true";
410  public const string FALSE = "false";
411 
428  public const string REMOVE_PREVIOUS_RESTRICTIONS = "remove_previous_restrictions";
429 
434  public const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value";
435 
439  public const string UNIFORM_WEIGHTS = "uniform_weights";
440 
447  public const string LEFT_TURN_PENALTY = "left_turn_penalty";
448 
455  public const string RIGHT_TURN_PENALTY = "right_turn_penalty";
456 
463  public const string INTERSECTION_PENALTY = "intersection_penalty";
464 
471  public const string SHARP_TURN_PENALTY = "sharp_turn_penalty";
472 
479  public const string NUM_BEST_PATHS = "num_best_paths";
480 
486  public const string MAX_NUM_COMBINATIONS = "max_num_combinations";
487 
511  public const string ACCURATE_SNAPS = "accurate_snaps";
512 
529  public const string OUTPUT_EDGE_PATH = "output_edge_path";
530 
547  public const string OUTPUT_WKT_PATH = "output_wkt_path";
548  } // end struct Options
549 
550 
552  public string graph_name { get; set; }
553 
574  public IList<string> weights_on_edges { get; set; } = new List<string>();
575 
599  public IList<string> restrictions { get; set; } = new List<string>();
600 
666  public string solver_type { get; set; } = SolverType.SHORTEST_PATH;
667 
672  public IList<string> source_nodes { get; set; } = new List<string>();
673 
678  public IList<string> destination_nodes { get; set; } = new List<string>();
679 
682  public string solution_table { get; set; } = "graph_solutions";
683 
896  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
897 
898 
901  public SolveGraphRequest() { }
902 
1242  IList<string> weights_on_edges = null,
1243  IList<string> restrictions = null,
1244  string solver_type = null,
1245  IList<string> source_nodes = null,
1246  IList<string> destination_nodes = null,
1247  string solution_table = null,
1248  IDictionary<string, string> options = null)
1249  {
1250  this.graph_name = graph_name ?? "";
1251  this.weights_on_edges = weights_on_edges ?? new List<string>();
1252  this.restrictions = restrictions ?? new List<string>();
1253  this.solver_type = solver_type ?? SolverType.SHORTEST_PATH;
1254  this.source_nodes = source_nodes ?? new List<string>();
1255  this.destination_nodes = destination_nodes ?? new List<string>();
1256  this.solution_table = solution_table ?? "graph_solutions";
1257  this.options = options ?? new Dictionary<string, string>();
1258  } // end constructor
1259 
1260  } // end class SolveGraphRequest
1261 
1262 
1263 
1268  {
1269 
1271  public bool result { get; set; }
1272 
1276  public IList<float> result_per_destination_node { get; set; } = new List<float>();
1277 
1279  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1280 
1281  } // end class SolveGraphResponse
1282 
1283 
1284 
1285 
1286 } // end namespace kinetica
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
Definition: SolveGraph.cs:599
const string PROBABILITY_RANK
Solves for the transitional probability (Hidden Markov) for each node based on the weights (probabili...
Definition: SolveGraph.cs:118
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:471
IList< string > source_nodes
It can be one of the nodal identifiers - e.g: &#39;NODE_WKTPOINT&#39; for source nodes.
Definition: SolveGraph.cs:672
bool result
Indicates a successful solution.
Definition: SolveGraph.cs:1271
const string SHORTEST_PATH
Solves for the optimal (shortest) path based on weights and restrictions from one source to destinati...
Definition: SolveGraph.cs:108
string solution_table
Name of the table to store the solution.
Definition: SolveGraph.cs:682
const string MIN_SOLUTION_RADIUS
For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:381
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:135
IDictionary< string, string > info
Additional information.
Definition: SolveGraph.cs:1279
string graph_name
Name of the graph resource to solve.
Definition: SolveGraph.cs:552
const string REMOVE_PREVIOUS_RESTRICTIONS
Ignore the restrictions applied to the graph during the creation stage and only use the restrictions ...
Definition: SolveGraph.cs:428
const string MAX_NUM_COMBINATIONS
For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated.
Definition: SolveGraph.cs:486
const string ACCURATE_SNAPS
Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier t...
Definition: SolveGraph.cs:511
SolveGraphRequest()
Constructs a SolveGraphRequest object with default parameters.
Definition: SolveGraph.cs:901
const string BACKHAUL_ROUTING
Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes...
Definition: SolveGraph.cs:139
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 RESTRICTION_THRESHOLD_VALUE
Value-based restriction comparison.
Definition: SolveGraph.cs:434
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:1241
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:113
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:529
const string UNIFORM_WEIGHTS
When specified, assigns the given value to all the edges in the graph.
Definition: SolveGraph.cs:439
const string MAX_SOLUTION_TARGETS
For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:390
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:455
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:463
IList< string > weights_on_edges
Additional weights to apply to the edges of an existing graph.
Definition: SolveGraph.cs:574
string solver_type
The type of solver to use for the graph.
Definition: SolveGraph.cs:666
IList< float > result_per_destination_node
Cost or Pagerank (based on solver type) for each destination node requested.
Definition: SolveGraph.cs:1276
IDictionary< string, string > options
Additional parameters MAX_SOLUTION_RADIUS: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only...
Definition: SolveGraph.cs:896
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:547
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:1267
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:447
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:124
const string EXPORT_SOLVE_RESULTS
Returns solution results inside the &lt;member name=&quot;result_per_destination_node&quot;&gt; array in the response...
Definition: SolveGraph.cs:408
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:145
const string NUM_BEST_PATHS
For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node...
Definition: SolveGraph.cs:479
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:130
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:102
const string MAX_SOLUTION_RADIUS
For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Definition: SolveGraph.cs:372
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:678
Additional parameters MAX_SOLUTION_RADIUS: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only...
Definition: SolveGraph.cs:363