Unordered set class. More...

#import <SCSet.h>

Inheritance diagram for SCSet:

Creating Sets
(SCSet *)	+ setWithCoder:

(SCSet *)	+ setWithContentsOfSerializedFile:

(SCSet *)	+ setWithDataDictionary:

(SCSet *)	+ setWithDataDictionaryFromFile:

(SCSet *)	+ setWithStream:

(SCSet *)	+ setWithFileStream:

(SCSet *)	+ setWithName:

(SCSet *)	+ setWithObject:

(SCSet *)	+ setWithObjects:

(SCSet *)	+ setWithCollection:

(SCSet *)	+ setWithSet:

(SCSet *)	+ set

Initializing Sets
(id)	- initWithName:

(id)	- initWithObject:

(id)	- initWithObjects:

(id)	- initWithCollection:

(id)	- initWithSet:

(id)	- init

Copying Sets
(void)	- setSet:

Comparing Sets
(BOOL)	- isSubsetOfSet:

(BOOL)	- intersectsSet:

(BOOL)	- isEqualToSet:

(BOOL)	- isEqualToContentsOfSet:

Accessing Set Members
SCArray *	allObjects

id	anyObject

Combining and Recombining Sets
(void)	- unionSet:

(void)	- minusSet:

(void)	- intersectSet:

Additional Inherited Members
Instance Methods inherited from SCCollection
(void)	- setCollection:

(void)	- setObject:

(void)	- setObjects:

(BOOL)	- isEqualToCollection:

(BOOL)	- isEqual:

(void)	- enumerateWithDelegate:

(void)	- enumerate

(void)	- reverseEnumerateWithDelegate:

(void)	- reverseEnumerate

(void)	- addObjects:

(void)	- addByte:

(void)	- addUByte:

(void)	- addShort:

(void)	- addUShort:

(void)	- addInteger:

(void)	- addUInteger:

(void)	- addLong:

(void)	- addULong:

(void)	- addChar:

(void)	- addUnichar:

(void)	- addCharString:

(void)	- addBool:

(void)	- addFloat:

(void)	- addDouble:

(void)	- addCollection:

(void)	- removeObjectsWithClassName:

(void)	- removeCollection:

(void)	- removeByte:

(void)	- removeUByte:

(void)	- removeShort:

(void)	- removeUShort:

(void)	- removeInteger:

(void)	- removeUInteger:

(void)	- removeLong:

(void)	- removeULong:

(void)	- removeChar:

(void)	- removeUnichar:

(void)	- removeCharString:

(void)	- removeBool:

(void)	- removeFloat:

(void)	- removeDouble:

(void)	- removeObjects:

(BOOL)	- containsByte:

(BOOL)	- containsUByte:

(BOOL)	- containsShort:

(BOOL)	- containsUShort:

(BOOL)	- containsInteger:

(BOOL)	- containsUInteger:

(BOOL)	- containsLong:

(BOOL)	- containsULong:

(BOOL)	- containsChar:

(BOOL)	- containsUnichar:

(BOOL)	- containsCharString:

(BOOL)	- containsBool:

(BOOL)	- containsFloat:

(BOOL)	- containsDouble:

(BOOL)	- containsObjects:

(BOOL)	- containsCollection:

(BOOL)	- containsAnyObject:

(BOOL)	- containsAnyObjectFromCollection:

(BOOL)	- isCollection

(BOOL)	- isLibraryCollection

(BOOL)	- isFoundationCollection

(BOOL)	- isArray

(BOOL)	- isLibraryArray

(BOOL)	- isFoundationArray

(BOOL)	- isFoundationSet

(BOOL)	- isOrderedSet

(BOOL)	- isLibraryOrderedSet

(BOOL)	- isFoundationOrderedSet

(BOOL)	- isDictionary

(BOOL)	- isLibraryDictionary

(BOOL)	- isFoundationDictionary

(BOOL)	- isStack

(BOOL)	- isQueue

(BOOL)	- isList

(BOOL)	- isSortable

Instance Methods inherited from SCObject
(id)	- initWithContentsOfSerializedFile:

(BOOL)	- writeContentsToSerializedFile:

(id)	- initWithDataDictionaryFromFile:

(void)	- writeToDataDictionaryFile:atomically:

(void)	- writeToDataDictionaryFile:

(NSDictionary *)	- dataDictionary

(id)	- initWithFileStream:

(void)	- writeToFileStream:

(void)	- appendToFileStream:

