get_class_train_data_knnT_get_class_train_data_knnGetClassTrainDataKnnGetClassTrainDataKnn (Operator)

Name

get_class_train_data_knnT_get_class_train_data_knnGetClassTrainDataKnnGetClassTrainDataKnn — Get the training data of a k-nearest neighbors (k-NN) classifier.

Signature

get_class_train_data_knn( : : KNNHandle : ClassTrainDataHandle)

Description

get_class_train_data_knnget_class_train_data_knnGetClassTrainDataKnnGetClassTrainDataKnnGetClassTrainDataKnn gets the training data of a k-nearest neighbors (k-NN) classifier and returns it in ClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleclassTrainDataHandle.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

KNNHandleKNNHandleKNNHandleKNNHandleKNNHandle (input_control) class_knn → (handle)

Handle of the k-NN classifier that contains training data.

ClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleclassTrainDataHandle (output_control) class_train_data → (handle)

Handle of the training data of the classifier.

Result

If the parameters are valid, the operator get_class_train_data_knnget_class_train_data_knnGetClassTrainDataKnnGetClassTrainDataKnnGetClassTrainDataKnn returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.