tabulated_function.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2007-12-07
 * Last modified: 2018-12-23
 *
 * License: GPL3
 *
 * Description:
 *
 *   Tabulated function
 *
 */

#ifndef MYGSL_TABULATED_FUNCTION_H
#define MYGSL_TABULATED_FUNCTION_H 1

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

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

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

namespace mygsl {

  class tabulated_function
    : public i_unary_function
    , public datatools::i_cloneable
  {
  public:
    typedef std::map<double,double> points_map_type;

    static const std::string & linear_interp_name();
    static const std::string & polynomial_interp_name();
    static const std::string & cspline_interp_name();
    static const std::string & cspline_periodic_interp_name();
    static const std::string & akima_interp_name();
    static const std::string & akima_periodic_interp_name();
    static const std::string & steffen_interp_name();
    static const std::string & default_interp_name();

  public:

    virtual bool has_explicit_domain_of_definition() const;

    virtual bool is_in_domain_of_definition(double x_) const;

    tabulated_function(const std::string & interp_name_ = "");

    tabulated_function(const tabulated_function & tab_func_);

    virtual ~tabulated_function();

    tabulated_function & operator=(const tabulated_function& tab_func_);

    bool is_verbose() const;

    void set_verbose(bool v_ = true);

    bool is_valid(double x_) const;

    const std::string & interpolator_name() const;

    const points_map_type & points() const;

    bool export_to_vectors(std::vector<double> & keys_,
                           std::vector<double> & values_) const;

    static const std::string & default_interpolator_name();

    static bool interpolator_name_is_valid(const std::string & name_);

    void scale(double s_);

    size_t size() const;

    bool is_table_locked() const;

    void lock_table(const std::string & interp_name_ = "");

    void unlock_table();

    void relock_table(const std::string & interp_name_ = "");

    void add_point(double x_, double y_, bool lock_after_ = false);

    double x_min() const;

    double x_max() const;

    void load_from_file(const std::string & filename_, uint32_t options_ = 0);

    virtual void tabfunc_load(std::istream & in_, void * context_ = 0);

    virtual void tabfunc_store(std::ostream & out_, void * context_ = 0) const;

    void print_points(std::ostream & out_,
                      const std::string & header_comment_ = "",
                      const std::string & footer_comment_ = "") const;


    virtual bool is_initialized() const;

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

    void reset();

    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;

  private:

    struct tabfunc_impl;
    tabfunc_impl * pImpl = nullptr; 

    MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(tabulated_function)

    
    DATATOOLS_CLONEABLE_DECLARATION(tabulated_function)
        
    BOOST_SERIALIZATION_BASIC_DECLARATION()

  };

} // end of namespace mygsl

#endif // MYGSL_TABULATED_FUNCTION_H

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