sinterval.hh

Go to the documentation of this file.

/*
 * This file is part of rasdaman community.
 *
 * Rasdaman community is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Rasdaman community 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright 2003 - 2010 Peter Baumann / rasdaman GmbH.
 *
 * For more information please see <http://www.rasdaman.org>
 * or contact Peter Baumann via <baumann@rasdaman.com>.
*/
 
#ifndef D_SINTERVAL_HH
#define D_SINTERVAL_HH
 
#include "raslib/mddtypes.hh"  // for r_Range, r_Bytes
#include <iosfwd>              // for ostream, cout
#include <string>
 
//@ManMemo: Module: {\bf raslib}
class r_Sinterval
{
public:
    using BoundType = r_Range;
    using OffsetType = size_t;
 
    r_Sinterval() = default;
    explicit r_Sinterval(const char *);
    r_Sinterval(r_Range low, r_Range high);
    explicit r_Sinterval(r_Range point);
 
    // Constructors for intervals with at least one open bound.
    r_Sinterval(char, r_Range high);
    r_Sinterval(r_Range low, char);
    r_Sinterval(char, char);
 
    // Equality comparison
    bool operator==(const r_Sinterval &) const;
    bool operator!=(const r_Sinterval &) const;
 
    // Read/Write methods:
    r_Range low() const noexcept;
    r_Range high() const noexcept;
    OffsetType get_extent() const;
    bool is_fixed() const noexcept;
    bool is_low_fixed() const noexcept;
    bool is_low_unbounded() const noexcept;
    bool is_high_fixed() const noexcept;
    bool is_high_unbounded() const noexcept;
    bool is_slice() const noexcept;
    void set_low(r_Range low);
    void set_low(char) noexcept;
    void set_high(r_Range high);
    void set_high(char) noexcept;
    void set_interval(r_Range low, r_Range high);
    void set_interval(char, r_Range high) noexcept;
    void set_interval(r_Range low, char) noexcept;
    void set_interval(char, char) noexcept;
    void set_slice() noexcept;
 
    const std::string &get_axis_name() const;
    void set_axis_name(const std::string &axis_name_arg);
    bool has_axis_name() const;
 
    OffsetType get_offset_to(BoundType o) const noexcept;
    OffsetType get_offset_to(const r_Sinterval &o) const noexcept;
    r_Sinterval translate_by(BoundType offset) const;
 
    // Methods/Operators for the union operation:
    r_Sinterval &union_of(const r_Sinterval &, const r_Sinterval &);
    r_Sinterval &union_with(const r_Sinterval &);
    r_Sinterval &operator+=(const r_Sinterval &);
    r_Sinterval create_union(const r_Sinterval &) const;
    r_Sinterval operator+(const r_Sinterval &) const;
    bool inside_of(const r_Sinterval &o) const;
 
    // Methods/Operators for the difference operation:
    r_Sinterval &difference_of(const r_Sinterval &, const r_Sinterval &);
    r_Sinterval &difference_with(const r_Sinterval &);
    r_Sinterval &operator-=(const r_Sinterval &);
    r_Sinterval create_difference(const r_Sinterval &) const;
    r_Sinterval operator-(const r_Sinterval &) const;
 
    // Methods/Operators for the intersection operation:
    r_Sinterval &intersection_of(const r_Sinterval &, const r_Sinterval &);
    r_Sinterval &intersection_with(const r_Sinterval &);
    r_Sinterval &operator*=(const r_Sinterval &);
    r_Sinterval create_intersection(const r_Sinterval &) const;
    r_Sinterval operator*(const r_Sinterval &) const;
    bool intersects_with(const r_Sinterval &) const;
 
    // Methods/Operators for the closure operation:
    r_Sinterval &closure_of(const r_Sinterval &, const r_Sinterval &);
    r_Sinterval &closure_with(const r_Sinterval &);
    r_Sinterval create_closure(const r_Sinterval &) const;
 
    void print_status(std::ostream &s) const;
 
    char *get_string_representation() const;
 
    std::string to_string() const;
 
    // Methods for internal use only:
    r_Bytes get_storage_size() const;
 
 
private:
    // Calculation methods for the operations:
    r_Sinterval calc_union(const r_Sinterval &a, const r_Sinterval &b) const;
    r_Sinterval calc_difference(const r_Sinterval &a, const r_Sinterval &b) const;
    r_Sinterval calc_intersection(const r_Sinterval &a, const r_Sinterval &b) const;
    r_Sinterval calc_closure(const r_Sinterval &a, const r_Sinterval &b) const;
    int classify(const r_Sinterval &a, const r_Sinterval &b) const;
 
    std::string axis_name;
    r_Range lower_bound{};
    r_Range upper_bound{};
 
    bool low_fixed{false};
    bool high_fixed{false};
    bool slice{false};
};
 
//@ManMemo: Module: {\bf raslib}
extern std::ostream &operator<<(std::ostream &s, const r_Sinterval &d);
 
#endif