name_multimap.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 NAME_MULTIMAP_H
#define NAME_MULTIMAP_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 STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

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

#ifndef STD_MAP_H
#include "SheafSystem/std_map.h"
#endif

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

namespace sheaf
{

class poset;
class name_multimap;
class scoped_index;

class SHEAF_DLL_SPEC name_multimap : public any
{
  friend SHEAF_DLL_SPEC size_t deep_size(const name_multimap& xp,  bool xinclude_shallow);

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

public:

  typedef pod_index_type index_type;

  typedef std::pair<index_type, std::string> entry_type;

  typedef std::list<std::string> name_list_type;

  typedef name_list_type::iterator name_iterator;

  typedef name_list_type::const_iterator const_name_iterator;

  typedef std::map<index_type, name_list_type >::iterator iterator;

  typedef std::map<index_type, name_list_type >::const_iterator const_iterator;

  name_multimap();

  name_multimap(const name_multimap& xother);

  name_multimap(const std::string xnames[], size_type xnames_ub);

  virtual ~name_multimap();

  std::string name(index_type xindex) const;

  std::string name(index_type xindex, int xi) const;

  const name_list_type& all_names(index_type xindex) const;

  void all_names(index_type xindex, block<std::string>& xresult) const;

  index_type index(const std::string& xname) const;

  void put_entry(const entry_type& xentry, bool xunique);

  void put_entry(index_type xindex, const std::string& xname, bool xunique);

  bool contains_name(const std::string& xname) const;

  bool contains_index(index_type xindex) const;

  bool contains_entry(const entry_type& xentry) const;

  bool contains_entry(index_type xindex, const std::string& xname) const;

  void delete_index(index_type xindex);

  void delete_name(const std::string& xname);

  void clear();

  bool empty() const;

  const_iterator begin() const;

  const_iterator end() const;

  int ct() const;

  void print() const;

  void print(std::ostream& xos, const name_multimap& xm) const;
  
  size_type name_ct(const index_type& xindex) const;

private:

  typedef std::map<std::string, index_type> name_to_index_map_type;

  name_to_index_map_type _name_to_index_map;

  typedef std::map< index_type, std::list<std::string> > index_to_name_map_type;

  index_to_name_map_type _index_to_name_map;



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

public:

  virtual name_multimap* clone() const;

  virtual bool invariant() const;

  virtual bool is_ancestor_of(const any* other) const;

  bool operator==(const name_multimap& xother);

  name_multimap& operator=(const name_multimap& xother);

protected:

private:

};


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

SHEAF_DLL_SPEC
std::ostream&
operator<<(std::ostream& xos, const name_multimap& xm);

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

#endif // ifndef NAME_MULTIMAP_H