C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

Static Public Member Functions | List of all members
Dictionary< Feature, SerializationTag > Class Template Reference

Class that represents a dictionary of a data set and provides methods to work with the data dictionary. More...

Static Public Member Functions

static services::SharedPtr
< Dictionary
create (size_t nfeat, FeaturesEqual featuresEqual=notEqual, services::Status *stat=NULL)
 
static services::SharedPtr
< Dictionary
create (services::Status *stat=NULL)
 

Additional Inherited Members

- Public Types inherited from DictionaryIface
enum  FeaturesEqual { notEqual, equal }
 Enumeration to specify whether the Data Dictionary contains equal features.
 

Class Declaration

template<typename Feature, int SerializationTag>
class daal::data_management::interface1::Dictionary< Feature, SerializationTag >

Constructor & Destructor Documentation

Dictionary ( size_t  nfeat,
FeaturesEqual  featuresEqual = notEqual 
)
inline

Constructor of a data dictionary

Parameters
[in]nfeatNumber of features in the table
[in]featuresEqualFlag specifying that all features have equal types and properties
Deprecated:
This item will be removed in a future release. Use Dictionary::create instead.
Dictionary ( )
inline

Default constructor of a data dictionary

Deprecated:
This item will be removed in a future release. Use Dictionary::create instead.

Member Function Documentation

static services::SharedPtr<Dictionary> create ( size_t  nfeat,
FeaturesEqual  featuresEqual = notEqual,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a data dictionary

Parameters
[in]nfeatNumber of features in the table
[in]featuresEqualFlag specifying that all features have equal types and properties
[in]statStatus of the dictionary construction
Returns
data dictionary
static services::SharedPtr<Dictionary> create ( services::Status *  stat = NULL)
inlinestatic

Constructs a default data dictionary

Parameters
[in]statStatus of the dictionary construction
Returns
data dictionary
DAAL_DEPRECATED services::SharedPtr<services::KernelErrorCollection> getErrors ( )
inline

Returns errors during the computation

Returns
Errors during the computation
Deprecated:
This item will be removed in a future release.
FeaturesEqual getFeaturesEqual ( ) const
inline

Returns the value of the featuresEqual flag

Returns
Value of the featuresEqual flag
size_t getNumberOfFeatures ( ) const
inline

Returns the number of features

Returns
Number of features
virtual int getSerializationTag ( ) const
inlinevirtual

Returns a serialization tag, a unique identifier of this class used in serialization

Returns
Serialization tag

Implements SerializationIface.

Feature& operator[] ( const size_t  idx)
inline

Returns a feature with a given index

Parameters
[in]idxIndex of the feature
Returns
Requested feature
services::Status resetDictionary ( )
inline

Resets a dictionary and sets the number of features to 0

virtual services::Status setAllFeatures ( const Feature &  defaultFeature)
inlinevirtual

Sets all features of a dictionary to the same type

Parameters
[in]defaultFeatureDefault feature class to which to set all features
services::Status setAllFeatures ( )
inline

Sets all features of a dictionary to the same type

Template Parameters
featureTypeDefault feature type to which to set all features
services::Status setFeature ( const Feature &  feature,
size_t  idx 
)
inline
Parameters
[in]featureData feature
[in]idxIndex of the data feature
services::Status setFeature ( size_t  idx)
inline

Adds a feature to a data dictionary

Parameters
[in]idxIndex of the data feature
virtual services::Status setNumberOfFeatures ( size_t  numberOfFeatures)
inlinevirtual

Sets the number of features

Parameters
[in]numberOfFeaturesNumber of features

The documentation for this class was generated from the following file:

For more complete information about compiler optimizations, see our Optimization Notice.