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

Public Attributes
const string	GPS_NOISE = "gps_noise"
	GPS noise value (in meters) to remove redundant sample points. More...

const string	NUM_SEGMENTS = "num_segments"
	Maximum number of potentially matching road segments for each sample point. More...

const string	SEARCH_RADIUS = "search_radius"
	Maximum search radius used when snapping sample points onto potentially matching surrounding segments. More...

const string	CHAIN_WIDTH = "chain_width"
	For the MARKOV_CHAIN solver only. More...

const string	SOURCE = "source"
	WKT starting point from sample_points for the solver. More...

const string	DESTINATION = "destination"
	WKT ending point from sample_points for the solver. More...

const string	PARTIAL_LOADING = "partial_loading"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	MAX_COMBINATIONS = "max_combinations"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	MAX_SUPPLY_COMBINATIONS = "max_supply_combinations"
	For the MATCH_SUPPLY_DEMAND solver only. 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	AGGREGATED_OUTPUT = "aggregated_output"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	OUTPUT_TRACKS = "output_tracks"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	MAX_TRIP_COST = "max_trip_cost"
	For the MATCH_SUPPLY_DEMAND and MATCH_PICKUP_DROPOFF solvers only. More...

const string	FILTER_FOLDING_PATHS = "filter_folding_paths"
	For the MARKOV_CHAIN solver only. More...

const string	UNIT_UNLOADING_COST = "unit_unloading_cost"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	MAX_NUM_THREADS = "max_num_threads"
	For the MARKOV_CHAIN solver only. More...

const string	SERVICE_LIMIT = "service_limit"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	ENABLE_REUSE = "enable_reuse"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	MAX_STOPS = "max_stops"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	SERVICE_RADIUS = "service_radius"
	For the MATCH_SUPPLY_DEMAND and MATCH_PICKUP_DROPOFF solvers only. More...

const string	PERMUTE_SUPPLIES = "permute_supplies"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	BATCH_TSM_MODE = "batch_tsm_mode"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	ROUND_TRIP = "round_trip"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	NUM_CYCLES = "num_cycles"
	For the MATCH_CLUSTERS solver only. More...

const string	NUM_LOOPS_PER_CYCLE = "num_loops_per_cycle"
	For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only. More...

const string	NUM_OUTPUT_CLUSTERS = "num_output_clusters"
	For the MATCH_CLUSTERS solver only. More...

const string	MAX_NUM_CLUSTERS = "max_num_clusters"
	For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only. More...

const string	CLUSTER_QUALITY_METRIC = "cluster_quality_metric"
	For the MATCH_CLUSTERS solver only. More...

const string	GIRVAN = "girvan"
	Uses the Newman Girvan quality metric for cluster solver. More...

const string	SPECTRAL = "spectral"
	Applies recursive spectral bisection (RSB) partitioning solver. More...

const string	RESTRICTED_TYPE = "restricted_type"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	ODD = "odd"
	Applies odd/even rule restrictions to odd tagged vehicles. More...

const string	EVEN = "even"
	Applies odd/even rule restrictions to even tagged vehicles. More...

const string	NONE = "none"
	Does not apply odd/even rule restrictions to any vehicles. More...

const string	SERVER_ID = "server_id"
	Indicates which graph server(s) to send the request to. More...

const string	INVERSE_SOLVE = "inverse_solve"
	For the MATCH_BATCH_SOLVES solver only. More...

const string	MIN_LOOP_LEVEL = "min_loop_level"
	For the MATCH_LOOPS solver only. More...

const string	MAX_LOOP_LEVEL = "max_loop_level"
	For the MATCH_LOOPS solver only. More...

const string	SEARCH_LIMIT = "search_limit"
	For the MATCH_LOOPS solver only. More...

const string	OUTPUT_BATCH_SIZE = "output_batch_size"
	For the MATCH_LOOPS solver only. More...

const string	MULTI_STEP = "multi_step"
	For the MATCH_SUPPLY_DEMAND solver only. More...

const string	CHARGING_CAPACITY = "charging_capacity"
	For the MATCH_CHARGING_STATIONS solver only. More...

const string	CHARGING_CANDIDATES = "charging_candidates"
	For the MATCH_CHARGING_STATIONS solver only. More...

