Class sigmoid

Inheritance Relationships

Base Type

Class Documentation

class sigmoid : public rcppsw::math::expression<double>

Encapsulates base aspects common to all sigmoid functions; does not calculate anything itself, as derived sigmoids each have different input parameter requirements to calculate the value of the function at a point in space.

Public Functions

inline explicit sigmoid(const config::sigmoid_config *const config)

Construct the sigmoid using parameters.

inline sigmoid(double reactivity, double offset, double gamma)

Construct the sigmoid by passing each parameter explicitly. Note that they are all of the same type, and therefore ordering is important.

sigmoid(void) = default
inline void init(double reactivity, double offset, double gamma)

Initialize the sigmoid after construction. Needed if the sigmoid is just one of many functions a class may use during its internal operations, and the selection must be performed after construction of the enclosing class.

Protected Functions

inline double gamma(void) const
inline double offset(void) const
inline double reactivity(void) const