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

Static Public Member Functions | List of all members
SOANumericTable Class Reference

Class that provides methods to access data stored as a structure of arrays, where each (contiguous) array represents values corresponding to a specific feature. More...

Static Public Member Functions

static services::SharedPtr
< SOANumericTable
create (size_t nColumns=0, size_t nRows=0, DictionaryIface::FeaturesEqual featuresEqual=DictionaryIface::notEqual, services::Status *stat=NULL)
 
static services::SharedPtr
< SOANumericTable
create (NumericTableDictionaryPtr ddict, size_t nRows, AllocationFlag memoryAllocationFlag=notAllocate, services::Status *stat=NULL)
 

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

SOANumericTable ( size_t  nColumns = 0,
size_t  nRows = 0,
DictionaryIface::FeaturesEqual  featuresEqual = DictionaryIface::notEqual 
)

Constructor for an empty Numeric Table

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]featuresEqualFlag that makes all features in the NumericTableDictionary equal
Deprecated:
This item will be removed in a future release. Use SOANumericTable::create instead.
DAAL_DEPRECATED SOANumericTable ( NumericTableDictionary ddict,
size_t  nRows,
AllocationFlag  memoryAllocationFlag = notAllocate 
)
inline

Constructor for an empty Numeric Table with a predefined NumericTableDictionary

Parameters
[in]ddictPointer to the predefined NumericTableDictionary
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
Deprecated:
This item will be removed in a future release.
SOANumericTable ( NumericTableDictionaryPtr  ddict,
size_t  nRows,
AllocationFlag  memoryAllocationFlag = notAllocate 
)

Constructor for an empty Numeric Table with a predefined NumericTableDictionary

Parameters
[in]ddictShared pointer to the predefined NumericTableDictionary
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
Deprecated:
This item will be removed in a future release. Use SOANumericTable::create instead.

Member Function Documentation

static services::SharedPtr<SOANumericTable> create ( size_t  nColumns = 0,
size_t  nRows = 0,
DictionaryIface::FeaturesEqual  featuresEqual = DictionaryIface::notEqual,
services::Status *  stat = NULL 
)
static

Constructs an empty Numeric Table

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]featuresEqualFlag that makes all features in the NumericTableDictionary equal
[out]statStatus of the numeric table construction
Returns
Empty numeric table
static services::SharedPtr<SOANumericTable> create ( NumericTableDictionaryPtr  ddict,
size_t  nRows,
AllocationFlag  memoryAllocationFlag = notAllocate,
services::Status *  stat = NULL 
)
static

Constructs an empty Numeric Table with a predefined NumericTableDictionary

Parameters
[in]ddictShared pointer to the predefined NumericTableDictionary
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[out]statStatus of the numeric table construction
Returns
Numeric table with a predefined NumericTableDictionary
void* getArray ( size_t  idx)
inline

Returns a pointer to an array of values for a given feature

Parameters
[in]idxFeature index
Returns
Pointer to the array of values
services::SharedPtr<byte> getArraySharedPtr ( size_t  idx)
inline

Returns a pointer to an array of values for a given feature

Parameters
[in]idxFeature index
Returns
Pointer to the array of values
services::Status getBlockOfColumnValues ( size_t  feature_idx,
size_t  vector_idx,
size_t  value_num,
ReadWriteMode  rwflag,
BlockDescriptor< double > &  block 
)
inlinevirtual

Gets a block of values for a given feature.

Parameters
[in]feature_idxFeature index.
[in]vector_idxIndex of the first feature vector to include into the block.
[in]value_numNumber of feature values in the block.
[in]rwflagFlag specifying read/write access to the block of feature values.
[out]blockThe block of feature values.
Returns
Actual number of feature values returned by the method.

Implements DenseNumericTableIface.

services::Status getBlockOfColumnValues ( size_t  feature_idx,
size_t  vector_idx,
size_t  value_num,
ReadWriteMode  rwflag,
BlockDescriptor< float > &  block 
)
inlinevirtual

Gets a block of values for a given feature.

Parameters
[in]feature_idxFeature index.
[in]vector_idxIndex of the first feature vector to include into the block.
[in]value_numNumber of feature values in the block.
[in]rwflagFlag specifying read/write access to the block of feature values.
[out]blockThe block of feature values.
Returns
Actual number of feature values returned by the method.

