OdHashSet.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ODA_HASH_SET_H_
#define _ODA_HASH_SET_H_
 
/* hash_set isn't included into STL standart initially, so implementations is
   available under different namespaces and could have implementation
   differences.                                                               */
 
/* Mostly STL implementations contain hash_set which uses separate hasher and predicate
   template arguments. In this implementations predicate defined as std::equal_to.
   Now this type of hash sets included in C++11 standart as unordered_set.
   This implementation contained by all compilers, which uses SGI STL, but
   Visual Studio contains it only since 2015 (previous versions contain Dinkumware hash_set
   implementation, which invokes std::less predicate, so we can't emulate unordered_set
   through this container.                                                                  */
// #ifdef UNORDEREDSET_SUPPORTED
// Syntax: OdUnorderedSet<KeyType, HashFunction, EqualityPredicate, Allocator>
 
#if defined(__GNUC__) && !defined(ANDROID)
// GCC
#define _GLIBCXX_PERMIT_BACKWARD_HASH
#include <ext/hash_set>
#define UNORDEREDSET_SUPPORTED
// This is for GCC-3.1+, GCC 3.0.x puts hash_set in the std namespace.
// Older compilers such as GCC before version 3.0 do not keep
// extensions in the `ext' directory, and ignore the `std' namespace.
#define OdUnorderedSet __gnu_cxx::hash_set
#define OdUnorderedSet_DefaultHasher __gnu_cxx::hash
#elif defined(__sun)
// sparc on Sun Studio compiler, solaris
// SUNpro uses Cstd by default which is haven't hash_set. But SUNpro ships with -library=stlport4
// which is could be enabled by compiler and linker options.
// LIBSTLPORT = -library=no%Cstd -L../../lib -lstlport_sunpro64
// First of all include <utility> to detect which STL is actually configured to use:
#include <utility>
// Enable hash_set only if stlport is used:
#ifdef _STLPORT_VERSION
#include <hash_set>
#define UNORDEREDSET_SUPPORTED
#define OdUnorderedSet std::hash_set
#define OdUnorderedSet_DefaultHasher std::hash
#endif // _STLPORT_VERSION
#elif defined(_MSC_VER) || defined(__BORLANDC__)
// MSVC, BB (Dinkumware)
#if (_MSC_VER >= 1600)
#include <unordered_set>
#define UNORDEREDSET_SUPPORTED
#define OdUnorderedSet std::unordered_set
#define OdUnorderedSet_DefaultHasher std::hash
#else
#include <hash_set>
#define HASHSET_SUPPORTED
#define OdUnorderedSet stdext::hash_set
namespace std 
{
  template <class DataType> struct hash 
  {
    size_t operator()(const DataType& x) const { return static_cast<size_t>(x); }
  };
}
#define OdUnorderedSet_DefaultHasher std::hash
#endif
#elif defined(sgi)
// SGI (StlPort)
#include <hash_set>
#define UNORDEREDSET_SUPPORTED
#define OdUnorderedSet std::hash_set
#define OdUnorderedSet_DefaultHasher std::hash
#elif defined(__hpux)
// HPUX
// HP aCC doesn't include an SGI-like hash_set. For this platform (or
// any others using Rogue Wave Software's Tools.h++ library), we wrap
// around them in std::
#include <rw/stdex/hashset.h>
#if 1 // to wrap in std if necessary
//#ifndef RW_ALLOCATOR_PLAIN
namespace std {
  template <class DataType> struct hash {
    size_t operator()(const DataType& x) const { return static_cast<size_t>(x); }
  };
  template < class KeyVal,
             class _HashFcn = hash<KeyVal>,
             class Pred = equal_to<KeyVal>,
             class Alloc = allocator<KeyVal> >
  class hash_set : public rw_hashset < KeyVal, _HashFcn, Pred, Alloc > {};
}
#define UNORDEREDSET_SUPPORTED
#define OdUnorderedSet std::hash_set
#define OdUnorderedSet_DefaultHasher std::hash
//#endif
#else // clear way without wrapping
#define UNORDEREDSET_SUPPORTED
#define OdUnorderedSet rw_hashset
#define OdUnorderedSet_DefaultHasher rw_hash
#endif
#elif defined(ANDROID)
#include <unordered_set>
#define UNORDEREDSET_SUPPORTED
#define OdUnorderedSet std::unordered_set
#define OdUnorderedSet_DefaultHasher std::hash
#else
// List of known platforms which isn't support hash_set:
// MSVC6 and earlier
// solaris w/o stlport
#error Unknown platform... check hash_set support
#endif
 
