Skip to main content

A set of string constants for the parameter SolveGraphRequest.options. More…

​
Static Public Attributes

const string MAX_SOLUTION_RADIUS = “max_solution_radius”
 For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
 
const string MIN_SOLUTION_RADIUS = “min_solution_radius”
 For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
 
const string MAX_SOLUTION_TARGETS = “max_solution_targets”
 For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
 
const string UNIFORM_WEIGHTS = “uniform_weights”
 When specified, assigns the given value to all the edges in the graph.
 
const string LEFT_TURN_PENALTY = “left_turn_penalty”
 This will add an additional weight over the edges labeled as ‘left turn’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.
 
const string RIGHT_TURN_PENALTY = “right_turn_penalty”
 This will add an additional weight over the edges labeled as’ right turn’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.
 
const string INTERSECTION_PENALTY = “intersection_penalty”
 This will add an additional weight over the edges labeled as ‘intersection’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.
 
const string SHARP_TURN_PENALTY = “sharp_turn_penalty”
 This will add an additional weight over the edges labeled as ‘sharp turn’ or ‘u-turn’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.
 
const string NUM_BEST_PATHS = “num_best_paths”
 For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node.
 
const string MAX_NUM_COMBINATIONS = “max_num_combinations”
 For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated.
 
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.
 
const string TRUE = “true”
 A boolean constant for the SolveGraphRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the SolveGraphRequest.Options options.
 
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.
 
const string SERVER_ID = “server_id”
 Indicates which graph server(s) to send the request to.
 
const string CONVERGENCE_LIMIT = “convergence_limit”
 For PAGE_RANK solvers only; Maximum percent relative threshold on the page rank scores of each node between consecutive iterations to satisfy convergence.
 
const string MAX_ITERATIONS = “max_iterations”
 For PAGE_RANK solvers only; Maximum number of page rank iterations for satisfying convergence.
 
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.
 
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.
 
const string SOLVE_HEURISTIC = “solve_heuristic”
 Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target.
 
const string ASTAR = “astar”
 Employs A-STAR heuristics to speed up the shortest path traversal.
 
const string NONE = “none”
 No heuristics are applied.
 
const string ASTAR_RADIUS = “astar_radius”
 For path solvers only when ‘solve_heuristic’ option is ‘astar’.
 

​
Detailed Description

A set of string constants for the parameter SolveGraphRequest.options.

Additional parameters.

Definition at line 93 of file SolveGraph.cs.

​
Member Data Documentation

​
◆ ASTAR

const string kinetica.SolveGraphRequest.Options.ASTAR = “astar”
 static

Employs A-STAR heuristics to speed up the shortest path traversal.

Definition at line 318 of file SolveGraph.cs.

​
◆ ASTAR_RADIUS

const string kinetica.SolveGraphRequest.Options.ASTAR_RADIUS = “astar_radius”
 static

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 328 of file SolveGraph.cs.

​
◆ CONVERGENCE_LIMIT

const string kinetica.SolveGraphRequest.Options.CONVERGENCE_LIMIT = “convergence_limit”
 static

For PAGE_RANK solvers only; Maximum percent relative threshold on the page rank 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 253 of file SolveGraph.cs.

​
◆ FALSE

const string kinetica.SolveGraphRequest.Options.FALSE = “false”
 static

A boolean constant for the SolveGraphRequest.Options options.

Definition at line 217 of file SolveGraph.cs.

​
◆ INTERSECTION_PENALTY

const string kinetica.SolveGraphRequest.Options.INTERSECTION_PENALTY = “intersection_penalty”
 static

This will add an additional weight over the edges labeled as ‘intersection’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.

The default value is ‘0.0’.

Definition at line 163 of file SolveGraph.cs.

​
◆ LEFT_TURN_PENALTY

const string kinetica.SolveGraphRequest.Options.LEFT_TURN_PENALTY = “left_turn_penalty”
 static

This will add an additional weight over the edges labeled as ‘left turn’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.

The default value is ‘0.0’.

Definition at line 149 of file SolveGraph.cs.

​
◆ MAX_ITERATIONS

const string kinetica.SolveGraphRequest.Options.MAX_ITERATIONS = “max_iterations”
 static

For PAGE_RANK solvers only; Maximum number of page rank iterations for satisfying convergence.

Default value is 100. The default value is ‘100’.

Definition at line 261 of file SolveGraph.cs.

