HashMap.h

//
// $Id: HashMap.h,v 1.24 2007/03/06 20:42:19 will_mason Exp $
//
// vi: set ft=objc:

/*
 * ObjectiveLib - a library of containers and algorithms for Objective-C
 *
 * Copyright (c) 2004-2007
 * Will Mason
 *
 * Portions:
 *
 * Copyright (c) 1994
 * Hewlett-Packard Company
 *
 * Copyright (c) 1996,1997
 * Silicon Graphics Computer Systems, Inc.
 *
 * Copyright (c) 1997
 * Moscow Center for SPARC Technology
 *
 * Copyright (c) 1999 
 * Boris Fomitchev
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * You may contact the author at will_mason@users.sourceforge.net.
 */

#if !defined(HASHMAP_OL_GUARD)
#define HASHMAP_OL_GUARD

#include <ObjectiveLib/Iterator.h>
#include <ObjectiveLib/Functional.h>

@class OLHashTableMap;

@interface OLHashMap :
#if defined(OL_NO_OPENSTEP)
    Object <OLStreamable>
#else
    NSObject <OLStreamable, NSCopying, NSCoding>
#endif
{
@protected
    OLHashTableMap* table;
}

+ (id) hashMap;

+ (id) hashMapFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

+ (id) hashMapWithHashMap: (OLHashMap*)right;

/* @{ */
- (id) init;

- (id) initFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

- (id) initFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last tableSize: (unsigned)size;

#if defined(OL_NO_OPENSTEP)
- (id) initFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last tableSize: (unsigned)size keyEqual: (Object<OLBoolBinaryFunction>*)eq;
#else
- (id) initFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last tableSize: (unsigned)size keyEqual: (NSObject<OLBoolBinaryFunction>*)eq;
#endif

#if !defined(OL_NO_OPENSTEP)

- (id) initWithCoder: (NSCoder*)decoder;
#endif

- (id) initWithHashMap: (OLHashMap*)right;

- (id) initWithObjectInStream: (OLObjectInStream*)stream;

- (id) initWithTableSize: (unsigned)size;

#if defined(OL_NO_OPENSTEP)
- (id) initWithTableSize: (unsigned)size keyEqual: (Object<OLBoolBinaryFunction>*)eq;
#else
- (id) initWithTableSize: (unsigned)size keyEqual: (NSObject<OLBoolBinaryFunction>*)eq;
#endif

#if defined(OL_NO_OPENSTEP)
- (id) free;
#else
- (void) dealloc;
#endif
/* @} */

- (void) assignKey: (id)key value: (id)value;

- (OLHashIterator*) begin;

- (void) clear;

- (int) compare: (id)other;

#if defined(OL_NO_OPENSTEP)

- (id) copy;
#else

- (id) copyWithZone: (NSZone*)zone;
#endif

- (unsigned) count: (id)key;

- (BOOL) empty;

#if !defined(OL_NO_OPENSTEP)

- (void) encodeWithCoder: (NSCoder*)encoder;
#endif

- (OLHashIterator*) end;

- (OLPair*) equalRange: (id)key;

- (void) erase: (OLHashIterator*)where;

- (void) eraseFrom: (OLHashIterator*)first to: (OLHashIterator*)last;

- (unsigned) eraseKey: (id)key;

- (OLHashIterator*) find: (id)key;

- (id) insert: (OLPair*)keyValue;

- (void) insertFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

- (id) insertKey: (id)key value: (id)val;

- (BOOL) isEqual: (id)object;

#if defined(OL_NO_OPENSTEP)
- (Object<OLBoolBinaryFunction>*) keyEqual;
#else
- (NSObject<OLBoolBinaryFunction>*) keyEqual;
#endif

- (unsigned) maxSize;

- (unsigned) size;

- (void) swap: (OLHashMap*)right;

- (id) valueForKey: (id)key;

- (void) writeSelfToStream: (OLObjectOutStream*)stream;

@end

@interface OLHashMultiMap : OLHashMap
{
}

+ (id) hashMultiMap;

+ (id) hashMultiMapFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

+ (id) hashMultiMapWithHashMap: (OLHashMap*)right;

- (void) assignKey: (id)key value: (id)value;

- (id) insert: (OLPair*)keyValue;
- (void) insertFrom: (OLForwardIterator*)first to: (OLForwardIterator*)last;

- (BOOL) isEqual: (id)object;

- (id) valueForKey: (id)key;

@end

#endif

---

Generated Sun Apr 22 15:17:58 2007, © 2004-2007 Will Mason