logistic_function.h

Go to the documentation of this file.

#ifndef MYGSL_LOGISTIC_FUNCTION_H
#define MYGSL_LOGISTIC_FUNCTION_H

// Third party:
// - Bayeux/datatools :
#include <datatools/i_cloneable.h>

// This project:
#include <mygsl/i_unary_function.h>

namespace mygsl {

  class logistic_function
    : public i_unary_function,
      public datatools::i_cloneable
  {
  public:

    logistic_function();

    logistic_function(double steepness_, double midpoint_, double amplitude_);

    virtual ~logistic_function();

    void set_steepness(double steepness_);

    double get_steepness() const;

    void set_midpoint(double midpoint_);

    double get_midpoint() const;

    void set_amplitude(double amplitude_);

    double get_amplitude() const;

    virtual bool is_initialized() const;

    virtual void initialize(const datatools::properties & config_,
                            const unary_function_dict_type & functors_);

    virtual void reset();

    virtual void tree_dump(std::ostream & out_ = std::clog,
                           const std::string & title_  = "",
                           const std::string & indent_ = "",
                           bool inherit_ = false) const;

  protected:

    double _eval(double x_) const;

    void _set_defaults();

  private:

    double _steepness_; 
    double _midpoint_;  
    double _amplitude_; 

    MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(logistic_function)

    
    DATATOOLS_CLONEABLE_DECLARATION(logistic_function)

  };

} // namespace mygsl

#endif // MYGSL_LOGISTIC_FUNCTION_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --