i_unary_function.h

Go to the documentation of this file.

#ifndef MYGSL_I_UNARY_FUNCTION_H
#define MYGSL_I_UNARY_FUNCTION_H 1

// Standard library:
#include <iostream>
#include <limits>
#include <functional>
#include <string>
#include <vector>
#include <map>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
// - Bayeux/datatools:
#include <datatools/handle.h>
#include <datatools/factory_macros.h>
#include <datatools/i_tree_dump.h>
#include <datatools/properties.h>

// This project:
#include <mygsl/ioutils.h>
#include <mygsl/interval.h>
#include <mygsl/unary_function_utils.h>

namespace mygsl {

  // // Forward class declaration:
  // class i_unary_function;

  // //! Alias for a handle to an unary function object
  // typedef datatools::handle<i_unary_function> unary_function_handle_type;

  // //! Alias for a handle to a const unary function object
  // typedef datatools::handle<const i_unary_function> const_unary_function_handle_type;

  // //! Alias for dictionary of handles to unary function objects
  // // typedef std::map<std::string, unary_function_handle_type> unary_function_dict_type;
  // typedef std::map<std::string, unary_function_handle_type> unary_function_dict_type;

  class i_unary_function
    : public std::unary_function<double,double>
    , public datatools::i_tree_dumpable
  {
  public:

    static const double DEFAULT_EPSILON;

    static const double AUTO_EPSILON;

    enum write_options_type {
      wo_none       = 0,
      wo_data_index = 0x1, 
      wo_skip_nan   = 0x2, 
      wo_skip_inf   = 0x4, 
      wo_skip_onzd  = 0x8, 
      wo_skip_odod  = 0x10, 
      wo_append     = 0x20, 
      wo_default    = wo_none
    };

    i_unary_function(double epsilon_ = 0.0);

    virtual ~i_unary_function();

    virtual bool has_explicit_domain_of_definition() const;

    virtual bool is_in_domain_of_definition(double x_) const;

    virtual double eval(double x_) const;

    double evaluate(double x_) const;

    virtual double eval_no_check(double x_) const;

    virtual double get_non_zero_domain_min() const;

    bool has_non_zero_domain_min() const;

    virtual double get_non_zero_domain_max() const;

    bool has_non_zero_domain_max() const;

    bool is_in_non_zero_domain(double x_) const;

    bool is_in_zero_domain(double x_) const;

    bool has_zero_domain() const;

    double operator() (double x_) const;

    void write_ascii(std::ostream & fout_,
                     double min_, double max_, unsigned int nsamples_,
                     int x_precision_ = 16,
                     int fx_precision_ = 16,
                     uint32_t options_ = wo_default) const;

    void write_ascii_with_units(std::ostream & fout_,
                                double min_, double max_, unsigned int nsamples_,
                                double x_unit_,
                                double fx_unit_,
                                int x_precision_ = 16,
                                int fx_precision_ = 16,
                                uint32_t options_ = wo_default) const;

    void write_ascii_file(const std::string & filename_,
                          double min_, double max_, unsigned int nsamples_,
                          int x_precision_ = 16,
                          int fx_precision_ = 16,
                          uint32_t options_ = wo_default) const;

    void write_ascii_file_with_units(const std::string & filename_,
                                     double min_, double max_, unsigned int nsamples_,
                                     const std::string & x_unit_label_,
                                     const std::string & fx_unit_label_,
                                     int x_precision_ = 16,
                                     int fx_precision_ = 16,
                                     uint32_t options_ = wo_default) const;

    static double g_function(double x_, void * functor_);

    void set_epsilon(double);

    double get_epsilon() const;

    void initialize_simple();

    void initialize_standalone(const datatools::properties & config_);

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

    virtual void reset();

    virtual bool is_initialized() const;

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

  protected:

    virtual double _eval(double x_) const = 0;

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

    void _base_reset();

    void _compute_auto_epsilon();

    void _set_defaults();

  private :

    double _epsilon_; 

    // Factory stuff :
    DATATOOLS_FACTORY_SYSTEM_REGISTER_INTERFACE(i_unary_function)

  };

} // namespace mygsl

// Registration macros:
#define MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(UnaryFunctorClass)   \
  private:                                                              \
  DATATOOLS_FACTORY_SYSTEM_AUTO_REGISTRATION_INTERFACE(::mygsl::i_unary_function, UnaryFunctorClass ) \
  

#define MYGSL_UNARY_FUNCTOR_REGISTRATION_IMPLEMENT(UnaryFunctorClass,UnaryFunctorClassId) \
  DATATOOLS_FACTORY_SYSTEM_AUTO_REGISTRATION_IMPLEMENTATION(::mygsl::i_unary_function, UnaryFunctorClass , UnaryFunctorClassId ) \
  

#endif // MYGSL_I_UNARY_FUNCTION_H

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