interval_set.h

Go to the documentation of this file.

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//


#ifndef INTERVAL_SET_H
#define INTERVAL_SET_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef STD_MAP_H
#include "SheafSystem/std_map.h"
#endif

#ifndef POD_TYPES_H
#include "SheafSystem/pod_types.h"
#endif

namespace sheaf
{

class interval_set_iterator;

struct SHEAF_DLL_SPEC interval
{
  typedef pod_index_type pod_type;

  pod_type _begin;

  pod_type _end;
};
  
class SHEAF_DLL_SPEC interval_set : public any
{

  friend class interval_set_iterator;
  friend SHEAF_DLL_SPEC size_t deep_size(const interval_set& xset, bool xinclude_shallow);

  // ===========================================================
  // ===========================================================

public:

  typedef pod_index_type pod_type;

  interval_set();

  interval_set(const interval_set& xother);

  ~interval_set();

  bool operator==(const interval_set& xother) const;

  void insert_interval(pod_type xbegin, pod_type xend);

  void insert_member(pod_type xmbr);

  void remove_interval(pod_type xbegin, pod_type xend);

  void remove_member(pod_type xmbr);

  bool contains_member(pod_type xmbr) const;

  size_type member_ct(pod_type xbegin, pod_type xend) const;

  bool interval_is_empty(pod_type xbegin, pod_type xend) const;

  bool interval_is_full(pod_type xbegin, pod_type xend) const;

  pod_type begin() const;

  pod_type end() const;
    
  void clear();

  bool is_empty() const;  

  interval_set_iterator* iterator(bool xis_full_iterator) const;  

protected:

private:

  void put_interval(pod_type xbegin, pod_type xend, bool xvalue);



  // ===========================================================
  // ===========================================================

public:

  typedef std::map<pod_type, bool> map_type;

  typedef map_type::const_iterator map_iterator_type;

  const map_type& interval_map() const;

  bool first_map_entry() const;

  bool last_map_entry() const;

protected:

private:

  map_type _interval_map;


  // ===========================================================
  // ===========================================================

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual interval_set* clone() const;

  interval_set& operator=(const interval_set& xother);

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
SHEAF_DLL_SPEC 
std::ostream& operator << (std::ostream& xos, const interval_set& xset);

SHEAF_DLL_SPEC
size_t deep_size(const interval_set& xset, bool xinclude_shallow = true);

} // namespace sheaf

#endif // ifndef INTERVAL_SET_H