A set of parameters for Kinetica.solveGraph. More...

Inheritance diagram for kinetica.SolveGraphRequest:

Collaboration diagram for kinetica.SolveGraphRequest:

Classes
struct	Options
	A set of string constants for the parameter options. More...

struct	SolverType
	A set of string constants for the parameter solver_type. More...

Public Member Functions
	SolveGraphRequest ()
	Constructs a SolveGraphRequest object with default parameters. More...

	SolveGraphRequest (string graph_name, IList< string > weights_on_edges=null, IList< string > restrictions=null, string solver_type=null, IList< string > source_nodes=null, IList< string > destination_nodes=null, string solution_table=null, IDictionary< string, string > options=null)
	Constructs a SolveGraphRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	graph_name `[get, set]`
	Name of the graph resource to solve. More...

IList< string >	weights_on_edges = new List<string>() `[get, set]`
	Additional weights to apply to the edges of an existing graph. More...

IList< string >	restrictions = new List<string>() `[get, set]`
	Additional restrictions to apply to the nodes/edges of an existing graph. More...

string	solver_type = SolverType.SHORTEST_PATH `[get, set]`
	The type of solver to use for the graph. More...

IList< string >	source_nodes = new List<string>() `[get, set]`
	It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes. More...

IList< string >	destination_nodes = new List<string>() `[get, set]`
	It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes. More...

string	solution_table = "graph_solutions" `[get, set]`
	Name of the table to store the solution, in [schema_name. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Additional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.solveGraph.

Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.

IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.

Definition at line 25 of file SolveGraph.cs.

Constructor & Destructor Documentation

◆ SolveGraphRequest() [1/2]

kinetica.SolveGraphRequest.SolveGraphRequest ( )

inline

Constructs a SolveGraphRequest object with default parameters.

Definition at line 741 of file SolveGraph.cs.

◆ SolveGraphRequest() [2/2]

kinetica.SolveGraphRequest.SolveGraphRequest	(	string	graph_name,
		IList< string >	weights_on_edges = `null`,
		IList< string >	restrictions = `null`,
		string	solver_type = `null`,
		IList< string >	source_nodes = `null`,
		IList< string >	destination_nodes = `null`,
		string	solution_table = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a SolveGraphRequest object with the specified parameters.

Parameters

graph_name	Name of the graph resource to solve.
weights_on_edges	Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15, 2} AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s). If using constant values in an identifier combination, the number of values specified must match across the combination. The default value is an empty List.
restrictions	Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination. If remove_previous_restrictions option is set to true, any provided restrictions will replace the existing restrictions. Otherwise, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED'). The default value is an empty List.
solver_type	The type of solver to use for the graph. Supported values: SHORTEST_PATH: Solves for the optimal (shortest) path based on weights and restrictions from one source to destinations nodes. Also known as the Dijkstra solver. PAGE_RANK: Solves for the probability of each destination node being visited based on the links of the graph topology. Weights are not required to use this solver. PROBABILITY_RANK: Solves for the transitional probability (Hidden Markov) for each node based on the weights (probability assigned over given edges). CENTRALITY: Solves for the degree of a node to depict how many pairs of individuals that would have to go through the node to reach one another in the minimum number of hops. Also known as betweenness. MULTIPLE_ROUTING: Solves for finding the minimum cost cumulative path for a round-trip starting from the given source and visiting each given destination node once then returning to the source. Also known as the travelling salesman problem. INVERSE_SHORTEST_PATH: Solves for finding the optimal path cost for each destination node to route to the source node. Also known as inverse Dijkstra or the service man routing problem. BACKHAUL_ROUTING: Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes. ALLPATHS: Solves for paths that would give costs between max and min solution radia - Make sure to limit by the 'max_solution_targets' option. Min cost shoudl be >= shortest_path cost. STATS_ALL: Solves for graph statistics such as graph diameter, longest pairs, vertex valences, topology numbers, average and max cluster sizes, etc. CLOSENESS: Solves for the centrality closeness score per node as the sum of the inverse shortest path costs to all nodes in the graph. The default value is SHORTEST_PATH.
source_nodes	It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes. For BACKHAUL_ROUTING, this list depicts the fixed assets. The default value is an empty List.
destination_nodes	It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes. For BACKHAUL_ROUTING, this list depicts the remote assets. The default value is an empty List.
solution_table	Name of the table to store the solution, in [schema_name.]table_name format, using standard name resolution rules. The default value is 'graph_solutions'.
options	Additional parameters. MAX_SOLUTION_RADIUS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'. MIN_SOLUTION_RADIUS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when MAX_SOLUTION_RADIUS is set. Sets the minimum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'. MAX_SOLUTION_TARGETS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destination_nodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '1000'. UNIFORM_WEIGHTS: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weights_on_edges will override this value. LEFT_TURN_PENALTY: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph 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 Kinetica.createGraph 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 Kinetica.createGraph 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 Kinetica.createGraph was invoked at graph creation. The default value is '0.0'. NUM_BEST_PATHS: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'. MAX_NUM_COMBINATIONS: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'. OUTPUT_EDGE_PATH: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. Supported values: TRUE FALSE The default value is FALSE. OUTPUT_WKT_PATH: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. Supported values: TRUE FALSE The default value is TRUE. 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. For SHORTEST_PATH solver type, the input is split amongst the server containing the corresponding graph. CONVERGENCE_LIMIT: For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node between consecutive iterations to satisfy convergence. Default value is 1 (one) percent. The default value is '1.0'. MAX_ITERATIONS: For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence. Default value is 100. The default value is '100'. MAX_RUNS: For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph. Default value of 0 enables this value to be auto computed by the solver. The default value is '0'. OUTPUT_CLUSTERS: For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output. Supported values: TRUE: An additional column 'CLUSTER' will be added for each node FALSE: No extra cluster info per node will be available in the output The default value is FALSE. SOLVE_HEURISTIC: Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target. Supported values: ASTAR: Employs A-STAR heuristics to speed up the shortest path traversal NONE: No heuristics are applied The default value is NONE. ASTAR_RADIUS: For path solvers only when 'solve_heuristic' option is 'astar'. The shortest path traversal front includes nodes only within this radius (kilometers) as it moves towards the target location. The default value is '70'. The default value is an empty Dictionary.

