add_class_train_data_knnT_add_class_train_data_knnAddClassTrainDataKnnAddClassTrainDataKnn (Operator)

Name

add_class_train_data_knnT_add_class_train_data_knnAddClassTrainDataKnnAddClassTrainDataKnn — Add training data to a k-nearest neighbors (k-NN) classifier.

Signature

add_class_train_data_knn( : : KNNHandle, ClassTrainDataHandle : )

Description

add_class_train_data_knnadd_class_train_data_knnAddClassTrainDataKnnAddClassTrainDataKnnAddClassTrainDataKnn adds the training data specified by ClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleclassTrainDataHandle to a k-nearest neighbors (k-NN) classifier specified by KNNHandleKNNHandleKNNHandleKNNHandleKNNHandle.

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 modifies the state of the following input parameter:

KNNHandleKNNHandleKNNHandleKNNHandleKNNHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

KNNHandleKNNHandleKNNHandleKNNHandleKNNHandle (input_control, state is modified) class_knn → (handle)

Handle of a k-NN which receives the training data.

ClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleclassTrainDataHandle (input_control) class_train_data → (handle)

Training data for a classifier.

Result

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