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

Public Types | List of all members
DataSourceIface Class Referenceabstract

Abstract interface class that defines the interface for a data management component responsible for representation of data in the raw format. This class declares the most generic methods for data access. More...

Public Types

enum  DataSourceStatus { readyForLoad = 1, waitingForRows = 2, endOfData = 3, notReady = 4 }
 Specifies the status of the Data Source. More...
 
enum  DictionaryCreationFlag { notDictionaryFromContext = 1, doDictionaryFromContext = 2 }
 Specifies whether a Data Dictionary is created from the context of a Data Source. More...
 
enum  NumericTableAllocationFlag { notAllocateNumericTable = 1, doAllocateNumericTable = 2 }
 Specifies whether a Numeric Table is allocated inside of the Data Source object. More...
 

Class Declaration

Member Enumeration Documentation

Enumerator
readyForLoad 

Data is ready to be loaded via loadDataBlock() function

waitingForRows 

No data is available, but it may be ready in future

endOfData 

No data is available

notReady 

DataSource not ready for loading

Enumerator
notDictionaryFromContext 

Do not create dictionary automatically

doDictionaryFromContext 

Do create dictionary when needed

Enumerator
notAllocateNumericTable 

Do not allocate Numeric Table automatically

doAllocateNumericTable 

Do allocate Numeric Table when needed

Member Function Documentation

virtual services::Status allocateNumericTable ( )
pure virtual
virtual services::Status createDictionaryFromContext ( )
pure virtual
virtual void freeNumericTable ( )
pure virtual
virtual DAAL_DEPRECATED_VIRTUAL DataSourceDictionary* getDictionary ( )
pure virtual

Returns a pointer to a data dictionary

Returns
Pointer to the Data Dictionary

Implemented in DataSource.

virtual DataSourceDictionaryPtr getDictionarySharedPtr ( )
pure virtual

Returns a shared pointer to a data dictionary

Returns
Shared pointer to the Data Dictionary

Implemented in DataSource.

virtual size_t getNumberOfAvailableRows ( )
pure virtual
virtual size_t getNumberOfColumns ( )
pure virtual

Returns the number of columns in a Data Source

Returns
Number of columns

Implemented in DataSource.

virtual NumericTablePtr getNumericTable ( )
pure virtual

Returns a pointer to a Numeric Table associated with a Data Source

Returns
Pointer to the Numeric Table

Implemented in DataSource.

virtual size_t getNumericTableNumberOfColumns ( )
pure virtual

Returns the number of columns in a Numeric Table associated with a Data Source

Returns
Number of columns

Implemented in DataSource, and CsvDataSource< FeatureManager, SummaryStatisticsType >.

virtual DataSourceStatus getStatus ( )
pure virtual
virtual size_t loadDataBlock ( size_t  maxRows)
pure virtual

Loads a data block of a specified size into an internally allocated Numeric Table

Parameters
[in]maxRowsMaximum number of rows to load from a Data Source into the Numeric Table

Implemented in CsvDataSource< FeatureManager, SummaryStatisticsType >, ODBCDataSource< FeatureManager, SummaryStatisticsType >, DataSource, and KDBDataSource< _featureManager, summaryStatisticsType >.

virtual size_t loadDataBlock ( size_t  maxRows,
size_t  rowOffset,
size_t  fullRows 
)
pure virtual

Loads a data block of a specified size into an internally allocated Numeric Table

Parameters
[in]maxRowsMaximum number of rows to load from a Data Source into the Numeric Table
[in]rowOffsetWrite data starting from rowOffset row
[in]fullRowsMaximum number of rows to allocate in the Numeric Table

Implemented in CsvDataSource< FeatureManager, SummaryStatisticsType >, and DataSource.

virtual size_t loadDataBlock ( size_t  maxRows,
NumericTable nt 
)
pure virtual

Loads a data block of a specified size into a provided Numeric Table

Parameters
[in]maxRowsMaximum number of rows to load from a Data Source into the Numeric Table
[in]ntPointer to the Numeric Table

Implemented in ODBCDataSource< FeatureManager, SummaryStatisticsType >, DataSource, CsvDataSource< FeatureManager, SummaryStatisticsType >, and KDBDataSource< _featureManager, summaryStatisticsType >.

virtual size_t loadDataBlock ( size_t  maxRows,
size_t  rowOffset,
size_t  fullRows,
NumericTable nt 
)
pure virtual

Loads a data block of a specified size into an internally allocated Numeric Table

Parameters
[in]maxRowsMaximum number of rows to load from a Data Source into the Numeric Table
[in]rowOffsetWrite data starting from rowOffset row
[in]fullRowsMaximum number of rows to allocate in the Numeric Table
[in]ntPointer to the Numeric Table

Implemented in DataSource, and CsvDataSource< FeatureManager, SummaryStatisticsType >.

virtual size_t loadDataBlock ( )
pure virtual
virtual size_t loadDataBlock ( NumericTable nt)
pure virtual

Loads a data block into a provided Numeric Table

Parameters
[in]ntPointer to the Numeric Table

Implemented in ODBCDataSource< FeatureManager, SummaryStatisticsType >, DataSource, CsvDataSource< FeatureManager, SummaryStatisticsType >, and KDBDataSource< _featureManager, summaryStatisticsType >.

virtual services::Status setDictionary ( DataSourceDictionary dict)
pure virtual

Sets a predefined Data Dictionary

Implemented in DataSource, and CsvDataSource< FeatureManager, SummaryStatisticsType >.


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

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