mlpack
Static Public Member Functions | List of all members
mlpack::ann::ElliotFunction Class Reference

The Elliot function, defined by. More...

#include <elliot_function.hpp>

Static Public Member Functions

static double Fn (const double x)
 Computes the Elliot function. More...
 
template<typename InputVecType , typename OutputVecType >
static void Fn (const InputVecType &x, OutputVecType &y)
 Computes the Elliot function. More...
 
static double Deriv (const double y)
 Computes the first derivative of the Elliot function. More...
 
template<typename InputVecType , typename OutputVecType >
static void Deriv (const InputVecType &y, OutputVecType &x)
 Computes the first derivatives of the Elliot function. More...
 

Detailed Description

The Elliot function, defined by.

\begin{eqnarray*} f(x) &=& \frac{x}{1 + |x|} \\ f'(x) &=& \frac{1}{(1 + |x|)^2} \end{eqnarray*}

Member Function Documentation

◆ Deriv() [1/2]

static double mlpack::ann::ElliotFunction::Deriv ( const double  y)
inlinestatic

Computes the first derivative of the Elliot function.

Parameters
yInput data.
Returns
f'(x).

◆ Deriv() [2/2]

template<typename InputVecType , typename OutputVecType >
static void mlpack::ann::ElliotFunction::Deriv ( const InputVecType &  y,
OutputVecType &  x 
)
inlinestatic

Computes the first derivatives of the Elliot function.

Parameters
yInput activations.
xThe resulting derivatives.

◆ Fn() [1/2]

static double mlpack::ann::ElliotFunction::Fn ( const double  x)
inlinestatic

Computes the Elliot function.

Parameters
xInput data.
Returns
f(x).

◆ Fn() [2/2]

template<typename InputVecType , typename OutputVecType >
static void mlpack::ann::ElliotFunction::Fn ( const InputVecType &  x,
OutputVecType &  y 
)
inlinestatic

Computes the Elliot function.

Parameters
xInput data.
yThe resulting output activation.

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