SolveGraphRequest.Options (Kinetica Java API 7.0.19.0 API)

java.lang.Object
- com.gpudb.protocol.SolveGraphRequest.Options

Enclosing class:

SolveGraphRequest
```
public static final class SolveGraphRequest.Options
extends Object
```
Additional parameters
- MAX_SOLUTION_RADIUS: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destinationNodes 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 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 destinationNodes 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 SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destinationNodes 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 '0'.
- EXPORT_SOLVE_RESULTS: Returns solution results inside the resultPerDestinationNode array in the response if set to true. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- REMOVE_PREVIOUS_RESTRICTIONS: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution.
- UNIFORM_WEIGHTS: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges 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 GPUdb.createGraph(CreateGraphRequest) 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 GPUdb.createGraph(CreateGraphRequest) 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 GPUdb.createGraph(CreateGraphRequest) 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 GPUdb.createGraph(CreateGraphRequest) 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'.
- ACCURATE_SNAPS: Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge. For the latter case (false), the solver modifies the resulting cost with the weights proportional to the ratio of the snap location within the edge. This may be an over-kill when the performance is considered and the difference is well less than 1 percent. In batch runs, since the performance is of utmost importance, the option is always considered 'false'. Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- 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.
- 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.
The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCURATE_SNAPS` Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge.
`static String`	`EXPORT_SOLVE_RESULTS` Returns solution results inside the `resultPerDestinationNode` array in the response if set to `true`.
`static String`	`FALSE`
`static String`	`INTERSECTION_PENALTY` This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the `GPUdb.createGraph(CreateGraphRequest)` was invoked at graph creation.
`static String`	`LEFT_TURN_PENALTY` This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the `GPUdb.createGraph(CreateGraphRequest)` was invoked at graph creation.
`static String`	`MAX_NUM_COMBINATIONS` For `MULTIPLE_ROUTING` solvers only; sets the cap on the combinatorial sequences generated.
`static String`	`MAX_SOLUTION_RADIUS` For `SHORTEST_PATH` and `INVERSE_SHORTEST_PATH` solvers only.
`static String`	`MAX_SOLUTION_TARGETS` For `SHORTEST_PATH` and `INVERSE_SHORTEST_PATH` solvers only.
`static String`	`MIN_SOLUTION_RADIUS` For `SHORTEST_PATH` and `INVERSE_SHORTEST_PATH` solvers only.
`static String`	`NUM_BEST_PATHS` For `MULTIPLE_ROUTING` solvers only; sets the number of shortest paths computed from each node.
`static String`	`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.
`static String`	`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.
`static String`	`REMOVE_PREVIOUS_RESTRICTIONS` Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to `true`.
`static String`	`RESTRICTION_THRESHOLD_VALUE` Value-based restriction comparison.
`static String`	`RIGHT_TURN_PENALTY` This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the `GPUdb.createGraph(CreateGraphRequest)` was invoked at graph creation.
`static String`	`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 `GPUdb.createGraph(CreateGraphRequest)` was invoked at graph creation.
`static String`	`TRUE`
`static String`	`UNIFORM_WEIGHTS` When specified, assigns the given value to all the edges in the graph.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAX_SOLUTION_RADIUS
```
public static final String MAX_SOLUTION_RADIUS
```
    For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destinationNodes 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'.
    
    See Also:
    
    Constant Field Values
  - MIN_SOLUTION_RADIUS
```
public static final String MIN_SOLUTION_RADIUS
```
    For 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 destinationNodes 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'.
    
    See Also:
    
    Constant Field Values
  - MAX_SOLUTION_TARGETS
```
public static final String MAX_SOLUTION_TARGETS
```
    For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destinationNodes 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 '0'.
    
    See Also:
    
    Constant Field Values
  - EXPORT_SOLVE_RESULTS
```
public static final String EXPORT_SOLVE_RESULTS
```
    Returns solution results inside the resultPerDestinationNode array in the response if set to true. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - REMOVE_PREVIOUS_RESTRICTIONS
```
public static final String REMOVE_PREVIOUS_RESTRICTIONS
```
    Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - RESTRICTION_THRESHOLD_VALUE
```
public static final String RESTRICTION_THRESHOLD_VALUE
```
    Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution.
    
    See Also:
    
    Constant Field Values
  - UNIFORM_WEIGHTS
```
public static final String UNIFORM_WEIGHTS
```
    When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.
    
    See Also:
    
    Constant Field Values
  - LEFT_TURN_PENALTY
```
public static final String LEFT_TURN_PENALTY
```
    This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the GPUdb.createGraph(CreateGraphRequest) was invoked at graph creation. The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - RIGHT_TURN_PENALTY
```
public static final String RIGHT_TURN_PENALTY
```
    This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the GPUdb.createGraph(CreateGraphRequest) was invoked at graph creation. The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - INTERSECTION_PENALTY
```
public static final String INTERSECTION_PENALTY
```
    This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the GPUdb.createGraph(CreateGraphRequest) was invoked at graph creation. The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - SHARP_TURN_PENALTY
```
public static final String 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 GPUdb.createGraph(CreateGraphRequest) was invoked at graph creation. The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - NUM_BEST_PATHS
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - MAX_NUM_COMBINATIONS
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - ACCURATE_SNAPS
```
public static final String ACCURATE_SNAPS
```
    Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge. For the latter case (false), the solver modifies the resulting cost with the weights proportional to the ratio of the snap location within the edge. This may be an over-kill when the performance is considered and the difference is well less than 1 percent. In batch runs, since the performance is of utmost importance, the option is always considered 'false'. Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - OUTPUT_EDGE_PATH
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - OUTPUT_WKT_PATH
```
public static final String 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.
    See Also:
    
    Constant Field Values

Class SolveGraphRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_SOLUTION_RADIUS

MIN_SOLUTION_RADIUS

MAX_SOLUTION_TARGETS

EXPORT_SOLVE_RESULTS

TRUE

FALSE

REMOVE_PREVIOUS_RESTRICTIONS

RESTRICTION_THRESHOLD_VALUE

UNIFORM_WEIGHTS

LEFT_TURN_PENALTY

RIGHT_TURN_PENALTY

INTERSECTION_PENALTY

SHARP_TURN_PENALTY

NUM_BEST_PATHS

MAX_NUM_COMBINATIONS

ACCURATE_SNAPS

OUTPUT_EDGE_PATH

OUTPUT_WKT_PATH