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

List of all members
NumericTable Class Reference

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

Additional Inherited Members

- Public Types inherited from NumericTableIface
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

Constructor & Destructor Documentation

DAAL_DEPRECATED NumericTable ( NumericTableDictionary ddict)
inline

Constructor for a Numeric Table with predefined dictionary

Parameters
[in]ddictPointer to the data dictionary
Deprecated:
This item will be removed in a future release.
NumericTable ( NumericTableDictionaryPtr  ddict)
inline

Constructor for a Numeric Table with predefined dictionary

Parameters
[in]ddictPointer to the data dictionary
NumericTable ( size_t  featnum,
size_t  obsnum,
DictionaryIface::FeaturesEqual  featuresEqual = DictionaryIface::notEqual 
)
inline

Constructor for a Numeric Table

Parameters
[in]featnumNumber of columns in the table
[in]obsnumNumber of rows in the table
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal

Member Function Documentation

virtual services::Status allocateBasicStatistics ( )
virtual

Allocates Numeric Tables for basic statistics

Implements NumericTableIface.

Reimplemented in MergedNumericTable.

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

Allocates memory for a data set

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

Implements NumericTableIface.

virtual services::Status assign ( float  value)
inlinevirtual

Fills a numeric table with a constant

Parameters
[in]valueConstant to initialize entries of the numeric table

Reimplemented in PackedTriangularMatrix< packedLayout, DataType >, HomogenNumericTable< DataType >, and PackedSymmetricMatrix< packedLayout, DataType >.

virtual services::Status assign ( double  value)
inlinevirtual

Fills a numeric table with a constant

Parameters
[in]valueConstant to initialize entries of the numeric table

Reimplemented in PackedTriangularMatrix< packedLayout, DataType >, HomogenNumericTable< DataType >, and PackedSymmetricMatrix< packedLayout, DataType >.

virtual services::Status assign ( int  value)
inlinevirtual

Fills a numeric table with a constant

Parameters
[in]valueConstant to initialize entries of the numeric table

Reimplemented in PackedTriangularMatrix< packedLayout, DataType >, HomogenNumericTable< DataType >, and PackedSymmetricMatrix< packedLayout, DataType >.

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

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.

Implements NumericTableIface.

Reimplemented in CSRNumericTable.

DAAL_DEPRECATED_VIRTUAL void freeDataMemory ( )
inlinevirtual

Deallocates the memory allocated for a data set

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

Implements NumericTableIface.

StorageLayout getDataLayout ( ) const
inlinevirtual

Returns a data layout used in the Numeric Table

Returns
Data layout

Implements NumericTableIface.

virtual MemoryStatus getDataMemoryStatus ( ) const
inlinevirtual

Gets the status of the memory used by a data set connected with a Numeric Table

Reimplemented in MergedNumericTable, and RowMergedNumericTable.

virtual DAAL_DEPRECATED_VIRTUAL NumericTableDictionary* getDictionary ( ) const
inlinevirtual

Returns a pointer to a data dictionary

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

Implements NumericTableIface.

virtual NumericTableDictionaryPtr getDictionarySharedPtr ( ) const
inlinevirtual

Returns a shared pointer to a data dictionary

Returns
Shared pointer to the data dictionary

Implements NumericTableIface.

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.
features::FeatureType getFeatureType ( size_t  feature_idx) const
inlinevirtual

Returns the type of a given feature

Parameters
[in]feature_idxFeature index
Returns
Feature type

Implements NumericTableIface.

size_t getNumberOfCategories ( size_t  feature_idx) const
inlinevirtual

Returns the number of categories for a given feature

Parameters
[in]feature_idxFeature index
Returns
Number of categories

Implements NumericTableIface.

size_t getNumberOfColumns ( ) const
inline

Returns the number of columns in the Numeric Table

Returns
Number of columns
size_t getNumberOfRows ( ) const
inline

Returns the number of rows in the Numeric Table

Returns
Number of rows
DataType getValue ( size_t  column,
size_t  row 
) const
inline

Returns value by given column and row from the numeric table

Parameters
[in]columnColumn
[in]rowRow
Returns
Value from numeric table
DataType getValue ( size_t  column,
size_t  row,
services::Status &  status 
) const
inline

Returns value by given column and row from the numeric table

Parameters
[in]columnColumn
[in]rowRow
[in,out]statusStatus of the operation
Returns
Value from numeric table
bool isNormalized ( NormalizationType  flag) const
inline

Checks if dataset stored in the numeric table is normalized, according to the given normalization flag

Parameters
[in]flagNormalization flag to check
Returns
Check result
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 from NumericTableIface.

virtual services::Status resize ( size_t  nrows)
inlinevirtual

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

Implements NumericTableIface.

Reimplemented in 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 from NumericTableIface.

Reimplemented in SOANumericTable.

NormalizationType setNormalizationFlag ( NormalizationType  flag)
inline

Sets the normalization flag for dataset stored in the numeric table

Parameters
[in]flagNormalization flag
Returns
Previous value of the normalization flag
DAAL_DEPRECATED_VIRTUAL services::Status setNumberOfColumns ( size_t  ncol)
inlinevirtual

Sets the number of columns in the Numeric Table

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

Implements NumericTableIface.

Reimplemented in PackedTriangularMatrix< packedLayout, DataType >.

DAAL_DEPRECATED_VIRTUAL services::Status setNumberOfRows ( size_t  nrow)
inlinevirtual

Sets the number of rows in the Numeric Table

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

Implements NumericTableIface.

Reimplemented in PackedTriangularMatrix< packedLayout, DataType >.

Member Data Documentation

NumericTableDictionaryPtr _ddict
protected

Basic statistics container


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

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