mxnet::cpp::Operator Class Reference

Operator interface. More...

#include <operator.h>

Collaboration diagram for mxnet::cpp::Operator:

Public Member Functions
	Operator (const std::string &operator_name)
	Operator constructor. More...
Operator &	operator= (const Operator &rhs)
template<typename T >
Operator &	SetParam (const std::string &name, const T &value)
	set config parameters More...
template<typename T >
Operator &	SetParam (int pos, const T &value)
	set config parameters from positional inputs More...
Operator &	SetInput (const std::string &name, Symbol symbol)
	add an input symbol More...
template<int N = 0>
void	PushInput (const Symbol &symbol)
	add an input symbol More...
Operator &	operator() ()
	add input symbols More...
Operator &	operator() (const Symbol &symbol)
	add input symbols More...
Operator &	operator() (const std::vector< Symbol > &symbols)
	add a list of input symbols More...
Symbol	CreateSymbol (const std::string &name="")
	create a Symbol from the current operator More...
Operator &	SetInput (const std::string &name, NDArray ndarray)
	add an input ndarray More...
template<int N = 0>
Operator &	PushInput (const NDArray &ndarray)
	add an input ndarray More...
template<class T , class... Args, int N = 0>
Operator &	PushInput (const T &t, Args...args)
	add positional inputs More...
template<class T , int N = 0>
Operator &	PushInput (const T &t)
	add the last positional input More...
Operator &	operator() (const NDArray &ndarray)
	add input ndarrays More...
Operator &	operator() (const std::vector< NDArray > &ndarrays)
	add a list of input ndarrays More...
template<typename... Args>
Operator &	operator() (Args...args)
	add input ndarrays More...
std::vector< NDArray >	Invoke ()
void	Invoke (NDArray &output)
void	Invoke (std::vector< NDArray > &outputs)

Detailed Description

Operator interface.

Constructor & Destructor Documentation

mxnet::cpp::Operator::Operator ( const std::string &  operator_name )

explicit

Operator constructor.

Parameters

operator_name

type of the operator

Member Function Documentation

Symbol mxnet::cpp::Operator::CreateSymbol

(

const std::string &

name = ""

)

create a Symbol from the current operator

Parameters

name	the name of the operator

Returns

the operator Symbol

std::vector<NDArray> mxnet::cpp::Operator::Invoke

(

)

void mxnet::cpp::Operator::Invoke

(

NDArray &

output

)

void mxnet::cpp::Operator::Invoke

(

std::vector< NDArray > &

outputs

)

Operator& mxnet::cpp::Operator::operator() ( )

inline

add input symbols

Returns

reference of self

Operator& mxnet::cpp::Operator::operator() ( const Symbol &  symbol )

inline

add input symbols

Parameters

symbol

the input symbol

Returns

reference of self

Operator& mxnet::cpp::Operator::operator() ( const std::vector< Symbol > &  symbols )

inline

add a list of input symbols

Parameters

symbols

the vector of the input symbols

Returns

reference of self

Operator& mxnet::cpp::Operator::operator() ( const NDArray &  ndarray )

inline

add input ndarrays

Parameters

ndarray

the input ndarray

Returns

reference of self

Operator& mxnet::cpp::Operator::operator() ( const std::vector< NDArray > &  ndarrays )

inline

add a list of input ndarrays

Parameters

ndarrays

the vector of the input ndarrays

Returns

reference of self

template<typename... Args>

Operator& mxnet::cpp::Operator::operator() ( Args...  args )

inline

add input ndarrays

Returns

reference of self

Operator& mxnet::cpp::Operator::operator=

(

const Operator &

rhs

)

template<int N = 0>

void mxnet::cpp::Operator::PushInput ( const Symbol &  symbol )

inline

add an input symbol

Parameters

symbol

the input symbol

template<int N = 0>

Operator& mxnet::cpp::Operator::PushInput ( const NDArray &  ndarray )

inline

add an input ndarray

Parameters

ndarray

the input ndarray

template<class T , class... Args, int N = 0>

Operator& mxnet::cpp::Operator::PushInput ( const T &  t, Args...  args  )

inline

add positional inputs

template<class T , int N = 0>

Operator& mxnet::cpp::Operator::PushInput ( const T &  t )

inline

add the last positional input

Operator& mxnet::cpp::Operator::SetInput	(	const std::string &	name,
		Symbol	symbol
	)

add an input symbol

Parameters

name	name of the input symbol
symbol	the input symbol

Returns

reference of self

Operator& mxnet::cpp::Operator::SetInput	(	const std::string &	name,
		NDArray	ndarray
	)

add an input ndarray

Parameters

name	name of the input ndarray
ndarray	the input ndarray

Returns

reference of self

template<typename T >

Operator& mxnet::cpp::Operator::SetParam ( const std::string &  name, const T &  value  )

inline

set config parameters

Parameters

name	name of the config parameter
value	value of the config parameter

Returns

reference of self

template<typename T >

Operator& mxnet::cpp::Operator::SetParam ( int  pos, const T &  value  )

inline

set config parameters from positional inputs

Parameters

pos	the position of parameter
value	value of the config parameter

Returns

reference of self

---

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

• cpp-package/include/mxnet-cpp/operator.h