DiCE API nvidia_logo_transpbg.gif Up
DiCE Interfaces

DiCE API for implementing distributed parallel computing algorithms. More...

Classes

class  mi::neuraylib::ITag_set
 Used to store a set of tags. More...
 
class  mi::neuraylib::IScheduler
 The scheduler allows to execute fragmented jobs. More...
 
class  mi::neuraylib::IElement
 This interface represents the abstract base class for all database elements. More...
 
class  mi::neuraylib::IJob
 This interface represents the base class for all database jobs. More...
 
class  mi::neuraylib::IExecution_listener
 A callback interface used for asynchronous execution of fragmented jobs. More...
 
class  mi::neuraylib::IFragmented_job
 This interface represents the base class for all fragmented jobs. More...
 
class  mi::neuraylib::Base< id1, ... >
 This mixin class can be used to implement the mi::base::IInterface interface. More...
 
class  mi::neuraylib::Element< id1, ... >
 This mixin class can be used to implement the mi::neuraylib::IElement interface. More...
 
class  mi::neuraylib::Job< id1, ... >
 This mixin class can be used to implement the mi::neuraylib::IJob interface. More...
 
class  mi::neuraylib::Fragmented_job< id1, ... >
 This mixin class can be used to implement the mi::neuraylib::IFragmented_job interface. More...
 
class  mi::neuraylib::IDeserializer
 Source for deserializing objects from byte streams. More...
 
class  mi::neuraylib::IObject_receiver
 The object receiver is responsible for creation and destruction of objects on the remote host. More...
 
class  mi::neuraylib::IDistributed_cache
 The distributed cache service can be used to create temporary objects in a cluster. More...
 
class  mi::neuraylib::IRDMA_buffer
 An RDMA buffer represents a piece of pinned memory which can be used to transfer data over RDMA. More...
 
class  mi::neuraylib::IRDMA_context
 The RDMA context works as a cache for RDMA buffers. More...
 
struct  mi::neuraylib::Tag_struct
 A tag represents a unique identifier for database elements in the database. More...
 
class  mi::neuraylib::Tag
 A tag represents a unique identifier for database elements in the database. More...
 
class  mi::neuraylib::ISerializable
 All serializable objects have to be derived from this interface. More...
 
class  mi::neuraylib::ISerializer
 Target for serializing objects to byte streams. More...
 
class  mi::neuraylib::IJob_execution_context
 Provides information about the context in which a job is executed. More...
 

Macros

#define MI_NEURAYLIB_DICE_VERSION_MAJOR   3
 DiCE API major product version number. More...
 
#define MI_NEURAYLIB_DICE_VERSION_MINOR   0
 DiCE API minor product version number. More...
 
#define MI_NEURAYLIB_DICE_VERSION_QUALIFIER   ""
 DiCE API product version qualifier, which is something like "alpha1", "beta2", or the empty string "", in which case the macro MI_NEURAYLIB_DICE_VERSION_QUALIFIER_EMPTY is defined as well. More...
 
#define MI_NEURAYLIB_DICE_PRODUCT_VERSION_STRING   "2023"
 DiCE product version number in a string representation, such as "2016". More...
 

Typedefs

typedef Uint8 mi::neuraylib::Privacy_level
 The privacy level is an unsigned 8 bit integer. More...
 

Functions

bool mi::neuraylib::operator== (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is equal to rhs. More...
 
bool mi::neuraylib::operator!= (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is not equal to rhs. More...
 
bool mi::neuraylib::operator< (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is less than rhs. More...
 
bool mi::neuraylib::operator> (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is greater than rhs. More...
 
bool mi::neuraylib::operator<= (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is less than or equal to rhs. More...
 
bool mi::neuraylib::operator>= (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is greater than or equal to rhs. More...
 

Variables

const Tag mi::neuraylib::NULL_TAG
 This value of the tag represents an invalid tag which can not be accessed. More...
 

Detailed Description

DiCE API for implementing distributed parallel computing algorithms.

The DiCE API represents a C++-based application programming interface that provides a framework for implementing parallel computing algorithms that are distributed in a cluster environment. The DiCE API provides an interface to the DiCE distributed database; it provides means for creating database elements and storing them in the distributed database and for accessing and changing elements of the distributed database.

Furthermore, it provides mechanisms for implementing and distributing computing units called jobs. Jobs enable parallelizing computing tasks on a local machine or in a cluster environment.

Macro Definition Documentation

 MI_NEURAYLIB_DICE_PRODUCT_VERSION_STRING

#define MI_NEURAYLIB_DICE_PRODUCT_VERSION_STRING   "2023"

DiCE product version number in a string representation, such as "2016".

 MI_NEURAYLIB_DICE_VERSION_MAJOR

#define MI_NEURAYLIB_DICE_VERSION_MAJOR   3

DiCE API major product version number.

 MI_NEURAYLIB_DICE_VERSION_MINOR

#define MI_NEURAYLIB_DICE_VERSION_MINOR   0

DiCE API minor product version number.

 MI_NEURAYLIB_DICE_VERSION_QUALIFIER

#define MI_NEURAYLIB_DICE_VERSION_QUALIFIER   ""

DiCE API product version qualifier, which is something like "alpha1", "beta2", or the empty string "", in which case the macro MI_NEURAYLIB_DICE_VERSION_QUALIFIER_EMPTY is defined as well.

Typedef Documentation

 Privacy_level

The privacy level is an unsigned 8 bit integer.

The privacy level is an integer in the range from 0 to 255. The privacy level 0 is used to identify the global scope. Thus the higher the privacy level is, the more private the corresponding scope.

Function Documentation

 operator!=()

bool mi::neuraylib::operator!= ( const Tag lhs,
const Tag rhs 
)
inline

Returns true if lhs is not equal to rhs.

 operator<()

bool mi::neuraylib::operator< ( const Tag lhs,
const Tag rhs 
)
inline

Returns true if lhs is less than rhs.

 operator<=()

bool mi::neuraylib::operator<= ( const Tag lhs,
const Tag rhs 
)
inline

Returns true if lhs is less than or equal to rhs.

 operator==()

bool mi::neuraylib::operator== ( const Tag lhs,
const Tag rhs 
)
inline

Returns true if lhs is equal to rhs.

 operator>()

bool mi::neuraylib::operator> ( const Tag lhs,
const Tag rhs 
)
inline

Returns true if lhs is greater than rhs.

 operator>=()

bool mi::neuraylib::operator>= ( const Tag lhs,
const Tag rhs 
)
inline

Returns true if lhs is greater than or equal to rhs.

Variable Documentation

 NULL_TAG

const Tag mi::neuraylib::NULL_TAG

This value of the tag represents an invalid tag which can not be accessed.