index_space_interval.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 INDEX_SPACE_INTERVAL_H
#define INDEX_SPACE_INTERVAL_H

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

#ifndef FACTORY_H
#include "SheafSystem/factory.h"
#endif

#ifndef INDEX_SPACE_COLLECTION_H
#include "SheafSystem/index_space_collection.h"
#endif

namespace sheaf
{
  
class SHEAF_DLL_SPEC index_space_interval : public index_space_collection
{

  friend class index_space_family_iterator;
  friend class index_space_interval_iterator;

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

public:

  virtual ~index_space_interval();

  using index_space_collection::begin;

  pod_type begin() const;

  using index_space_collection::end;

  pod_type end() const;

  bool in_bounds(pod_type xspace_id) const;

protected:

  index_space_interval();

  index_space_interval(const index_space_interval& xother) { };

  void new_state(index_space_family& xid_spaces, size_type xub);

  virtual bool supports_persistent_id_spaces() const;

  pod_type _begin;

  pod_type _end;

private:



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

public:

  virtual bool operator==(const index_space_collection& xother) const;

  using index_space_collection::contains;

  virtual bool contains(pod_type xlocal_id) const;

  virtual bool contains_family(pod_type xspace_id) const;

  virtual pod_type local_scope(pod_type xspace_id) const;

  virtual pod_type family_scope(pod_type xlocal_id) const;

protected:

  virtual index_space_interval& operator=(const index_space_collection& xother);

private:



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

public:

  virtual const index_space_family& id_spaces() const;

  virtual index_space_family& id_spaces();

protected:

  index_space_family* _id_spaces;

private:



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

public:

  virtual const std::string& class_name() const;

  static factory<index_space_interval>& id_space_interval_factory();

  virtual index_space_interval* clone() const = 0;

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

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

} // end namespace sheaf

#endif // ifndef INDEX_SPACE_INTERVAL_H