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

List of all members
InputDataArchive Class Reference

Provides methods to create an archive data object (serialized) and access this object. More...

Class Declaration

Constructor & Destructor Documentation

InputDataArchive ( )
inline

Default constructor

InputDataArchive ( DataArchiveIface arch)
inline

Constructor of an input data archive from a DataArchiveIface The new InputDataArchive object will own the provided pointer and free it when it gets deleted.

InputDataArchive ( daal::data_management::CompressorImpl *  compressor)
inline

Constructor of an input data archive to a byte array of compressed data

Member Function Documentation

void archiveFooter ( )
inline

Generates a footer for a data archive

void archiveHeader ( )
inline

Generates a header for a data archive

size_t copyArchiveToArray ( byte *  ptr,
size_t  maxLength 
)
inline

Copies a data archive in the byte format to user-specified memory

Parameters
[in]ptrPointer to the byte array
[in]maxLengthSize of the array
Returns
Actual size of the data archive in bytes
DAAL_DEPRECATED byte* getArchiveAsArray ( )
inline

Returns a data archive in the byte format

Returns
Pointer to the byte buffer with the archive data
Deprecated:
This item will be removed in a future release.
DAAL_DEPRECATED void getArchiveAsArray ( const byte **  ptr,
size_t *  size 
)
inline

Returns a data archive in the byte format

Parameters
[in]ptrPointer to the byte buffer with the archive data
[in]sizePointer to the size of the array
Deprecated:
This item will be removed in a future release.
services::SharedPtr<byte> getArchiveAsArraySharedPtr ( )
inline

Returns a data archive in the byte format

Returns
Pointer to the byte buffer with the archive data
DAAL_DEPRECATED std::string getArchiveAsString ( )
inline

Returns a data archive in the STL string format

Returns
Object of the std::string type with the archive data
Deprecated:
This item will be removed in a future release.
const DataArchive& getDataArchive ( )
inline

Returns a data archive object of the InputDataArchive type

Returns
Data archive object
services::SharedPtr<services::ErrorCollection> getErrors ( )
inline

Returns errors during the computation

Returns
Errors during the computation
size_t getSizeOfArchive ( )
inline

Returns the size of an archive

Returns
Size of the archive in bytes
void segmentFooter ( )
inline

Generates a footer for a segment in the DataArchive object

void segmentHeader ( int  tag = 0)
inline

Generates a header for a segment in the DataArchive object

void set ( T &  val)
inline

Performs data serialization of one value of the basic datatype

Template Parameters
Tbasic datatype
Parameters
[in]valReference to the data to serialize
void set ( daal::services::Collection< T > &  val)
inline

Performs data serialization of Collection of the basic datatype

Template Parameters
Tbasic datatype
Parameters
[in]valReference to the data to serialize
void set ( T *  ptr,
size_t  size 
)
inline

Performs data serialization of an array of values of the basic datatype

Template Parameters
TBasic datatype
Parameters
[in]ptrPointer to the array of data to convert to the serialized format
[in]sizeSize of the array pointed to by ptr
void setObj ( T *  ptr,
size_t  size = 1 
)
inline

Performs data serialization creating a data segment

Template Parameters
TClass that implements SerializationIface
Parameters
[in]ptrPointer to an array of data to convert to the serialized format
[in]sizeSize of the array pointed to by ptr
void setSharedPtrObj ( services::SharedPtr< T > &  obj)
inline

Performs data serialization creating a data segment

Parameters
[in]objSerializable object
void setSingleObj ( SerializationIface **  ptr)
inline

Performs data serialization creating a data segment

Parameters
[in]ptrPointer to the serializable object

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

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