const string	CHARGING_PENALTY = "charging_penalty"
	For the MATCH_CHARGING_STATIONS solver only. More...

const string	DETOUR_MARK_COST = "detour_mark_cost"
	For the MATCH_ROUTE_DETOUR solver only. More...

const string	DETOUR_REENTRY_FACTOR = "detour_reentry_factor"
	For the MATCH_ROUTE_DETOUR solver only. More...

const string	DETOUR_SEARCH_RADIUS = "detour_search_radius"
	For the MATCH_ROUTE_DETOUR solver only. More...

const string	DETOUR_SEARCH_LIMIT = "detour_search_limit"
	For the MATCH_ROUTE_DETOUR solver only. More...

const string	MAX_HOPS = "max_hops"
	For the MATCH_SIMILARITY and MATCH_EMBEDDING solvers only. More...

const string	TRAVERSAL_NODE_LIMIT = "traversal_node_limit"
	For the MATCH_SIMILARITY solver only. More...

const string	PAIRED_SIMILARITY = "paired_similarity"
	For the MATCH_SIMILARITY solver only. More...

const string	FORCE_UNDIRECTED = "force_undirected"
	For the MATCH_PATTERN and MATCH_EMBEDDING solvers only. More...

const string	MAX_VECTOR_DIMENSION = "max_vector_dimension"
	For the MATCH_EMBEDDING solver only. More...

const string	OPTIMIZE_EMBEDDING_WEIGHTS = "optimize_embedding_weights"
	For the MATCH_EMBEDDING solvers only. More...

const string	EMBEDDING_WEIGHTS = "embedding_weights"
	For the MATCH_EMBEDDING solver only. More...

const string	OPTIMIZATION_SAMPLING_SIZE = "optimization_sampling_size"
	For the MATCH_EMBEDDING solver only. More...

const string	OPTIMIZATION_MAX_ITERATIONS = "optimization_max_iterations"
	For the MATCH_EMBEDDING solver only. More...

const string	OPTIMIZATION_ERROR_TOLERANCE = "optimization_error_tolerance"
	For the MATCH_EMBEDDING solver only. More...

const string	OPTIMIZATION_ITERATION_RATE = "optimization_iteration_rate"
	For the MATCH_EMBEDDING solver only. More...

const string	MAX_RADIUS = "max_radius"
	For the MATCH_ISOCHRONE solver only. More...

Detailed Description

A set of string constants for the parameter options.

Additional parameters.

Definition at line 105 of file MatchGraph.cs.

Member Data Documentation

◆ AGGREGATED_OUTPUT

const string MatchGraphRequest.Options.AGGREGATED_OUTPUT = "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'.

Definition at line 228 of file MatchGraph.cs.

◆ BATCH_TSM_MODE

const string MatchGraphRequest.Options.BATCH_TSM_MODE = "batch_tsm_mode"

For the MATCH_SUPPLY_DEMAND solver only.

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.

Definition at line 382 of file MatchGraph.cs.

◆ CHAIN_WIDTH

const string MatchGraphRequest.Options.CHAIN_WIDTH = "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'.

Definition at line 133 of file MatchGraph.cs.

◆ CHARGING_CANDIDATES

const string MatchGraphRequest.Options.CHARGING_CANDIDATES = "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'.

Definition at line 595 of file MatchGraph.cs.

◆ CHARGING_CAPACITY

const string MatchGraphRequest.Options.CHARGING_CAPACITY = "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'.

Definition at line 587 of file MatchGraph.cs.

◆ CHARGING_PENALTY

const string MatchGraphRequest.Options.CHARGING_PENALTY = "charging_penalty"

For the MATCH_CHARGING_STATIONS solver only.

This is the penalty for full charging. The default value is '30000.0'.

Definition at line 602 of file MatchGraph.cs.

◆ CLUSTER_QUALITY_METRIC

const string MatchGraphRequest.Options.CLUSTER_QUALITY_METRIC = "cluster_quality_metric"

For the MATCH_CLUSTERS solver only.

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.

Definition at line 458 of file MatchGraph.cs.

◆ DESTINATION

const string MatchGraphRequest.Options.DESTINATION = "destination"

WKT ending point from sample_points for the solver.

The default behavior for the endpoint is to use time to determine the destination point. The default value is 'POINT NULL'.

