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

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

Class that provides methods to access a collection of numeric tables as if they are joined by columns. More...

Static Public Member Functions

static services::SharedPtr
< MergedNumericTable
create (services::Status *stat=NULL)
 
static services::SharedPtr
< MergedNumericTable
create (const NumericTablePtr &nestedTable, services::Status *stat=NULL)
 
static services::SharedPtr
< MergedNumericTable
create (const NumericTablePtr &first, const NumericTablePtr &second, 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

Constructor for an empty merge Numeric Table

Deprecated:
This item will be removed in a future release. Use MergedNumericTable::create instead.
MergedNumericTable ( NumericTablePtr  table)

Constructor for a merge Numeric Table consisting of one table

Parameters
[in]tablePointer to the table
Deprecated:
This item will be removed in a future release. Use MergedNumericTable::create instead.
MergedNumericTable ( NumericTablePtr  first,
NumericTablePtr  second 
)

Constructor for a merge Numeric Table consisting of two tables

Parameters
[in]firstPointer to the first table
[in]secondPointer to the second table
Deprecated:
This item will be removed in a future release. Use MergedNumericTable::create instead.

Member Function Documentation

services::Status addNumericTable ( NumericTablePtr  table)
inline

Adds the table to the right of the merge Numeric Table

Parameters
[in]tablePointer to the table
services::Status allocateBasicStatistics ( )
inlinevirtual

Allocates Numeric Tables for basic statistics

Reimplemented from NumericTable.

static services::SharedPtr<MergedNumericTable> create ( services::Status *  stat = NULL)
static

Constructor for an empty merge Numeric Table

Parameters
[out]statStatus of the MergedNumericTable construction
static services::SharedPtr<MergedNumericTable> create ( const NumericTablePtr &  nestedTable,
services::Status *  stat = NULL 
)
static

Constructs a merge Numeric Table consisting of one table

Parameters
[in]nestedTablePointer to the table
[out]statStatus of the MergedNumericTable construction
Returns
Merge Numeric Table of one table
static services::SharedPtr<MergedNumericTable> create ( const NumericTablePtr &  first,
const NumericTablePtr &  second,
services::Status *  stat = NULL 
)
static

Constructs a merge Numeric Table consisting of two tables

Parameters
[in]firstPointer to the first table
[in]secondPointer to the second table
[out]statStatus of the MergedNumericTable construction
Returns
Merge Numeric Table of two tables
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.

MemoryStatus getDataMemoryStatus ( ) const
inlinevirtual

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

Reimplemented from NumericTable.

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 resize ( size_t  nrows)
inlinevirtual

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

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.