integer_range.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2011-09-22
 * 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:
 *
 *   Integer range class.
 *
 */

#ifndef DATATOOLS_INTEGER_RANGE_H
#define DATATOOLS_INTEGER_RANGE_H

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

// Third Party:
// - Boost:
#include <boost/cstdint.hpp>

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

namespace datatools {

  class integer_range
  {
  public:

    // Intrinsic integer is 32 bits:
    typedef int32_t value_type;

    integer_range();

    integer_range(value_type from_, value_type 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(value_type from_, range_bound_info_type policy_ = range_bound_included);

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

    void set(value_type from, value_type 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_singleton() const;

    bool is_lower_included() const;

    bool is_upper_included() const;

    value_type get_lower_bound() const;

    value_type get_upper_bound() const;

    uint64_t count() const;

    bool is_empty() const;

    // Collections of 'make-methods' :

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

    // "[min_int;max_int]"
    void make_full();

    // "[0;max_int]"
    void make_full_positive();

    // "[min_int;0]"
    void make_full_negative();

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

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

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

    bool has(value_type value) const;

    bool has(const integer_range & ir) const;

    void dump(std::ostream& out = std::clog) const;

    friend std::ostream& operator<<(std::ostream & out,
                                    const integer_range & range_);

    friend std::istream& operator>>(std::istream & in,
                                    integer_range & range_);

    value_type begin() const;

    value_type end() const;

    value_type first() const;

    value_type last() const;

    int compare(const integer_range& range_) const;

    bool operator<(const integer_range & range_) const;

    bool operator>(const integer_range & range_) const;

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

    void make_canonical(integer_range & range_) const;

    bool intersect(const integer_range & range_, integer_range & inter_) const;

    bool intersect(const integer_range & range_) const;

  private:
    range_bound_info_type _lower_flag_; 
    value_type            _lower_;      
    range_bound_info_type _upper_flag_; 
    value_type            _upper_;      
  };

} // end of namespace datatools

#endif // DATATOOLS_INTEGER_RANGE_H

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