gompertz_function.h

Go to the documentation of this file.

#ifndef MYGSL_GOMPERTZ_FUNCTION_H
#define MYGSL_GOMPERTZ_FUNCTION_H

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

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

namespace mygsl {

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

    gompertz_function();

    gompertz_function(double asymptote_,
                      double displacement_,
                      double growth_rate_);

    virtual ~gompertz_function();

    void set_asymptote(double asymptote_);

    double get_asymptote() const;

    void set_displacement(double displacement_);

    double get_displacement() const;

    void set_growth_rate(double growth_rate_);

    double get_growth_rate() 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 _asymptote_;    
    double _displacement_; 
    double _growth_rate_;  

    MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(gompertz_function)

    
    DATATOOLS_CLONEABLE_DECLARATION(gompertz_function)

  };

} // namespace mygsl

#endif // MYGSL_GOMPERTZ_FUNCTION_H

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