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

Static Public Member Functions | List of all members
Matrix< DataType > Class Template Reference

Represents a two-dimensional table of numbers of the same type. More...

Static Public Member Functions

static services::SharedPtr
< Matrix< DataType > > 
create (size_t nColumns=0, size_t nRows=0, DataType *const ptr=0, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (size_t nColumns, size_t nRows, services::SharedPtr< DataType > &ptr, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns=0, size_t nRows=0, DataType *const ptr=0, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns, size_t nRows, const services::SharedPtr< DataType > &ptr, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (size_t nColumns, size_t nRows, NumericTable::AllocationFlag memoryAllocationFlag, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns, size_t nRows, NumericTable::AllocationFlag memoryAllocationFlag, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (size_t nColumns, size_t nRows, DataType *const ptr, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (size_t nColumns, size_t nRows, const services::SharedPtr< DataType > &ptr, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns, size_t nRows, DataType *const ptr, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns, size_t nRows, const services::SharedPtr< DataType > &ptr, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (size_t nColumns, size_t nRows, NumericTable::AllocationFlag memoryAllocationFlag, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< Matrix< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns, size_t nRows, NumericTable::AllocationFlag memoryAllocationFlag, const DataType &constValue, services::Status *stat=NULL)
 
- Static Public Member Functions inherited from HomogenNumericTable< DataType >
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (NumericTableDictionaryPtr ddictForHomogenNumericTable, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DataType *const ptr, size_t nColumns=0, size_t nRows=0, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (const services::SharedPtr< DataType > &ptr, size_t nColumns, size_t nRows, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, DataType *const ptr=0, size_t nColumns=0, size_t nRows=0, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, const services::SharedPtr< DataType > &ptr, size_t nColumns, size_t nRows, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DataType *const ptr, size_t nColumns, size_t nRows, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (const services::SharedPtr< DataType > &ptr, size_t nColumns, size_t nRows, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, DataType *const ptr, size_t nColumns, size_t nRows, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, const services::SharedPtr< DataType > &ptr, size_t nColumns, size_t nRows, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (size_t nColumns, size_t nRows, AllocationFlag memoryAllocationFlag, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns, size_t nRows, AllocationFlag memoryAllocationFlag, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (size_t nColumns, size_t nRows, AllocationFlag memoryAllocationFlag, const DataType &constValue, services::Status *stat=NULL)
 
static services::SharedPtr
< HomogenNumericTable
< DataType > > 
create (DictionaryIface::FeaturesEqual featuresEqual, size_t nColumns, size_t nRows, AllocationFlag memoryAllocationFlag, const DataType &constValue, services::Status *stat=NULL)
 

Additional Inherited Members

- Public Types inherited from HomogenNumericTable< DataType >
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<typename DataType = DAAL_DATA_TYPE>
class daal::data_management::interface1::Matrix< DataType >

Template Parameters
DataTypeDefines the underlying data type that describes the matrix

Constructor & Destructor Documentation

Matrix ( size_t  nColumns = 0,
size_t  nRows = 0,
DataType *const  ptr = 0 
)
inline

Constructor for a matrix

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
Matrix ( size_t  nColumns,
size_t  nRows,
const services::SharedPtr< DataType > &  ptr 
)
inline

Constructor for a matrix

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
Deprecated:
This item will be removed in a future release. Use Matrix::create instead.
Matrix ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns = 0,
size_t  nRows = 0,
DataType *const  ptr = 0 
)
inline

Constructor for a matrix

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
Matrix ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
const services::SharedPtr< DataType > &  ptr 
)
inline

Constructor for a matrix

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
Matrix ( size_t  nColumns,
size_t  nRows,
NumericTable::AllocationFlag  memoryAllocationFlag 
)
inline

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

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
Matrix ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
NumericTable::AllocationFlag  memoryAllocationFlag 
)
inline

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

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
Matrix ( size_t  nColumns,
size_t  nRows,
DataType *const  ptr,
const DataType &  constValue 
)
inline

Constructor for a matrix. Fills the table with a constant

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
Matrix ( size_t  nColumns,
size_t  nRows,
const services::SharedPtr< DataType > &  ptr,
const DataType &  constValue 
)
inline

Constructor for a matrix. Fills the table with a constant

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
Matrix ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
DataType *const  ptr,
const DataType &  constValue 
)
inline

Constructor for a matrix. Fills the table with a constant

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
Matrix ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
const services::SharedPtr< DataType > &  ptr,
const DataType &  constValue 
)
inline

Constructor for a matrix. Fills the table with a constant

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
Matrix ( size_t  nColumns,
size_t  nRows,
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]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[in]constValueConstant to initialize entries of the homogeneous numeric table
Matrix ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
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]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[in]constValueConstant to initialize entries of the homogeneous numeric table

Member Function Documentation

static services::SharedPtr<Matrix<DataType> > create ( size_t  nColumns = 0,
size_t  nRows = 0,
DataType *const  ptr = 0,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[out]statStatus of the matrix construction
Returns
Matrix
static services::SharedPtr<Matrix<DataType> > create ( size_t  nColumns,
size_t  nRows,
services::SharedPtr< DataType > &  ptr,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[out]statStatus of the matrix construction
Returns
Matrix
static services::SharedPtr<Matrix<DataType> > create ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns = 0,
size_t  nRows = 0,
DataType *const  ptr = 0,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[out]statStatus of the matrix construction
Returns
Matrix
static services::SharedPtr<Matrix<DataType> > create ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
const services::SharedPtr< DataType > &  ptr,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[out]statStatus of the matrix construction
Returns
Matrix
static services::SharedPtr<Matrix<DataType> > create ( size_t  nColumns,
size_t  nRows,
NumericTable::AllocationFlag  memoryAllocationFlag,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix with memory allocation controlled via a flag

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[out]statStatus of the matrix construction
Returns
Matrix
static services::SharedPtr<Matrix<DataType> > create ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
NumericTable::AllocationFlag  memoryAllocationFlag,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix with memory allocation controlled via a flag

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[out]statStatus of the matrix construction
Returns
Matrix
static services::SharedPtr<Matrix<DataType> > create ( size_t  nColumns,
size_t  nRows,
DataType *const  ptr,
const DataType &  constValue,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix and fills it with a constant

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
[out]statStatus of the matrix construction
Returns
Matrix initialized with a constant
static services::SharedPtr<Matrix<DataType> > create ( size_t  nColumns,
size_t  nRows,
const services::SharedPtr< DataType > &  ptr,
const DataType &  constValue,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix and fills it with a constant

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
[out]statStatus of the matrix construction
Returns
Matrix initialized with a constant
static services::SharedPtr<Matrix<DataType> > create ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
DataType *const  ptr,
const DataType &  constValue,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix and fills it with a constant

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
[out]statStatus of the matrix construction
Returns
Matrix initialized with a constant
static services::SharedPtr<Matrix<DataType> > create ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
const services::SharedPtr< DataType > &  ptr,
const DataType &  constValue,
services::Status *  stat = NULL 
)
inlinestatic

Constructs a matrix and fills it with a constant

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]ptrPointer to and an array with a homogeneous data set
[in]constValueConstant to initialize entries of the homogeneous numeric table
[out]statStatus of the matrix construction
Returns
Matrix initialized with a constant
static services::SharedPtr<Matrix<DataType> > create ( size_t  nColumns,
size_t  nRows,
NumericTable::AllocationFlag  memoryAllocationFlag,
const DataType &  constValue,
services::Status *  stat = NULL 
)
inlinestatic

Constructor for a matrix with memory allocation controlled via a flag and filling the matrix with a constant

Parameters
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[in]constValueConstant to initialize entries of the homogeneous numeric table
[out]statStatus of the matrix construction
Returns
Matrix initialized with a constant
static services::SharedPtr<Matrix<DataType> > create ( DictionaryIface::FeaturesEqual  featuresEqual,
size_t  nColumns,
size_t  nRows,
NumericTable::AllocationFlag  memoryAllocationFlag,
const DataType &  constValue,
services::Status *  stat = NULL 
)
inlinestatic

Constructor for a matrix with memory allocation controlled via a flag and filling the matrix with a constant

Parameters
[in]featuresEqualFlag that makes all features in the Numeric Table Data Dictionary equal
[in]nColumnsNumber of columns in the table
[in]nRowsNumber of rows in the table
[in]memoryAllocationFlagFlag that controls internal memory allocation for data in the numeric table
[in]constValueConstant to initialize entries of the homogeneous numeric table
[out]statStatus of the matrix construction
Returns
Matrix initialized with a constant

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

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