Implements DenseNumericTableIface.

services::Status getBlockOfColumnValues ( size_t  feature_idx,
size_t  vector_idx,
size_t  value_num,
ReadWriteMode  rwflag,
BlockDescriptor< int > &  block 
)
inlinevirtual

Gets a block of values for a given feature.

Parameters
[in]feature_idxFeature index.
[in]vector_idxIndex of the first feature vector to include into the block.
[in]value_numNumber of feature values in the block.
[in]rwflagFlag specifying read/write access to the block of feature values.
[out]blockThe block of feature values.
Returns
Actual number of feature values returned by the method.

Implements DenseNumericTableIface.

services::Status getBlockOfRows ( size_t  vector_idx,
size_t  vector_num,
ReadWriteMode  rwflag,
BlockDescriptor< double > &  block 
)
inlinevirtual

Gets a block of rows from a table.

Parameters
[in]vector_idxIndex of the first row to include into the block.
[in]vector_numNumber of rows in the block.
[in]rwflagFlag specifying read/write access to the block of feature vectors.
[out]blockThe block of feature vectors.
Returns
Actual number of feature vectors returned by the method.

Implements DenseNumericTableIface.

services::Status getBlockOfRows ( size_t  vector_idx,
size_t  vector_num,
ReadWriteMode  rwflag,
BlockDescriptor< float > &  block 
)
inlinevirtual

Gets a block of rows from a table.

Parameters
[in]vector_idxIndex of the first row to include into the block.
[in]vector_numNumber of rows in the block.
[in]rwflagFlag specifying read/write access to the block of feature vectors.
[out]blockThe block of feature vectors.
Returns
Actual number of feature vectors returned by the method.

Implements DenseNumericTableIface.

services::Status getBlockOfRows ( size_t  vector_idx,
size_t  vector_num,
ReadWriteMode  rwflag,
BlockDescriptor< int > &  block 
)
inlinevirtual

Gets a block of rows from a table.

Parameters
[in]vector_idxIndex of the first row to include into the block.
[in]vector_numNumber of rows in the block.
[in]rwflagFlag specifying read/write access to the block of feature vectors.
[out]blockThe block of feature vectors.
Returns
Actual number of feature vectors returned by the method.

Implements DenseNumericTableIface.

services::Status releaseBlockOfColumnValues ( BlockDescriptor< double > &  block)
inlinevirtual

Releases a block of values for a given feature.

Parameters
[in]blockThe block of feature values.

Implements DenseNumericTableIface.

services::Status releaseBlockOfColumnValues ( BlockDescriptor< float > &  block)
inlinevirtual

Releases a block of values for a given feature.

Parameters
[in]blockThe block of feature values.

Implements DenseNumericTableIface.

services::Status releaseBlockOfColumnValues ( BlockDescriptor< int > &  block)
inlinevirtual

Releases a block of values for a given feature.

Parameters
[in]blockThe block of feature values.

Implements DenseNumericTableIface.

services::Status releaseBlockOfRows ( BlockDescriptor< double > &  block)
inlinevirtual

Releases a block of rows.

Parameters
[in]blockThe block of rows.

Implements DenseNumericTableIface.

services::Status releaseBlockOfRows ( BlockDescriptor< float > &  block)
inlinevirtual

Releases a block of rows.

Parameters
[in]blockThe block of rows.

Implements DenseNumericTableIface.

services::Status releaseBlockOfRows ( BlockDescriptor< int > &  block)
inlinevirtual

Releases a block of rows.

Parameters
[in]blockThe block of rows.

Implements DenseNumericTableIface.

services::Status setArray ( const services::SharedPtr< T > &  ptr,
size_t  idx 
)
inline

Sets a pointer to an array of values for a given feature

Template Parameters
TType of feature values
Parameters
[in]ptrPointer to the array of the T type that stores feature values
[in]idxFeature index
services::Status setArray ( T *  ptr,
size_t  idx 
)
inline

Sets a pointer to an array of values for a given feature

Template Parameters
TType of feature values
Parameters
[in]ptrPointer to the array of the T type that stores feature values
[in]idxFeature index
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 NumericTable.


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

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