Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/aggregate/convexhull

URL: http://<db.host>:<db.port>/aggregate/convexhull

Calculates and returns the convex hull for the values in a table specified by input parameter table_name.

Input Parameter Description

Name	Type	Description
table_name	string	Name of table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules.
x_column_name	string	Name of the column containing the x coordinates of the points for the operation being performed.
y_column_name	string	Name of the column containing the y coordinates of the points for the operation being performed.
options	map of string to strings	Optional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'aggregate_convex_hull_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /aggregate/convexhull endpoint:

Name	Type	Description
x_vector	array of doubles	Array of x coordinates of the resulting convex set.
y_vector	array of doubles	Array of y coordinates of the resulting convex set.
count	int	Count of the number of points in the convex set.
is_valid	boolean
info	map of string to strings	Additional information.

Empty string in case of an error.