SCOrderedSet.h

Go to the documentation of this file.

//
//  SCOrderedSet.h
//  scl
//
//  Created by Viacheslav Smolensky on 04.02.16.
//  Copyright (c) 2007 - 2017 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCCollection.h>
#import <scl/SCSorterProtocol.h>
#import <scl/SCIndexedCollection.h>
#import <scl/SCMutableIndexedCollection.h>

#pragma mark -
#pragma mark Константы класса

#define SCOrderedSetClass   @"SCOrderedSet" 


@interface SCOrderedSet : SCCollection <SCIndexedCollection, SCMutableIndexedCollection> {
    NSMutableOrderedSet *fOrderedSet;   // Внутреннее представление элементов упорядоченного множества
}

@property (nonatomic, assign, readonly, getter=sortedOrderedSet) SCOrderedSet *sortedOrderedSet;

@property (nonatomic, retain, readonly, getter=allObjects) SCArray *allObjects;

@property (nonatomic, retain, readonly, getter=firstObject) id firstObject;

@property (nonatomic, retain, readonly, getter=firstString) NSString *firstString;

@property (nonatomic, retain, readonly, getter=firstNumber) NSNumber *firstNumber;

@property (nonatomic, retain, readonly, getter=lastObject) id lastObject;

@property (nonatomic, retain, readonly, getter=lastString) NSString *lastString;

@property (nonatomic, retain, readonly, getter=lastNumber) NSNumber *lastNumber;

@property (nonatomic, retain, readonly, getter=reversedOrderedSet) SCOrderedSet *reversedOrderedSet;

@property (nonatomic, assign, readonly, getter=indexOfLastObject) SCIndex indexOfLastObject;

#pragma mark -
#pragma mark Создание упорядоченных множеств
+ (SCOrderedSet *)orderedSetWithCoder:(NSCoder *)coder;
+ (SCOrderedSet *)orderedSetWithContentsOfSerializedFile:(NSString *)path;
+ (SCOrderedSet *)orderedSetWithDataDictionary:(NSDictionary *)dictionary;
+ (SCOrderedSet *)orderedSetWithDataDictionaryFromFile:(NSString *)path;
+ (SCOrderedSet *)orderedSetWithStream:(SCStream *)stream;
+ (SCOrderedSet *)orderedSetWithFileStream:(NSString *)path;

+ (SCOrderedSet *)orderedSetWithName:(NSString *)name;
+ (SCOrderedSet *)orderedSetWithObject:(id)object;
+ (SCOrderedSet *)orderedSetWithObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
+ (SCOrderedSet *)orderedSetWithCollection:(id)collection;
+ (SCOrderedSet *)orderedSetWithArray:(SCArray *)array;
+ (SCOrderedSet *)orderedSetWithSet:(SCSet *)set;
+ (SCOrderedSet *)orderedSetWithOrderedSet:(SCOrderedSet *)orderedSet;
+ (SCOrderedSet *)orderedSet;

+ (SCOrderedSet *)orderedSetWithAscendingSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
+ (SCOrderedSet *)orderedSetWithDescendingSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
+ (SCOrderedSet *)orderedSetWithSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
+ (SCOrderedSet *)orderedSetWithAscendingSortedCollection:(id)collection;
+ (SCOrderedSet *)orderedSetWithDescendingSortedCollection:(id)collection;
+ (SCOrderedSet *)orderedSetWithSortedCollection:(id)collection;

#pragma mark -
#pragma mark Инициализация упорядоченных множеств
- (id)initWithName:(NSString *)name;
- (id)initWithObject:(id)object;
- (id)initWithObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (id)initWithCollection:(id)collection;
- (id)initWithArray:(SCArray *)array;
- (id)initWithSet:(SCSet *)set;
- (id)initWithOrderedSet:(SCOrderedSet *)orderedSet;
- (id)init;

- (id)initWithAscendingSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
- (id)initWithDescendingSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
- (id)initWithSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
- (id)initWithAscendingSortedCollection:(id)collection;
- (id)initWithDescendingSortedCollection:(id)collection;
- (id)initWithSortedCollection:(id)collection;

#pragma mark -
#pragma mark Копирование упорядоченных множеств
- (void)setSet:(SCSet *)set;
- (void)setOrderedSet:(SCOrderedSet *)orderedSet;
- (void)setAscendingSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
- (void)setDescendingSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
- (void)setSortedCollection:(id)collection sorter:(id<SCSorter>)sorter;
- (void)setAscendingSortedCollection:(id)collection;
- (void)setDescendingSortedCollection:(id)collection;
- (void)setSortedCollection:(id)collection;