Instance Methods inherited from <SCCoding>
Instance Methods inherited from <SCDictionaring>
Instance Methods inherited from <SCCollectioning>
Instance Methods inherited from <SCMutableCollection>
Instance Methods inherited from <SCCollection>
Class Methods inherited from SCCollection
(BOOL)	+ isCollectionClass:

(BOOL)	+ isLibraryCollectionClass:

(BOOL)	+ isFoundationCollectionClass:

(BOOL)	+ isArrayClass:

(BOOL)	+ isLibraryArrayClass:

(BOOL)	+ isFoundationArrayClass:

(BOOL)	+ isSetClass:

(BOOL)	+ isLibrarySetClass:

(BOOL)	+ isFoundationSetClass:

(BOOL)	+ isOrderedSetClass:

(BOOL)	+ isLibraryOrderedSetClass:

(BOOL)	+ isFoundationOrderedSetClass:

(BOOL)	+ isDictionaryClass:

(BOOL)	+ isLibraryDictionaryClass:

(BOOL)	+ isFoundationDictionaryClass:

(BOOL)	+ isStackClass:

(BOOL)	+ isQueueClass:

(BOOL)	+ isListClass:

(BOOL)	+ isSortableClass:

(BOOL)	+ isCollection:

(BOOL)	+ isLibraryCollection:

(BOOL)	+ isFoundationCollection:

(BOOL)	+ isArray:

(BOOL)	+ isLibraryArray:

(BOOL)	+ isFoundationArray:

(BOOL)	+ isSet:

(BOOL)	+ isLibrarySet:

(BOOL)	+ isFoundationSet:

(BOOL)	+ isOrderedSet:

(BOOL)	+ isLibraryOrderedSet:

(BOOL)	+ isFoundationOrderedSet:

(BOOL)	+ isDictionary:

(BOOL)	+ isLibraryDictionary:

(BOOL)	+ isFoundationDictionary:

(BOOL)	+ isStack:

(BOOL)	+ isQueue:

(BOOL)	+ isList:

(BOOL)	+ isSortable:

Properties inherited from SCCollection
NSString *	name

BOOL	readOnly

id< SCCollectionDelegate >	delegate

SCULong	count

BOOL	empty

NSString *	typeName

NSString *	description

NSEnumerator *	objectEnumerator

NSEnumerator *	reverseObjectEnumerator

Properties inherited from <SCCollection>
SCULong	count

BOOL	empty

NSString *	description

SCArray *	array

SCSet *	set

SCOrderedSet *	orderedSet

SCDictionary *	dictionary

SCStack *	stack

SCQueue *	queue

SCUnidirectionalList *	unidirectionalList

SCBidirectionalList *	bidirectionalList

NSArray *	foundationArray

NSSet *	foundationSet

NSOrderedSet *	foundationOrderedSet

NSDictionary *	foundationDictionary

NSEnumerator *	objectEnumerator

Detailed Description

Unordered set class.

Since: version 1.1.3

Implements the unordered object sets.
Class instances can thrown the following exceptions:

Method Documentation

- (id) init

Initializes an empty unnamed set using the default settings.

Returns: A newly initialized set

- (id) initWithCollection: (id) collection

Initializes a set using the objects from the specified collection of any supported type.

Parameters

collection - existing source collection

Returns: A newly initialized set with the objects from the specified collection

Exceptions

SCCollectionException - collection error detected

Reimplemented from SCCollection.

- (id) initWithName: (NSString *) name

Initializes an empty set using the specified set name.

Attention: Designed initializer

Parameters

name	- name of the set

Returns: A newly initialized set

- (id) initWithObject: (id) object

Initializes a set using the specified existing object.

Parameters

object - existing source object

Returns: A newly initializes set with the specified object

Exceptions

SCCollectionException - collection error detected

- (id) initWithObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Initializes a set using the existing objects from the specified nil terminated list.

Parameters

object	- first object within the list
...	- other objects within the list
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Returns: A newly initialized set with the objects from the specified list

- (id) initWithSet: (SCSet *) set

Initializes a set using the settings and content of the specified existing set.

Attention: Designed initializer

Parameters

set	- existing source set

Returns: A newly initialized set with the settings and content of the specified set

Exceptions

SCCollectionException - collection error detected

- (void) intersectSet: (id) set

Removes from the receiving set each object that isn't a member of the specified collection of any supported type.

Parameters

set	- collection with which to perform the intersection

Exceptions

SCCollectionException - collection error detected

- (BOOL) intersectsSet: (id) set

Returns a boolean value that indicates whether at least one object in the receiving set is also present in the specified collection of any supported type.

Parameters

set	- collection with which to compare the receiving set

Returns: YES if at least one object in the receiving set is also present in the specified collection, otherwise NO

