Skip to content

get_sample_num_class_knnGetSampleNumClassKnnGetSampleNumClassKnnget_sample_num_class_knnT_get_sample_num_class_knn🔗

Short description🔗

get_sample_num_class_knnGetSampleNumClassKnnGetSampleNumClassKnnget_sample_num_class_knnT_get_sample_num_class_knn — 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( class_knn KNNHandle, out integer NumSamples )void GetSampleNumClassKnn( const HTuple& KNNHandle, HTuple* NumSamples )static void HOperatorSet.GetSampleNumClassKnn( HTuple KNNHandle, out HTuple numSamples )def get_sample_num_class_knn( knnhandle: HHandle ) -> int

Herror T_get_sample_num_class_knn( const Htuple KNNHandle, Htuple* NumSamples )

Hlong HClassKnn::GetSampleNumClassKnn( ) const

int HClassKnn.GetSampleNumClassKnn( )

Description🔗

get_sample_num_class_knnGetSampleNumClassKnn returns in NumSamplesnumSamplesnum_samples the number of training samples that are stored in the k-nearest neighbors (k-NN) classifier given by KNNHandleKNNHandleknnhandle. get_sample_num_class_knnGetSampleNumClassKnn should be called before the individual training samples are accessed with get_sample_class_knnGetSampleClassKnn.

Execution information🔗

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🔗

KNNHandleKNNHandleknnhandle (input_control) class_knn → (handle)HTuple (HHandle)HClassKnn, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the k-NN classifier.

NumSamplesnumSamplesnum_samples (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of stored training samples.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

add_sample_class_knnAddSampleClassKnn

Possible successors

get_sample_class_knnGetSampleClassKnn

See also

create_class_knnCreateClassKnn

Module🔗

Foundation