oaHashMap.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaHashMap.h
//
// This file contains the definitions of the oaHashMap class.
//
//  oaHashMap
//      This class implements a base class that can be used for all types of
//      hash maps. It is used by deriving from it for a particular key and data
//      type and then overriding the virtual functions hash() and compare() for
//      that particular key type.
//
//  oaHashMapIter
//      This class implements an iterator over all objects in a hash map.
//
// The following class is a private implementation class used by the public
// classes described above.
//
//  oaHashMapTbl
//      This class implements a hash table that stores indices into a separate
//      array of keys that is stored in a separate, owning class.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaHashMap_P)
#define oaHashMap_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaArray.h"
#include "oaHashTbl.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward declaration.
// *****************************************************************************
template<class K, class D>
class oaHashMap;
template<class K, class D>
class oaHashMapIter;



// *****************************************************************************
// oaHashMapTbl
//
// This class implements a hash table that stores indices into an array of keys
// that is stored in an owning class.
// *****************************************************************************
template<class K, class D>
class oaHashMapTbl : public oaHashTbl<oaUInt4> {
protected:
                            oaHashMapTbl(oaUInt4 sizeIn = 32);

    virtual void            hash(oaUInt4    index,
                                 oaUInt4    &start,
                                 oaUInt4    &stride) const;
    virtual oaBoolean       compare(oaUInt4     index,
                                    const void  *data) const;

    void                    setOwner(oaHashMap<K, D> *ownerIn);

    oaHashMap<K, D>         *owner;

    friend class oaHashMap<K, D>;
};



// *****************************************************************************
// oaHashMap<K, D>
// *****************************************************************************
template<class K, class D>
class oaHashMap {
public:
                                oaHashMap(oaUInt4 sizeIn = 32);

    void                        add(const K &key,
                                    const D &datum);
    oaBoolean                   find(const K    &key,
                                     D          &datum) const;
    void                        remove(const K &key);

    oaUInt4                     getNumEntries() const;

protected:
    virtual void                hash(K          key,
                                     oaUInt4    &start,
                                     oaUInt4    &stride) const = 0;
    virtual oaBoolean           compare(K   key1,
                                        K   key2) const = 0;

    void                        hashIndex(oaUInt4   index,
                                          oaUInt4   &start,
                                          oaUInt4   &stride) const;
    oaBoolean                   compareIndex(oaUInt4    index,
                                             const K    &key) const;

    const oaHashMapTbl<K, D>    *getHashTbl() const;

    oaHashMapTbl<K, D>          tbl;

private:
    oaArray<K>                  keys;
    oaArray<D>                  data;

    friend class oaHashMapTbl<K, D>;
    friend class oaHashMapIter<K, D>;
};



// *****************************************************************************
// oaHashMapIter<K, D>
//
// This class defines an iterator for enumerating the contents of an oaHashMap.
// *****************************************************************************
template<class K, class D>
class oaHashMapIter {
public:
                            oaHashMapIter(oaHashMap<K, D> &mapIn);

    void                    reset();

    oaBoolean               getNext(K   &key,
                                    D   &datum);

protected:
    oaHashMap<K, D>         &map;
    oaUInt4                 index;
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.