real_range.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2011-09-25
 * Last modified: 2014-08-31
 *
 * License:
 *
 * Copyright (C) 2011-2014 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   Real range/interval class.
 *
 */

#ifndef DATATOOLS_REAL_RANGE_H
#define DATATOOLS_REAL_RANGE_H

// Standard Library:
#include <iostream>
#include <string>
#include <set>

// This Project:
#include <datatools/range_tools.h>

namespace datatools {

  class real_range
  {
  public:

    real_range();

    real_range(double from_, double to_,
               range_bound_info_type from_policy_ = range_bound_included,
               range_bound_info_type to_policy_ = range_bound_included);

    bool is_valid() const;

    void invalidate();

    void reset_lower();

    void reset_upper();

    void reset();

    void set_lower(double from_, range_bound_info_type policy_ = range_bound_included);

    void set_upper(double to_, range_bound_info_type policy_ = range_bound_included);

    void set(double from_,
             double to_,
             range_bound_info_type from_policy_ = range_bound_included,
             range_bound_info_type to_policy_   = range_bound_included);

    bool is_lower_bounded() const;

    bool is_upper_bounded() const;

    bool is_half_bounded() const;

    bool is_bounded() const;

    bool is_lower_included() const;

    bool is_upper_included() const;

    double get_lower() const;

    double get_upper() const;

    double width(double tolerance_ = -1.0) const;

    bool is_empty(double tolerance_ = -1.0) const;

    bool is_singleton(double tolerance_ = -1.0) const;

    double singleton(double tolerance_ = -1.0) const;

    // Collections of 'make' methods :

    // "[2;2]"
    void make_singleton(double);

    // "(0;0)"
    void make_empty();

    // "[0;)"
    void make_positive_unbounded();

    // "(;0]"
    void make_negative_unbounded();

    // "[lower;)" or "(lower;[
    void make_upper_unbounded(double from_, bool inclusive_ = true);

    // "(;upper]" or "(;upper)"
    void make_lower_unbounded(double to_, bool inclusive_ = true);

    // "(;)"
    void make_unbounded();

    // "(lower;upper]" or "(lower;upper)"
    // "[lower;upper]" or "[lower;upper)"
    void make_bounded(double from_, double to_,
                      bool lower_included_ = true,
                      bool upper_included_ = true);

    bool has(double value_, double tolerance_ = -1.0) const;

    bool has(const real_range & rr_, double tolerance_ = -1.0) const;

    void dump(std::ostream & out_ = std::clog, double tolerance_ = -1.0) const;

    double first(double tolerance_ = -1.0) const;

    double last(double tolerance_ = -1.0) const;

    bool has_unit_label() const;

    void set_unit_label(const std::string &);

    void reset_unit_label();

    const std::string & get_unit_label() const;

    bool has_preferred_unit() const;

    void reset_preferred_unit();

    void set_preferred_unit(const std::string & pus_);

    const std::string & get_preferred_unit() const;

    friend std::ostream & operator<<(std::ostream & out_,
                                    const real_range & range_);

    friend std::istream & operator>>(std::istream & in_,
                                    real_range & range_);

    static double compute_tolerance(double lower_, double upper_,
                                    double relative_tolerance_ = -1.0);

    int compare(const real_range & range_) const;

    bool operator<(const real_range & range_) const;

    bool operator>(const real_range & range_) const;

    bool operator==(const real_range & range_) const;

  protected:

    double _effective_tolerance(double tolerance_) const;

    void _set_defaults();

  private:

    std::string            _unit_label_;     
    std::string            _preferred_unit_; 
    range_bound_info_type  _lower_flag_;     
    double                 _lower_;          
    range_bound_info_type  _upper_flag_;     
    double                 _upper_;          
  };

} // end of namespace datatools

#endif // DATATOOLS_REAL_RANGE_H

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