linear_sampling.h

Go to the documentation of this file.

//
// Copyright (c) 2016 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_LINEAR_SAMPLING_H
#define MYGSL_LINEAR_SAMPLING_H

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

namespace mygsl {

  class linear_sampling
    : public base_sampling
  {
  public:

    linear_sampling();

    virtual ~linear_sampling();

    virtual double get_min() const;

    virtual double get_max() const;

    std::size_t get_nsteps() const;

    std::size_t get_nsamples() const;

    double get_step() const;

    double get_guard() const;

    virtual bool is_initialized() const;

    virtual void initialize(const datatools::properties &);

    virtual void reset();

    virtual bool value_to_index(const double x_,
                                std::size_t & index_,
                                sampling::index_classification_type & classification_flags_) const;

    virtual sampling::index_classification_type
    index_to_value(const std::size_t index_, double & value_) const;

    void make_range(const double min_,
                    const double max_,
                    const std::size_t nsteps_,
                    const double guard_ = 0.0);

    void make_from_min(const double min_,
                       const std::size_t nsteps_,
                       const double step_,
                       const double guard_ = 0.0);


    void make_to_max(const double max_,
                     const std::size_t nsteps_,
                     const double step_,
                     const double guard_ = 0.0);

  private:

    void _set_guard_(double guard_);

    void _init_();

    void _reset_();

  private:

    double      _min_;     
    double      _max_;     
    std::size_t _nsteps_;  
    double      _step_;    
    double      _guard_;   

  };

} // end of namespace mygsl

#endif // MYGSL_BASE_SAMPLING_H

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