|
Kinetica C# API
Version 7.1.10.0
|
|
Kinetica C# API
Version 7.1.10.0
|
Additional parameters
Public Attributes | |
| const string | MAX_SOLUTION_RADIUS = "max_solution_radius" |
| For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. More... | |
| const string | MIN_SOLUTION_RADIUS = "min_solution_radius" |
| For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. More... | |
| const string | MAX_SOLUTION_TARGETS = "max_solution_targets" |
| For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. More... | |
| const string | UNIFORM_WEIGHTS = "uniform_weights" |
| When specified, assigns the given value to all the edges in the graph. More... | |
| const string | LEFT_TURN_PENALTY = "left_turn_penalty" |
| This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | RIGHT_TURN_PENALTY = "right_turn_penalty" |
| This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | INTERSECTION_PENALTY = "intersection_penalty" |
| This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | SHARP_TURN_PENALTY = "sharp_turn_penalty" |
| This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | NUM_BEST_PATHS = "num_best_paths" |
| For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. More... | |
| const string | MAX_NUM_COMBINATIONS = "max_num_combinations" |
| For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. More... | |
| const string | OUTPUT_EDGE_PATH = "output_edge_path" |
| If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. More... | |
| const string | TRUE = "true" |
| An additional column 'CLUSTER' will be added for each node More... | |
| const string | FALSE = "false" |
| No extra cluster info per node will be available in the output More... | |
| const string | OUTPUT_WKT_PATH = "output_wkt_path" |
| If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. More... | |
| const string | SERVER_ID = "server_id" |
| Indicates which graph server(s) to send the request to. More... | |
| const string | CONVERGENCE_LIMIT = "convergence_limit" |
| For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node between consecutive iterations to satisfy convergence. More... | |
| const string | MAX_ITERATIONS = "max_iterations" |
| For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence. More... | |
| const string | MAX_RUNS = "max_runs" |
| For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph. More... | |
| const string | OUTPUT_CLUSTERS = "output_clusters" |
| For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output. More... | |
| const string | SOLVE_HEURISTIC = "solve_heuristic" |
| Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target Supported values: | |
| const string | ASTAR = "astar" |
| Employs A-STAR heuristics to speed up the shortest path traversal More... | |
| const string | NONE = "none" |
| No heuristics are applied More... | |
| const string | ASTAR_RADIUS = "astar_radius" |
| For path solvers only when 'solve_heuristic' option is 'astar'. More... | |
Additional parameters
Sets the maximum solution cost radius, which ignores the list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'. MIN_SOLUTION_RADIUS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'. MAX_SOLUTION_TARGETS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '1000'. UNIFORM_WEIGHTS: When specified, assigns the given value to all the edges in the graph. Note that weights provided in will override this value. LEFT_TURN_PENALTY: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. RIGHT_TURN_PENALTY: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. INTERSECTION_PENALTY: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. SHARP_TURN_PENALTY: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. NUM_BEST_PATHS: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'. MAX_NUM_COMBINATIONS: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'. OUTPUT_EDGE_PATH: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. Supported values:
The default value is FALSE. OUTPUT_WKT_PATH: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. Supported values:
The default value is TRUE. SERVER_ID: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. For SHORTEST_PATH solver type, the input is split amongst the server containing the corresponding graph. CONVERGENCE_LIMIT: For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node between consecutive iterations to satisfy convergence. Default value is 1 (one) percent. The default value is '1.0'. MAX_ITERATIONS: For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence. Default value is 100. The default value is '100'. MAX_RUNS: For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph. Default value of 0 enables this value to be auto computed by the solver. The default value is '0'. OUTPUT_CLUSTERS: For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output. Supported values:
The default value is FALSE. SOLVE_HEURISTIC: Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target Supported values:
The default value is NONE. ASTAR_RADIUS: For path solvers only when 'solve_heuristic' option is 'astar'. The shortest path traversal front includes nodes only within this radius (kilometers) as it moves towards the target location. The default value is '70'.
The default value is an empty Dictionary. A set of string constants for the parameter options.
Definition at line 401 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.ASTAR = "astar" |
Employs A-STAR heuristics to speed up the shortest path traversal
Definition at line 596 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.ASTAR_RADIUS = "astar_radius" |
For path solvers only when 'solve_heuristic' option is 'astar'.
The shortest path traversal front includes nodes only within this radius (kilometers) as it moves towards the target location. The default value is '70'.
Definition at line 605 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.CONVERGENCE_LIMIT = "convergence_limit" |
For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node between consecutive iterations to satisfy convergence.
Default value is 1 (one) percent. The default value is '1.0'.
Definition at line 538 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.FALSE = "false" |
No extra cluster info per node will be available in the output
Definition at line 506 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.INTERSECTION_PENALTY = "intersection_penalty" |
This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 457 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.LEFT_TURN_PENALTY = "left_turn_penalty" |
This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 441 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_ITERATIONS = "max_iterations" |
For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence.
Default value is 100. The default value is '100'.
Definition at line 543 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_NUM_COMBINATIONS = "max_num_combinations" |
For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated.
If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'.
Definition at line 480 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_RUNS = "max_runs" |
For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph.
Default value of 0 enables this value to be auto computed by the solver. The default value is '0'.
Definition at line 550 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_SOLUTION_RADIUS = "max_solution_radius" |
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Sets the maximum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
Definition at line 410 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_SOLUTION_TARGETS = "max_solution_targets" |
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Sets the maximum number of solution targets, which ignores the destination_nodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '1000'.
Definition at line 428 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MIN_SOLUTION_RADIUS = "min_solution_radius" |
For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
Definition at line 419 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.NONE = "none" |
No heuristics are applied
Definition at line 599 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.NUM_BEST_PATHS = "num_best_paths" |
For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node.
This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'.
Definition at line 473 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.OUTPUT_CLUSTERS = "output_clusters" |
For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output.
Supported values:
The default value is FALSE.
Definition at line 572 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.OUTPUT_EDGE_PATH = "output_edge_path" |
If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves.
Supported values:
The default value is FALSE.
Definition at line 498 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.OUTPUT_WKT_PATH = "output_wkt_path" |
If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves.
Supported values:
The default value is TRUE.
Definition at line 524 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.RIGHT_TURN_PENALTY = "right_turn_penalty" |
This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 449 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.SERVER_ID = "server_id" |
Indicates which graph server(s) to send the request to.
Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. For SHORTEST_PATH solver type, the input is split amongst the server containing the corresponding graph.
Definition at line 532 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.SHARP_TURN_PENALTY = "sharp_turn_penalty" |
This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 465 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.SOLVE_HEURISTIC = "solve_heuristic" |
Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target Supported values:
The default value is NONE.
Definition at line 592 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.TRUE = "true" |
An additional column 'CLUSTER' will be added for each node
Definition at line 502 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.UNIFORM_WEIGHTS = "uniform_weights" |
When specified, assigns the given value to all the edges in the graph.
Note that weights provided in weights_on_edges will override this value.
Definition at line 433 of file SolveGraph.cs.
1.8.5 
