> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.SolveGraphRequest.Options > kinetica.SolveGraphRequest.Options — Kinetica C# API

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: