Creating and Destroying Handles - 5.2 English

Creating and Destroying Handles - 5.2 English - 68552

AOCL API Guide (68552)

Document ID

68552

Release Date

2025-12-29

Version

5.2 English

da_status da_handle_init_s(da_handle *handle, da_handle_type handle_type)#

Initialize a da_handle with default values.

Set up a da_handle to be used with a specific chapter. This function must be called before calling any functions that require a valid handle.

For more info on the handle structure: higher-level handle description.

Parameters:

handle – [inout] the main data structure.
handle_type – [in] the type of handle to initialize (see da_handle_type).

Returns:

da_status. The function returns:

da_status_success - the operation was successfully completed.
da_status_memory_error - a memory allocation error occurred.
da_status_internal_error - this should not occur and indicates a memory corruption issue.

void da_handle_destroy(da_handle *handle)#

Destroy the da_handle struct.

Free all allocated memory in handle.

This function should always be called after finishing using the handle.

Note

Memory leaks may occur if handles are not destroyed after use.

typedef struct _da_handle *da_handle#

The main handle object.

For more information on the handle structure, see the higher-level handle description.

typedef enum da_handle_type_ da_handle_type#: Alias for the da_handle_type_ enum.

enum da_handle_type_#

Enumeration defining the types of handles available.

Values:

enumerator da_handle_uninitialized#: the handle has not yet been initialized.

enumerator da_handle_linmod#: the handle is to be used with functions from the linear models chapter.

enumerator da_handle_pca#: the handle is to be used with functions for computing the principal component analysis.

enumerator da_handle_kmeans#: the handle is to be used with functions for computing k-means clustering.

enumerator da_handle_dbscan#: the handle is to be used with functions for computing DBSCAN clustering.

enumerator da_handle_decision_tree#: the handle is to be used with functions for computing decision trees.

enumerator da_handle_decision_forest#: the handle is to be used with functions for computing decision forests.

enumerator da_handle_nlls#: the handle is to be used with functions from the nonlinear data fitting chapter.

enumerator da_handle_nn#: the handle is to be used with functions from the nearest neighbors chapter.

enumerator da_handle_svm#: the handle is to be used with functions for computing the svm.

Note that the da_handle functionality also includes option setting, result extraction and error handling capabilities, which are described separately.