MatchGraphRequest.Options (Kinetica Java API 7.0.19.0 API)

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

Enclosing class:

MatchGraphRequest
```
public static final class MatchGraphRequest.Options
extends Object
```
Additional parameters
- GPS_NOISE: GPS noise value (in meters) to remove redundant sample points. Use -1 to disable noise reduction. The default value accounts for 95% of point variation (+ or -5 meters). The default value is '5.0'.
- NUM_SEGMENTS: Maximum number of potentially matching road segments for each sample point. For the markov_chain solver, the default is 3. The default value is '3'.
- SEARCH_RADIUS: Maximum search radius used when snapping sample points onto potentially matching surrounding segments. The default value corresponds to approximately 100 meters. The default value is '0.001'.
- CHAIN_WIDTH: For the markov_chain solver only. Length of the sample points lookahead window within the Markov kernel; the larger the number, the more accurate the solution. The default value is '9'.
- SOURCE: Optional WKT starting point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the starting point. The default value is 'POINT NULL'.
- DESTINATION: Optional WKT ending point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the destination point. The default value is 'POINT NULL'.
- PARTIAL_LOADING: For the match_supply_demand solver only. When false (non-default), trucks do not off-load at the demand (store) side if the remainder is less than the store's need Supported values:
  - TRUE: Partial off-loading at multiple store (demand) locations
  - FALSE: No partial off-loading allowed if supply is less than the store's demand.
  The default value is TRUE.
- MAX_COMBINATIONS: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the demand locations - can increase this up to 2M. The default value is '10000'.
- 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'.
- AGGREGATED_OUTPUT: For the match_supply_demand solver only. When it is true (default), each record in the output table shows a particular truck's scheduled cumulative round trip path (MULTILINESTRING) and the corresponding aggregated cost. Otherwise, each record shows a single scheduled truck route (LINESTRING) towards a particular demand location (store id) with its corresponding cost. The default value is 'true'.
- MAX_TRIP_COST: For the match_supply_demand solver only. If this constraint is greater than zero (default) then the trucks will skip travelling from one demand location to another if the cost between them is greater than this number (distance or time). Zero (default) value means no check is performed. The default value is '0.0'.
- FILTER_FOLDING_PATHS: For the markov_chain solver only. When true (non-default), the paths per sequence combination is checked for folding over patterns and can significantly increase the execution time depending on the chain width and the number of gps samples. Supported values:
  - TRUE: Filter out the folded paths.
  - FALSE: Do not filter out the folded paths
  The default value is FALSE.
- UNIT_UNLOADING_COST: For the match_supply_demand solver only. The unit cost per load amount to be delivered. If this value is greater than zero (default) then the additional cost of this unit load multiplied by the total dropped load will be added over to the trip cost to the demand location. The default value is '0.0'.
- MAX_NUM_THREADS: For the markov_chain solver only. If specified (greater than zero), the maximum number of threads will not be greater than the specified value. It can be lower due to the memory and the number cores available. Default value of zero allows the algorithm to set the maximal number of threads within these constraints. The default value is '0'.
- TRUCK_SERVICE_LIMIT: For the match_supply_demand solver only. If specified (greather than zero), any truck's total service cost (distance or time) will be limited by the specified value including multiple rounds (if set). The default value is '0.0'.
- ENABLE_TRUCK_REUSE: For the match_supply_demand solver only. If specified (true), all trucks can be scheduled for second rounds from their originating depots. Supported values:
  - TRUE: Allows reusing trucks for scheduling again.
  - FALSE: Trucks are scheduled only once from their depots.
  The default value is FALSE.
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`	`AGGREGATED_OUTPUT` For the `match_supply_demand` solver only.
`static String`	`CHAIN_WIDTH` For the `markov_chain` solver only.
`static String`	`DESTINATION` Optional WKT ending point from `samplePoints` for the solver.
`static String`	`ENABLE_TRUCK_REUSE` For the `match_supply_demand` solver only.
`static String`	`FALSE` Trucks are scheduled only once from their depots.
`static String`	`FILTER_FOLDING_PATHS` For the `markov_chain` solver only.
`static String`	`GPS_NOISE` GPS noise value (in meters) to remove redundant sample points.
`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_COMBINATIONS` For the `match_supply_demand` solver only.
`static String`	`MAX_NUM_THREADS` For the `markov_chain` solver only.
`static String`	`MAX_TRIP_COST` For the `match_supply_demand` solver only.
`static String`	`NUM_SEGMENTS` Maximum number of potentially matching road segments for each sample point.
`static String`	`PARTIAL_LOADING` For the `match_supply_demand` solver only.
`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`	`SEARCH_RADIUS` Maximum search radius used when snapping sample points onto potentially matching surrounding segments.
`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`	`SOURCE` Optional WKT starting point from `samplePoints` for the solver.
`static String`	`TRUCK_SERVICE_LIMIT` For the `match_supply_demand` solver only.
`static String`	`TRUE` Allows reusing trucks for scheduling again.
`static String`	`UNIT_UNLOADING_COST` For the `match_supply_demand` solver only.

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

- Field Detail
  - GPS_NOISE
```
public static final String GPS_NOISE
```
    GPS noise value (in meters) to remove redundant sample points. Use -1 to disable noise reduction. The default value accounts for 95% of point variation (+ or -5 meters). The default value is '5.0'.
    
    See Also:
    
    Constant Field Values
  - NUM_SEGMENTS
```
public static final String NUM_SEGMENTS
```
    Maximum number of potentially matching road segments for each sample point. For the markov_chain solver, the default is 3. The default value is '3'.
    
    See Also:
    
    Constant Field Values
  - SEARCH_RADIUS
```
public static final String SEARCH_RADIUS
```
    Maximum search radius used when snapping sample points onto potentially matching surrounding segments. The default value corresponds to approximately 100 meters. The default value is '0.001'.
    
    See Also:
    
    Constant Field Values
  - CHAIN_WIDTH
```
public static final String CHAIN_WIDTH
```
    For the markov_chain solver only. Length of the sample points lookahead window within the Markov kernel; the larger the number, the more accurate the solution. The default value is '9'.
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final String SOURCE
```
    Optional WKT starting point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the starting point. The default value is 'POINT NULL'.
    
    See Also:
    
    Constant Field Values
  - DESTINATION
```
public static final String DESTINATION
```
    Optional WKT ending point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the destination point. The default value is 'POINT NULL'.
    
    See Also:
    
    Constant Field Values
  - PARTIAL_LOADING
```
public static final String PARTIAL_LOADING
```
    For the match_supply_demand solver only. When false (non-default), trucks do not off-load at the demand (store) side if the remainder is less than the store's need Supported values:
    - TRUE: Partial off-loading at multiple store (demand) locations
    - FALSE: No partial off-loading allowed if supply is less than the store's demand.
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    Allows reusing trucks for scheduling again.
    
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    Trucks are scheduled only once from their depots.
    
    See Also:
    
    Constant Field Values
  - MAX_COMBINATIONS
```
public static final String MAX_COMBINATIONS
```
    For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the demand locations - can increase this up to 2M. The default value is '10000'.
    
    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
  - AGGREGATED_OUTPUT
```
public static final String AGGREGATED_OUTPUT
```
    For the match_supply_demand solver only. When it is true (default), each record in the output table shows a particular truck's scheduled cumulative round trip path (MULTILINESTRING) and the corresponding aggregated cost. Otherwise, each record shows a single scheduled truck route (LINESTRING) towards a particular demand location (store id) with its corresponding cost. The default value is 'true'.
    
    See Also:
    
    Constant Field Values
  - MAX_TRIP_COST
```
public static final String MAX_TRIP_COST
```
    For the match_supply_demand solver only. If this constraint is greater than zero (default) then the trucks will skip travelling from one demand location to another if the cost between them is greater than this number (distance or time). Zero (default) value means no check is performed. The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - FILTER_FOLDING_PATHS
```
public static final String FILTER_FOLDING_PATHS
```
    For the markov_chain solver only. When true (non-default), the paths per sequence combination is checked for folding over patterns and can significantly increase the execution time depending on the chain width and the number of gps samples. Supported values:
    - TRUE: Filter out the folded paths.
    - FALSE: Do not filter out the folded paths
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - UNIT_UNLOADING_COST
```
public static final String UNIT_UNLOADING_COST
```
    For the match_supply_demand solver only. The unit cost per load amount to be delivered. If this value is greater than zero (default) then the additional cost of this unit load multiplied by the total dropped load will be added over to the trip cost to the demand location. The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - MAX_NUM_THREADS
```
public static final String MAX_NUM_THREADS
```
    For the markov_chain solver only. If specified (greater than zero), the maximum number of threads will not be greater than the specified value. It can be lower due to the memory and the number cores available. Default value of zero allows the algorithm to set the maximal number of threads within these constraints. The default value is '0'.
    
    See Also:
    
    Constant Field Values
  - TRUCK_SERVICE_LIMIT
```
public static final String TRUCK_SERVICE_LIMIT
```
    For the match_supply_demand solver only. If specified (greather than zero), any truck's total service cost (distance or time) will be limited by the specified value including multiple rounds (if set). The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - ENABLE_TRUCK_REUSE
```
public static final String ENABLE_TRUCK_REUSE
```
    For the match_supply_demand solver only. If specified (true), all trucks can be scheduled for second rounds from their originating depots. Supported values:
    - TRUE: Allows reusing trucks for scheduling again.
    - FALSE: Trucks are scheduled only once from their depots.
    The default value is FALSE.
    See Also:
    
    Constant Field Values

Class MatchGraphRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GPS_NOISE

NUM_SEGMENTS

SEARCH_RADIUS

CHAIN_WIDTH

SOURCE

DESTINATION

PARTIAL_LOADING

TRUE

FALSE

MAX_COMBINATIONS

LEFT_TURN_PENALTY

RIGHT_TURN_PENALTY

INTERSECTION_PENALTY

SHARP_TURN_PENALTY

AGGREGATED_OUTPUT

MAX_TRIP_COST

FILTER_FOLDING_PATHS

UNIT_UNLOADING_COST

MAX_NUM_THREADS

TRUCK_SERVICE_LIMIT

ENABLE_TRUCK_REUSE