/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

NameTypeDescription
table_namestringName 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_namestringName of the column containing the x coordinates of the points for the operation being performed.
y_column_namestringName of the column containing the y coordinates of the points for the operation being performed.
optionsmap of string to stringsOptional 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'aggregate_convex_hull_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
x_vectorarray of doublesArray of x coordinates of the resulting convex set.
y_vectorarray of doublesArray of y coordinates of the resulting convex set.
countintCount of the number of points in the convex set.
is_validboolean 
infomap of string to stringsAdditional information.

Empty string in case of an error.