gate_function.h

Go to the documentation of this file.

//
// Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of Bayeux.
//
// Bayeux is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Bayeux is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Bayeux. If not, see <http://www.gnu.org/licenses/>.

#ifndef MYGSL_GATE_FUNCTION_H
#define MYGSL_GATE_FUNCTION_H

// Standard library:
#include <limits>

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

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

namespace mygsl {

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

    gate_function();

    gate_function(double width_,
                  double center_ = 0.0,
                  double amplitude_ = std::numeric_limits<double>::quiet_NaN());

    virtual ~gate_function();

    virtual bool is_initialized() const;

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

    virtual void reset();

    void set_width(double width_);

    double get_width() const;

    void set_center(double center_);

    double get_center() const;

    void set_amplitude(double amplitude_);

    double get_amplitude() const;

    double get_non_zero_domain_min() const;

    double get_non_zero_domain_max() 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:

    double _center_;    
    double _width_;     
    double _amplitude_; 

    MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(gate_function)

    
    DATATOOLS_CLONEABLE_DECLARATION(gate_function)

  };

} // end of namespace mygsl

#endif // MYGSL_GATE_FUNCTION_H

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