SCSet.h

Go to the documentation of this file.

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

#import <Foundation/Foundation.h>
#import <scl/NSArray+SCArray.h>
#import <scl/NSDictionary+SCDictionary.h>
#import <scl/SCCollection.h>

#pragma mark -
#pragma mark Class Constants

#define SCSetClass  @"SCSet"


@interface SCSet : SCCollection {
    NSMutableSet *_set; // Internal data storage
}

@property (nonatomic, readonly, assign) SCArray *allObjects;

@property (nonatomic, readonly, assign) id anyObject;

#pragma mark -
#pragma mark Creating Sets
+ (instancetype)setWithCoder:(NSCoder *)coder;
+ (instancetype)setWithContentsOfSerializedFile:(NSString *)path;
+ (instancetype)setWithDataDictionary:(NSDictionary *)dictionary;
+ (instancetype)setWithDataDictionaryFromFile:(NSString *)path;
+ (instancetype)setWithStream:(SCStream *)stream;
+ (instancetype)setWithFileStream:(NSString *)path;
+ (instancetype)setWithData:(NSData *)data;
+ (instancetype)setWithContentsOfFile:(NSString *)path;
+ (instancetype)setWithContentsOfURL:(NSURL *)url;
+ (instancetype)setWithContentsOfURLString:(NSString *)urlString;

+ (instancetype)setWithName:(NSString *)name;
+ (instancetype)setWithObject:(id<SCCollectioning>)object;
+ (instancetype)setWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
+ (instancetype)setWithCollection:(id<SCCollection>)collection;
+ (instancetype)setWithSet:(SCSet *)set;
+ (instancetype)setWithArray:(SCArray *)array;
+ (instancetype)set;

#pragma mark -
#pragma mark Initializing Sets
- (instancetype)initWithName:(NSString *)name;
- (instancetype)initWithObject:(id<SCCollectioning>)object;
- (instancetype)initWithObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (instancetype)initWithCollection:(id<SCCollection>)collection;
- (instancetype)initWithSet:(SCSet *)set;
- (instancetype)initWithArray:(SCArray *)array;
- (instancetype)init;

#pragma mark -
#pragma mark Copying Sets
- (void)setSet:(SCSet *)set;
- (void)setArray:(SCArray *)array;

#pragma mark -
#pragma mark Comparing Sets
- (BOOL)isSubsetOfSet:(id<SCCollection>)set;
- (BOOL)intersectsSet:(id<SCCollection>)set;
- (BOOL)isEqualToSet:(SCSet *)set;
- (BOOL)isEqualToArray:(SCArray *)array;

#pragma mark -
#pragma mark Deriving New Sets
- (SCSet *)setByAddingObject:(id<SCCollectioning>)object;
- (SCSet *)setByAddingObjects:(id<SCCollectioning>)object, ... NS_REQUIRES_NIL_TERMINATION;
- (SCSet *)setByAddingObjectsFromArray:(SCArray *)array;
- (SCSet *)setByAddingArray:(SCArray *)array;
- (SCSet *)setByAddingObjectsFromSet:(SCSet *)set;
- (SCSet *)setByAddingSet:(SCSet *)set;
- (SCSet *)setByAddingCollection:(id<SCCollection>)collection;

#pragma mark -
#pragma mark Adding Objects
- (void)addObjectsFromArray:(SCArray *)array;
- (void)addArray:(SCArray *)array;
- (void)addObjectsFromSet:(SCSet *)set;
- (void)addSet:(SCSet *)set;

#pragma mark -
#pragma mark Accessing Set Members
- (id)member:(id<SCCollectioning>)object;

#pragma mark -
#pragma mark Combining and Recombining Sets
- (void)unionSet:(id<SCCollection>)set;
- (void)minusSet:(id<SCCollection>)set;
- (void)intersectSet:(id<SCCollection>)set;

@end