Definition at line 147 of file MatchGraph.cs.

◆ DETOUR_MARK_COST

const string MatchGraphRequest.Options.DETOUR_MARK_COST = "detour_mark_cost"

For the MATCH_ROUTE_DETOUR solver only.

Cost along the route at which to search for nearby stations If zero, it solves along the trip sliding the 3 SSSP cycle kernel by radius amount. The default value is '3600.0'.

Definition at line 611 of file MatchGraph.cs.

◆ DETOUR_REENTRY_FACTOR

const string MatchGraphRequest.Options.DETOUR_REENTRY_FACTOR = "detour_reentry_factor"

For the MATCH_ROUTE_DETOUR solver only.

Multiplier on detour_mark_cost to determine the reentry point on the route (default 1.2 means 20% further along). The default value is '1.2'.

Definition at line 619 of file MatchGraph.cs.

◆ DETOUR_SEARCH_LIMIT

const string MatchGraphRequest.Options.DETOUR_SEARCH_LIMIT = "detour_search_limit"

For the MATCH_ROUTE_DETOUR solver only.

Maximum number of nearby stations to consider within the search radius around the mark point. The default value is '10'.

Definition at line 635 of file MatchGraph.cs.

◆ DETOUR_SEARCH_RADIUS

const string MatchGraphRequest.Options.DETOUR_SEARCH_RADIUS = "detour_search_radius"

For the MATCH_ROUTE_DETOUR solver only.

Search radius around the mark point for finding nearby prospective stations (e.g. cafes, pit stops, EV charging stations). The default value is '600.0'.

Definition at line 627 of file MatchGraph.cs.

◆ EMBEDDING_WEIGHTS

const string MatchGraphRequest.Options.EMBEDDING_WEIGHTS = "embedding_weights"

For the MATCH_EMBEDDING solver only.

User specified weights per sub feature in vector embeddings. The string contains the comma separated float values for each sub-feature in the vector space. These values will ONLY be used if 'optimize_embedding_weights' is false. The default value is '1.0,1.0,1.0,1.0'.

Definition at line 717 of file MatchGraph.cs.

◆ ENABLE_REUSE

const string MatchGraphRequest.Options.ENABLE_REUSE = "enable_reuse"

For the MATCH_SUPPLY_DEMAND solver only.

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.

Definition at line 319 of file MatchGraph.cs.

◆ EVEN

const string MatchGraphRequest.Options.EVEN = "even"

Applies odd/even rule restrictions to even tagged vehicles.

Definition at line 499 of file MatchGraph.cs.

◆ FALSE

const string MatchGraphRequest.Options.FALSE = "false"

Definition at line 170 of file MatchGraph.cs.

◆ FILTER_FOLDING_PATHS

const string MatchGraphRequest.Options.FILTER_FOLDING_PATHS = "filter_folding_paths"

For the MARKOV_CHAIN solver only.

Supported values:

TRUE: Filter out the folded paths.
FALSE: Do not filter out the folded paths.

The default value is FALSE.

Definition at line 269 of file MatchGraph.cs.

◆ FORCE_UNDIRECTED

const string MatchGraphRequest.Options.FORCE_UNDIRECTED = "force_undirected"

For the MATCH_PATTERN and MATCH_EMBEDDING solvers only.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 684 of file MatchGraph.cs.

◆ GIRVAN

const string MatchGraphRequest.Options.GIRVAN = "girvan"

Uses the Newman Girvan quality metric for cluster solver.

Definition at line 462 of file MatchGraph.cs.

◆ GPS_NOISE

const string MatchGraphRequest.Options.GPS_NOISE = "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'.

Definition at line 112 of file MatchGraph.cs.

◆ INTERSECTION_PENALTY

const string MatchGraphRequest.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 208 of file MatchGraph.cs.

◆ INVERSE_SOLVE

const string MatchGraphRequest.Options.INVERSE_SOLVE = "inverse_solve"

For the MATCH_BATCH_SOLVES solver only.

Supported values:

TRUE: Solves using inverse shortest path solver.
FALSE: Solves using direct shortest path solver.

The default value is FALSE.

Definition at line 530 of file MatchGraph.cs.

◆ LEFT_TURN_PENALTY

