index_equivalence_class.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_EQUIVALENCE_CLASS_H
#define INDEX_EQUIVALENCE_CLASS_H

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

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

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

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

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

#ifndef STD_LIST_H
#include "SheafSystem/std_list.h"
#endif

#ifndef STD_UTILITY_H
#include "SheafSystem/std_utility.h"
#endif

namespace sheaf
{

class index_space_family;

class SHEAF_DLL_SPEC index_equivalence_class
{

  friend class index_equivalence_iterator;

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

public:

  typedef pod_index_type pod_type;

  typedef std::pair<pod_type, pod_type> member_type;

  typedef std::list<member_type> list_type;

  index_equivalence_class(const index_space_family& xid_spaces,
              bool xonly_persistent,
              bool xsort_ids);

  virtual ~index_equivalence_class();

  index_equivalence_class& operator=(const index_equivalence_class& xother);

  const list_type& equivalence_list(pod_index_type xrep_id) const;

  const list_type& equivalence_list(const scoped_index& xrep_id) const;

  size_type equivalence_ct(pod_index_type xrep_id) const;

  size_type equivalence_ct(const scoped_index& xrep_id) const;

  bool contains_rep_id(pod_index_type xrep_id) const;

  bool contains_rep_id(const scoped_index& xrep_id) const;

  static bool id_space_less_than(const member_type& xitem1, const member_type& xitem2);

protected:

  index_equivalence_class() { };

  index_equivalence_class(const index_equivalence_class& xother) { };

  block<list_type> _equivalence_lists;

private:

};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
} // namespace sheaf

#endif // ifndef INDEX_EQUIVALENCE_CLASS_H