Query#

cuest.bindings.cuestQuery(
*,
handle: cuest.bindings.cuest.cuestHandle,
type: int,
object: object,
attribute: int,
attributeValue: object,
attributeValueSize: object | None = None,
) → cuest.bindings.cuest.CuestStatus#

Query an attribute of a cuEST opaque handle.

The result pointer ( attributeValue ) must reference sufficient memory for the type matching the specified attribute.

Parameters#

handle[in]cuestHandle

cuEST handle. Must not be NULL.

type[in]CuestType

enum indicating which type of object is being queried. Python enum mirroring the C API type cuestType_t.

object[in]cuEST object handle (of the type given by type)

cuEST object to be queried (opaque handle). Must not be NULL.

attribute[in]int

Attribute/property to query. (Should be an enum appropriate to the type of object.)

attributeValue[out]data handle (matching the queried attribute’s type) or Pointer

Pointer to memory for result (type depends on attribute). Attributes that return GPU-resident arrays take the same Pointer handle as the Compute calls, wrapping a device allocation that receives the result.

attributeValueSize[in]int, optional

Size in bytes of the memory referenced by attributeValue. When omitted, the size is inferred from the data handle type; it must be given when the size cannot be inferred from the type (e.g. sizeof(double) * numMO * numAO for CUEST_GRIDKINTPLAN_CANONICAL_ORTHOGONALIZATION_MATRIX_GPU). When given, it overrides the inferred size.

Returns#

status[out]CuestStatus