const string MatchGraphRequest.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 194 of file MatchGraph.cs.

◆ MAX_COMBINATIONS

const string MatchGraphRequest.Options.MAX_COMBINATIONS = "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'.

Definition at line 178 of file MatchGraph.cs.

◆ MAX_HOPS

const string MatchGraphRequest.Options.MAX_HOPS = "max_hops"

For the MATCH_SIMILARITY and MATCH_EMBEDDING solvers only.

Searches within this maximum hops for source and target node pairs to compute the Jaccard scores. The default value is '3'.

Definition at line 644 of file MatchGraph.cs.

◆ MAX_LOOP_LEVEL

const string MatchGraphRequest.Options.MAX_LOOP_LEVEL = "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'.

Definition at line 546 of file MatchGraph.cs.

◆ MAX_NUM_CLUSTERS

const string MatchGraphRequest.Options.MAX_NUM_CLUSTERS = "max_num_clusters"

For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only.

If set (value greater than zero), it terminates when the number of clusters goes below than this number. For embedding solver the default is 8. The default value is '0'.

Definition at line 438 of file MatchGraph.cs.

◆ MAX_NUM_THREADS

const string MatchGraphRequest.Options.MAX_NUM_THREADS = "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'.

Definition at line 290 of file MatchGraph.cs.

◆ MAX_RADIUS

const string MatchGraphRequest.Options.MAX_RADIUS = "max_radius"

For the MATCH_ISOCHRONE solver only.

Sets the maximal reachability limit for computing isochrones. Zero means no limit. The default value is '0.0'.

Definition at line 761 of file MatchGraph.cs.

◆ MAX_STOPS

const string MatchGraphRequest.Options.MAX_STOPS = "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'.

Definition at line 329 of file MatchGraph.cs.

◆ MAX_SUPPLY_COMBINATIONS

const string MatchGraphRequest.Options.MAX_SUPPLY_COMBINATIONS = "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'.

Definition at line 187 of file MatchGraph.cs.

◆ MAX_TRIP_COST

const string MatchGraphRequest.Options.MAX_TRIP_COST = "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 traveling 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'.

Definition at line 250 of file MatchGraph.cs.

◆ MAX_VECTOR_DIMENSION

const string MatchGraphRequest.Options.MAX_VECTOR_DIMENSION = "max_vector_dimension"

For the MATCH_EMBEDDING solver only.

Limits the number of dimensions in node vector embeddings. The default value is '1000'.

Definition at line 691 of file MatchGraph.cs.

◆ MIN_LOOP_LEVEL

const string MatchGraphRequest.Options.MIN_LOOP_LEVEL = "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'.

Definition at line 538 of file MatchGraph.cs.

◆ MULTI_STEP

const string MatchGraphRequest.Options.MULTI_STEP = "multi_step"

For the MATCH_SUPPLY_DEMAND solver only.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 578 of file MatchGraph.cs.

◆ NONE

const string MatchGraphRequest.Options.NONE = "none"

Does not apply odd/even rule restrictions to any vehicles.

Definition at line 503 of file MatchGraph.cs.

◆ NUM_CYCLES

const string MatchGraphRequest.Options.NUM_CYCLES = "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'.

Definition at line 412 of file MatchGraph.cs.

◆ NUM_LOOPS_PER_CYCLE

const string MatchGraphRequest.Options.NUM_LOOPS_PER_CYCLE = "num_loops_per_cycle"

For the MATCH_CLUSTERS and MATCH_EMBEDDING solvers only.

Terminates the cluster exchanges within the first step iterations of a cycle (inner loop) unless convergence is reached. The default value is '10'.

Definition at line 421 of file MatchGraph.cs.

◆ NUM_OUTPUT_CLUSTERS

const string MatchGraphRequest.Options.NUM_OUTPUT_CLUSTERS = "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'.

Definition at line 429 of file MatchGraph.cs.

◆ NUM_SEGMENTS

const string MatchGraphRequest.Options.NUM_SEGMENTS = "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'.

Definition at line 119 of file MatchGraph.cs.

◆ ODD

const string MatchGraphRequest.Options.ODD = "odd"

Applies odd/even rule restrictions to odd tagged vehicles.

Definition at line 495 of file MatchGraph.cs.

◆ OPTIMIZATION_ERROR_TOLERANCE

