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

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 additional weight over the edges labeled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph was invoked at graph creation. More...

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. More...

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. More...

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. 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 page rank 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 page rank 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. More...

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...

Detailed Description

A set of string constants for the parameter options.

Additional parameters.

Definition at line 93 of file SolveGraph.cs.

Member Data Documentation

◆ ASTAR

const string SolveGraphRequest.Options.ASTAR = "astar"

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

Definition at line 296 of file SolveGraph.cs.

◆ ASTAR_RADIUS

const string 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 306 of file SolveGraph.cs.

◆ CONVERGENCE_LIMIT

const string SolveGraphRequest.Options.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.

Default value is 1 (one) percent. The default value is '1.0'.

Definition at line 239 of file SolveGraph.cs.

◆ FALSE

const string SolveGraphRequest.Options.FALSE = "false"

No extra cluster info per node will be available in the output.

Definition at line 206 of file SolveGraph.cs.

◆ INTERSECTION_PENALTY

const string SolveGraphRequest.Options.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.

The default value is '0.0'.

Definition at line 155 of file SolveGraph.cs.

◆ LEFT_TURN_PENALTY

const string SolveGraphRequest.Options.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.

The default value is '0.0'.

Definition at line 141 of file SolveGraph.cs.

◆ MAX_ITERATIONS

const string SolveGraphRequest.Options.MAX_ITERATIONS = "max_iterations"

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

◆ MAX_NUM_COMBINATIONS

const string 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 182 of file SolveGraph.cs.

◆ MAX_RUNS

const string 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 254 of file SolveGraph.cs.

◆ MAX_SOLUTION_RADIUS

const string 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 104 of file SolveGraph.cs.

◆ MAX_SOLUTION_TARGETS

const string 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 127 of file SolveGraph.cs.

◆ MIN_SOLUTION_RADIUS

const string 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 116 of file SolveGraph.cs.

◆ NONE

const string SolveGraphRequest.Options.NONE = "none"

No heuristics are applied.

Definition at line 299 of file SolveGraph.cs.

◆ NUM_BEST_PATHS

const string 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 173 of file SolveGraph.cs.

◆ OUTPUT_CLUSTERS

const string 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:

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

◆ OUTPUT_EDGE_PATH

const string 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:

TRUE
FALSE

The default value is FALSE.

Definition at line 198 of file SolveGraph.cs.

◆ OUTPUT_WKT_PATH

const string 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:

TRUE
FALSE

The default value is TRUE.

Definition at line 222 of file SolveGraph.cs.

◆ RIGHT_TURN_PENALTY

const string SolveGraphRequest.Options.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.

The default value is '0.0'.

Definition at line 148 of file SolveGraph.cs.

◆ SERVER_ID

const string 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 231 of file SolveGraph.cs.

◆ SHARP_TURN_PENALTY

const string SolveGraphRequest.Options.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.

The default value is '0.0'.

Definition at line 163 of file SolveGraph.cs.

◆ SOLVE_HEURISTIC

const string 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:

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

◆ TRUE

const string SolveGraphRequest.Options.TRUE = "true"

An additional column 'CLUSTER' will be added for each node.

Definition at line 202 of file SolveGraph.cs.

◆ UNIFORM_WEIGHTS

const string 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 134 of file SolveGraph.cs.

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

Kinetica/Protocol/SolveGraph.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ ASTAR

◆ ASTAR_RADIUS

◆ CONVERGENCE_LIMIT

◆ FALSE

◆ INTERSECTION_PENALTY

◆ LEFT_TURN_PENALTY

◆ MAX_ITERATIONS

◆ MAX_NUM_COMBINATIONS

◆ MAX_RUNS

◆ MAX_SOLUTION_RADIUS

◆ MAX_SOLUTION_TARGETS

◆ MIN_SOLUTION_RADIUS

◆ NONE

◆ NUM_BEST_PATHS

◆ OUTPUT_CLUSTERS

◆ OUTPUT_EDGE_PATH

◆ OUTPUT_WKT_PATH

◆ RIGHT_TURN_PENALTY

◆ SERVER_ID

◆ SHARP_TURN_PENALTY

◆ SOLVE_HEURISTIC

◆ TRUE

◆ UNIFORM_WEIGHTS