A PackedFunc wrapper to provide typed function signature. It is backed by a PackedFunc internally. More...

#include <packed_func.h>

Collaboration diagram for mxnet::runtime::TypedPackedFunc< R(Args...)>:

Public Types
using	TSelf = TypedPackedFunc< R(Args...)>
	short hand for this function type More...

Public Member Functions
	TypedPackedFunc ()
	default constructor More...

	TypedPackedFunc (std::nullptr_t null)
	constructor from null More...

	TypedPackedFunc (PackedFunc packed)
	construct by wrap a PackedFunc More...

	TypedPackedFunc (const MXNetRetValue &value)
	constructor from MXNetRetValue More...

	TypedPackedFunc (const MXNetArgValue &value)
	constructor from MXNetArgValue More...

template<typename FLambda , typename = typename std::enable_if< std::is_convertible<FLambda, std::function<R(Args...)> >::value>::type>
	TypedPackedFunc (const FLambda &typed_lambda)
	construct from a lambda function with the same signature. More...

template<typename FLambda , typename = typename std::enable_if< std::is_convertible<FLambda, std::function<R(Args...)> >::value>::type>
TSelf &	operator= (FLambda typed_lambda)
	copy assignment operator from typed lambda More...

TSelf &	operator= (PackedFunc packed)
	copy assignment operator from PackedFunc. More...

R	operator() (Args...args) const
	Invoke the operator. More...

	operator PackedFunc () const
	convert to PackedFunc More...

const PackedFunc &	packed () const

bool	operator== (std::nullptr_t null) const

bool	operator!= (std::nullptr_t null) const

template<typename FType >
void	AssignTypedLambda (FType flambda)

Friends
class	MXNetRetValue

Detailed Description

template<typename R, typename... Args>
class mxnet::runtime::TypedPackedFunc< R(Args...)>

A PackedFunc wrapper to provide typed function signature. It is backed by a PackedFunc internally.

TypedPackedFunc enables compile time type checking. TypedPackedFunc works with the runtime system:

It can be passed as an argument of PackedFunc.
It can be assigned to MXNetRetValue.
It can be directly converted to a type-erased PackedFunc.

Developers should prefer TypedPackedFunc over PackedFunc in C++ code as it enables compile time checking. We can construct a TypedPackedFunc from a lambda function with the same signature.

// user defined lambda function.
auto addone = [](int x)->int {
  return x + 1;
};
// We can directly convert
// lambda function to TypedPackedFunc
TypedPackedFunc<int(int)> ftyped(addone);
// invoke the function.
int y = ftyped(1);
// Can be directly converted to PackedFunc
PackedFunc packed = ftype;

Template Parameters

R	The return value of the function.
Args	The argument signature of the function.

Member Typedef Documentation

template<typename R , typename... Args>

using mxnet::runtime::TypedPackedFunc< R(Args...)>::TSelf = TypedPackedFunc<R(Args...)>

short hand for this function type

Constructor & Destructor Documentation

template<typename R , typename... Args>

mxnet::runtime::TypedPackedFunc< R(Args...)>::TypedPackedFunc ( )

inline

default constructor

template<typename R , typename... Args>

mxnet::runtime::TypedPackedFunc< R(Args...)>::TypedPackedFunc ( std::nullptr_t null )

inline

constructor from null

template<typename R , typename... Args>

mxnet::runtime::TypedPackedFunc< R(Args...)>::TypedPackedFunc ( PackedFunc packed )

inline

construct by wrap a PackedFunc

Example usage:

PackedFunc packed([](MXNetArgs args, MXNetRetValue *rv) {
  int x = args[0];
  *rv = x + 1;
 });
// construct from packed function
TypedPackedFunc<int(int)> ftyped(packed);
// call the typed version.
CHECK_EQ(ftyped(1), 2);

Parameters

packed The packed function

template<typename R , typename... Args>

mxnet::runtime::TypedPackedFunc< R(Args...)>::TypedPackedFunc ( const MXNetRetValue & value )

inline

constructor from MXNetRetValue

Parameters

value The MXNetRetValue

template<typename R , typename... Args>

mxnet::runtime::TypedPackedFunc< R(Args...)>::TypedPackedFunc ( const MXNetArgValue & value )

inline

constructor from MXNetArgValue

Parameters

value The MXNetArgValue

template<typename R , typename... Args>

template<typename FLambda , typename = typename std::enable_if< std::is_convertible<FLambda, std::function<R(Args...)> >::value>::type>

mxnet::runtime::TypedPackedFunc< R(Args...)>::TypedPackedFunc ( const FLambda & typed_lambda )

inline

construct from a lambda function with the same signature.

Example usage:

auto typed_lambda = [](int x)->int { return x + 1; }
// construct from packed function
TypedPackedFunc<int(int)> ftyped(typed_lambda);
// call the typed version.
CHECK_EQ(ftyped(1), 2);

Parameters

typed_lambda typed lambda function.

Template Parameters

FLambda the type of the lambda function.

Member Function Documentation

template<typename R , typename... Args>

template<typename FType >

void mxnet::runtime::TypedPackedFunc< R(Args...)>::AssignTypedLambda ( FType flambda )

inline

template<typename R , typename... Args>

mxnet::runtime::TypedPackedFunc< R(Args...)>::operator PackedFunc ( ) const

inline

convert to PackedFunc

Returns: the internal PackedFunc

template<typename R , typename... Args>

bool mxnet::runtime::TypedPackedFunc< R(Args...)>::operator!= ( std::nullptr_t null ) const

inline

Returns: Whether the packed function is not nullptr

template<typename R , typename... Args>

R mxnet::runtime::TypedPackedFunc< R(Args...)>::operator() ( Args... args ) const

inline

Invoke the operator.

Parameters

args	The arguments

Returns: The return value.

template<typename R , typename... Args>

template<typename FLambda , typename = typename std::enable_if< std::is_convertible<FLambda, std::function<R(Args...)> >::value>::type>

TSelf& mxnet::runtime::TypedPackedFunc< R(Args...)>::operator= ( FLambda typed_lambda )

inline

copy assignment operator from typed lambda

Example usage:

// construct from packed function
TypedPackedFunc<int(int)> ftyped;
ftyped = [](int x) { return x + 1; }
// call the typed version.
CHECK_EQ(ftyped(1), 2);

Parameters

typed_lambda typed lambda function.

Template Parameters

FLambda the type of the lambda function.

Returns: reference to self.

template<typename R , typename... Args>

TSelf& mxnet::runtime::TypedPackedFunc< R(Args...)>::operator= ( PackedFunc packed )

inline

copy assignment operator from PackedFunc.

Parameters

packed The packed function.

Returns: reference to self.

template<typename R , typename... Args>

bool mxnet::runtime::TypedPackedFunc< R(Args...)>::operator== ( std::nullptr_t null ) const

inline

Returns: Whether the packed function is nullptr

template<typename R , typename... Args>

const PackedFunc& mxnet::runtime::TypedPackedFunc< R(Args...)>::packed ( ) const

inline

Returns: reference the internal PackedFunc

Friends And Related Function Documentation

template<typename R , typename... Args>

friend class MXNetRetValue

friend

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

/work/mxnet/include/mxnet/runtime/packed_func.h

Public Types

Public Member Functions

Friends

Detailed Description

template<typename R, typename... Args> class mxnet::runtime::TypedPackedFunc< R(Args...)>

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename R, typename... Args>
class mxnet::runtime::TypedPackedFunc< R(Args...)>