AVLSet autogsdoc generated documentation

Authors

Generated by pauljohn

Contents -

  1. Software documentation for the AVLSet class
  2. Software documentation for the AVLSetIndex_c class
  3. AVLSet types

Software documentation for the AVLSet class

AVLSet : SwarmObject

Declared in:
AVLSet.h
Conforms to:
KeyedCollection

Description forthcoming.

Method summary

createBegin:

+ (id) createBegin: (id)aZone;

Description forthcoming.

createBegin:Param:Zone:

+ (id) createBegin: (int(*)(const void*,const void*,void*))comparFunc Param: (void*)param Zone: (id)aZone;

Description forthcoming.

add:

- (BOOL) add: (id)anObject;

Description forthcoming.

allSameClass

- (BOOL) allSameClass;

Description forthcoming.

at:

- (id) at: (id)aKey;

Description forthcoming.

at:memberSlot:

- (BOOL) at: (id)aKey memberSlot: (id**)memptr;

Description forthcoming.

atOffset:

- (id) atOffset: (unsigned)x;

Description forthcoming.

begin:

- (id) begin: (id)aZone;

Description forthcoming.

beginPermuted:

- (id) beginPermuted: (id)aZone;

Description forthcoming.

contains:

- (BOOL) contains: (id)aKey;

Description forthcoming.

containsKey:

- (BOOL) containsKey: (id)aKey;

Description forthcoming.

copy:

- (id) copy: (id)aZone;

Description forthcoming.

count

- (int) count;

Description forthcoming.

createEnd

- (id) createEnd;

Description forthcoming.

createIndex:fromMember:

- (id) createIndex: (id<Zone>)aZone fromMember: (id)anObject;

Description forthcoming.

deleteAll

- (void) deleteAll;

Description forthcoming.

describeForEach:

- (void) describeForEach: (id)outputCharStream;

Description forthcoming.

describeForEachID:

- (void) describeForEachID: (id)outputCharStream;

Description forthcoming.

drop

- (void) drop;

Description forthcoming.

forEach:

- (void) forEach: (SEL)aSelector;

Description forthcoming.

forEach::

- (void) forEach: (SEL)aSelector : (id)arg1;

Description forthcoming.

forEach:::

- (void) forEach: (SEL)aSelector : (id)arg1 : (id)arg2;

Description forthcoming.

forEach::::

- (void) forEach: (SEL)aSelector : (id)arg1 : (id)arg2 : (id)arg3;

Description forthcoming.

forEachKey:

- (void) forEachKey: (SEL)aSelector;

Description forthcoming.

forEachKey::

- (void) forEachKey: (SEL)aSelector : (id)arg1;

Description forthcoming.

forEachKey:::

- (void) forEachKey: (SEL)aSelector : (id)arg1 : (id)arg2;

Description forthcoming.

forEachKey::::

- (void) forEachKey: (SEL)aSelector : (id)arg1 : (id)arg2 : (id)arg3;

Description forthcoming.

forcefulReplace:

- (id) forcefulReplace: (id)anObject;

Description forthcoming.

getCount

- (unsigned) getCount;

Description forthcoming.

getFirst

- (id) getFirst;

Description forthcoming.

getLast

- (id) getLast;

Description forthcoming.

getReplaceOnly

- (BOOL) getReplaceOnly;

Description forthcoming.

getTree

- (avl_tree*) getTree;

Description forthcoming.

remove:

- (id) remove: (id)aKey;

Description forthcoming.

removeAll

- (void) removeAll;

Description forthcoming.

removeFirst

- (id) removeFirst;

Description forthcoming.

removeKey:

- (id) removeKey: (id)aKey;

Description forthcoming.

removeLast

- (id) removeLast;

Description forthcoming.

replace:

- (id*) replace: (id)anObject;

Description forthcoming.

setCompareCStrings

- (id) setCompareCStrings;

Description forthcoming.

setCompareFunction:

- (id) setCompareFunction: (compare_avl_t)compareFunction;

Description forthcoming.

setCompareIDs

- (id) setCompareIDs;

Description forthcoming.

setCompareIntegers

- (id) setCompareIntegers;

Description forthcoming.

setCompareUnsignedIntegers

- (id) setCompareUnsignedIntegers;

Description forthcoming.

setIndexFromMemberLoc:

- (void) setIndexFromMemberLoc: (int)byteOffset;

Description forthcoming.

setInitialValue:

- (void) setInitialValue: (id)initialValue;

Description forthcoming.

setReplaceOnly:

- (id) setReplaceOnly: (BOOL)condition;

Description forthcoming.

traverse:

- (id) traverse: (avl_traverser*)travPtr;

Description forthcoming.

walk:Param:

- (void) walk: (void(*)(void*,void*))aFunction Param: (void*)PARAM;

Description forthcoming.

Software documentation for the AVLSetIndex_c class

AVLSetIndex_c : Index_any

Declared in:
AVLSet.h
Conforms to:
KeyedCollectionIndex

Description forthcoming.

Instance variables

tree

@public avl_tree* tree;

Description forthcoming.

Method summary

_I_Using

- (id) _I_Using;

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.

get

- (id) get;

Description forthcoming.

getCollection

- (id) getCollection;

Description forthcoming.

getLoc

- (id<Symbol>) getLoc;

Description forthcoming.

getOffset

- (int) getOffset;

Description forthcoming.

init

- (id) init;

Description forthcoming.

next

- (id) next;

Description forthcoming.

prev

- (id) prev;

Description forthcoming.

put:

- (id) put: (id)anObject;

Description forthcoming.

remove

- (id) remove;

Description forthcoming.

replace:

- (id) replace: (id)anObject;

Description forthcoming.

setLoc:

- (void) setLoc: (id<Symbol>)locSymbol;

Description forthcoming.

setOffset:

- (id) setOffset: (unsigned)targetOffset;

Description forthcoming.

AVLSet types

compare_avl_t

typedef int(* compare_avl_t;

Description forthcoming.