CEL

Public API Reference

celNNActivationFunc Class Reference

Abstract class representing an activation function callback for the neural network property class. More...

#include <propclass/neuralnet.h>

Inheritance diagram for celNNActivationFunc:

List of all members.

Public Member Functions

virtual void Function (celData &data)=0
 The callback method. Performs the activation function on the data.
virtual celDataType GetDataType ()=0
 Returns the type of data upon which this function operates.
virtual ~celNNActivationFunc ()
 Destructor.

Static Protected Member Functions

template<typename T >
static celDataType DataType ()
 Convenience template for subclasses of celNNActivationFunc.
template<typename T >
static const T & GetFrom (const celData &input)
 Convenience template for subclasses of celNNActivationFunc.

Detailed Description

Abstract class representing an activation function callback for the neural network property class.

This is passed to the iPcNeuralNet::SetActivationFunc() method, and is used as the activation function for the nodes in the network. The user of the property class can use one of the supplied implementations of celActivationFunc, or they can implement their own.

The supplied implementations can also be selected using pcneuralnet's "SetActivationFunc" action. See the specific implementation class for the "cel.activationFunc." string ID to use.

Definition at line 202 of file neuralnet.h.


Constructor & Destructor Documentation

virtual celNNActivationFunc::~celNNActivationFunc (  )  [inline, virtual]

Destructor.

Definition at line 212 of file neuralnet.h.


Member Function Documentation

celDataType celNNActivationFunc::DataType< float > (  )  [inline, static, protected]

Convenience template for subclasses of celNNActivationFunc.

Implementations of celNNActivationFunc may, if they wish, use this method template to translate a C++ type declarator into a CEL_DATA constant.

The template is specialised for all integer types and float (not double). Attempting to use any other type for the template parameter will result in a linker error.

const uint32 & celNNActivationFunc::GetFrom< uint32 > ( const celData input  )  [inline, static, protected]

Convenience template for subclasses of celNNActivationFunc.

Implementations of celNNActivationFunc may, if they wish, use this method template to extract data from a celData structure in a generic way, since celData does not provide its own generic Get() method.

The template is specialised for all integer types and float (not double). Attempting to use any other type for the template parameter will result in a linker error.


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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.6.1