explicit_index_space_state.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 EXPLICIT_INDEX_SPACE_STATE_H
#define EXPLICIT_INDEX_SPACE_STATE_H

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

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

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

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

namespace sheaf
{

class abstract_product_structure;
class explicit_index_space_handle;
class explicit_index_space_iterator;
class hub_index_space_handle;
class index_space_collection;
class index_space_family;
class index_space_handle;
class index_space_iterator;
class scoped_index;

class SHEAF_DLL_SPEC explicit_index_space_state : public any
{

  friend class explicit_index_space_collection;
  friend class explicit_index_space_interval;
  friend class index_space_family;

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

public:

  typedef pod_index_type pod_type;

  virtual ~explicit_index_space_state();

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

  const index_space_collection& host() const;

  index_space_collection& host();

  pod_type index() const;

  virtual size_type deep_size(bool xinclude_shallow) const;

protected:

  explicit_index_space_state();

  explicit_index_space_state(const explicit_index_space_state& xother) { };

  virtual explicit_index_space_state& operator=(const explicit_index_space_state& xother);

  void new_state(index_space_family& xid_spaces,
         const std::string& xname,
         bool xis_persistent);

  void new_state(index_space_family& xid_spaces,
         pod_type xid,
         const std::string& xname,
         bool xis_persistent);

  index_space_collection* _host;

  pod_type _index;

private:



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

public:

  const index_space_family& id_spaces() const;

  index_space_family& id_spaces();

  const hub_index_space_handle& hub_id_space() const;

  size_type ct() const;

  bool is_empty() const;

  pod_type begin() const;

  pod_type end() const;

  bool is_gathered() const;
    
  virtual bool contains(pod_type xid) const = 0;

  bool contains(const scoped_index& xid) const;

  bool contains_hub(pod_type xid) const;

  virtual bool contains_unglued_hub(pod_type xid) const = 0;

  virtual bool contains_glued_hub(pod_type xid) const;

  bool contains(pod_type xid, const scoped_index& xhub_id) const;

  virtual bool contains(pod_type xid, pod_type xhub_id) const;

  virtual pod_type pod(pod_type xid) const = 0;

  pod_type pod(const scoped_index& xid) const;

  pod_type hub_pod(pod_type xid) const;

  virtual pod_type unglued_hub_pod(pod_type xid) const = 0;

  virtual pod_type glued_hub_pod(pod_type xid) const ;

  bool is_persistent() const;

protected:

  void invalidate_extrema();

  size_type _ct;

  pod_type _begin;

  pod_type _end;

  bool _is_persistent;

private:



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

public:

  virtual void new_product_structure(const abstract_product_structure& xproduct);

  virtual void delete_product_structure();

  const abstract_product_structure& product_structure() const;

  abstract_product_structure& product_structure();

  bool has_product_structure() const;

protected:

  abstract_product_structure* _product;

private:



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

public:

  virtual index_space_handle& get_id_space() const = 0;

  virtual void release_id_space(index_space_handle& xid_space) const = 0;

  virtual bool allocated_id_space(const index_space_handle& xid_space) const = 0;

protected:

  void attach(explicit_index_space_handle& xid_space) const;

private:



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

public:

  virtual index_space_iterator& get_iterator() const = 0;

  virtual void release_iterator(index_space_iterator& xitr) const = 0;

  virtual bool allocated_iterator(const index_space_iterator& xitr) const = 0;

protected:

  void attach(explicit_index_space_iterator& xitr) const;

private:



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

public:

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

  static factory<explicit_index_space_state>& id_space_factory();

  virtual explicit_index_space_state* 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 
size_t deep_size(const explicit_index_space_state& xn, bool xinclude_shallow = true);
  
SHEAF_DLL_SPEC 
std::ostream & operator << (std::ostream &xos, const explicit_index_space_state& xn);

} // end namespace sheaf

#endif // ifndef EXPLICIT_INDEX_SPACE_STATE_H