get_sample_num_class_knnT_get_sample_num_class_knnGetSampleNumClassKnnGetSampleNumClassKnn (Operator)

Name

get_sample_num_class_knnT_get_sample_num_class_knnGetSampleNumClassKnnGetSampleNumClassKnn — Return the number of training samples stored in the training data of a k-nearest neighbors (k-NN) classifier.

Signature

get_sample_num_class_knn( : : KNNHandle : NumSamples)

Description

get_sample_num_class_knnget_sample_num_class_knnGetSampleNumClassKnnGetSampleNumClassKnnGetSampleNumClassKnn returns in NumSamplesNumSamplesNumSamplesNumSamplesnumSamples the number of training samples that are stored in the k-nearest neighbors (k-NN) classifier given by KNNHandleKNNHandleKNNHandleKNNHandleKNNHandle. get_sample_num_class_knnget_sample_num_class_knnGetSampleNumClassKnnGetSampleNumClassKnnGetSampleNumClassKnn should be called before the individual training samples are accessed with get_sample_class_knnget_sample_class_knnGetSampleClassKnnGetSampleClassKnnGetSampleClassKnn.

Execution Information

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

Parameters

KNNHandleKNNHandleKNNHandleKNNHandleKNNHandle (input_control) class_knn → (handle)

Handle of the k-NN classifier.

NumSamplesNumSamplesNumSamplesNumSamplesnumSamples (output_control) integer → (integer)

Number of stored training samples.

Result

If KNNHandleKNNHandleKNNHandleKNNHandleKNNHandle is valid, the operator get_sample_num_class_knnget_sample_num_class_knnGetSampleNumClassKnnGetSampleNumClassKnnGetSampleNumClassKnn returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.