poset_slicer.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_SLICER

#ifndef POSET_SLICER_H
#define POSET_SLICER_H

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

#ifndef POSET_DFT_H
#include "SheafSystem/poset_dft.h"
#endif

namespace sheaf
{

class abstract_poset_member;
class subposet;
class total_poset_member;
  
class SHEAF_DLL_SPEC poset_slicer: public poset_dft
{

  friend class poset_state_handle;
  friend class abstract_poset_member;


public:

  enum slice_mode { MAXIMAL, MINIMAL, ALL };

  // queries:

  virtual bool invariant() const;

  // constructors:

  poset_slicer(const poset_state_handle* xhost);

  ~poset_slicer();

  // Action

  subposet* find(abstract_poset_member* xanchor,
                 subposet* xlayer,
                 bool xdown,
                 slice_mode xmode = ALL);

  void find_pa(abstract_poset_member* xanchor,
               subposet* xlayer,
               bool xdown,
               subposet* result,
               slice_mode xmode = ALL);

  subposet* find(subposet* xanchor, subposet* xlayer, bool xdown, slice_mode xmode = ALL);

  void find_pa(const subposet* xanchor, subposet* xlayer, bool xdown, subposet* result, slice_mode xmode = ALL);

  subposet* find_jims(abstract_poset_member* xanchor, slice_mode xmode = ALL);

  void find_jims_pa(abstract_poset_member* xanchor, subposet* result, slice_mode xmode = ALL);

  subposet* find_jims(const subposet* xanchor, slice_mode xmode = ALL);

  void find_jims_pa(const subposet* xanchor, subposet* result, slice_mode xmode = ALL);

  subposet* down_set(abstract_poset_member* xanchor, slice_mode xmode = ALL);

  void down_set_pa(abstract_poset_member* xanchor, subposet* result, slice_mode xmode = ALL);

  subposet* up_set(abstract_poset_member* xanchor, slice_mode xmode = ALL);

  void up_set_pa(abstract_poset_member* xanchor, subposet* result, slice_mode xmode = ALL);

  subposet* down_set(const subposet* xanchor, slice_mode xmode = ALL);

  void down_set_pa(const subposet* xanchor, subposet* result, slice_mode xmode = ALL);

  subposet* up_set(const subposet* xanchor, slice_mode xmode = ALL);

  void up_set_pa(const subposet* xanchor, subposet* result, slice_mode xmode = ALL);


private:

  // data:

  subposet* _layer;

  // The given subset being interesected with
  // the down set (up set) of _anchor.

  subposet* _slice;

  // The result; the intersection of _layer
  // with the down set or up set of _anchor

  slice_mode _mode;
  // Include only maximal, minimal or all members

  bool _select_only_shallowest;
  // True if maximal and going down or minimal and going up

  bool _select_only_deepest;
  // True if minimal and going down or maxinal and going up

  std::stack<bool> _select_enabled;
  // True if selection enabled

  int _depth_below_shallowest;
  int _height_above_deepest;


  // Actions:

  void vertical_set_pa(const subposet* xanchor, subposet* result, slice_mode xmode, bool xdown);

  void previsit_action(abstract_poset_member* xmbr);
  void link_action(abstract_poset_member* xmbr, abstract_poset_member* linked_mbr);
  void postvisit_action(abstract_poset_member* xmbr);


  void find_pa(const block<scoped_index>& xanchor,
               subposet* xlayer,
               bool xdown,
               subposet* result,
               slice_mode xmode = ALL);

  inline bool only_shallowest();
  inline bool only_deepest();
  inline bool layer_contains_member(const abstract_poset_member* xmbr);
  inline bool slice_contains_member(abstract_poset_member* xmbr);
  inline void insert_member(abstract_poset_member* xmbr);




};
  
} // namespace sheaf

#endif // ifndef POSET_SLICER_H