const string MatchGraphRequest.Options.OPTIMIZATION_ERROR_TOLERANCE = "optimization_error_tolerance"

For the MATCH_EMBEDDING solver only.

When the relative error between all of the weights' consecutive iterations falls below this threshold the optimization cycle is interrupted unless the number of iterations reaches the limit set by the option 'max_optimization_iterations'. The default value is '0.001'.

Definition at line 745 of file MatchGraph.cs.

◆ OPTIMIZATION_ITERATION_RATE

const string MatchGraphRequest.Options.OPTIMIZATION_ITERATION_RATE = "optimization_iteration_rate"

For the MATCH_EMBEDDING solver only.

It is otherwise known as the learning rate, which is the proportionality constant in front of the gradient term in successive iterations. The default value is '0.3'.

Definition at line 753 of file MatchGraph.cs.

◆ OPTIMIZATION_MAX_ITERATIONS

const string MatchGraphRequest.Options.OPTIMIZATION_MAX_ITERATIONS = "optimization_max_iterations"

For the MATCH_EMBEDDING solver only.

When the iterations (epochs) for the convergence of the stochastic gradient descent algorithm reaches this number it bails out unless relative error between consecutive iterations is below the 'optimization_error_tolerance' option. The default value is '1000'.

Definition at line 735 of file MatchGraph.cs.

◆ OPTIMIZATION_SAMPLING_SIZE

const string MatchGraphRequest.Options.OPTIMIZATION_SAMPLING_SIZE = "optimization_sampling_size"

For the MATCH_EMBEDDING solver only.

Sets the number of random nodes from the graph for solving the weights using stochastic gradient descent. The default value is '1000'.

Definition at line 725 of file MatchGraph.cs.

◆ OPTIMIZE_EMBEDDING_WEIGHTS

const string MatchGraphRequest.Options.OPTIMIZE_EMBEDDING_WEIGHTS = "optimize_embedding_weights"

For the MATCH_EMBEDDING solvers only.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 707 of file MatchGraph.cs.

◆ OUTPUT_BATCH_SIZE

const string MatchGraphRequest.Options.OUTPUT_BATCH_SIZE = "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'.

Definition at line 562 of file MatchGraph.cs.

◆ OUTPUT_TRACKS

const string MatchGraphRequest.Options.OUTPUT_TRACKS = "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'.

Definition at line 238 of file MatchGraph.cs.

◆ PAIRED_SIMILARITY

const string MatchGraphRequest.Options.PAIRED_SIMILARITY = "paired_similarity"

For the MATCH_SIMILARITY solver only.

Supported values:

TRUE
FALSE

The default value is TRUE.

Definition at line 667 of file MatchGraph.cs.

◆ PARTIAL_LOADING

const string MatchGraphRequest.Options.PARTIAL_LOADING = "partial_loading"

For the MATCH_SUPPLY_DEMAND solver only.

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.

Definition at line 167 of file MatchGraph.cs.

◆ PERMUTE_SUPPLIES

const string MatchGraphRequest.Options.PERMUTE_SUPPLIES = "permute_supplies"

For the MATCH_SUPPLY_DEMAND solver only.

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.

Definition at line 362 of file MatchGraph.cs.

◆ RESTRICTED_TYPE

const string MatchGraphRequest.Options.RESTRICTED_TYPE = "restricted_type"

For the MATCH_SUPPLY_DEMAND solver only.

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.

Definition at line 491 of file MatchGraph.cs.

◆ RIGHT_TURN_PENALTY

const string MatchGraphRequest.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 201 of file MatchGraph.cs.

◆ ROUND_TRIP

const string MatchGraphRequest.Options.ROUND_TRIP = "round_trip"

For the MATCH_SUPPLY_DEMAND solver only.

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.

Definition at line 404 of file MatchGraph.cs.

◆ SEARCH_LIMIT

const string MatchGraphRequest.Options.SEARCH_LIMIT = "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'.

Definition at line 554 of file MatchGraph.cs.

◆ SEARCH_RADIUS

const string MatchGraphRequest.Options.SEARCH_RADIUS = "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'.

Definition at line 125 of file MatchGraph.cs.

◆ SERVER_ID

const string MatchGraphRequest.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. The default value is ''.

