subposet_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 SUBPOSET_STATE_H
#define SUBPOSET_STATE_H

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

#ifndef DOF_DESCRIPTOR_ARRAY_H
#include "SheafSystem/dof_descriptor_array.h"
#endif

#ifndef INDEX_SPACE_FAMILY_H
#include "SheafSystem/index_space_family.h"
#endif

#ifndef SCATTERED_INSERTION_INDEX_SPACE_HANDLE_H
#include "SheafSystem/scattered_insertion_index_space_handle.h"
#endif

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

#ifndef STD_STRING_H
#include "SheafSystem/std_string.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

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

namespace sheaf
{

template <typename T>
class block;

class SHEAF_DLL_SPEC subposet_state
{
  // ===========================================================
  // ===========================================================

public:

  subposet_state();

  ~subposet_state();

  void initialize(int xmember_ub, const scoped_index& xindex, bool xinitialize);

  void initialize(int xmember_ub,
          const scoped_index& xindex,
                  const block<pod_index_type>& xmembers);

  void initialize(int xmember_ub,
                  const scoped_index& xindex,
                  const block<scoped_index>& xmembers);

  bool is_initialized() const;

  void terminate();

  bool is_terminated() const;

  const scoped_index& next() const;

  void put_next(const scoped_index& xnext);

  zn_to_bool* members() const;

  void put_members(const zn_to_bool* xmembers);

  const scoped_index& index() const;

  bool is_dof_subposet() const;

  void put_is_dof_subposet(bool xis_dof_subposet);

  size_type dof_ct() const;

  void put_dof_ct(size_type xdof_ct);

  size_type dof_tuple_ub();

  dof_descriptor_array* dof_descriptors() const;

  void put_dof_descriptors(const dof_descriptor_array* xdof_descriptors);

  bool has_id_space() const;

  const scattered_insertion_index_space_handle& id_space() const;

  scattered_insertion_index_space_handle& id_space();

  void put_id_space(const index_space_family& xid_spaces,
            pod_index_type xid);

  void put_id_space(const index_space_family& xid_spaces,
            const std::string& xname);

  bool is_persistent() const;

  void put_is_persistent(bool xvalue);

protected:

  zn_to_bool* _members;

  scoped_index _index;

  bool _is_dof_subposet;

  size_type _dof_ct;

  dof_descriptor_array* _dof_descriptors;

  scattered_insertion_index_space_handle* _id_space;

  bool _is_persistent;

private:

};


// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================

SHEAF_DLL_SPEC
std::ostream & operator << (std::ostream &os, subposet_state& s);

SHEAF_DLL_SPEC
size_t deep_size(const subposet_state& xp, bool xinclude_shallow = true);
 
} // namespace sheaf

#endif // ifndef SUBPOSET_STATE_H