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

Public Types | List of all members
PackedTriangularMatrix< packedLayout, DataType > Class Template Reference

Class that provides methods to access a packed triangular matrix stored as a one-dimensional array. More...

Public Types

typedef DataType baseDataType
 
- 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

template<NumericTableIface::StorageLayout packedLayout, typename DataType = DAAL_DATA_TYPE>
class daal::data_management::interface1::PackedTriangularMatrix< packedLayout, DataType >

Template Parameters
DataTypeDefines the underlying data type that describes the packed triangular matrix

Member Typedef Documentation

typedef DataType baseDataType

Typedef that stores the data type used for template instantiation

Constructor & Destructor Documentation

PackedTriangularMatrix ( DataType *const  ptr = 0,
size_t  nDim = 0 
)
inline

Constructor for a Numeric Table with user-allocated memory

Parameters
[in]ptrPointer to and an array with a homogeneous data set
[in]nDimMatrix dimension
PackedTriangularMatrix ( const services::SharedPtr< DataType > &  ptr,
size_t  nDim 
)
inline

Constructor for a Numeric Table with user-allocated memory

Parameters
[in]ptrPointer to and an array with a homogeneous data set
[in]nDimMatrix dimension
PackedTriangularMatrix ( DataType *const  ptr,
size_t  nDim,
const DataType &  constValue 
)
inline

Constructor for a Numeric Table with user-allocated memory and filling the table with a constant

Parameters
[in]ptrPointer to and an array with a homogeneous data set
[in]nDimMatrix dimension
[in]constValueConstant to initialize entries of the packed symmetric matrix
PackedTriangularMatrix ( const services::SharedPtr< DataType > &  ptr,
size_t  nDim,
const DataType &  constValue 
)
inline

Constructor for a Numeric Table with user-allocated memory and filling the table with a constant

Parameters
[in]ptrPointer to and an array with a homogeneous data set
[in]nDimMatrix dimension
[in]constValueConstant to initialize entries of the packed symmetric matrix
PackedTriangularMatrix ( size_t  nDim,
AllocationFlag  memoryAllocationFlag 
)
inline

Constructor for a Numeric Table with memory allocation controlled via a flag

Parameters
[in]nDimMatrix dimension
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
PackedTriangularMatrix ( size_t  nDim,
NumericTable::AllocationFlag  memoryAllocationFlag,
const DataType &  constValue 
)
inline

Constructor for a Numeric Table with memory allocation controlled via a flag and filling the table with a constant

Parameters
[in]nDimMatrix dimension
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[in]constValueConstant to initialize entries of the packed symmetric matrix

Member Function Documentation

services::Status assign ( value)
inline

Fills a numeric table with a constant

Parameters
[in]valueConstant to initialize entries of the packed symmetric matrix
virtual services::Status assign ( float  value)
inlinevirtual

Fills a numeric table with a constant

Parameters
[in]valueConstant to initialize entries of the numeric table

Reimplemented from NumericTable.

virtual services::Status assign ( double  value)
inlinevirtual

Fills a numeric table with a constant

Parameters
[in]valueConstant to initialize entries of the numeric table

Reimplemented from NumericTable.

virtual services::Status assign ( int  value)
inlinevirtual

Fills a numeric table with a constant

Parameters
[in]valueConstant to initialize entries of the numeric table

Reimplemented from NumericTable.

DataType* getArray ( ) const
inline

Returns a pointer to a data set registered in the packed symmetric matrix

Returns
Pointer to the data set
services::SharedPtr<DataType> getArraySharedPtr ( ) const
inline

Returns a pointer to a data set registered in the packed symmetric matrix

Returns
Pointer to the data set
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 getPackedArray ( ReadWriteMode  rwflag,
BlockDescriptor< double > &  block 
)
inlinevirtual

Gets the whole packed array of a requested data type

Parameters
[in]rwflagFlag specifying read/write access to a block of feature vectors.
[out]blockThe block of feature values.
Returns
Actual number of feature vectors returned by the method.

Implements PackedArrayNumericTableIface.

services::Status getPackedArray ( ReadWriteMode  rwflag,
BlockDescriptor< float > &  block 
)
inlinevirtual

Gets the whole packed array of a requested data type

Parameters
[in]rwflagFlag specifying read/write access to a block of feature vectors.
[out]blockThe block of feature values.
Returns
Actual number of feature vectors returned by the method.

Implements PackedArrayNumericTableIface.

services::Status getPackedArray ( ReadWriteMode  rwflag,
BlockDescriptor< int > &  block 
)
inlinevirtual

Gets the whole packed array of a requested data type

Parameters
[in]rwflagFlag specifying read/write access to a block of feature vectors.
[out]blockThe block of feature values.
Returns
Actual number of feature vectors returned by the method.

Implements PackedArrayNumericTableIface.

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 releasePackedArray ( BlockDescriptor< double > &  block)
inlinevirtual

Releases a packed array

Parameters
[in]blockThe block of feature values.

Implements PackedArrayNumericTableIface.

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

Releases a packed array

Parameters
[in]blockThe block of feature values.

Implements PackedArrayNumericTableIface.

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

Releases a packed array

Parameters
[in]blockThe block of feature values.

Implements PackedArrayNumericTableIface.

services::Status setArray ( DataType *const  ptr)
inline

Sets a pointer to an array that stores a packed triangular matrix

Parameters
[in]ptrPointer to the array that stores the packed triangular matrix
services::Status setArray ( const services::SharedPtr< DataType > &  ptr)
inline

Sets a pointer to a packed array

Parameters
[in]ptrPointer to the data set in the packed format
virtual services::Status setNumberOfColumns ( size_t  ncol)
inlinevirtual

Sets the number of columns in the Numeric Table

Parameters
[in]ncolNumber of columns
Deprecated:
This item will be removed in a future release.

Reimplemented from NumericTable.

virtual services::Status setNumberOfRows ( size_t  nrow)
inlinevirtual

Sets the number of rows in the Numeric Table

Parameters
[in]nrowNumber of rows
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.