heaviside_function.h

Go to the documentation of this file.

#ifndef MYGSL_HEAVISIDE_FUNCTION_H
#define MYGSL_HEAVISIDE_FUNCTION_H

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

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

namespace mygsl {

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

    enum convention_type {
      CONVENTION_INVALID          = 0,
      CONVENTION_HALF_MAXIMUM     = 1,
      CONVENTION_RIGHT_CONTINUOUS = 2,
      CONVENTION_LEFT_CONTINUOUS  = 3,
      CONVENTION_CONTINUOUS       = 4
    };

    heaviside_function(convention_type convention_ = CONVENTION_INVALID);

    virtual ~heaviside_function();

    void set_convention(convention_type convention_);

    convention_type get_convention() const;

    virtual bool is_initialized() const;

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

    void reset();

    double get_non_zero_domain_min() const;

    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:

    convention_type _convention_ = CONVENTION_HALF_MAXIMUM;

    MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(heaviside_function)

    
    DATATOOLS_CLONEABLE_DECLARATION(heaviside_function)

  };

} // namespace mygsl

#endif // MYGSL_HEAVISIDE_FUNCTION_H

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