GCC Middle and Back End API Reference
Data Structures | Public Member Functions | Private Types | Private Member Functions | Private Attributes
ordered_hash_map< KeyId, Value, Traits > Class Template Reference

#include <ordered-hash-map.h>

Inheritance diagram for ordered_hash_map< KeyId, Value, Traits >:
Inheritance graph
[legend]
Collaboration diagram for ordered_hash_map< KeyId, Value, Traits >:
Collaboration graph
[legend]

Data Structures

class  iterator
 

Public Member Functions

 ordered_hash_map ()
 
 ordered_hash_map (const ordered_hash_map &other)
 
bool put (const Key &k, const Value &v)
 
Value * get (const Key &k)
 
Value & get_or_insert (const Key &k, bool *existed=NULL)
 
void remove (const Key &k)
 
size_t elements () const
 
iterator begin () const
 
iterator end () const
 

Private Types

typedef Traits::key_type Key
 

Private Member Functions

void operator= (const ordered_hash_map &)
 

Private Attributes

hash_map< KeyId, Value, Traits > m_map
 
auto_vec< Key > m_keys
 
hash_map< KeyId, int > m_key_index
 

Detailed Description

template<typename KeyId, typename Value, typename Traits>
class ordered_hash_map< KeyId, Value, Traits >
A type-safe hash map that retains the insertion order of keys.
   Copyright (C) 2019-2024 Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.   
Notes:
- The keys must be PODs, since vec<> uses assignment to populate slots
  without properly initializing them.
- doesn't have GTY support.
- supports removal, but retains order of original insertion.
  (Removal might be better handled by using a doubly-linked list
  of nodes, holding the values).   
Two-argument form.

Member Typedef Documentation

◆ Key

template<typename KeyId , typename Value , typename Traits >
typedef Traits::key_type ordered_hash_map< KeyId, Value, Traits >::Key
private

Constructor & Destructor Documentation

◆ ordered_hash_map() [1/2]

template<typename KeyId , typename Value , typename Traits >
ordered_hash_map< KeyId, Value, Traits >::ordered_hash_map ( )
inline

◆ ordered_hash_map() [2/2]

template<typename KeyId , typename Value , typename Traits >
ordered_hash_map< KeyId, Value, Traits >::ordered_hash_map ( const ordered_hash_map< KeyId, Value, Traits > & other)
inline

References FOR_EACH_VEC_ELT, i, and ordered_hash_map< KeyId, Value, Traits >::m_keys.

Member Function Documentation

◆ begin()

template<typename KeyId , typename Value , typename Traits >
iterator ordered_hash_map< KeyId, Value, Traits >::begin ( ) const
inline

References ordered_hash_map< KeyId, Value, Traits >::end(), and i.

Referenced by ana::state_purge_map::begin_decls(), and ana::state_purge_map::begin_ssas().

◆ elements()

template<typename KeyId , typename Value , typename Traits >
size_t ordered_hash_map< KeyId, Value, Traits >::elements ( ) const
inline

References ordered_hash_map< KeyId, Value, Traits >::m_map.

◆ end()

template<typename KeyId , typename Value , typename Traits >
iterator ordered_hash_map< KeyId, Value, Traits >::end ( ) const
inline

References ordered_hash_map< KeyId, Value, Traits >::m_keys.

Referenced by ordered_hash_map< KeyId, Value, Traits >::begin(), ana::state_purge_map::end_decls(), and ana::state_purge_map::end_ssas().

◆ get()

template<typename KeyId , typename Value , typename Traits >
Value * ordered_hash_map< KeyId, Value, Traits >::get ( const Key & k)
inline

References ggc_alloc(), and ordered_hash_map< KeyId, Value, Traits >::m_map.

Referenced by ordered_hash_map< KeyId, Value, Traits >::iterator::operator*(), and ordered_hash_map< KeyId, Value, Traits >::iterator::valid_index_p().

◆ get_or_insert()

template<typename KeyId , typename Value , typename Traits >
Value & ordered_hash_map< KeyId, Value, Traits >::get_or_insert ( const Key & k,
bool * existed = NULL )
inline

References hash_map< KeyId, Value, Traits >::get_or_insert(), ggc_alloc(), ordered_hash_map< KeyId, Value, Traits >::m_key_index, ordered_hash_map< KeyId, Value, Traits >::m_keys, and ordered_hash_map< KeyId, Value, Traits >::m_map.

◆ operator=()

template<typename KeyId , typename Value , typename Traits >
void ordered_hash_map< KeyId, Value, Traits >::operator= ( const ordered_hash_map< KeyId, Value, Traits > & )
private

◆ put()

template<typename KeyId , typename Value , typename Traits >
bool ordered_hash_map< KeyId, Value, Traits >::put ( const Key & k,
const Value & v )
inline

References hash_map< KeyId, Value, Traits >::get_or_insert(), ggc_alloc(), ordered_hash_map< KeyId, Value, Traits >::m_key_index, ordered_hash_map< KeyId, Value, Traits >::m_keys, and ordered_hash_map< KeyId, Value, Traits >::m_map.

◆ remove()

template<typename KeyId , typename Value , typename Traits >
void ordered_hash_map< KeyId, Value, Traits >::remove ( const Key & k)
inline

References ggc_alloc(), and ordered_hash_map< KeyId, Value, Traits >::m_map.

Field Documentation

◆ m_key_index

template<typename KeyId , typename Value , typename Traits >
hash_map<KeyId, int> ordered_hash_map< KeyId, Value, Traits >::m_key_index
private

Referenced by ordered_hash_map< KeyId, Value, Traits >::get_or_insert(), and ordered_hash_map< KeyId, Value, Traits >::put().

◆ m_keys

template<typename KeyId , typename Value , typename Traits >
auto_vec<Key> ordered_hash_map< KeyId, Value, Traits >::m_keys
private

Referenced by ordered_hash_map< KeyId, Value, Traits >::end(), ordered_hash_map< KeyId, Value, Traits >::get_or_insert(), ordered_hash_map< KeyId, Value, Traits >::iterator::operator*(), ordered_hash_map< KeyId, Value, Traits >::ordered_hash_map(), ordered_hash_map< KeyId, Value, Traits >::put(), and ordered_hash_map< KeyId, Value, Traits >::iterator::valid_index_p().

◆ m_map

template<typename KeyId , typename Value , typename Traits >
hash_map<KeyId, Value, Traits> ordered_hash_map< KeyId, Value, Traits >::m_map
private

Referenced by ordered_hash_map< KeyId, Value, Traits >::elements(), ordered_hash_map< KeyId, Value, Traits >::get(), ordered_hash_map< KeyId, Value, Traits >::get_or_insert(), ordered_hash_map< KeyId, Value, Traits >::put(), and ordered_hash_map< KeyId, Value, Traits >::remove().

The documentation for this class was generated from the following file: