poset_traverser.h

//
// 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.
//
// Interface for class POSET_TRAVERSER

#ifndef POSET_TRAVERSER_H
#define POSET_TRAVERSER_H

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

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

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

#ifndef ZN_TO_BOOL_H
#include "SheafSystem/zn_to_bool.h"
#endif

namespace sheaf
{

class abstract_poset_member;
class poset_state_handle;
class poset_component;
class total_poset_member;
  
class SHEAF_DLL_SPEC poset_traverser: public any
{


public:

  // constructors:

  poset_traverser(const poset_state_handle* xanchor);

  ~poset_traverser();

  // queries:

  virtual bool invariant() const;

  inline poset_state_handle* host()
  {
    return _host;
  };

  inline const poset_state_handle* host() const
  {
    return _host;
  };

  bool has_same_host(const poset_component* other) const;

  virtual abstract_poset_member* anchor();

  virtual const abstract_poset_member* anchor() const;

  

  inline bool in_down_set() const
  {
    return _in_down_set;
  };

  void traverse(const abstract_poset_member* xanchor, bool down, bool reset_markers = true);

protected:

  poset_state_handle* _host;

  zn_to_bool* _visited;

  abstract_poset_member* _anchor;

  bool _in_down_set;

  bool has_been_visited(const abstract_poset_member* xmbr) const;

  

  inline bool has_been_visited(int xindex) const
  {
    return (*_visited)[xindex];
  };

  scoped_index member_index_ub() const;

  bool no_members_visited() const;

  bool all_members_visited() const;

  void mark_members_not_visited();

  void mark_visited(const abstract_poset_member* xmbr);

  inline void mark_visited(int xindex)
  {
    _visited->force(xindex, true);
  };

  inline void mark_not_visited(int xindex)
  {
    _visited->force(xindex, false);
  };

  virtual void private_traverse() = 0;

  inline void ensure_visited_ub()
  {
    if(_visited->ub() < member_index_ub().pod())
      _visited->extend_to(member_index_ub().pod());
  }

};
  
} // namespace sheaf

#endif