#pragma mark -
#pragma mark Сравнение упорядоченных множеств
- (BOOL)isSubsetOfOrderedSet:(id)orderedSet;
- (BOOL)isSubsetOfSet:(id)set;
- (BOOL)intersectsOrderedSet:(id)orderedSet;
- (BOOL)intersectsSet:(id)set;
- (BOOL)isEqualToOrderedSet:(id)orderedSet;
- (BOOL)isEqualToContentsOfOrderedSet:(SCOrderedSet *)orderedSet;

#pragma mark -
#pragma mark Сортировка упорядоченных множеств
- (void)sortAscendingWithSorter:(id<SCSorter>)sorter;
- (void)sortDescendingWithSorter:(id<SCSorter>)sorter;
- (void)sortWithSorter:(id<SCSorter>)sorter;
- (void)sortAscending;
- (void)sortDescending;
- (void)sort;
- (SCOrderedSet *)ascendingSortedOrderedSetWithSorter:(id<SCSorter>)sorter;
- (SCOrderedSet *)descendingSortedOrderedSetWithSorter:(id<SCSorter>)sorter;
- (SCOrderedSet *)sortedOrderedSetWithSorter:(id<SCSorter>)sorter;
- (SCOrderedSet *)ascendingSortedOrderedSet;
- (SCOrderedSet *)descendingSortedOrderedSet;
- (SCOrderedSet *)sortedOrderedSet;

#pragma mark -
#pragma mark Добавление объектов
- (void)insertObject:(id)object atIndex:(SCIndex)index;
- (void)insertByte:(SCByte)value atIndex:(SCIndex)index;
- (void)insertUByte:(SCUByte)value atIndex:(SCIndex)index;
- (void)insertShort:(SCShort)value atIndex:(SCIndex)index;
- (void)insertUShort:(SCUShort)value atIndex:(SCIndex)index;
- (void)insertInteger:(SCInteger)value atIndex:(SCIndex)index;
- (void)insertUInteger:(SCUInteger)value atIndex:(SCIndex)index;
- (void)insertLong:(SCLong)value atIndex:(SCIndex)index;
- (void)insertULong:(SCULong)value atIndex:(SCIndex)index;
- (void)insertChar:(char)value atIndex:(SCIndex)index;
- (void)insertUnichar:(unichar)value atIndex:(SCIndex)index;
- (void)insertCharString:(const char *)string atIndex:(SCIndex)index;
- (void)insertBool:(BOOL)value atIndex:(SCIndex)index;
- (void)insertFloat:(SCFloat)value atIndex:(SCIndex)index;
- (void)insertDouble:(SCDouble)value atIndex:(SCIndex)index;

- (void)setObject:(id)object atIndex:(SCIndex)index;
- (void)setByte:(SCByte)value atIndex:(SCIndex)index;
- (void)setUByte:(SCUByte)value atIndex:(SCIndex)index;
- (void)setShort:(SCShort)value atIndex:(SCIndex)index;
- (void)setUShort:(SCUShort)value atIndex:(SCIndex)index;
- (void)setInteger:(SCInteger)value atIndex:(SCIndex)index;
- (void)setUInteger:(SCUInteger)value atIndex:(SCIndex)index;
- (void)setLong:(SCLong)value atIndex:(SCIndex)index;
- (void)setULong:(SCULong)value atIndex:(SCIndex)index;
- (void)setChar:(char)value atIndex:(SCIndex)index;
- (void)setUnichar:(unichar)value atIndex:(SCIndex)index;
- (void)setCharString:(const char *)string atIndex:(SCIndex)index;
- (void)setBool:(BOOL)value atIndex:(SCIndex)index;
- (void)setFloat:(SCFloat)value atIndex:(SCIndex)index;
- (void)setDouble:(SCDouble)value atIndex:(SCIndex)index;

- (void)insertAtIndex:(SCIndex)index objects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)insertCollection:(id)collection atIndex:(SCIndex)index;
- (void)insertAtIndexes:(NSIndexSet *)indexes objects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)insertCollection:(id)collection atIndexes:(NSIndexSet *)indexes;

