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

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

Class that provides methods to access data stored as a contiguous array of heterogeneous feature vectors, while each feature vector is represented by a data structure. Therefore, the data is represented as an array of structures. More...

Static Public Member Functions

static services::SharedPtr
< AOSNumericTable
create (size_t structSize=0, size_t ncol=0, size_t nrow=0, services::Status *stat=NULL)
 
template<typename StructDataType >
static services::SharedPtr
< AOSNumericTable
create (const services::SharedPtr< StructDataType > &ptr, size_t ncol, size_t nrow=0, services::Status *stat=NULL)
 
template<typename StructDataType >
static services::SharedPtr
< AOSNumericTable
create (StructDataType *ptr, size_t ncol, size_t nrow=0, 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

AOSNumericTable ( size_t  structSize = 0,
size_t  ncol = 0,
size_t  nrow = 0 
)

Constructor for an empty Numeric Table with a predefined size of the structure that represents a feature vector

Parameters
[in]structSizeSize of the structure that represents the feature vector
[in]ncolNumber of columns in the table
[in]nrowNumber of rows in the table
Deprecated:
This item will be removed in a future release. Use AOSNumericTable::create instead.
AOSNumericTable ( const services::SharedPtr< StructDataType > &  ptr,
size_t  ncol,
size_t  nrow = 0 
)
inline

Constructor for a Numeric Table with user-allocated memory

Parameters
[in]ptrPointer to a data set in the AOS format
[in]ncolNumber of columns in the table
[in]nrowNumber of rows in the table
Deprecated:
This item will be removed in a future release. Use AOSNumericTable::create instead.
AOSNumericTable ( StructDataType *  ptr,
size_t  ncol,
size_t  nrow = 0 
)
inline

Constructor for a Numeric Table with user-allocated memory

Parameters
[in]ptrPointer to a data set in the AOS format
[in]ncolNumber of columns in the table
[in]nrowNumber of rows in the table
Deprecated:
This item will be removed in a future release. Use AOSNumericTable::create instead.

Member Function Documentation

static services::SharedPtr<AOSNumericTable> create ( size_t  structSize = 0,
size_t  ncol = 0,
size_t  nrow = 0,
services::Status *  stat = NULL 
)
static

Constructs an empty Numeric Table with a predefined size of the structure that represents a feature vector

Parameters
[in]structSizeSize of the structure that represents the feature vector
[in]ncolNumber of columns in the table
[in]nrowNumber of rows in the table
[out]statStatus of the table construction
Returns
Empty numeric table with a predefined size of the structure that represents a feature vector
static services::SharedPtr<AOSNumericTable> create ( const services::SharedPtr< StructDataType > &  ptr,
size_t  ncol,
size_t  nrow = 0,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a Numeric Table with user-allocated memory

Parameters
[in]ptrPointer to a data set in the AOS format
[in]ncolNumber of columns in the table
[in]nrowNumber of rows in the table
[out]statStatus of the table construction
Returns
Numeric table with user-allocated memory
static services::SharedPtr<AOSNumericTable> create ( StructDataType *  ptr,
size_t  ncol,
size_t  nrow = 0,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a Numeric Table with user-allocated memory

Parameters
[in]ptrPointer to a data set in the AOS format
[in]ncolNumber of columns in the table
[in]nrowNumber of rows in the table
[out]statStatus of the table construction
Returns
Numeric table with user-allocated memory
void* getArray ( )
inline

Returns a pointer to an array of structures in a Numeric Table

Returns
Pointer to a data set in the AOS format
const void* getArray ( ) const
inline

Returns a pointer to an array of structures in a Numeric Table

Returns
Pointer to a data set in the AOS format
services::SharedPtr<byte> getArraySharedPtr ( )
inline

Returns a pointer to an array of structures in a Numeric Table

Returns
Pointer to a data set in the AOS format
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 ( void *const  ptr,
size_t  obsnum = 0 
)
inline

Sets a pointer to an array of structures in a Numeric Table

Parameters
[in]ptrPointer to a data set in the AOS format
[in]obsnumNumber of rows in the table
services::Status setArray ( const services::SharedPtr< byte > &  ptr,
size_t  obsnum = 0 
)
inline

Sets a pointer to an array of structures in a Numeric Table

Parameters
[in]ptrPointer to a data set in the AOS format
[in]obsnumNumber of rows in the table
services::Status setFeature ( size_t  idx,
size_t  offset,
features::FeatureType  featureType = features::DAAL_CONTINUOUS,
size_t  categoryNumber = 0 
)
inline

Sets a feature in an AOS Numeric Table

Template Parameters
TType of feature values
Parameters
[in]idxFeature index
[in]offsetFeature offset in the structure representing the feature vector
[in]featureTypeFeature type
[in]categoryNumberNumber of categories for categorical features
void setOffset ( size_t  idx,
size_t  offset 
)
inline

Sets an offset in an AOS Numeric Table

Parameters
[in]idxFeature index
[in]offsetFeature offset in the structure representing the feature vector

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

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