Definition at line 510 of file MatchGraph.cs.

◆ SERVICE_LIMIT

const string MatchGraphRequest.Options.SERVICE_LIMIT = "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'.

Definition at line 299 of file MatchGraph.cs.

◆ SERVICE_RADIUS

const string MatchGraphRequest.Options.SERVICE_RADIUS = "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'.

Definition at line 340 of file MatchGraph.cs.

◆ SHARP_TURN_PENALTY

const string MatchGraphRequest.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 216 of file MatchGraph.cs.

◆ SOURCE

const string MatchGraphRequest.Options.SOURCE = "source"

WKT starting point from sample_points for the solver.

The default behavior for the endpoint is to use time to determine the starting point. The default value is 'POINT NULL'.

Definition at line 140 of file MatchGraph.cs.

◆ SPECTRAL

const string MatchGraphRequest.Options.SPECTRAL = "spectral"

Applies recursive spectral bisection (RSB) partitioning solver.

Definition at line 466 of file MatchGraph.cs.

◆ TRAVERSAL_NODE_LIMIT

const string MatchGraphRequest.Options.TRAVERSAL_NODE_LIMIT = "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'.

Definition at line 651 of file MatchGraph.cs.

◆ TRUE

const string MatchGraphRequest.Options.TRUE = "true"

Definition at line 169 of file MatchGraph.cs.

◆ UNIT_UNLOADING_COST

const string MatchGraphRequest.Options.UNIT_UNLOADING_COST = "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'.

Definition at line 279 of file MatchGraph.cs.

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

Kinetica/Protocol/MatchGraph.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ AGGREGATED_OUTPUT

◆ BATCH_TSM_MODE

◆ CHAIN_WIDTH

◆ CHARGING_CANDIDATES

◆ CHARGING_CAPACITY

◆ CHARGING_PENALTY

◆ CLUSTER_QUALITY_METRIC

◆ DESTINATION

◆ DETOUR_MARK_COST

◆ DETOUR_REENTRY_FACTOR

◆ DETOUR_SEARCH_LIMIT

◆ DETOUR_SEARCH_RADIUS

◆ EMBEDDING_WEIGHTS

◆ ENABLE_REUSE

◆ EVEN

◆ FALSE

◆ FILTER_FOLDING_PATHS

◆ FORCE_UNDIRECTED

◆ GIRVAN

◆ GPS_NOISE

◆ INTERSECTION_PENALTY

◆ INVERSE_SOLVE

◆ LEFT_TURN_PENALTY

◆ MAX_COMBINATIONS

◆ MAX_HOPS

◆ MAX_LOOP_LEVEL

◆ MAX_NUM_CLUSTERS

◆ MAX_NUM_THREADS

◆ MAX_RADIUS

◆ MAX_STOPS

◆ MAX_SUPPLY_COMBINATIONS

◆ MAX_TRIP_COST

◆ MAX_VECTOR_DIMENSION

◆ MIN_LOOP_LEVEL

◆ MULTI_STEP

◆ NONE

◆ NUM_CYCLES

◆ NUM_LOOPS_PER_CYCLE

◆ NUM_OUTPUT_CLUSTERS

◆ NUM_SEGMENTS

◆ ODD

◆ OPTIMIZATION_ERROR_TOLERANCE

◆ OPTIMIZATION_ITERATION_RATE

◆ OPTIMIZATION_MAX_ITERATIONS

◆ OPTIMIZATION_SAMPLING_SIZE

◆ OPTIMIZE_EMBEDDING_WEIGHTS

◆ OUTPUT_BATCH_SIZE

◆ OUTPUT_TRACKS

◆ PAIRED_SIMILARITY

◆ PARTIAL_LOADING

◆ PERMUTE_SUPPLIES

◆ RESTRICTED_TYPE

◆ RIGHT_TURN_PENALTY

◆ ROUND_TRIP

◆ SEARCH_LIMIT

◆ SEARCH_RADIUS

◆ SERVER_ID

◆ SERVICE_LIMIT

◆ SERVICE_RADIUS

◆ SHARP_TURN_PENALTY

◆ SOURCE

◆ SPECTRAL

◆ TRAVERSAL_NODE_LIMIT

◆ TRUE

◆ UNIT_UNLOADING_COST