SCSet.h

Go to the documentation of this file.

//
//  SCSet.h
//  scl
//
//  Created by Viacheslav Smolensky on 13.04.12.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCCollection.h>

#define SCSetClass @"SCSet" ///< SCSet class name

@interface SCSet : SCCollection {
    NSMutableSet *fSet; // Internal set
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET
// Set name property
@property (retain, getter=setName, setter=setSetName:) NSString *setName;
#endif

#pragma mark -
#pragma mark Creating Set

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

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

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

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

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

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

+ (SCSet *)set;

+ (SCSet *)setWithSetName:(NSString *)name capacity:(SCULong)capacity;

+ (SCSet *)setWithSetName:(NSString *)name;

+ (SCSet *)setWithCapacity:(SCULong)capacity;

+ (SCSet *)setWithDelegate:(id<SCCollectionDelegate>)delegate;

+ (SCSet *)setWithDelegate:(id<SCCollectionDelegate>)delegate collection:(id)collection;

+ (SCSet *)setWithCollection:(id)collection;

+ (SCSet *)setWithDelegate:(id<SCCollectionDelegate>)delegate object:(id)object;

+ (SCSet *)setWithObject:(id)object;

+ (SCSet *)setWithDelegate:(id<SCCollectionDelegate>)delegate objects:(id)object, ...;

+ (SCSet *)setWithObjects:(id)object, ...;

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

#pragma mark -
#pragma mark Initializing Set

- (id)init;

- (id)initWithSetName:(NSString *)name capacity:(SCULong)capacity;

- (id)initWithSetName:(NSString *)name;

- (id)initWithCapacity:(SCULong)capacity;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate collection:(id)collection;

- (id)initWithCollection:(id)collection;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate object:(id)object;

- (id)initWithObject:(id)object;

- (id)initWithDelegate:(id<SCCollectionDelegate>)delegate objects:(id)object, ...;

- (id)initWithObjects:(id)object, ...;

- (id)initWithSet:(SCSet *)set;

#pragma mark -
#pragma mark Querying and Setting Set Properties

- (NSString *)setName;

- (void)setSetName:(NSString *)name;

#pragma mark -
#pragma mark Querying Set

- (SCArray *)allObjects;

- (id)anyObject;

#pragma mark -
#pragma mark Comparing Sets

- (BOOL)isSubsetOfCollection:(id)collection;

- (BOOL)intersectsCollection:(id)collection;

#pragma mark -
#pragma mark Removing Objects

- (void)removeObject:(id)object;

- (void)removeByte:(SCByte)byte;

- (void)removeUByte:(SCUByte)byte;

- (void)removeShort:(SCShort)shortint;

- (void)removeUShort:(SCUShort)shortint;

- (void)removeInteger:(SCInteger)integer;

- (void)removeUInteger:(SCUInteger)integer;

- (void)removeLong:(SCLong)longint;

- (void)removeULong:(SCULong)longint;

- (void)removeChar:(char)chr;

- (void)removeUnichar:(unichar)chr;

- (void)removeCharString:(const char *)string;

- (void)removeBool:(BOOL)boolean;

- (void)removeFloat:(SCFloat)flt;

- (void)removeDouble:(SCDouble)dbl;

- (void)removeObjects:(id)object, ...;

- (void)removeObjectsInCollection:(id)collection;

- (void)removeObjectsEqualTo:(id)object;

#pragma mark -
#pragma mark Combining and Recombining Sets

- (void)unionCollection:(id)collection;

- (void)minusCollection:(id)collection;

- (void)intersectCollection:(id)collection;

@end