get_sample_num_class_train_dataget_sample_num_class_train_dataGetSampleNumClassTrainDataGetSampleNumClassTrainData (Operator)

Name

get_sample_num_class_train_dataget_sample_num_class_train_dataGetSampleNumClassTrainDataGetSampleNumClassTrainData — Return the number of training samples stored in the training data.

Signature

get_sample_num_class_train_data( : : ClassTrainDataHandle : NumSamples)

Description

get_sample_num_class_train_dataget_sample_num_class_train_dataGetSampleNumClassTrainDataGetSampleNumClassTrainDataGetSampleNumClassTrainData returns in NumSamplesNumSamplesNumSamplesNumSamplesnumSamples the number of training samples which are stored in the training data specified by 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.

Parameters

ClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleClassTrainDataHandleclassTrainDataHandle (input_control) class_train_data → (integer)

Handle of training data.

NumSamplesNumSamplesNumSamplesNumSamplesnumSamples (output_control) integer → (integer)

Number of stored training samples.

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