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

Public Types | List of all members
NumericTableIface Class Referenceabstract

Abstract interface class for a data management component responsible for representation of data in the numeric format. This class declares the most general methods for data access. More...

Public Types

enum  MemoryStatus { notAllocated, userAllocated, internallyAllocated }
 Enumeration to specify the status of memory related to the Numeric Table. More...
 
enum  AllocationFlag { doNotAllocate = 0, notAllocate = 0, doAllocate = 1 }
 Enumeration to specify whether the Numeric Table must allocate memory. More...
 
enum  BasicStatisticsId { minimum = 0, maximum = 1, sum = 2, sumSquares = 3 }
 Enumeration to specify estimates of basic statistics stored. More...
 
enum  FeatureBasicStatistics { counters }
 Enumeration to specify feature-specific estimates of basic statistics stored. More...
 
enum  NormalizationType { nonNormalized = 0, standardScoreNormalized = 1, minMaxNormalized = 2 }
 Enumeration to specify types of normalization. More...
 
enum  StorageLayout
 Storage layouts that may need to be supported. More...
 

Class Declaration

Member Enumeration Documentation

Enumerator
doNotAllocate 

Memory will not be allocated by NumericTable

notAllocate 

Memory will not be allocated by NumericTable

Deprecated:
This item will be removed in a future release. Use doNotAllocate instead.
doAllocate 

Memory will be allocated by NumericTable when needed

Enumerator
minimum 

Minimum estimate

maximum 

Maximum estimate

sum 

Sum estimate

sumSquares 

Sum squares estimate

Enumerator
counters 

Counters estimate

Enumerator
notAllocated 

No memory allocated

userAllocated 

Memory allocated on user side

internallyAllocated 

Memory allocated and managed by NumericTable

Enumerator
nonNormalized 

Default: non-normalized

standardScoreNormalized 

Standard score normalization (mean=0, variance=1)

minMaxNormalized 

Min-max normalization

Member Function Documentation

virtual services::Status allocateBasicStatistics ( )
pure virtual

Allocates Numeric Tables for basic statistics

Implemented in NumericTable, and MergedNumericTable.

virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateDataMemory ( daal::MemType  type = daal::dram)
pure virtual

Allocates memory for a data set

Deprecated:
This item will be removed in a future release.

Implemented in NumericTable.

virtual services::Status check ( const char *  description,
bool  checkDataAllocation = true 
) const
pure virtual

Checks the correctness of this numeric table

Parameters
[in]descriptionAdditional information about error
[in]checkDataAllocationFlag that specifies whether to check the data allocation status
Returns
Check status: True if the table satisfies the requirements, false otherwise.

Implemented in NumericTable, and CSRNumericTable.

virtual DAAL_DEPRECATED_VIRTUAL void freeDataMemory ( )
pure virtual

Deallocates the memory allocated for a data set

Deprecated:
This item will be removed in a future release.

Implemented in NumericTable.

virtual StorageLayout getDataLayout ( ) const
pure virtual

Returns a data layout used in the Numeric Table

Returns
Data layout

Implemented in NumericTable.

virtual DAAL_DEPRECATED_VIRTUAL NumericTableDictionary* getDictionary ( ) const
pure virtual

Returns a pointer to a data dictionary

Returns
Pointer to the data dictionary
Deprecated:
This item will be removed in a future release.

Implemented in NumericTable.

virtual NumericTableDictionaryPtr getDictionarySharedPtr ( ) const
pure virtual

Returns a shared pointer to a data dictionary

Returns
Shared pointer to the data dictionary

Implemented in NumericTable.

virtual features::FeatureType getFeatureType ( size_t  feature_idx) const
pure virtual

Returns the type of a given feature

Parameters
[in]feature_idxFeature index
Returns
Feature type

Implemented in NumericTable.

virtual size_t getNumberOfCategories ( size_t  feature_idx) const
pure virtual

Returns the number of categories for a given feature

Parameters
[in]feature_idxFeature index
Returns
Number of categories

Implemented in NumericTable.

virtual DAAL_DEPRECATED_VIRTUAL services::Status resetDictionary ( )
inlinevirtual

Resets a data dictionary for the Numeric Table

Deprecated:
This item will be removed in a future release.

Reimplemented in NumericTable.

virtual services::Status resize ( size_t  nrows)
pure virtual

Sets the number of rows in the Numeric Table and allocates memory for a data set

Implemented in NumericTable, CSRNumericTable, MergedNumericTable, and RowMergedNumericTable.

virtual DAAL_DEPRECATED_VIRTUAL services::Status setDictionary ( NumericTableDictionary ddict)
inlinevirtual

Sets a data dictionary in the Numeric Table

Parameters
[in]ddictPointer to the data dictionary
Deprecated:
This item will be removed in a future release.

Reimplemented in NumericTable, and SOANumericTable.

virtual DAAL_DEPRECATED_VIRTUAL services::Status setNumberOfColumns ( size_t  ncol)
pure virtual

Sets the number of columns in the Numeric Table

Parameters
[in]ncolNumber of columns
Deprecated:
This item will be removed in a future release.

Implemented in PackedTriangularMatrix< packedLayout, DataType >, and NumericTable.

virtual DAAL_DEPRECATED_VIRTUAL services::Status setNumberOfRows ( size_t  nrow)
pure virtual

Sets the number of rows in the Numeric Table

Parameters
[in]nrowNumber of rows
Deprecated:
This item will be removed in a future release.

Implemented in PackedTriangularMatrix< packedLayout, DataType >, and NumericTable.


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

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