Definition at line 1142 of file SolveGraph.cs.

Property Documentation

◆ destination_nodes

IList<string> kinetica.SolveGraphRequest.destination_nodes = new List<string>()

getset

It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes.

For BACKHAUL_ROUTING, this list depicts the remote assets. The default value is an empty List.

Definition at line 467 of file SolveGraph.cs.

◆ graph_name

string kinetica.SolveGraphRequest.graph_name

getset

Name of the graph resource to solve.

Definition at line 324 of file SolveGraph.cs.

◆ options

IDictionary<string, string> kinetica.SolveGraphRequest.options = new Dictionary<string, string>()

getset

Additional parameters.

MAX_SOLUTION_RADIUS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
MIN_SOLUTION_RADIUS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when MAX_SOLUTION_RADIUS is set. Sets the minimum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
MAX_SOLUTION_TARGETS: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destination_nodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '1000'.
UNIFORM_WEIGHTS: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weights_on_edges will override this value.
LEFT_TURN_PENALTY: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph 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 Kinetica.createGraph 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 Kinetica.createGraph 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 Kinetica.createGraph was invoked at graph creation. The default value is '0.0'.
NUM_BEST_PATHS: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'.
MAX_NUM_COMBINATIONS: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'.
OUTPUT_EDGE_PATH: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. Supported values:
- TRUE
- FALSE
The default value is FALSE.
OUTPUT_WKT_PATH: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. Supported values:
- TRUE
- FALSE
The default value is TRUE.
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. For SHORTEST_PATH solver type, the input is split amongst the server containing the corresponding graph.
CONVERGENCE_LIMIT: For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node between consecutive iterations to satisfy convergence. Default value is 1 (one) percent. The default value is '1.0'.
MAX_ITERATIONS: For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence. Default value is 100. The default value is '100'.
MAX_RUNS: For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph. Default value of 0 enables this value to be auto computed by the solver. The default value is '0'.
OUTPUT_CLUSTERS: For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output. Supported values:
- TRUE: An additional column 'CLUSTER' will be added for each node
- FALSE: No extra cluster info per node will be available in the output
The default value is FALSE.
SOLVE_HEURISTIC: Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target. Supported values:
- ASTAR: Employs A-STAR heuristics to speed up the shortest path traversal
- NONE: No heuristics are applied
The default value is NONE.
ASTAR_RADIUS: For path solvers only when 'solve_heuristic' option is 'astar'. The shortest path traversal front includes nodes only within this radius (kilometers) as it moves towards the target location. The default value is '70'.

