Additional parameters

GPS_NOISE: GPS noise value (in meters) to remove redundant sample points.

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"
	Optional WKT starting point from sample_points for the solver. More...

const string	DESTINATION = "destination"
	Optional 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"
	Allows reusing trucks for scheduling again. More...

const string	FALSE = "false"
	Trucks are scheduled only once from their depots. More...

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

const string	LEFT_TURN_PENALTY = "left_turn_penalty"
	This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More...

const string	RIGHT_TURN_PENALTY = "right_turn_penalty"
	This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More...

const string	INTERSECTION_PENALTY = "intersection_penalty"
	This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More...

const string	SHARP_TURN_PENALTY = "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 Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More...

const string	AGGREGATED_OUTPUT = "aggregated_output"
	For the match_supply_demand solver only. More...

const string	MAX_TRIP_COST = "max_trip_cost"
	For the match_supply_demand solver 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	TRUCK_SERVICE_LIMIT = "truck_service_limit"
	For the match_supply_demand solver only. More...

const string	ENABLE_TRUCK_REUSE = "enable_truck_reuse"
	For the match_supply_demand solver only. More...

Detailed Description

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 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 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 /create/graph 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 /create/graph 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 /create/graph 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 /create/graph 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 Dictionary. A set of string constants for the parameter options.

Definition at line 333 of file MatchGraph.cs.

Member Data Documentation

const string kinetica.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 446 of file MatchGraph.cs.

const string kinetica.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 357 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.DESTINATION = "destination"

Optional 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 369 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.ENABLE_TRUCK_REUSE = "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.

Definition at line 522 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.FALSE = "false"

Trucks are scheduled only once from their depots.

Definition at line 398 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.FILTER_FOLDING_PATHS = "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.

Definition at line 477 of file MatchGraph.cs.

const string kinetica.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 340 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.INTERSECTION_PENALTY = "intersection_penalty"

This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.

The default value is '0.0'.

Definition at line 428 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.LEFT_TURN_PENALTY = "left_turn_penalty"

This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.

The default value is '0.0'.

Definition at line 412 of file MatchGraph.cs.

const string kinetica.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 404 of file MatchGraph.cs.

const string kinetica.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 493 of file MatchGraph.cs.

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

Definition at line 454 of file MatchGraph.cs.

const string kinetica.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 345 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.PARTIAL_LOADING = "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.

Definition at line 391 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.RIGHT_TURN_PENALTY = "right_turn_penalty"

This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.

The default value is '0.0'.

Definition at line 420 of file MatchGraph.cs.

const string kinetica.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 351 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.SHARP_TURN_PENALTY = "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 Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.

The default value is '0.0'.

Definition at line 436 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.SOURCE = "source"

Optional 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 363 of file MatchGraph.cs.

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

Definition at line 500 of file MatchGraph.cs.

const string kinetica.MatchGraphRequest.Options.TRUE = "true"

Allows reusing trucks for scheduling again.

Definition at line 394 of file MatchGraph.cs.

const string kinetica.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 485 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