#pragma mark -
#pragma mark Удаление объектов
- (void)removeFirstObject;
- (void)removeLastObject;
- (void)removeObjectAtIndex:(SCIndex)index;
- (void)removeObjectsAtIndexes:(NSIndexSet *)indexes;
- (void)removeObjectsInRange:(NSRange)range;

#pragma mark -
#pragma mark Замена объектов
- (void)replaceObjectAtIndex:(SCIndex)index withObject:(id)object;
- (void)replaceObjectAtIndex:(SCIndex)index withByte:(SCByte)value;
- (void)replaceObjectAtIndex:(SCIndex)index withUByte:(SCUByte)value;
- (void)replaceObjectAtIndex:(SCIndex)index withShort:(SCShort)value;
- (void)replaceObjectAtIndex:(SCIndex)index withUShort:(SCUShort)value;
- (void)replaceObjectAtIndex:(SCIndex)index withInteger:(SCInteger)value;
- (void)replaceObjectAtIndex:(SCIndex)index withUInteger:(SCUInteger)value;
- (void)replaceObjectAtIndex:(SCIndex)index withLong:(SCLong)value;
- (void)replaceObjectAtIndex:(SCIndex)index withULong:(SCULong)value;
- (void)replaceObjectAtIndex:(SCIndex)index withChar:(char)value;
- (void)replaceObjectAtIndex:(SCIndex)index withUnichar:(unichar)value;
- (void)replaceObjectAtIndex:(SCIndex)index withCharString:(const char *)string;
- (void)replaceObjectAtIndex:(SCIndex)index withBool:(BOOL)value;
- (void)replaceObjectAtIndex:(SCIndex)index withFloat:(SCFloat)value;
- (void)replaceObjectAtIndex:(SCIndex)index withDouble:(SCDouble)value;

- (void)replaceObjectsAtIndexes:(NSIndexSet *)indexes withObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)replaceObjectsAtIndexes:(NSIndexSet *)indexes withCollection:(id)collection;
- (void)replaceObjectsInRange:(NSRange)range withObjects:(id)object, ... NS_REQUIRES_NIL_TERMINATION;
- (void)replaceObjectsInRange:(NSRange)range withCollection:(id)collection;

#pragma mark -
#pragma mark Перемещение объектов
- (void)exchangeObjectAtIndex:(SCIndex)index withObjectAtIndex:(SCIndex)destination;
- (void)moveObjectAtIndex:(SCIndex)index toIndex:(SCIndex)destination;
- (void)reverse;

#pragma mark -
#pragma mark Доступ к объектам
- (SCArray *)allObjects;
- (id)firstObject;
- (NSString *)firstString;
- (NSNumber *)firstNumber;
- (id)lastObject;
- (NSString *)lastString;
- (NSNumber *)lastNumber;
- (id)objectAtIndex:(SCIndex)index;
- (NSString *)stringAtIndex:(SCIndex)index;
- (NSNumber *)numberAtIndex:(SCIndex)index;
- (SCArray *)objectsAtIndexes:(NSIndexSet *)indexes;
- (SCOrderedSet *)reversedOrderedSet;

#pragma mark -
#pragma mark Поиск объектов
- (SCIndex)indexOfObject:(id)object;
- (SCIndex)indexOfByte:(SCByte)value;
- (SCIndex)indexOfUByte:(SCUByte)value;
- (SCIndex)indexOfShort:(SCShort)value;
- (SCIndex)indexOfUShort:(SCUShort)value;
- (SCIndex)indexOfInteger:(SCInteger)value;
- (SCIndex)indexOfUInteger:(SCUInteger)value;
- (SCIndex)indexOfLong:(SCLong)value;
- (SCIndex)indexOfULong:(SCULong)value;
- (SCIndex)indexOfChar:(char)value;
- (SCIndex)indexOfUnichar:(unichar)value;
- (SCIndex)indexOfCharString:(const char *)string;
- (SCIndex)indexOfBool:(BOOL)value;
- (SCIndex)indexOfFloat:(SCFloat)value;
- (SCIndex)indexOfDouble:(SCDouble)value;
- (SCIndex)indexOfLastObject;

#pragma mark -
#pragma mark Комбинирование и рекомбинирование упорядоченных множеств
- (void)unionOrderedSet:(id)orderedSet;
- (void)unionSet:(id)set;
- (void)minusOrderedSet:(id)set;
- (void)minusSet:(id)set;
- (void)intersectOrderedSet:(id)orderedSet;
- (void)intersectSet:(id)set;

@end