The default value is an empty Dictionary.

Definition at line 737 of file SolveGraph.cs.

◆ restrictions

IList<string> kinetica.SolveGraphRequest.restrictions = new List<string>()

getset

Additional restrictions to apply to the nodes/edges of an existing graph.

Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination. If remove_previous_restrictions option is set to true, any provided restrictions will replace the existing restrictions. Otherwise, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED'). The default value is an empty List.

Definition at line 362 of file SolveGraph.cs.

◆ solution_table

string kinetica.SolveGraphRequest.solution_table = "graph_solutions"

getset

Name of the table to store the solution, in [schema_name.

]table_name format, using standard name resolution rules.

The default value is 'graph_solutions'.

Definition at line 475 of file SolveGraph.cs.

◆ solver_type

string kinetica.SolveGraphRequest.solver_type = SolverType.SHORTEST_PATH

getset

The type of solver to use for the graph.

Supported values:

SHORTEST_PATH: Solves for the optimal (shortest) path based on weights and restrictions from one source to destinations nodes. Also known as the Dijkstra solver.
PAGE_RANK: Solves for the probability of each destination node being visited based on the links of the graph topology. Weights are not required to use this solver.
PROBABILITY_RANK: Solves for the transitional probability (Hidden Markov) for each node based on the weights (probability assigned over given edges).
CENTRALITY: Solves for the degree of a node to depict how many pairs of individuals that would have to go through the node to reach one another in the minimum number of hops. Also known as betweenness.
MULTIPLE_ROUTING: Solves for finding the minimum cost cumulative path for a round-trip starting from the given source and visiting each given destination node once then returning to the source. Also known as the travelling salesman problem.
INVERSE_SHORTEST_PATH: Solves for finding the optimal path cost for each destination node to route to the source node. Also known as inverse Dijkstra or the service man routing problem.
BACKHAUL_ROUTING: Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes.
ALLPATHS: Solves for paths that would give costs between max and min solution radia - Make sure to limit by the 'max_solution_targets' option. Min cost shoudl be >= shortest_path cost.
STATS_ALL: Solves for graph statistics such as graph diameter, longest pairs, vertex valences, topology numbers, average and max cluster sizes, etc.
CLOSENESS: Solves for the centrality closeness score per node as the sum of the inverse shortest path costs to all nodes in the graph.

The default value is SHORTEST_PATH.

Definition at line 451 of file SolveGraph.cs.

◆ source_nodes

IList<string> kinetica.SolveGraphRequest.source_nodes = new List<string>()

getset

It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes.

For BACKHAUL_ROUTING, this list depicts the fixed assets. The default value is an empty List.

Definition at line 459 of file SolveGraph.cs.

◆ weights_on_edges

IList<string> kinetica.SolveGraphRequest.weights_on_edges = new List<string>()

getset

Additional weights to apply to the edges of an existing graph.

Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15, 2} AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s). If using constant values in an identifier combination, the number of values specified must match across the combination. The default value is an empty List.

Definition at line 342 of file SolveGraph.cs.

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

Kinetica/Protocol/SolveGraph.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SolveGraphRequest() [1/2]

◆ SolveGraphRequest() [2/2]

Property Documentation

◆ destination_nodes

◆ graph_name

◆ options

◆ restrictions

◆ solution_table

◆ solver_type

◆ source_nodes

◆ weights_on_edges