mxnet
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Public Attributes | List of all members
mxnet::NDArrayFunctionReg Struct Reference

Registry entry for NDArrayFunction. More...

#include <ndarray.h>

Inheritance diagram for mxnet::NDArrayFunctionReg:
Inheritance graph
Collaboration diagram for mxnet::NDArrayFunctionReg:
Collaboration graph

Public Member Functions

 NDArrayFunctionReg ()
 constructor More...
 
NDArrayFunctionRegset_function (void(*fsetvalue)(const real_t &rhs, NDArray *out))
 set the function body to a NDArray setvalue function this will also auto set the parameters correctly More...
 
NDArrayFunctionRegset_function (void(*fternary)(const NDArray &lhs, const NDArray &mhs, const NDArray &rhs, NDArray *out))
 set the function body to a ternary NDArray function this will also auto set the parameters correctly More...
 
NDArrayFunctionRegset_function (void(*fbinary)(const NDArray &lhs, const NDArray &rhs, NDArray *out))
 set the function body to a binary NDArray function this will also auto set the parameters correctly More...
 
NDArrayFunctionRegset_function (void(*fscalar)(const NDArray &lhs, const real_t &rhs, NDArray *out))
 set the function body to a binary NDArray function this will also auto set the parameters correctly More...
 
NDArrayFunctionRegset_function (void(*funary)(const NDArray &src, NDArray *out))
 set the function body to a unary NDArray function this will also auto set the parameters correctly More...
 
NDArrayFunctionRegset_function (void(*fgeneric)(NDArray **used_vars, real_t *s, NDArray **mutate_vars, const std::map< std::string, std::string > &param))
 set the function body to a unary NDArray function this will also auto set the parameters correctly More...
 
NDArrayFunctionRegset_num_use_vars (unsigned n)
 set the number of mutate variables More...
 
NDArrayFunctionRegset_num_mutate_vars (unsigned n)
 set the number of mutate variables More...
 
NDArrayFunctionRegset_num_scalars (unsigned n)
 set the number of scalar arguments More...
 
NDArrayFunctionRegset_type_mask (int tmask)
 set type mask More...
 

Public Attributes

unsigned num_use_vars
 number of variable used by this function More...
 
unsigned num_mutate_vars
 number of variable mutated by this function More...
 
unsigned num_scalars
 number of scalars used by this function More...
 
int type_mask
 information on how function should be called from API More...
 

Detailed Description

Registry entry for NDArrayFunction.

Constructor & Destructor Documentation

mxnet::NDArrayFunctionReg::NDArrayFunctionReg ( )
inline

constructor

Member Function Documentation

NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_function ( void(*)(const real_t &rhs, NDArray *out)  fsetvalue)
inline

set the function body to a NDArray setvalue function this will also auto set the parameters correctly

Parameters
fsetvaluefunction body to set
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_function ( void(*)(const NDArray &lhs, const NDArray &mhs, const NDArray &rhs, NDArray *out)  fternary)
inline

set the function body to a ternary NDArray function this will also auto set the parameters correctly

Parameters
fternaryfunction body to set
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_function ( void(*)(const NDArray &lhs, const NDArray &rhs, NDArray *out)  fbinary)
inline

set the function body to a binary NDArray function this will also auto set the parameters correctly

Parameters
fbinaryfunction body to set
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_function ( void(*)(const NDArray &lhs, const real_t &rhs, NDArray *out)  fscalar)
inline

set the function body to a binary NDArray function this will also auto set the parameters correctly

Parameters
fscalarfunction body to set
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_function ( void(*)(const NDArray &src, NDArray *out)  funary)
inline

set the function body to a unary NDArray function this will also auto set the parameters correctly

Parameters
funaryfunction body to set
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_function ( void(*)(NDArray **used_vars, real_t *s, NDArray **mutate_vars, const std::map< std::string, std::string > &param)  fgeneric)
inline

set the function body to a unary NDArray function this will also auto set the parameters correctly

Parameters
fgenericfunction body to set
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_num_mutate_vars ( unsigned  n)
inline

set the number of mutate variables

Parameters
nnumber of mutate variablesx
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_num_scalars ( unsigned  n)
inline

set the number of scalar arguments

Parameters
nnumber of scalar arguments
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_num_use_vars ( unsigned  n)
inline

set the number of mutate variables

Parameters
nnumber of mutate variablesx
Returns
ref to the registered entry, used to set properties
NDArrayFunctionReg& mxnet::NDArrayFunctionReg::set_type_mask ( int  tmask)
inline

set type mask

Parameters
tmasktypemask
Returns
ref to the registered entry, used to set properties

Member Data Documentation

unsigned mxnet::NDArrayFunctionReg::num_mutate_vars

number of variable mutated by this function

unsigned mxnet::NDArrayFunctionReg::num_scalars

number of scalars used by this function

unsigned mxnet::NDArrayFunctionReg::num_use_vars

number of variable used by this function

int mxnet::NDArrayFunctionReg::type_mask

information on how function should be called from API


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