/* Dinkumware hash_set implementation require following specification of hasher and predicate:
  struct Hasher {
    enum { bucket_size = 4, min_buckets = 8 };
    size_t operator()(const Key &key) const {
      return hash(key);
    }
    bool operator()(const Key &ls, const Key &rs) const {
      return ls < rs;
    }
  };
  It is combines hash function and predicate. We can use this specification as client for
  OdUnorderedSet implementation too using two comparisons through less predicate:
  equal_to == !(l < r) && !(r < l). Of course this solution can cause perfomance loss
  if keys comparison isn't simple, but at least it will work onto all platforms.          */
// #ifdef HASHSET_SUPPORTED
// Syntax: OdHashSetLs<KeyType, HashWithLessPredicate, Allocator>
 
#ifdef UNORDEREDSET_SUPPORTED
#define HASHSET_SUPPORTED
template <class Key> struct od_std_hash_set_def_func : public OdUnorderedSet_DefaultHasher<Key>, public std::less<Key> {};
template <class Key, class _HashFcn>
struct od_std_hash_set_generalized_equal_to : protected _HashFcn
{ bool operator()(const Key& leftArg, const Key& rightArg) const {
    return !_HashFcn::operator()(leftArg, rightArg) && !_HashFcn::operator()(rightArg, leftArg); } };
template <class Key, class _HashFcn = od_std_hash_set_def_func<Key>, class Alloc = std::allocator<Key> >
class OdHashSetLs : public OdUnorderedSet<Key, _HashFcn, od_std_hash_set_generalized_equal_to<Key, _HashFcn>, Alloc> {};
#elif defined(_MSC_VER) || defined(__BORLANDC__)
// MSVC (this container available only since vc7), BB
#if (_MSC_VER >= 1300) || defined(__BORLANDC__)
#include <hash_set>
#define HASHSET_SUPPORTED
#define OdHashSetLs stdext::hash_set
#define OdHashSet_DefaultHasher stdext::hash_compare
#endif
#endif
 
/* Typically default implementation of predicate is enough for our needs.
   OdHashSet template doesn't require specification of predicate and uses default
   which is depends from hash_set implementation.                                 */
// #ifdef HASHSET_SUPPORTED
// Syntax: OdHashSet<KeyType, HashFunction, Allocator>
#ifdef UNORDEREDSET_SUPPORTED
template <class Key, class HashFcn = OdUnorderedSet_DefaultHasher<Key>, class Alloc = std::allocator<Key> >
class OdHashSet : public OdUnorderedSet<Key, HashFcn, std::equal_to<Key>, Alloc> {};
#elif defined(HASHSET_SUPPORTED)
template <class Key, class HashFcn>
struct od_std_hash_set_add_less_predicate : public HashFcn, public std::less<Key> {
  size_t operator()(const Key &key) const { return HashFcn::operator()(key); }
  bool operator()(const Key &ls, const Key &rs) const { return std::less<Key>::operator()(ls, rs); } };  
template <class Key, class HashFcn = OdHashSet_DefaultHasher<Key>, class Alloc = std::allocator<Key> >
class OdHashSet : public OdHashSetLs<Key, od_std_hash_set_add_less_predicate<Key, HashFcn>, Alloc> {};
#endif
 
template <class T> struct OdHashSet_PtrHasher : OdUnorderedSet_DefaultHasher<OdIntPtr> {
  enum { bucket_size = 4, min_buckets = 8 };
  size_t operator()(const T* key) const { return OdUnorderedSet_DefaultHasher<OdIntPtr>::operator()((OdIntPtr)key); }
};
 
#endif //_ODA_HASH_SET_H_