​
◆ MAX_NUM_COMBINATIONS

const string kinetica.SolveGraphRequest.Options.MAX_NUM_COMBINATIONS = “max_num_combinations”
 static

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 190 of file SolveGraph.cs.

​
◆ MAX_RUNS

const string kinetica.SolveGraphRequest.Options.MAX_RUNS = “max_runs”
 static

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 270 of file SolveGraph.cs.

​
◆ MAX_SOLUTION_RADIUS

const string kinetica.SolveGraphRequest.Options.MAX_SOLUTION_RADIUS = “max_solution_radius”
 static

For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.

Sets the maximum solution cost radius, which ignores the SolveGraphRequest.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 106 of file SolveGraph.cs.

​
◆ MAX_SOLUTION_TARGETS

const string kinetica.SolveGraphRequest.Options.MAX_SOLUTION_TARGETS = “max_solution_targets”
 static

For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.

Sets the maximum number of solution targets, which ignores the SolveGraphRequest.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 135 of file SolveGraph.cs.

​
◆ MIN_SOLUTION_RADIUS

const string kinetica.SolveGraphRequest.Options.MIN_SOLUTION_RADIUS = “min_solution_radius”
 static

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 SolveGraphRequest.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 121 of file SolveGraph.cs.

​
◆ NONE

const string kinetica.SolveGraphRequest.Options.NONE = “none”
 static

No heuristics are applied.

Definition at line 321 of file SolveGraph.cs.

​
◆ NUM_BEST_PATHS

const string kinetica.SolveGraphRequest.Options.NUM_BEST_PATHS = “num_best_paths”
 static

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 181 of file SolveGraph.cs.

​
◆ OUTPUT_CLUSTERS

const string kinetica.SolveGraphRequest.Options.OUTPUT_CLUSTERS = “output_clusters”
 static

For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output.

Supported values:

  • TRUE: An additional column ‘CLUSTER’ will be added for each node.
  • FALSE: No extra cluster info per node will be available in the output.

The default value is FALSE.

Definition at line 294 of file SolveGraph.cs.

​
◆ OUTPUT_EDGE_PATH

const string kinetica.SolveGraphRequest.Options.OUTPUT_EDGE_PATH = “output_edge_path”
 static

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 209 of file SolveGraph.cs.

​
◆ OUTPUT_WKT_PATH

const string kinetica.SolveGraphRequest.Options.OUTPUT_WKT_PATH = “output_wkt_path”
 static

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 235 of file SolveGraph.cs.

​
◆ RIGHT_TURN_PENALTY

const string kinetica.SolveGraphRequest.Options.RIGHT_TURN_PENALTY = “right_turn_penalty”
 static

This will add an additional weight over the edges labeled as’ right turn’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.

The default value is ‘0.0’.

Definition at line 156 of file SolveGraph.cs.

​
◆ SERVER_ID

const string kinetica.SolveGraphRequest.Options.SERVER_ID = “server_id”
 static

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 244 of file SolveGraph.cs.

​
◆ SHARP_TURN_PENALTY

const string kinetica.SolveGraphRequest.Options.SHARP_TURN_PENALTY = “sharp_turn_penalty”
 static

This will add an additional weight over the edges labeled as ‘sharp turn’ or ‘u-turn’ if the ‘add_turn’ option parameter of the Kinetica.createGraph was invoked at graph creation.

The default value is ‘0.0’.

Definition at line 171 of file SolveGraph.cs.

​
◆ SOLVE_HEURISTIC

const string kinetica.SolveGraphRequest.Options.SOLVE_HEURISTIC = “solve_heuristic”
 static

Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target.

Supported values:

  • ASTAR: Employs A-STAR heuristics to speed up the shortest path traversal.
  • NONE: No heuristics are applied.

The default value is NONE.

Definition at line 314 of file SolveGraph.cs.

​
◆ TRUE

const string kinetica.SolveGraphRequest.Options.TRUE = “true”
 static

A boolean constant for the SolveGraphRequest.Options options.

Definition at line 213 of file SolveGraph.cs.

​
◆ UNIFORM_WEIGHTS

const string kinetica.SolveGraphRequest.Options.UNIFORM_WEIGHTS = “uniform_weights”
 static

When specified, assigns the given value to all the edges in the graph.

Note that weights provided in SolveGraphRequest.weights_on_edges will override this value.

Definition at line 142 of file SolveGraph.cs.

The documentation for this struct was generated from the following files: