MatchGraphRequest.Options (Kinetica Java API 7.1.10.4 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'.
- MAX_SUPPLY_COMBINATIONS: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the supply locations if/when 'permute_supplies' is true. 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'.
- OUTPUT_TRACKS: For the match_supply_demand solver only. When it is true (non-default), the output will be in tracks format for all the round trips of each truck in which the timestamps are populated directly from the edge weights starting from their originating depots. The default value is 'false'.
- MAX_TRIP_COST: For the match_supply_demand and match_pickup_dropoff solvers only. If this constraint is greater than zero (default) then the trucks/rides will skip travelling from one demand/pick 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'.
- SERVICE_LIMIT: For the match_supply_demand solver only. If specified (greater than zero), any supply actor'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_REUSE: For the match_supply_demand solver only. If specified (true), all supply actors can be scheduled for second rounds from their originating depots. Supported values:
  - TRUE: Allows reusing supply actors (trucks, e.g.) for scheduling again.
  - FALSE: Supply actors are scheduled only once from their depots.
  The default value is FALSE.
- MAX_STOPS: For the match_supply_demand solver only. If specified (greater than zero), a supply actor (truck) can at most have this many stops (demand locations) in one round trip. Otherwise, it is unlimited. If 'enable_truck_reuse' is on, this condition will be applied separately at each round trip use of the same truck. The default value is '0'.
- SERVICE_RADIUS: For the match_supply_demand and match_pickup_dropoff solvers only. If specified (greater than zero), it filters the demands/picks outside this radius centered around the supply actor/ride's originating location (distance or time). The default value is '0.0'.
- PERMUTE_SUPPLIES: For the match_supply_demand solver only. If specified (true), supply side actors are permuted for the demand combinations during msdo optimization - note that this option increases optimization time significantly - use of 'max_combinations' option is recommended to prevent prohibitively long runs Supported values:
  - TRUE: Generates sequences over supply side permutations if total supply is less than twice the total demand
  - FALSE: Permutations are not performed, rather a specific order of supplies based on capacity is computed
  The default value is TRUE.
- BATCH_TSM_MODE: For the match_supply_demand solver only. When enabled, it sets the number of visits on each demand location by a single salesman at each trip is considered to be (one) 1, otherwise there is no bound. Supported values:
  - TRUE: Sets only one visit per demand location by a salesman (tsm mode)
  - FALSE: No preset limit (usual msdo mode)
  The default value is FALSE.
- ROUND_TRIP: For the match_supply_demand solver only. When enabled, the supply will have to return back to the origination location. Supported values:
  - TRUE: The optimization is done for trips in round trip manner always returning to originating locations
  - FALSE: Supplies do not have to come back to their originating locations in their routes. The routes are considered finished at the final dropoff.
  The default value is TRUE.
- NUM_CYCLES: For the match_clusters solver only. Terminates the cluster exchange iterations across 2-step-cycles (outer loop) when quality does not improve during iterations. The default value is '10'.
- NUM_LOOPS_PER_CYCLE: For the match_clusters solver only. Terminates the cluster exchanges within the first step iterations of a cycle (inner loop) unless convergence is reached. The default value is '10'.
- NUM_OUTPUT_CLUSTERS: For the match_clusters solver only. Limits the output to the top 'num_output_clusters' clusters based on density. Default value of zero outputs all clusters. The default value is '0'.
- MAX_NUM_CLUSTERS: For the match_clusters solver only. If set (value greater than zero), it terminates when the number of clusters goes below than this number. The default value is '0'.
- CLUSTER_QUALITY_METRIC: For the match_clusters solver only. The quality metric for Louvain modularity optimization solver. Supported values:
  - GIRVAN: Uses the Newman Girvan quality metric for cluster solver
  - SPECTRAL: Applies recursive spectral bisection (RSB) partitioning solver
  The default value is GIRVAN.
- RESTRICTED_TYPE: For the match_supply_demand solver only. Optimization is performed by restricting routes labeled by 'MSDO_ODDEVEN_RESTRICTED' only for this supply actor (truck) type Supported values:
  - ODD: Applies odd/even rule restrictions to odd tagged vehicles.
  - EVEN: Applies odd/even rule restrictions to even tagged vehicles.
  - NONE: Does not apply odd/even rule restrictions to any vehicles.
  The default value is NONE.
- 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. The default value is ''.
- INVERSE_SOLVE: For the match_batch_solves solver only. Solves source-destination pairs using inverse shortest path solver. Supported values:
  - TRUE: Solves using inverse shortest path solver.
  - FALSE: Solves using direct shortest path solver.
  The default value is FALSE.
- MIN_LOOP_LEVEL: For the match_loops solver only. Finds closed loops around each node deducible not less than this minimal hop (level) deep. The default value is '0'.
- MAX_LOOP_LEVEL: For the match_loops solver only. Finds closed loops around each node deducible not more than this maximal hop (level) deep. The default value is '5'.
- SEARCH_LIMIT: For the match_loops solver only. Searches within this limit of nodes per vertex to detect loops. The value zero means there is no limit. The default value is '10000'.
- OUTPUT_BATCH_SIZE: For the match_loops solver only. Uses this value as the batch size of the number of loops in flushing(inserting) to the output table. The default value is '1000'.
- CHARGING_CAPACITY: For the match_charging_stations solver only. This is the maximum ev-charging capacity of a vehicle (distance in meters or time in seconds depending on the unit of the graph weights). The default value is '300000.0'.
- CHARGING_CANDIDATES: For the match_charging_stations solver only. Solver searches for this many number of stations closest around each base charging location found by capacity. The default value is '10'.
- CHARGING_PENALTY: For the match_charging_stations solver only. This is the penalty for full charging. The default value is '30000.0'.
- MAX_HOPS: For the match_similarity solver only. Searches within this maximum hops for source and target node pairs to compute the Jaccard scores. The default value is '3'.
- TRAVERSAL_NODE_LIMIT: For the match_similarity solver only. Limits the traversal depth if it reaches this many number of nodes. The default value is '1000'.
- PAIRED_SIMILARITY: For the match_similarity solver only. If true, it computes Jaccard score between each pair, otherwise it will compute Jaccard from the intersection set between the source and target nodes Supported values:
  - TRUE
  - FALSE
  The default value is TRUE.
- FORCE_UNDIRECTED: For the match_pattern solver only. Pattern matching will be using both pattern and graph as undirected if set to true. Supported values:
  - TRUE
  - FALSE
  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`	`BATCH_TSM_MODE` For the `match_supply_demand` solver only.
`static String`	`CHAIN_WIDTH` For the `markov_chain` solver only.
`static String`	`CHARGING_CANDIDATES` For the `match_charging_stations` solver only.
`static String`	`CHARGING_CAPACITY` For the `match_charging_stations` solver only.
`static String`	`CHARGING_PENALTY` For the `match_charging_stations` solver only.
`static String`	`CLUSTER_QUALITY_METRIC` For the `match_clusters` solver only.
`static String`	`DESTINATION` Optional WKT ending point from `samplePoints` for the solver.
`static String`	`ENABLE_REUSE` For the `match_supply_demand` solver only.
`static String`	`EVEN` Applies odd/even rule restrictions to even tagged vehicles.
`static String`	`FALSE`
`static String`	`FILTER_FOLDING_PATHS` For the `markov_chain` solver only.
`static String`	`FORCE_UNDIRECTED` For the `match_pattern` solver only.
`static String`	`GIRVAN` Uses the Newman Girvan quality metric for cluster solver
`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`	`INVERSE_SOLVE` For the `match_batch_solves` solver only.
`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_HOPS` For the `match_similarity` solver only.
`static String`	`MAX_LOOP_LEVEL` For the `match_loops` solver only.
`static String`	`MAX_NUM_CLUSTERS` For the `match_clusters` solver only.
`static String`	`MAX_NUM_THREADS` For the `markov_chain` solver only.
`static String`	`MAX_STOPS` For the `match_supply_demand` solver only.
`static String`	`MAX_SUPPLY_COMBINATIONS` For the `match_supply_demand` solver only.
`static String`	`MAX_TRIP_COST` For the `match_supply_demand` and `match_pickup_dropoff` solvers only.
`static String`	`MIN_LOOP_LEVEL` For the `match_loops` solver only.
`static String`	`NONE` Does not apply odd/even rule restrictions to any vehicles.
`static String`	`NUM_CYCLES` For the `match_clusters` solver only.
`static String`	`NUM_LOOPS_PER_CYCLE` For the `match_clusters` solver only.
`static String`	`NUM_OUTPUT_CLUSTERS` For the `match_clusters` solver only.
`static String`	`NUM_SEGMENTS` Maximum number of potentially matching road segments for each sample point.
`static String`	`ODD` Applies odd/even rule restrictions to odd tagged vehicles.
`static String`	`OUTPUT_BATCH_SIZE` For the `match_loops` solver only.
`static String`	`OUTPUT_TRACKS` For the `match_supply_demand` solver only.
`static String`	`PAIRED_SIMILARITY` For the `match_similarity` solver only.
`static String`	`PARTIAL_LOADING` For the `match_supply_demand` solver only.
`static String`	`PERMUTE_SUPPLIES` For the `match_supply_demand` solver only.
`static String`	`RESTRICTED_TYPE` 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`	`ROUND_TRIP` For the `match_supply_demand` solver only.
`static String`	`SEARCH_LIMIT` For the `match_loops` solver only.
`static String`	`SEARCH_RADIUS` Maximum search radius used when snapping sample points onto potentially matching surrounding segments.
`static String`	`SERVER_ID` Indicates which graph server(s) to send the request to.
`static String`	`SERVICE_LIMIT` For the `match_supply_demand` solver only.
`static String`	`SERVICE_RADIUS` For the `match_supply_demand` and `match_pickup_dropoff` solvers only.
`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`	`SPECTRAL` Applies recursive spectral bisection (RSB) partitioning solver
`static String`	`TRAVERSAL_NODE_LIMIT` For the `match_similarity` solver only.
`static String`	`TRUE`
`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
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    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
  - MAX_SUPPLY_COMBINATIONS
```
public static final String MAX_SUPPLY_COMBINATIONS
```
    For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the supply locations if/when 'permute_supplies' is true. 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
  - OUTPUT_TRACKS
```
public static final String OUTPUT_TRACKS
```
    For the match_supply_demand solver only. When it is true (non-default), the output will be in tracks format for all the round trips of each truck in which the timestamps are populated directly from the edge weights starting from their originating depots. The default value is 'false'.
    
    See Also:
    
    Constant Field Values
  - MAX_TRIP_COST
```
public static final String MAX_TRIP_COST
```
    For the match_supply_demand and match_pickup_dropoff solvers only. If this constraint is greater than zero (default) then the trucks/rides will skip travelling from one demand/pick 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
  - SERVICE_LIMIT
```
public static final String SERVICE_LIMIT
```
    For the match_supply_demand solver only. If specified (greater than zero), any supply actor'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_REUSE
```
public static final String ENABLE_REUSE
```
    For the match_supply_demand solver only. If specified (true), all supply actors can be scheduled for second rounds from their originating depots. Supported values:
    - TRUE: Allows reusing supply actors (trucks, e.g.) for scheduling again.
    - FALSE: Supply actors are scheduled only once from their depots.
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - MAX_STOPS
```
public static final String MAX_STOPS
```
    For the match_supply_demand solver only. If specified (greater than zero), a supply actor (truck) can at most have this many stops (demand locations) in one round trip. Otherwise, it is unlimited. If 'enable_truck_reuse' is on, this condition will be applied separately at each round trip use of the same truck. The default value is '0'.
    
    See Also:
    
    Constant Field Values
  - SERVICE_RADIUS
```
public static final String SERVICE_RADIUS
```
    For the match_supply_demand and match_pickup_dropoff solvers only. If specified (greater than zero), it filters the demands/picks outside this radius centered around the supply actor/ride's originating location (distance or time). The default value is '0.0'.
    
    See Also:
    
    Constant Field Values
  - PERMUTE_SUPPLIES
```
public static final String PERMUTE_SUPPLIES
```
    For the match_supply_demand solver only. If specified (true), supply side actors are permuted for the demand combinations during msdo optimization - note that this option increases optimization time significantly - use of 'max_combinations' option is recommended to prevent prohibitively long runs Supported values:
    - TRUE: Generates sequences over supply side permutations if total supply is less than twice the total demand
    - FALSE: Permutations are not performed, rather a specific order of supplies based on capacity is computed
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - BATCH_TSM_MODE
```
public static final String BATCH_TSM_MODE
```
    For the match_supply_demand solver only. When enabled, it sets the number of visits on each demand location by a single salesman at each trip is considered to be (one) 1, otherwise there is no bound. Supported values:
    - TRUE: Sets only one visit per demand location by a salesman (tsm mode)
    - FALSE: No preset limit (usual msdo mode)
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - ROUND_TRIP
```
public static final String ROUND_TRIP
```
    For the match_supply_demand solver only. When enabled, the supply will have to return back to the origination location. Supported values:
    - TRUE: The optimization is done for trips in round trip manner always returning to originating locations
    - FALSE: Supplies do not have to come back to their originating locations in their routes. The routes are considered finished at the final dropoff.
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - NUM_CYCLES
```
public static final String NUM_CYCLES
```
    For the match_clusters solver only. Terminates the cluster exchange iterations across 2-step-cycles (outer loop) when quality does not improve during iterations. The default value is '10'.
    
    See Also:
    
    Constant Field Values
  - NUM_LOOPS_PER_CYCLE
```
public static final String NUM_LOOPS_PER_CYCLE
```
    For the match_clusters solver only. Terminates the cluster exchanges within the first step iterations of a cycle (inner loop) unless convergence is reached. The default value is '10'.
    
    See Also:
    
    Constant Field Values
  - NUM_OUTPUT_CLUSTERS
```
public static final String NUM_OUTPUT_CLUSTERS
```
    For the match_clusters solver only. Limits the output to the top 'num_output_clusters' clusters based on density. Default value of zero outputs all clusters. The default value is '0'.
    
    See Also:
    
    Constant Field Values
  - MAX_NUM_CLUSTERS
```
public static final String MAX_NUM_CLUSTERS
```
    For the match_clusters solver only. If set (value greater than zero), it terminates when the number of clusters goes below than this number. The default value is '0'.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_QUALITY_METRIC
```
public static final String CLUSTER_QUALITY_METRIC
```
    For the match_clusters solver only. The quality metric for Louvain modularity optimization solver. Supported values:
    - GIRVAN: Uses the Newman Girvan quality metric for cluster solver
    - SPECTRAL: Applies recursive spectral bisection (RSB) partitioning solver
    The default value is GIRVAN.
    See Also:
    
    Constant Field Values
  - GIRVAN
```
public static final String GIRVAN
```
    Uses the Newman Girvan quality metric for cluster solver
    
    See Also:
    
    Constant Field Values
  - SPECTRAL
```
public static final String SPECTRAL
```
    Applies recursive spectral bisection (RSB) partitioning solver
    
    See Also:
    
    Constant Field Values
  - RESTRICTED_TYPE
```
public static final String RESTRICTED_TYPE
```
    For the match_supply_demand solver only. Optimization is performed by restricting routes labeled by 'MSDO_ODDEVEN_RESTRICTED' only for this supply actor (truck) type Supported values:
    - ODD: Applies odd/even rule restrictions to odd tagged vehicles.
    - EVEN: Applies odd/even rule restrictions to even tagged vehicles.
    - NONE: Does not apply odd/even rule restrictions to any vehicles.
    The default value is NONE.
    See Also:
    
    Constant Field Values
  - ODD
```
public static final String ODD
```
    Applies odd/even rule restrictions to odd tagged vehicles.
    
    See Also:
    
    Constant Field Values
  - EVEN
```
public static final String EVEN
```
    Applies odd/even rule restrictions to even tagged vehicles.
    
    See Also:
    
    Constant Field Values
  - NONE
```
public static final String NONE
```
    Does not apply odd/even rule restrictions to any vehicles.
    
    See Also:
    
    Constant Field Values
  - SERVER_ID
```
public static final String 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. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - INVERSE_SOLVE
```
public static final String INVERSE_SOLVE
```
    For the match_batch_solves solver only. Solves source-destination pairs using inverse shortest path solver. Supported values:
    - TRUE: Solves using inverse shortest path solver.
    - FALSE: Solves using direct shortest path solver.
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - MIN_LOOP_LEVEL
```
public static final String MIN_LOOP_LEVEL
```
    For the match_loops solver only. Finds closed loops around each node deducible not less than this minimal hop (level) deep. The default value is '0'.
    
    See Also:
    
    Constant Field Values
  - MAX_LOOP_LEVEL
```
public static final String MAX_LOOP_LEVEL
```
    For the match_loops solver only. Finds closed loops around each node deducible not more than this maximal hop (level) deep. The default value is '5'.
    
    See Also:
    
    Constant Field Values
  - SEARCH_LIMIT
```
public static final String SEARCH_LIMIT
```
    For the match_loops solver only. Searches within this limit of nodes per vertex to detect loops. The value zero means there is no limit. The default value is '10000'.
    
    See Also:
    
    Constant Field Values
  - OUTPUT_BATCH_SIZE
```
public static final String OUTPUT_BATCH_SIZE
```
    For the match_loops solver only. Uses this value as the batch size of the number of loops in flushing(inserting) to the output table. The default value is '1000'.
    
    See Also:
    
    Constant Field Values
  - CHARGING_CAPACITY
```
public static final String CHARGING_CAPACITY
```
    For the match_charging_stations solver only. This is the maximum ev-charging capacity of a vehicle (distance in meters or time in seconds depending on the unit of the graph weights). The default value is '300000.0'.
    
    See Also:
    
    Constant Field Values
  - CHARGING_CANDIDATES
```
public static final String CHARGING_CANDIDATES
```
    For the match_charging_stations solver only. Solver searches for this many number of stations closest around each base charging location found by capacity. The default value is '10'.
    
    See Also:
    
    Constant Field Values
  - CHARGING_PENALTY
```
public static final String CHARGING_PENALTY
```
    For the match_charging_stations solver only. This is the penalty for full charging. The default value is '30000.0'.
    
    See Also:
    
    Constant Field Values
  - MAX_HOPS
```
public static final String MAX_HOPS
```
    For the match_similarity solver only. Searches within this maximum hops for source and target node pairs to compute the Jaccard scores. The default value is '3'.
    
    See Also:
    
    Constant Field Values
  - TRAVERSAL_NODE_LIMIT
```
public static final String TRAVERSAL_NODE_LIMIT
```
    For the match_similarity solver only. Limits the traversal depth if it reaches this many number of nodes. The default value is '1000'.
    
    See Also:
    
    Constant Field Values
  - PAIRED_SIMILARITY
```
public static final String PAIRED_SIMILARITY
```
    For the match_similarity solver only. If true, it computes Jaccard score between each pair, otherwise it will compute Jaccard from the intersection set between the source and target nodes Supported values:
    - TRUE
    - FALSE
    The default value is TRUE.
    See Also:
    
    Constant Field Values
  - FORCE_UNDIRECTED
```
public static final String FORCE_UNDIRECTED
```
    For the match_pattern solver only. Pattern matching will be using both pattern and graph as undirected if set to true. Supported values:
    - TRUE
    - FALSE
    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

MAX_SUPPLY_COMBINATIONS

LEFT_TURN_PENALTY

RIGHT_TURN_PENALTY

INTERSECTION_PENALTY

SHARP_TURN_PENALTY

AGGREGATED_OUTPUT

OUTPUT_TRACKS

MAX_TRIP_COST

FILTER_FOLDING_PATHS

UNIT_UNLOADING_COST

MAX_NUM_THREADS

SERVICE_LIMIT

ENABLE_REUSE

MAX_STOPS

SERVICE_RADIUS

PERMUTE_SUPPLIES

BATCH_TSM_MODE

ROUND_TRIP

NUM_CYCLES

NUM_LOOPS_PER_CYCLE

NUM_OUTPUT_CLUSTERS

MAX_NUM_CLUSTERS

CLUSTER_QUALITY_METRIC

GIRVAN

SPECTRAL

RESTRICTED_TYPE

ODD

EVEN

NONE

SERVER_ID

INVERSE_SOLVE

MIN_LOOP_LEVEL

MAX_LOOP_LEVEL

SEARCH_LIMIT

OUTPUT_BATCH_SIZE

CHARGING_CAPACITY

CHARGING_CANDIDATES

CHARGING_PENALTY

MAX_HOPS

TRAVERSAL_NODE_LIMIT

PAIRED_SIMILARITY

FORCE_UNDIRECTED