C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

Public Types | List of all members
CsvDataSource< _featureManager, _summaryStatisticsType > Class Template Referenceabstract

Specifies methods to access data stored in files. More...

Public Types

typedef _featureManager FeatureManager
 
- Public Types inherited from DataSourceIface
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

template<typename _featureManager, typename _summaryStatisticsType = DAAL_SUMMARY_STATISTICS_TYPE>
class daal::data_management::interface1::CsvDataSource< _featureManager, _summaryStatisticsType >

Template Parameters
_featureManagerFeatureManager to use to get numeric data from file strings

Member Typedef Documentation

◆ FeatureManager

typedef _featureManager FeatureManager

Typedef that stores the parser datatype

Constructor & Destructor Documentation

◆ CsvDataSource()

CsvDataSource ( DataSourceIface::NumericTableAllocationFlag  doAllocateNumericTable = DataSource::notAllocateNumericTable,
DataSourceIface::DictionaryCreationFlag  doCreateDictionaryFromContext = DataSource::notDictionaryFromContext,
size_t  initialMaxRows = 10 
)
inline

Main constructor for a Data Source

Parameters
[in]doAllocateNumericTableFlag that specifies whether a Numeric Table associated with a File Data Source is allocated inside the Data Source
[in]doCreateDictionaryFromContextFlag that specifies whether a Data Dictionary is created from the context of the File Data Source
[in]initialMaxRowsInitial value of maximum number of rows in Numeric Table allocated in loadDataBlock() method

Member Function Documentation

◆ createDictionaryFromContext()

services::Status createDictionaryFromContext ( )
inlinevirtual

Creates a Data Dictionary by extracting information from a Data Source

Implements DataSourceIface.

Reimplemented in StringDataSource< _featureManager, _summaryStatisticsType >, and FileDataSource< _featureManager, _summaryStatisticsType >.

◆ getFeatureManager()

FeatureManager& getFeatureManager ( )
inline

Returns a feature manager associated with a File Data Source

Returns
Feature manager associated with the File Data Source

◆ getNumberOfAvailableRows()

size_t getNumberOfAvailableRows ( )
inlinevirtual

Returns the number of rows available in a Data Source

Returns
Number of rows

Implements DataSourceIface.

◆ getNumericTableNumberOfColumns()

size_t getNumericTableNumberOfColumns ( )
inlinevirtual

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

Returns
Number of columns

Reimplemented from DataSource.

◆ loadDataBlock() [1/6]

size_t loadDataBlock ( NumericTable nt)
inlinevirtual

Loads a data block into a provided Numeric Table

Parameters
[in]ntPointer to the Numeric Table

Implements DataSourceIface.

◆ loadDataBlock() [2/6]

size_t loadDataBlock ( size_t  maxRows,
NumericTable nt 
)
inlinevirtual

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

Implements DataSourceIface.

◆ loadDataBlock() [3/6]

size_t loadDataBlock ( size_t  maxRows,
size_t  rowOffset,
size_t  fullRows,
NumericTable nt 
)
inlinevirtual

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

Implements DataSourceIface.

◆ loadDataBlock() [4/6]

size_t loadDataBlock ( )
inlinevirtual

Loads a data block into an internally allocated Numeric Table

Implements DataSourceIface.

◆ loadDataBlock() [5/6]

size_t loadDataBlock ( size_t  maxRows)
inlinevirtual

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

Implements DataSourceIface.

◆ loadDataBlock() [6/6]

size_t loadDataBlock ( size_t  maxRows,
size_t  rowOffset,
size_t  fullRows 
)
inlinevirtual

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

Implements DataSourceIface.

◆ setDictionary()

services::Status setDictionary ( DataSourceDictionary dict)
inlinevirtual

Sets a predefined Data Dictionary

Implements DataSourceIface.


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

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