Exceptions

SCCollectionException - collection error detected

- (BOOL) isEqualToContentsOfSet: (SCSet *) set

Compares the contents of the receiving set to the contents of the specified collection of any supported type.

Parameters

set	- collection with which to compare the receiving set

Returns: YES if the contents of the specified collection is equal to the contents of the receiving set, otherwise NO

- (BOOL) isEqualToSet: (SCSet *) set

Compares the settings and contents of the receiving set to the settings and contents of the specified collection of any supported type.

Parameters

set	- collection with which to compare the receiving set

Returns: YES if the settings and contents of the specified collection are equal to the settings and contents of the receing set, otherwise NO

- (BOOL) isSubsetOfSet: (id) set

Returns a boolean value that indicates whether every object in the receiving set is also present in the specified collection of any supported type.

Parameters

set	- collection with which to compare the receiving set

Returns: YES if every object in the receiving set is also present in the specified collection, otherwise NO

Exceptions

SCCollectionException - collection erro detected

- (void) minusSet: (id) set

Removes each object in the specified collection of any supported type from the receiving set, if present.

Parameters

set	- collection of objects to remove from the receiving list

Exceptions

SCCollectionException - collection error detected

+ (SCSet *) set

Returns an empty unnamed set created by using the default settings.

Returns: A created set

Reimplemented from SCCollection.

- (void) setSet: (SCSet *) set

Empties the receiving set, then copies the settings and adds each object contained in another given set.

Parameters

set	- set whose members replace the receiving set content and settings.

Exceptions

SCCollectionException - collection error detected

+ (SCSet *) setWithCoder: (NSCoder *) coder

Returns a set created by using the specified coder.

Parameters

coder - source coder

Returns: A created set

+ (SCSet *) setWithCollection: (id) collection

Returns a set created by using the objects from the specified existing collection of any supported type.

Parameters

collection - existing source collection

Returns: A created set with the objects from the specified collection

Exceptions

SCCollectionException - collection error detected

+ (SCSet *) setWithContentsOfSerializedFile: (NSString *) path

Returns a set created by using the content of serialized file with the specified path.

Parameters

path	- path of the source serialized file

Returns: A created set

+ (SCSet *) setWithDataDictionary: (NSDictionary *) dictionary

Returns a set created by using the specified data dictionary.

Parameters

dictionary - source data dictionary

Returns: A created set

+ (SCSet *) setWithDataDictionaryFromFile: (NSString *) path

Returns a set created by using the data dictionary from the specified file.

Parameters

path	- path of the source dictionary file

Returns: A created set

+ (SCSet *) setWithFileStream: (NSString *) path

Returns a set created by using the data from the file stream with the specified path.

Parameters

path	- path of the source file stream

Returns: A created set

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

+ (SCSet *) setWithName: (NSString *) name

Returns an empty set created by using the specified set name.

Parameters

name	- name of the set

Returns: A created set

+ (SCSet *) setWithObject: (id) object

Returns a set created by using the specified existing object.

Parameters

object - existing source object

Returns: A created set with the specified object

Exceptions

SCCollectionException - collection error detected

+ (SCSet *) setWithObjects:	(id)	object
,		NS_REQUIRES_NIL_TERMINATION

Returns a set created by using the existing objects from the specified nil terminated list.

Parameters

object	- first object within the list
...	- other objects within the list
NS_REQUIRES_NIL_TERMINATION	- mandatory nil pointer

Returns: A created set with the specified objects

+ (SCSet *) setWithSet: (SCSet *) set

Returns a set created by using the specified existing set.

Parameters

set	- existing source set

Returns: A created set with the settings and objects from the specified existing set

Exceptions

SCCollectionException - collection error detected

+ (SCSet *) setWithStream: (SCStream *) stream

Returns a set created by using the data from the specified stream.

Parameters

stream - source stream

Returns: A created set

Exceptions

SCStreamException	- stream error detected
SCSystemException	- system error detected

- (void) unionSet: (id) set

Adds each object in the specified collection of any supported type to the receiving set, if not present.

Parameters

set	- collection of objects to add to the receiving list

Exceptions

SCCollectionException - collection error detected

Property Documentation

- (SCArray *) allObjects

readnonatomicretain

An array containing the members of the set, or an empty array if the set has no members

- (id) anyObject

readnonatomicretain

One of the objects in the set, or nil if the set contains no objects

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

SCSet.h
SCSet.m

Creating Sets

Initializing Sets

Copying Sets

Comparing Sets

Accessing Set Members

Combining and Recombining Sets

Additional Inherited Members

Detailed Description

Method Documentation

Property Documentation