Kinetica C# API
Version 7.1.10.0
|
A set of parameters for Kinetica.solveGraph(string,IList{string},IList{string},string,IList{string},IList{string},string,IDictionary{string, string}). More...
Classes | |
struct | Options |
Additional parameters
| |
struct | SolverType |
The type of solver to use for the graph. 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... | |
![]() | |
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 [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 = new List<string>() [get, set] |
The type of solver to use for the graph. More... | |
IList< string > | source_nodes = SolverType.SHORTEST_PATH [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 = new List<string>() [get, set] |
Name of the table to store the solution, in [schema_name. More... | |
IDictionary< string, string > | options = "graph_solutions" [get, set] |
Additional parameters
| |
![]() | |
Schema | Schema [get] |
Avro Schema for this class More... | |
Additional Inherited Members | |
![]() | |
static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.solveGraph(string,IList{string},IList{string},string,IList{string},IList{string},string,IDictionary{string, string}).
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 Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
Definition at line 33 of file SolveGraph.cs.
|
inline |
Constructs a SolveGraphRequest object with default parameters.
Definition at line 989 of file SolveGraph.cs.
|
inline |
Constructs a SolveGraphRequest object with the specified 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:
|
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
|
Definition at line 1359 of file SolveGraph.cs.
|
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 749 of file SolveGraph.cs.
|
getset |
Name of the graph resource to solve.
Definition at line 610 of file SolveGraph.cs.
|
getset |
Additional parameters
Sets the maximum solution cost radius, which ignores the 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 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 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 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 /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'. 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:
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:
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:
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:
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 984 of file SolveGraph.cs.
|
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 656 of file SolveGraph.cs.
|
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 756 of file SolveGraph.cs.
|
getset |
The type of solver to use for the graph.
Supported values:
The default value is SHORTEST_PATH.
Definition at line 737 of file SolveGraph.cs.
|
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 743 of file SolveGraph.cs.
|
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 632 of file SolveGraph.cs.