Objects ordered array class. More...

#import <SCArray.h>

Inheritance diagram for SCArray:

Public Member Functions
Initializing Array
(id)	- init
(id)	- initWithArrayName:capacity:
(id)	- initWithArrayName:
(id)	- initWithCapacity:
(id)	- initWithDelegate:
(id)	- initWithDelegate:collection:
(id)	- initWithCollection:
(id)	- initWithDelegate:object:
(id)	- initWithObject:
(id)	- initWithDelegate:objects:
(id)	- initWithObjects:
(id)	- initWithArray:
(id)	- initWithAscendingSortedCollection:usingMethod:
(id)	- initWithDescendingSortedCollection:usingMethod:
(id)	- initWithSortedCollection:usingMethod:
(id)	- initWithAscendingSortedCollection:
(id)	- initWithDescendingSortedCollection:
(id)	- initWithSortedCollection:
Querying and Setting Array Properties
(NSString *)	- arrayName
(void)	- setArrayName:
Setting and Copying Arrays
(void)	- copySortedAscendingFromCollection:usingMethod:
(void)	- copySortedDescendingFromCollection:usingMethod:
(void)	- copySortedFromCollection:usingMethod:
(void)	- copySortedAscendingFromCollection:
(void)	- copySortedDescendingFromCollection:
(void)	- copySortedFromCollection:
Querying Array
(id)	- firstObject
(NSString *)	- firstString
(NSNumber *)	- firstNumber
(SCByte)	- firstByte
(SCUByte)	- firstUByte
(SCShort)	- firstShort
(SCUShort)	- firstUShort
(SCInteger)	- firstInteger
(SCUInteger)	- firstUInteger
(SCLong)	- firstLong
(SCULong)	- firstULong
(char)	- firstChar
(unichar)	- firstUnichar
(const char *)	- firstCharString
(BOOL)	- firstBool
(SCFloat)	- firstFloat
(SCDouble)	- firstDouble
(id)	- lastObject
(NSString *)	- lastString
(NSNumber *)	- lastNumber
(SCByte)	- lastByte
(SCUByte)	- lastUByte
(SCShort)	- lastShort
(SCUShort)	- lastUShort
(SCInteger)	- lastInteger
(SCUInteger)	- lastUInteger
(SCLong)	- lastLong
(SCULong)	- lastULong
(char)	- lastChar
(unichar)	- lastUnichar
(const char *)	- lastCharString
(BOOL)	- lastBool
(SCFloat)	- lastFloat
(SCDouble)	- lastDouble
(id)	- objectAtIndex:
(NSString *)	- stringAtIndex:
(NSNumber *)	- numberAtIndex:
(SCByte)	- byteAtIndex:
(SCUByte)	- uByteAtIndex:
(SCShort)	- shortAtIndex:
(SCUShort)	- uShortAtIndex:
(SCInteger)	- integerAtIndex:
(SCUInteger)	- uIntegerAtIndex:
(SCLong)	- longAtIndex:
(SCULong)	- uLongAtIndex:
(char)	- charAtIndex:
(unichar)	- unicharAtIndex:
(const char *)	- charStringAtIndex:
(BOOL)	- boolAtIndex:
(SCFloat)	- floatAtIndex:
(SCDouble)	- doubleAtIndex:
(SCArray *)	- objectsAtIndexes:
(SCArray *)	- objectsInRange:
(SCArray *)	- objectsFromIndex:
(SCArray *)	- objectsToIndex:
Find Objects in Array
(SCIndex)	- indexOfObject:
(SCIndex)	- indexOfByte:
(SCIndex)	- indexOfUByte:
(SCIndex)	- indexOfShort:
(SCIndex)	- indexOfUShort:
(SCIndex)	- indexOfInteger:
(SCIndex)	- indexOfUInteger:
(SCIndex)	- indexOfLong:
(SCIndex)	- indexOfULong:
(SCIndex)	- indexOfChar:
(SCIndex)	- indexOfUnichar:
(SCIndex)	- indexOfCharString:
(SCIndex)	- indexOfBool:
(SCIndex)	- indexOfFloat:
(SCIndex)	- indexOfDouble:
(SCIndex)	- indexOfObject:atIndexes:
(SCIndex)	- indexOfByte:atIndexes:
(SCIndex)	- indexOfUByte:atIndexes:
(SCIndex)	- indexOfShort:atIndexes:
(SCIndex)	- indexOfUShort:atIndexes:
(SCIndex)	- indexOfInteger:atIndexes:
(SCIndex)	- indexOfUInteger:atIndexes:
(SCIndex)	- indexOfLong:atIndexes:
(SCIndex)	- indexOfULong:atIndexes:
(SCIndex)	- indexOfChar:atIndexes:
(SCIndex)	- indexOfUnichar:atIndexes:
(SCIndex)	- indexOfCharString:atIndexes:
(SCIndex)	- indexOfBool:atIndexes:
(SCIndex)	- indexOfFloat:atIndexes:
(SCIndex)	- indexOfDouble:atIndexes:
(SCIndex)	- indexOfObject:inRange:
(SCIndex)	- indexOfByte:inRange:
(SCIndex)	- indexOfUByte:inRange:
(SCIndex)	- indexOfShort:inRange:
(SCIndex)	- indexOfUShort:inRange:
(SCIndex)	- indexOfInteger:inRange:
(SCIndex)	- indexOfUInteger:inRange:
(SCIndex)	- indexOfLong:inRange:
(SCIndex)	- indexOfULong:inRange:
(SCIndex)	- indexOfChar:inRange:
(SCIndex)	- indexOfUnichar:inRange:
(SCIndex)	- indexOfCharString:inRange:
(SCIndex)	- indexOfBool:inRange:
(SCIndex)	- indexOfFloat:inRange:
(SCIndex)	- indexOfDouble:inRange:
(SCIndex)	- indexOfObject:fromIndex:
(SCIndex)	- indexOfByte:fromIndex:
(SCIndex)	- indexOfUByte:fromIndex:
(SCIndex)	- indexOfShort:fromIndex:
(SCIndex)	- indexOfUShort:fromIndex:
(SCIndex)	- indexOfInteger:fromIndex:
(SCIndex)	- indexOfUInteger:fromIndex:
(SCIndex)	- indexOfLong:fromIndex:
(SCIndex)	- indexOfULong:fromIndex:
(SCIndex)	- indexOfChar:fromIndex:
(SCIndex)	- indexOfUnichar:fromIndex:
(SCIndex)	- indexOfCharString:fromIndex:
(SCIndex)	- indexOfBool:fromIndex:
(SCIndex)	- indexOfFloat:fromIndex:
(SCIndex)	- indexOfDouble:fromIndex:
(SCIndex)	- indexOfObject:toIndex:
(SCIndex)	- indexOfByte:toIndex:
(SCIndex)	- indexOfUByte:toIndex:
(SCIndex)	- indexOfShort:toIndex:
(SCIndex)	- indexOfUShort:toIndex:
(SCIndex)	- indexOfInteger:toIndex:
(SCIndex)	- indexOfUInteger:toIndex:
(SCIndex)	- indexOfLong:toIndex:
(SCIndex)	- indexOfULong:toIndex:
(SCIndex)	- indexOfChar:toIndex:
(SCIndex)	- indexOfUnichar:toIndex:
(SCIndex)	- indexOfCharString:toIndex:
(SCIndex)	- indexOfBool:toIndex:
(SCIndex)	- indexOfFloat:toIndex:
(SCIndex)	- indexOfDouble:toIndex:
(SCIndex)	- indexOfLastObject
Sorting Array
(void)	- sortingArrayAscendingWithMethod:
(void)	- sortingArrayDescendingWithMethod:
(void)	- sortingArrayWithMethod:
(void)	- sortingArrayAscending
(void)	- sortingArrayDescending
(void)	- sortingArray
(SCArray *)	- sortedArrayAscendingWithMethod:
(SCArray *)	- sortedArrayDescendingWithMethod:
(SCArray *)	- sortedArrayWithMethod:
(SCArray *)	- sortedArrayAscending
(SCArray *)	- sortedArrayDescending
(SCArray *)	- sortedArray
Adding Objects
(void)	- insertObject:atIndex:
(void)	- insertByte:atIndex:
(void)	- insertUByte:atIndex:
(void)	- insertShort:atIndex:
(void)	- insertUShort:atIndex:
(void)	- insertInteger:atIndex:
(void)	- insertUInteger:atIndex:
(void)	- insertLong:atIndex:
(void)	- insertULong:atIndex:
(void)	- insertChar:atIndex:
(void)	- insertUnichar:atIndex:
(void)	- insertCharString:atIndex:
(void)	- insertBool:atIndex:
(void)	- insertFloat:atIndex:
(void)	- insertDouble:atIndex:
(void)	- insertAtIndex:objects:
(void)	- insertObjectsFromCollection:atIndex:
(void)	- insertAtIndexes:objects:
(void)	- insertObjectsFromCollection:atIndexes:
Removing Objects
(void)	- removeFirstObject
(void)	- removeLastObject
(void)	- removeObjectAtIndex:
(void)	- removeObjectsAtIndexes:
(void)	- removeObjectsInRange:
(void)	- removeObjectsFromIndex:
(void)	- removeObjectsToIndex:
(void)	- removeObjectsEqualTo:
(void)	- removeObjectsEqualTo:atIndexes:
(void)	- removeObjectsEqualTo:inRange:
(void)	- removeObjectsEqualTo:fromIndex:
(void)	- removeObjectsEqualTo:toIndex:
(void)	- removeObjectsInCollection:
(void)	- removeObject:
(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)	- removeObject:atIndexes:
(void)	- removeObject:inRange:
(void)	- removeObject:fromIndex:
(void)	- removeObject:toIndex:
(void)	- removeObjects:
Replacing Objects
(void)	- replaceObjectAtIndex:withObject:
(void)	- replaceObjectAtIndex:withByte:
(void)	- replaceObjectAtIndex:withUByte:
(void)	- replaceObjectAtIndex:withShort:
(void)	- replaceObjectAtIndex:withUShort:
(void)	- replaceObjectAtIndex:withInteger:
(void)	- replaceObjectAtIndex:withUInteger:
(void)	- replaceObjectAtIndex:withLong:
(void)	- replaceObjectAtIndex:withULong:
(void)	- replaceObjectAtIndex:withChar:
(void)	- replaceObjectAtIndex:withUnichar:
(void)	- replaceObjectAtIndex:withCharString:
(void)	- replaceObjectAtIndex:withBool:
(void)	- replaceObjectAtIndex:withFloat:
(void)	- replaceObjectAtIndex:withDouble:
(void)	- replaceObjectsAtIndexes:withObjects:
(void)	- replaceObjectsAtIndexes:withObjectsFromCollection:
(void)	- replaceObjectsInRange:withObjects:
(void)	- replaceObjectsInRange:withObjectsFromCollection:
(void)	- replaceObjectsFromIndex:withObjects:
(void)	- replaceObjectsFromIndex:withObjectsFromCollection:
(void)	- replaceObjectsToIndex:withObjects:
(void)	- replaceObjectsToIndex:withObjectsFromCollection:
Moving and Copying Objects
(void)	- exchangeObjectAtIndex:withObjectAtIndex:
(void)	- duplicateObjectAtIndex:
(void)	- duplicateObjectsInRange:
(void)	- duplicateObjectsFromIndex:
(void)	- duplicateObjectsToIndex:
(void)	- duplicateAllObjects
(void)	- duplicate
(void)	- copyObjectAtIndex:toIndex:
(void)	- copyObjectsInRange:toIndex:
(void)	- copyObjectsFromIndex:toIndex:
(void)	- copyObjectsToIndex:toIndex:
(void)	- moveObjectAtIndex:toIndex:
(void)	- moveObjectsInRange:toIndex:
(void)	- moveObjectsFromIndex:toIndex:
(void)	- moveObjectsToIndex:toIndex:
(void)	- forwardMoveObjectAtIndex:steps:
(void)	- forwardMoveObjectsInRange:steps:
(void)	- forwardMoveObjectsFromIndex:steps:
(void)	- forwardMoveObjectAtIndex:
(void)	- forwardMoveObjectsInRange:
(void)	- forwardMoveObjectsFromIndex:
(void)	- backwardMoveObjectAtIndex:steps:
(void)	- backwardMoveObjectsInRange:steps:
(void)	- backwardMoveObjectsToIndex:steps:
(void)	- backwardMoveObjectAtIndex:
(void)	- backwardMoveObjectsInRange:
(void)	- backwardMoveObjectsToIndex:
(void)	- moveToFirstPositionObjectAtIndex:
(void)	- moveToFirstPositionObjectsInRange:
(void)	- moveToFirstPositionObjectsFromIndex:
(void)	- moveToLastPositionObjectAtIndex:
(void)	- moveToLastPositionObjectsInRange:
(void)	- moveToLastPositionObjectsToIndex:
(void)	- reverse
(SCArray *)	- reversedArray
Static Public Member Functions
Creating Array
(SCArray *)	+ arrayWithDataDictionary:
(SCArray *)	+ arrayWithDataDictionaryFromFile:
(SCArray *)	+ arrayWithCoder:
(SCArray *)	+ arrayWithContentsOfSerializedFile:
(SCArray *)	+ arrayWithStream:
(SCArray *)	+ arrayWithFileStream:
(SCArray *)	+ array
(SCArray *)	+ arrayWithArrayName:capacity:
(SCArray *)	+ arrayWithArrayName:
(SCArray *)	+ arrayWithCapacity:
(SCArray *)	+ arrayWithDelegate:
(SCArray *)	+ arrayWithDelegate:collection:
(SCArray *)	+ arrayWithCollection:
(SCArray *)	+ arrayWithDelegate:object:
(SCArray *)	+ arrayWithObject:
(SCArray *)	+ arrayWithDelegate:objects:
(SCArray *)	+ arrayWithObjects:
(SCArray *)	+ arrayWithArray:
(SCArray *)	+ arrayWithAscendingSortedCollection:usingMethod:
(SCArray *)	+ arrayWithDescendingSortedCollection:usingMethod:
(SCArray *)	+ arrayWithSortedCollection:usingMethod:
(SCArray *)	+ arrayWithAscendingSortedCollection:
(SCArray *)	+ arrayWithDescendingSortedCollection:
(SCArray *)	+ arrayWithSortedCollection:

Detailed Description

Objects ordered array class.

Class implements the representation of an class instances ordered collection called array and declares items management methods.
Class was introduced in version 1.1.3.

Class declares the following properties:

NSString* arrayName - array name

Member Function Documentation

+ (SCArray *) array

Returns the array created by using the default settings.

Returns:: A created array

Reimplemented from SCCollection.

- (NSString *) arrayName

Returns the array name.

Returns:: Array name

+ (SCArray *) arrayWithArray: (SCArray *) array

Returns the array created by using the existing array.

Parameters:

array - source array

Returns:: A created array

Exceptions:

SCCollectionError - array error detected

+ (SCArray *) arrayWithArrayName: (NSString *) name

Returns the array created by using the specified array name.

Parameters:

name	- array name

Returns:: A created array

+ (SCArray *) arrayWithArrayName:	(NSString *)	name
capacity:	(SCULong)	capacity

Returns the array created by using the specified array name and capacity.

Parameters:

name	- array name
capacity	- array capacity

Returns:: A created array

+ (SCArray *) arrayWithAscendingSortedCollection: (id) collection

Returns the ascending sorted array created by using the specified existing collection.

Parameters:

collection - source collection

Returns:: A created array

Exceptions:

SCCollectionException - collection error detected

+ (SCArray *) arrayWithAscendingSortedCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Returns the ascending sorted array created by using the specified existing collection and sorting algorithm.

Parameters:

collection	- source collection
method	- sorting algorithm

Returns:: A created array

Exceptions:

SCCollectionException - collection error detected

+ (SCArray *) arrayWithCapacity: (SCULong) capacity

Returns the array created by using the specified array capacity.

Parameters:

capacity - array capacity

Returns:: A created array

+ (SCArray *) arrayWithCoder: (NSCoder *) coder

Returns an array created by using the specified coder.

Parameters:

coder - source coder

Returns:: A created array

+ (SCArray *) arrayWithCollection: (id) collection

Returns the array created by using the specified existing collection.

Parameters:

collection - existing source collection

Returns:: A created array

+ (SCArray *) arrayWithContentsOfSerializedFile: (NSString *) path

Returns an array created by using the contents of serialized file with the specified path.

Parameters:

path	- source serialized file path

Returns:: A created array

+ (SCArray *) arrayWithDataDictionary: (NSDictionary *) dictionary

Returns an array created by using the specified dictionary.

Parameters:

dictionary - source dictionary

Returns:: A created array

+ (SCArray *) arrayWithDataDictionaryFromFile: (NSString *) path

Returns an array created by using the dictionary from the specified file.

Parameters:

path	- source dictionary file path

Returns:: A created array

+ (SCArray *) arrayWithDelegate: (id<SCCollectionDelegate>) delegate

Returns the array created by using the specified delegate object.

Parameters:

delegate - delegate object

Returns:: A created array

+ (SCArray *) arrayWithDelegate:	(id<SCCollectionDelegate>)	delegate
collection:	(id)	collection

Returns the array created by using the specified delegate object and existing collection.

Parameters:

delegate	- delegate object
collection	- existing source collection

Returns:: A created array

Exceptions:

SCCollectionException - array error detected

+ (SCArray *) arrayWithDelegate:	(id<SCCollectionDelegate>)	delegate
object:	(id)	object

Returns the array created by using the specified delegate object and existing object.

Parameters:

delegate	- delegate object
object	- existing object

Returns:: A created array

Exceptions:

SCCollectionException - array error detected

+ (SCArray *) arrayWithDelegate:	(id<SCCollectionDelegate>)	delegate
objects:	(id)	object
,		...

Returns the array created by using the specified delegate objects and nil terminated list of existing objects.

Parameters:

delegate	- delegate object
object	- first object
...	- other objects

Returns:: A created array

Exceptions:

SCCollectionException - array error detected

+ (SCArray *) arrayWithDescendingSortedCollection: (id) collection

Returns the descending sorted array created by using the specified existing collection.

Parameters:

collection - source collection

Returns:: A created array

Exceptions:

SCCollectionException - collection error detected

+ (SCArray *) arrayWithDescendingSortedCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Returns the descending sorted array created by using the specified existing collection and sorting algorithm.

Parameters:

collection	- source collection
method	- sorting algorithm

Returns:: A created array

Exceptions:

SCCollectionException - collection error detected

+ (SCArray *) arrayWithFileStream: (NSString *) path

Returns an array created from the stream file with the specified path.

Parameters:

path	- stream file path

Returns:: A created array

Exceptions:

SCStreamException - stream operation error detected

+ (SCArray *) arrayWithObject: (id) object

Returns the array created by using the specified existing object.

Parameters:

object - existing object

Returns:: A created array

Exceptions:

SCCollectionException - array error detected

+ (SCArray *) arrayWithObjects:	(id)	object
,		...

Returns the array created by using the specified nil terminated list of existing objects.

Parameters:

object	- first object
...	- other objects

Returns:: A created array

Exceptions:

SCCollectionException - array error detected

+ (SCArray *) arrayWithSortedCollection: (id) collection

Returns the ascending sorted array created by using the specified existing collection.

Parameters:

collection - source collection

Returns:: A created array

Exceptions:

SCCollectionException - collection error detected

+ (SCArray *) arrayWithSortedCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Returns the ascending sorted array created by using the specified existing collection and sorting algorithm.

Parameters:

collection	- source collection
method	- sorting algorithm

Returns:: A created array

Exceptions:

SCCollectionException - collection error detected

+ (SCArray *) arrayWithStream: (SCStream *) stream

Returns an array created from the specified stream.

Parameters:

stream - stream for reading array

Returns:: A created array

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

- (void) backwardMoveObjectAtIndex: (SCIndex) index

Moves the object at the specified index to an one position to the bottom of the array.

Parameters:

index - moved object index

Exceptions:

SCCollectionException - array error detected

- (void) backwardMoveObjectAtIndex:	(SCIndex)	index
steps:	(SCULong)	steps

Moves the object at the specified index to a given count of positions to the bottom of the array.

Parameters:

index	- moved object index
steps	- count of positions

Exceptions:

SCCollectionException - array error detected

- (void) backwardMoveObjectsInRange: (NSRange) range

Moves the objects within the specified range to an one position to the bottom of the array.

Parameters:

range - range of moved objects

Exceptions:

SCCollectionException - array error detected

- (void) backwardMoveObjectsInRange:	(NSRange)	range
steps:	(SCULong)	steps

Moves the objects within the specified range to a given count of positions to the bottom of the array.

Parameters:

range	- range of moved objects
steps	- count of positions

Exceptions:

SCCollectionException - array error detected

- (void) backwardMoveObjectsToIndex: (SCIndex) index

Moves the objects between first and specified index to an one position to the bottom of the array.

Parameters:

index - last index of moved objects

Exceptions:

SCCollectionException - array error detected

- (void) backwardMoveObjectsToIndex:	(SCIndex)	index
steps:	(SCULong)	steps

Moves the objects between first and specified index to a given count of positions to the bottom of the array.

Parameters:

index	- last index of moved objects
steps	- count of positions

Exceptions:

SCCollectionException - array error detected

- (BOOL) boolAtIndex: (SCIndex) index

Returns the boolean value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (SCByte) byteAtIndex: (SCIndex) index

Returns the signed 8-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (char) charAtIndex: (SCIndex) index

Returns the char value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (const char *) charStringAtIndex: (SCIndex) index

Returns the char string located at the specified index.

Parameters:

index - required number index

Returns:: Char string at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) copyObjectAtIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Copies the object at the specified index to a given destination index.

Parameters:

index	- source index
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) copyObjectsFromIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Copies the objects between the specified and the last index to a given destination index.

Parameters:

index	- first index of copied objects
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) copyObjectsInRange:	(NSRange)	range
toIndex:	(SCIndex)	destination

Copies the objects within the specified range to a given destination index.

Parameters:

range	- range of the objects
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) copyObjectsToIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Copies the objects between first and specified index to a given destination index.

Parameters:

index	- last index of copied objects
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) copySortedAscendingFromCollection: (id) collection

Replaces the content and settings of the receiving collection of ascending sorted content and settings from the specified existing collection with using the default sorting algorithm.

Parameters:

collection - existing collection

Exceptions:

SCCollectionException - collection error detected

- (void) copySortedAscendingFromCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving collection of ascending sorted content and settings from the specified existing collection with using the specified sorting algorithm.

Parameters:

collection	- existing collection
method	- sorting algorithm

Exceptions:

SCCollectionException - collection error detected

- (void) copySortedDescendingFromCollection: (id) collection

Replaces the content and settings of the receiving collection of ascending sorted content and settings from the specified existing collection with using the default sorting algorithm.

Parameters:

collection - existing collection

Exceptions:

SCCollectionException - collection error detected

- (void) copySortedDescendingFromCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving collection of descending sorted content and settings from the specified existing collection with using the specified sorting algorithm.

Parameters:

collection	- existing collection
method	- sorting algorithm

Exceptions:

SCCollectionException - collection error detected

- (void) copySortedFromCollection: (id) collection

Replaces the content and settings of the receiving collection of ascending sorted content and settings from the specified existing collection with using the default sorting algorithm.

Parameters:

collection - existing collection

Exceptions:

SCCollectionException - collection error detected

- (void) copySortedFromCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Replaces the content and settings of the receiving collection of ascending sorted content and settings from the specified existing collection with using the specified sorting algorithm.

Parameters:

collection	- existing collection
method	- sorting algorithm

Exceptions:

SCCollectionException - collection error detected

- (SCDouble) doubleAtIndex: (SCIndex) index

Returns the double precision float value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) duplicate

Duplicates content of the receving array.

Exceptions:

SCCollectionException - array error detected

- (void) duplicateAllObjects

Duplicates all objects within receiving array.

Exceptions:

SCCollectionException - array error detected

- (void) duplicateObjectAtIndex: (SCIndex) index

Duplicates the object at the specified index.

Parameters:

index - duplicated object index

Exceptions:

SCCollectionException - array error detected

- (void) duplicateObjectsFromIndex: (SCIndex) index

Duplicate the objects between the specified and the last index.

Parameters:

index - first index of the duplicated objects

Exceptions:

SCCollectionException - array error detected

- (void) duplicateObjectsInRange: (NSRange) range

Duplicate the objects within the specified range.

Parameters:

range - range of duplicated objects

Exceptions:

SCCollectionException - array error detected

- (void) duplicateObjectsToIndex: (SCIndex) index

Duplicate the objects between the first and the specified index.

Parameters:

index - last index of the duplicated objects

Exceptions:

SCCollectionException - array error detected

- (void) exchangeObjectAtIndex:	(SCIndex)	index
withObjectAtIndex:	(SCIndex)	destination

Exchanges the objects in the array at given indices.

Parameters:

index	- index of the first object
destination	- index of the second object

Exceptions:

SCCollectionException - array error detected

- (BOOL) firstBool

Returns the first boolean value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCByte) firstByte

Returns the first signed 8-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (char) firstChar

Returns the first char value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (const char *) firstCharString

Returns the first char string from the receiving array.

Returns:: First char string

Exceptions:

SCCollectionException - array error detected

- (SCDouble) firstDouble

Returns the first double precision float value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCFloat) firstFloat

Returns the first single precision float value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCInteger) firstInteger

Returns the first signed 32-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCLong) firstLong

Returns the first signed 64-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (NSNumber *) firstNumber

Returns the first number from the receiving array.

Returns:: First number

Exceptions:

SCCollectionException - array error detected

- (id) firstObject

Returns the first object from the receiving array.

Returns:: First object

Exceptions:

SCCollectionException - array error detected

- (SCShort) firstShort

Returns the first signed 16-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (NSString *) firstString

Returns the first string from the receiving array.

Returns:: First string

Exceptions:

SCCollectionException - array error detected

- (SCUByte) firstUByte

Returns the first unsigned 8-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCUInteger) firstUInteger

Returns the first unsigned 32-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCULong) firstULong

Returns the first unsigned 64-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (unichar) firstUnichar

Returns the first unichar value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCUShort) firstUShort

Returns the first unsigned 16-bit integer value from the receiving array.

Returns:: First value

Exceptions:

SCCollectionException - array error detected

- (SCFloat) floatAtIndex: (SCIndex) index

Returns the single precision float value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) forwardMoveObjectAtIndex: (SCIndex) index

Moves the object at the specified index to an one position to the top of the array.

Parameters:

index - moved object index

Exceptions:

SCCollectionException - array error detected

- (void) forwardMoveObjectAtIndex:	(SCIndex)	index
steps:	(SCULong)	steps

Moves the object at the specified index to a given count of positions to the top of the array.

Parameters:

index	- moved object index
steps	- count of positions

Exceptions:

SCCollectionException - array error detected

- (void) forwardMoveObjectsFromIndex: (SCIndex) index

Moves the objects from the specified index to an one position to the top of the array.

Parameters:

index - first index of moved objects

Exceptions:

SCCollectionException - array error detected

- (void) forwardMoveObjectsFromIndex:	(SCIndex)	index
steps:	(SCULong)	steps

Moves the objects from the specified index to a given count of positions to the top of the array.

Parameters:

index	- first index of moved objects
steps	- count of positions

Exceptions:

SCCollectionException - array error detected

- (void) forwardMoveObjectsInRange: (NSRange) range

Moves the objects within the specified range to an one position to the top of the array.

Parameters:

range - range of moved objects

Exceptions:

SCCollectionException - array error detected

- (void) forwardMoveObjectsInRange:	(NSRange)	range
steps:	(SCULong)	steps

Moves the objects within the specified range to a given count of positions to the top of the array.

Parameters:

range	- range of moved objects
steps	- count of positions

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfBool: (BOOL) boolean

Returns the lowest index whose corresponding array value is equal to the specified boolean value.

Parameters:

boolean - desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfBool:	(BOOL)	boolean
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given boolean value.

Parameters:

boolean	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfBool:	(BOOL)	boolean
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given boolean value.

Parameters:

boolean	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfBool:	(BOOL)	boolean
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given boolean value.

Parameters:

boolean	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfBool:	(BOOL)	boolean
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given boolean value.

Parameters:

boolean	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfByte: (SCByte) byte

Returns the lowest index whose corresponding array value is equal to the specified signed 8-bit integer value.

Parameters:

byte	- desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfByte:	(SCByte)	byte
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given signed 8-bit integer value.

Parameters:

byte	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfByte:	(SCByte)	byte
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given signed 8-bit integer value.

Parameters:

byte	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfByte:	(SCByte)	byte
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given signed 8-bit integer value.

Parameters:

byte	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfByte:	(SCByte)	byte
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given signed 8-bit integer value.

Parameters:

byte	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfChar: (char) chr

Returns the lowest index whose corresponding array value is equal to the specified char value.

Parameters:

chr	- desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfChar:	(char)	chr
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given char value.

Parameters:

chr	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfChar:	(char)	chr
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given char value.

Parameters:

chr	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfChar:	(char)	chr
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given char value.

Parameters:

chr	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfChar:	(char)	chr
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given char value.

Parameters:

chr	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfCharString: (const char *) string

Returns the lowest index whose corresponding array value is equal to the specified char string.

Parameters:

string - desired string

Returns:: Index of object that equals to the specified string, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfCharString:	(const char *)	string
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given char string.

Parameters:

string	- desired string
indexes	- index set

Returns:: Index of object that equals to the specified string, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfCharString:	(const char *)	string
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given char string.

Parameters:

string	- desired string
index	- first index for searching

Returns:: Index of object that equals to the specified string, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfCharString:	(const char *)	string
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given char string.

Parameters:

string	- desired string
range	- search range

Returns:: Index of object that equals to the specified string, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfCharString:	(const char *)	string
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given char string.

Parameters:

string	- desired string
index	- last index for searching

Returns:: Index of object that equals to the specified string, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfDouble: (SCDouble) dbl

Returns the lowest index whose corresponding array value is equal to the specified double precision float value.

Parameters:

dbl	- desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfDouble:	(SCDouble)	dbl
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given double precision float value.

Parameters:

dbl	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfDouble:	(SCDouble)	dbl
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given double precision float value.

Parameters:

dbl	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfDouble:	(SCDouble)	dbl
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given double precision float value.

Parameters:

dbl	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfDouble:	(SCDouble)	dbl
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given double precision float value.

Parameters:

dbl	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfFloat: (SCFloat) flt

Returns the lowest index whose corresponding array value is equal to the specified single precision float value.

Parameters:

flt	- desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfFloat:	(SCFloat)	flt
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given single precision float value.

Parameters:

flt	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfFloat:	(SCFloat)	flt
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given single precision float value.

Parameters:

flt	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfFloat:	(SCFloat)	flt
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given single precision float value.

Parameters:

flt	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfFloat:	(SCFloat)	flt
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given single precision float value.

Parameters:

flt	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfInteger: (SCInteger) integer

Returns the lowest index whose corresponding array value is equal to the specified signed 32-bit integer value.

Parameters:

integer - desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfInteger:	(SCInteger)	integer
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given signed 32-bit integer value.

Parameters:

integer	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfInteger:	(SCInteger)	integer
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given signed 32-bit integer value.

Parameters:

integer	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfInteger:	(SCInteger)	integer
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given signed 32-bit integer value.

Parameters:

integer	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfInteger:	(SCInteger)	integer
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given signed 32-bit integer value.

Parameters:

integer	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfLastObject

Returns the index of the last object within the receiving array.

Returns:: Index of the last object or SCNotFound if array is empty

- (SCIndex) indexOfLong: (SCLong) longint

Returns the lowest index whose corresponding array value is equal to the specified signed 64-bit integer value.

Parameters:

longint - desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfLong:	(SCLong)	longint
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given signed 64-bit integer value.

Parameters:

longint	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfLong:	(SCLong)	longint
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given signed 64-bit integer value.

Parameters:

longint	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfLong:	(SCLong)	longint
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given signed 64-bit integer value.

Parameters:

longint	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfLong:	(SCLong)	longint
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given signed 64-bit integer value.

Parameters:

longint	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfObject: (id) object

Returns the lowest index whose corresponding array value is equal to a given object.

Parameters:

object - desired object

Returns:: Index of object that equals to the specified object, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfObject:	(id)	object
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given object.

Parameters:

object	- desired object
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfObject:	(id)	object
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given object.

Parameters:

object	- desired object
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfObject:	(id)	object
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given object.

Parameters:

object	- desired object
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfObject:	(id)	object
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given object.

Parameters:

object	- desired object
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfShort: (SCShort) shortint

Returns the lowest index whose corresponding array value is equal to the specified signed 16-bit integer value.

Parameters:

shortint - desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfShort:	(SCShort)	shortint
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given signed 16-bit integer value.

Parameters:

shortint	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfShort:	(SCShort)	shortint
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given signed 16-bit integer value.

Parameters:

shortint	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfShort:	(SCShort)	shortint
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given signed 16-bit integer value.

Parameters:

shortint	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfShort:	(SCShort)	shortint
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given signed 16-bit integer value.

Parameters:

shortint	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUByte: (SCUByte) byte

Returns the lowest index whose corresponding array value is equal to the specified unsigned 8-bit integer value.

Parameters:

byte	- desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUByte:	(SCUByte)	byte
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given unsigned 8-bit integer value.

Parameters:

byte	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUByte:	(SCUByte)	byte
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given unsigned 8-bit integer value.

Parameters:

byte	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUByte:	(SCUByte)	byte
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given unsigned 8-bit integer value.

Parameters:

byte	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUByte:	(SCUByte)	byte
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given unsigned 8-bit integer value.

Parameters:

byte	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUInteger: (SCUInteger) integer

Returns the lowest index whose corresponding array value is equal to the specified unsigned 32-bit integer value.

Parameters:

integer - desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUInteger:	(SCUInteger)	integer
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given unsigned 32-bit integer value.

Parameters:

integer	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUInteger:	(SCUInteger)	integer
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given unsigned 32-bit integer value.

Parameters:

integer	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUInteger:	(SCUInteger)	integer
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given unsigned 32-bit integer value.

Parameters:

integer	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUInteger:	(SCUInteger)	integer
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given unsigned 32-bit integer value.

Parameters:

integer	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfULong: (SCULong) longint

Returns the lowest index whose corresponding array value is equal to the specified unsigned 64-bit integer value.

Parameters:

longint - desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfULong:	(SCULong)	longint
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given unsigned 64-bit integer value.

Parameters:

longint	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfULong:	(SCULong)	longint
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given unsigned 64-bit integer value.

Parameters:

longint	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfULong:	(SCULong)	longint
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given unsigned 64-bit integer value.

Parameters:

longint	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfULong:	(SCULong)	longint
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given unsigned 64-bit integer value.

Parameters:

longint	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUnichar: (unichar) chr

Returns the lowest index whose corresponding array value is equal to the specified unichar value.

Parameters:

chr	- desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUnichar:	(unichar)	chr
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given unichar value.

Parameters:

chr	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUnichar:	(unichar)	chr
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given unichar value.

Parameters:

chr	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUnichar:	(unichar)	chr
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given unichar value.

Parameters:

chr	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUnichar:	(unichar)	chr
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given unichar value.

Parameters:

chr	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUShort: (SCUShort) shortint

Returns the lowest index whose corresponding array value is equal to the specified unsigned 16-bit integer value.

Parameters:

shortint - desired value

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUShort:	(SCUShort)	shortint
atIndexes:	(NSIndexSet *)	indexes

Returns the lowest index from the specified index set whose corresponding array value is equal to a given unsigned 16-bit integer value.

Parameters:

shortint	- desired value
indexes	- index set

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUShort:	(SCUShort)	shortint
fromIndex:	(SCIndex)	index

Returns the lowest index from the specified index whose corresponding array value is equal to a given unsigned 16-bit integer value.

Parameters:

shortint	- desired value
index	- first index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUShort:	(SCUShort)	shortint
inRange:	(NSRange)	range

Returns the lowest index from the specified range whose corresponding array value is equal to a given unsigned 16-bit integer value.

Parameters:

shortint	- desired value
range	- search range

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (SCIndex) indexOfUShort:	(SCUShort)	shortint
toIndex:	(SCIndex)	index

Returns the lowest index between first and the specified index whose corresponding array value is equal to a given unsigned 16-bit integer value.

Parameters:

shortint	- desired value
index	- last index for searching

Returns:: Index of object that equals to the specified value, otherwise SCNotFound

Exceptions:

SCCollectionException - array error detected

- (id) init

Initializes the array using the default settings.

Returns:: A newly initialized array

Reimplemented from SCCollection.

- (id) initWithArray: (SCArray *) array

Initializes the array using the existing array.

Parameters:

array - source array

Returns:: A newly initialized array

Exceptions:

SCCollectionError - array error detected

- (id) initWithArrayName: (NSString *) name

Initializes the array using the specified array name.

Parameters:

name	- array name

Returns:: A newly initialized array

- (id) initWithArrayName:	(NSString *)	name
capacity:	(SCULong)	capacity

Initializes the array using the specified array name and capacity.

Parameters:

name	- array name
capacity	- array capacity

Returns:: A newly initialized array

- (id) initWithAscendingSortedCollection: (id) collection

Initializes the ascending sorted array using the specified existing collection.

Parameters:

collection - source collection

Returns:: A newly initialized array

Exceptions:

SCCollectionException - collection error detected

- (id) initWithAscendingSortedCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Initializes the ascending sorted array using the specified existing collection and sorting algorithm.

Parameters:

collection	- source collection
method	- sorting algorithm

Returns:: A newly initialized array

Exceptions:

SCCollectionException - collection error detected

- (id) initWithCapacity: (SCULong) capacity

Initializes the array using the specified array capacity.

Parameters:

capacity - array capacity

Returns:: A newly initialized array

- (id) initWithCollection: (id) collection

Initializes the array using the specified existing collection.

Parameters:

collection - existing source collection

Returns:: A newly initialized array

Exceptions:

SCCollectionException - array error detected

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

Initializes the array using the specified delegate object.

Parameters:

delegate - delegate object

Returns:: A newly initialized array

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

Initializes the array using the specified delegate object and existing collection.

Parameters:

delegate	- delegate object
collection	- existing source collection

Returns:: A newly initialized array

Exceptions:

SCCollectionException - array error detected

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

Initializes the array using the specified delegate object and existing object.

Parameters:

delegate	- delegate object
object	- existing object

Returns:: A newly initialized array

Exceptions:

SCCollectionException - array error detected

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

Initializes the array using the specified delegate objects and nil terminated list of existing objects.

Parameters:

delegate	- delegate object
object	- first object
...	- other objects

Returns:: A newly initialized array

Exceptions:

SCCollectionException - array error detected

- (id) initWithDescendingSortedCollection: (id) collection

Initializes the descending sorted array using the specified existing collection.

Parameters:

collection - source collection

Returns:: A newly initialized array

Exceptions:

SCCollectionException - collection error detected

- (id) initWithDescendingSortedCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Initializes the descending sorted array using the specified existing collection and sorting algorithm.

Parameters:

collection	- source collection
method	- sorting algorithm

Returns:: A newly initialized array

Exceptions:

SCCollectionException - collection error detected

- (id) initWithObject: (id) object

Initializes the array using the specified existing object.

Parameters:

object - existing object

Returns:: A newly initialized array

Exceptions:

SCCollectionException - array error detected

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

Initializes the array using the specified nil terminated list of existing objects.

Parameters:

object	- first object
...	- other objects

Returns:: A newly initialized array

Exceptions:

SCCollectionException - array error detected

- (id) initWithSortedCollection: (id) collection

Initializes the ascending sorted array using the specified existing collection.

Parameters:

collection - source collection

Returns:: A newly initialized array

Exceptions:

SCCollectionException - collection error detected

- (id) initWithSortedCollection:	(id)	collection
usingMethod:	(id<SCSortingProtocol>)	method

Initializes the ascending sorted array using the specified existing collection and sorting algorithm.

Parameters:

collection	- source collection
method	- sorting algorithm

Returns:: A newly initialized array

Exceptions:

SCCollectionException - collection error detected

- (void) insertAtIndex:	(SCIndex)	index
objects:	(id)	object
,		...

Inserts the objects from a given nil terminated list into the array's contents at a given index.

Parameters:

object	- fist adding object
...	- other adding objects
index	- index at which to insert objects

Exceptions:

SCCollectionException - array error detected

- (void) insertAtIndexes:	(NSIndexSet *)	indexes
objects:	(id)	object
,		...

Inserts the objects from a given nil terminated list into the receiving array at the specified indexes.

Parameters:

indexes	- indexes at which the objects should be inserted
object	- first inserting object
...	- other inserting objects

Exceptions:

SCCollectionException - array error detected

- (void) insertBool:	(BOOL)	boolean
atIndex:	(SCIndex)	index

Inserts a given boolean value into the array's contents at a given index.

Parameters:

boolean	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertByte:	(SCByte)	byte
atIndex:	(SCIndex)	index

Inserts a given signed 8-bit integer value into the array's contents at a given index.

Parameters:

byte	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertChar:	(char)	chr
atIndex:	(SCIndex)	index

Inserts a given char value into the array's contents at a given index.

Parameters:

chr	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertCharString:	(const char *)	string
atIndex:	(SCIndex)	index

Inserts a given char string into the array's contents at a given index.

Parameters:

string	- inserting string
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertDouble:	(SCDouble)	dbl
atIndex:	(SCIndex)	index

Inserts a given double precision float value into the array's contents at a given index.

Parameters:

dbl	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertFloat:	(SCFloat)	flt
atIndex:	(SCIndex)	index

Inserts a given single precision float value into the array's contents at a given index.

Parameters:

flt	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertInteger:	(SCInteger)	integer
atIndex:	(SCIndex)	index

Inserts a given signed 32-bit integer value into the array's contents at a given index.

Parameters:

integer	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertLong:	(SCLong)	longint
atIndex:	(SCIndex)	index

Inserts a given signed 64-bit integer value into the array's contents at a given index.

Parameters:

longint	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertObject:	(id)	object
atIndex:	(SCIndex)	index

Inserts a given object into the array's contents at a given index.

Parameters:

object	- inserting object
index	- index at which to insert object

Exceptions:

SCCollectionException - array error detected

- (void) insertObjectsFromCollection:	(id)	collection
atIndex:	(SCIndex)	index

Inserts the objects from a given collection into the receiving array at a given index.

Parameters:

collection	- source collection
index	- index at which to insert objects

Exceptions:

SCCollectionException - array error detected

- (void) insertObjectsFromCollection:	(id)	collection
atIndexes:	(NSIndexSet *)	indexes

Inserts the objects from a given collection into the receiving array at the specified indexes.

Parameters:

collection	- source collection
indexes	- indexes at which the objects should be inserted

Exceptions:

SCCollectionException - array error detected

- (void) insertShort:	(SCShort)	shortint
atIndex:	(SCIndex)	index

Inserts a given signed 16-bit integer value into the array's contents at a given index.

Parameters:

shortint	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertUByte:	(SCUByte)	byte
atIndex:	(SCIndex)	index

Inserts a given unsigned 8-bit integer value into the array's contents at a given index.

Parameters:

byte	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertUInteger:	(SCUInteger)	integer
atIndex:	(SCIndex)	index

Inserts a given unsigned 32-bit integer value into the array's contents at a given index.

Parameters:

integer	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertULong:	(SCULong)	longint
atIndex:	(SCIndex)	index

Inserts a given unsigned 64-bit integer value into the array's contents at a given index.

Parameters:

longint	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertUnichar:	(unichar)	chr
atIndex:	(SCIndex)	index

Inserts a given unichar value into the array's contents at a given index.

Parameters:

chr	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (void) insertUShort:	(SCUShort)	shortint
atIndex:	(SCIndex)	index

Inserts a given unsigned 16-bit integer value into the array's contents at a given index.

Parameters:

shortint	- inserting value
index	- index at which to insert value

Exceptions:

SCCollectionException - array error detected

- (SCInteger) integerAtIndex: (SCIndex) index

Returns the signed 32-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (BOOL) lastBool

Returns the last boolean value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCByte) lastByte

Returns the last signed 8-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (char) lastChar

Returns the last char value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (const char *) lastCharString

Returns the last char string from the receiving array.

Returns:: Last char string

Exceptions:

SCCollectionException - array error detected

- (SCDouble) lastDouble

Returns the last double precision float value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCFloat) lastFloat

Returns the last single precision float value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCInteger) lastInteger

Returns the last signed 32-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCLong) lastLong

Returns the last signed 64-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (NSNumber *) lastNumber

Returns the last number from the receiving array.

Returns:: Last number

Exceptions:

SCCollectionException - array error detected

- (id) lastObject

Returns the last object from the receiving array.

Returns:: Last object

Exceptions:

SCCollectionException - array error detected

- (SCShort) lastShort

Returns the last signed 16-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (NSString *) lastString

Returns the last string from the receiving array.

Returns:: Last string

Exceptions:

SCCollectionException - array error detected

- (SCUByte) lastUByte

Returns the last unsigned 8-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCUInteger) lastUInteger

Returns the last unsigned 32-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCULong) lastULong

Returns the last unsigned 64-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (unichar) lastUnichar

Returns the last unichar value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCUShort) lastUShort

Returns the last unsigned 16-bit integer value from the receiving array.

Returns:: Last value

Exceptions:

SCCollectionException - array error detected

- (SCLong) longAtIndex: (SCIndex) index

Returns the signed 64-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) moveObjectAtIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Moves the object at the specified index to a given destination index.

Parameters:

index	- index of moved object
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) moveObjectsFromIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Moves the objects from the specified index to a given destination index.

Parameters:

index	- first index of moved objects
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) moveObjectsInRange:	(NSRange)	range
toIndex:	(SCIndex)	destination

Moves the objects within the specified range to a given destination index.

Parameters:

range	- range of moved objects
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) moveObjectsToIndex:	(SCIndex)	index
toIndex:	(SCIndex)	destination

Moves the objects between first and specified index to a given destination index.

Parameters:

index	- last index of moved objects
destination	- destination index

Exceptions:

SCCollectionException - array error detected

- (void) moveToFirstPositionObjectAtIndex: (SCIndex) index

Moves the object at the specified index to the first position within the array.

Parameters:

index - moved object index

Exceptions:

SCCollectionException - array error detected

- (void) moveToFirstPositionObjectsFromIndex: (SCIndex) index

Moves the objects between the specified and the last index to the first postion of the array.

Parameters:

index - index of first moved object

Exceptions:

SCCollectionException - array error detected

- (void) moveToFirstPositionObjectsInRange: (NSRange) range

Moves the objects within the specified range to the first position of the array.

Parameters:

range - range of objects

Exceptions:

SCCollectionException - array error detected

- (void) moveToLastPositionObjectAtIndex: (SCIndex) index

Moves the object at the specified index to the last position within the array.

Parameters:

index - moved object index

Exceptions:

SCCollectionException - array error detected

- (void) moveToLastPositionObjectsInRange: (NSRange) range

Moves the objects within the specified range to the last position of the array.

Parameters:

range - range of objects

Exceptions:

SCCollectionException - array error detected

- (void) moveToLastPositionObjectsToIndex: (SCIndex) index

Moves the objects between the first and the specified index to the last position of the array.

Parameters:

index - index of last moved object

Exceptions:

SCCollectionException - array error detected

- (NSNumber *) numberAtIndex: (SCIndex) index

Returns the number located at the specified index.

Parameters:

index - required number index

Returns:: Number at the specified index

Exceptions:

SCCollectionException - array error detected

- (id) objectAtIndex: (SCIndex) index

Returns the object located at the specified index.

Parameters:

index - required object index

Returns:: Object at the specified index

Exceptions:

SCCollectionException - incorrect index detected

- (SCArray *) objectsAtIndexes: (NSIndexSet *) indexes

Returns an array containing the objects in the array at the indexes specified by a given index set.

Parameters:

indexes - index set

Returns:: Array with the required objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) objectsFromIndex: (SCIndex) index

Returns an array containing the objects in the array from the specified index.

Parameters:

index - index of the first object for copying

Returns:: Array with the required objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) objectsInRange: (NSRange) range

Returns an array containing the objects in the array in the specified range.

Parameters:

range - objects range

Returns:: Array with the required objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) objectsToIndex: (SCIndex) index

Returns an array containing the objects in the array to the specified index.

Parameters:

index - index of the last object for copying

Returns:: Array with the required objects

Exceptions:

SCCollectionException - array error detected

- (void) removeBool: (BOOL) boolean

Removes all occurrences in the array of a given boolean value.

Parameters:

boolean - value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeByte: (SCByte) byte

Removes all occurrences in the array of a given signed 8-bit integer value.

Parameters:

byte	- value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeChar: (char) chr

Removes all occurrences in the array of a given char value.

Parameters:

chr	- value to remove from the array

Exceptions:

SCCollectionException - array error detected

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

Removes all occurrences in the array of a given char string.

Parameters:

string - string to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeDouble: (SCDouble) dbl

Removes all occurrences in the array of a given double precision float value.

Parameters:

dbl	- value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeFirstObject

Removes from array the first object.

Exceptions:

SCCollectionException - array error detected

- (void) removeFloat: (SCFloat) flt

Removes all occurrences in the array of a given single precision float value.

Parameters:

flt	- value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeInteger: (SCInteger) integer

Removes all occurrences in the array of a given signed 32-bit integer value.

Parameters:

integer - value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeLastObject

Removes from array the last object.

Exceptions:

SCCollectionException - array error detected

- (void) removeLong: (SCLong) longint

Removes all occurrences in the array of a given signed 64-bit integer value.

Parameters:

longint - value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeObject: (id) object

Removes all occurrences in the array of a given object.

Parameters:

object - object to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeObject:	(id)	object
atIndexes:	(NSIndexSet *)	indexes

Removes all occurrences at a specified indexes in the array of a given object.

Parameters:

object	- object to remove from the array
indexes	- indexes set from which to remove object

Exceptions:

SCCollectionException - array error detected

- (void) removeObject:	(id)	object
fromIndex:	(SCIndex)	index

Removes all occurrences started from the specified index in the array of a given object.

Parameters:

object	- object to remove from the array
index	- index from which to remove object

Exceptions:

SCCollectionException - array error detected

- (void) removeObject:	(id)	object
inRange:	(NSRange)	range

Removes all occurrences within a specified range in the array of a given object.

Parameters:

object	- object to remove from the array
range	- range from which to remove object

Exceptions:

SCCollectionException - array error detected

- (void) removeObject:	(id)	object
toIndex:	(SCIndex)	index

Removes all occurrences before the specified index in the array of a given object.

Parameters:

object	- object to remove from the array
index	- index to which to remove object

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectAtIndex: (SCIndex) index

Removes from array the object at the specified index.

Parameters:

index - index of the removed object

Exceptions:

SCCollectionException - array error detected

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

Removes all occurrences in the array of the objects from the specified nil terminated list.

Parameters:

object	- first object to remove from the array
...	- other objects to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsAtIndexes: (NSIndexSet *) indexes

Removes from array the objects at the indexes from the specified index set.

Parameters:

indexes - deleted objects index set

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsEqualTo: (id) object

Removes from the receiving array objects which equal to the specified object.

Parameters:

object - template object to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsEqualTo:	(id)	object
atIndexes:	(NSIndexSet *)	indexes

Removes all occurrences at a specified indexes in the array of the objects which equal to a given object.

Parameters:

object	- template object to remove from the array
indexes	- index set from which to remove objects

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsEqualTo:	(id)	object
fromIndex:	(SCIndex)	index

Removes all occurrences started from the specified index in the array of the objects which equal to a given object.

Parameters:

object	- template object to remove from the array
index	- index from which to remove object

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsEqualTo:	(id)	object
inRange:	(NSRange)	range

Removes all occurrences within the specified range in the array of the objects which equal to a given object.

Parameters:

object	- template object to remove from the array
range	- range from which to remove object

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsEqualTo:	(id)	object
toIndex:	(SCIndex)	index

Removes all occurrences before the specified index in the array of the objects which equal to a given object.

Parameters:

object	- template object to remove from the array
index	- index to which to remove object

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsFromIndex: (SCIndex) index

Removes from the array objects from the specified index.

Parameters:

index - first index of removed objects

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsInCollection: (id) collection

Removes from the receiving array the objects in the specified collection.

Parameters:

collection - collection containing the objects to be removed from the receiving array

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsInRange: (NSRange) range

Removes from the array objects in the specified range.

Parameters:

range - range of the removed objects

Exceptions:

SCCollectionException - array error detected

- (void) removeObjectsToIndex: (SCIndex) index

Removes from the receiving array objects to the specified index.

Parameters:

index - last index of removed objects

Exceptions:

SCCollectionException - array error detected

- (void) removeShort: (SCShort) shortint

Removes all occurrences in the array of a given signed 16-bit integer value.

Parameters:

shortint - value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeUByte: (SCUByte) byte

Removes all occurrences in the array of a given unsigned 8-bit integer value.

Parameters:

byte	- value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeUInteger: (SCUInteger) integer

Removes all occurrences in the array of a given unsigned 32-bit integer value.

Parameters:

integer - value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeULong: (SCULong) longint

Removes all occurrences in the array of a given unsigned 64-bit integer value.

Parameters:

longint - value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeUnichar: (unichar) chr

Removes all occurrences in the array of a given unichar value.

Parameters:

chr	- value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) removeUShort: (SCUShort) shortint

Removes all occurrences in the array of a given unsigned 16-bit integer value.

Parameters:

shortint - value to remove from the array

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withBool:	(BOOL)	boolean

Replaces the object at the specified index with a given boolean value.

Parameters:

index	- index of the object to be replaced
boolean	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withByte:	(SCByte)	byte

Replaces the object at the specified index with a given signed 8-bit integer value.

Parameters:

index	- index of the object to be replaced
byte	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withChar:	(char)	chr

Replaces the object at the specified index with a given char value.

Parameters:

index	- index of the object to be replaced
chr	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withCharString:	(const char *)	string

Replaces the object at the specified index with a given char string value.

Parameters:

index	- index of the object to be replaced
string	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withDouble:	(SCDouble)	dbl

Replaces the object at the specified index with a given double precision float value.

Parameters:

index	- index of the object to be replaced
dbl	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withFloat:	(SCFloat)	flt

Replaces the object at the specified index with a given single precision float value.

Parameters:

index	- index of the object to be replaced
flt	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withInteger:	(SCInteger)	integer

Replaces the object at the specified index with a given signed 32-bit integer value.

Parameters:

index	- index of the object to be replaced
integer	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withLong:	(SCLong)	longint

Replaces the object at the specified index with a given signed 64-bit integer value.

Parameters:

index	- index of the object to be replaced
longint	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withObject:	(id)	object

Replaces the object at the specified index with a given object.

Parameters:

index	- index of the object to be replaced
object	- object with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withShort:	(SCShort)	sht

Replaces the object at the specified index with a given signed 16-bit integer value.

Parameters:

index	- index of the object to be replaced
sht	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withUByte:	(SCUByte)	byte

Replaces the object at the specified index with a given unsigned 8-bit integer value.

Parameters:

index	- index of the object to be replaced
byte	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withUInteger:	(SCUInteger)	integer

Replaces the object at the specified index with a given unsigned 32-bit integer value.

Parameters:

index	- index of the object to be replaced
integer	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withULong:	(SCULong)	longint

Replaces the object at the specified index with a given unsigned 64-bit integer value.

Parameters:

index	- index of the object to be replaced
longint	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withUnichar:	(unichar)	chr

Replaces the object at the specified index with a given unichar value.

Parameters:

index	- index of the object to be replaced
chr	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectAtIndex:	(SCIndex)	index
withUShort:	(SCUShort)	sht

Replaces the object at the specified index with a given unsigned 16-bit integer value.

Parameters:

index	- index of the object to be replaced
sht	- value with which to replace the object at the specified index

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsAtIndexes:	(NSIndexSet *)	indexes
withObjects:	(id)	object
,		...

Replaces the objects in the receiving array at specified locations with the objects from a given nil terminated list.

Parameters:

indexes	- indexes of objects to be replaced
object	- first object from list of objects to replace objects in the receiving array
...	- other objects from list of objects to replace objects in the receiving array

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsAtIndexes:	(NSIndexSet *)	indexes
withObjectsFromCollection:	(id)	collection

Replaces the objects in the receiving array at specified locations with the objects from a given collection.

Parameters:

indexes	- indexes of objects to be replaced
collection	- objects with which to replace the objects in the receiving array

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsFromIndex:	(SCIndex)	index
withObjects:	(id)	object
,		...

Replaces the objects from the specified index with all of the objects from a given nil terminated list.

Parameters:

index	- first index of replaceable objects
object	- first replacement for the objects from the list
...	- other replacements for the objects from the list

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsFromIndex:	(SCIndex)	index
withObjectsFromCollection:	(id)	collection

Replaces the objects from the specified index with all of the objects from a given collection.

Parameters:

index	- first index of replaceable objects
collection	- collection of objects from which to select replacements for the objects

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsInRange:	(NSRange)	range
withObjects:	(id)	object
,		...

Replaces the objects in the receiving array specified by a given range with all of the objects from a specified nil terminated list.

Parameters:

range	- range of objects to replace in (or remove from) the receiving array
object	- first object for replacement
...	- other objects for replacement

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsInRange:	(NSRange)	range
withObjectsFromCollection:	(id)	collection

Replaces the objects in the receiving array specified by a given range with all of the objects from a specified collection.

Parameters:

range	- range of objects to replace in (or remove from) the receiving array
collection	- collection of objects from which to select replacements for the objects

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsToIndex:	(SCIndex)	index
withObjects:	(id)	object
,		...

Replaces the objects to the specified index with all of the objects from a given nil terminated list.

Parameters:

index	- last index of replaceable objects
object	- first replacement for the objects from the list
...	- other replacements for the objects from the list

Exceptions:

SCCollectionException - array error detected

- (void) replaceObjectsToIndex:	(SCIndex)	index
withObjectsFromCollection:	(id)	collection

Replaces the objects to the specified index with all of the objects from a given collection.

Parameters:

index	- last index of replaceable objects
collection	- collection of objects from which to select replacements for the objects

Exceptions:

SCCollectionException - array error detected

- (void) reverse

Reverses the order of all objects in the receiving array.

Exceptions:

SCCollectionException - array error detected

- (SCArray *) reversedArray

Returns the array with the all objects from the receiving array in reverse order.

Returns:: Array with the objects in reverse order

- (void) setArrayName: (NSString *) name

Sets the array name.

Parameters:

name	- array name

- (SCShort) shortAtIndex: (SCIndex) index

Returns the signed 16-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (SCArray *) sortedArray

Returns the array with ascending sorted using the default algorithm objects from the receving array.

Returns:: Array with sorted objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) sortedArrayAscending

Returns the array with ascending sorted using the default algorithm objects from the receving array.

Returns:: Array with sorted objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) sortedArrayAscendingWithMethod: (id<SCSortingProtocol>) method

Returns the array with ascending sorted using the specified algorithm objects from the receving array.

Parameters:

method - sorting algorithm

Returns:: Array with sorted objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) sortedArrayDescending

Returns the array with descending sorted using the default algorithm objects from the receving array.

Returns:: Array with sorted objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) sortedArrayDescendingWithMethod: (id<SCSortingProtocol>) method

Returns the array with descending sorted using the specified algorithm objects from the receving array.

Parameters:

method - sorting algorithm

Returns:: Array with sorted objects

Exceptions:

SCCollectionException - array error detected

- (SCArray *) sortedArrayWithMethod: (id<SCSortingProtocol>) method

Returns the array with ascending sorted using the specified algorithm objects from the receving array.

Parameters:

method - sorting algorithm

Returns:: Array with sorted objects

Exceptions:

SCCollectionException - array error detected

- (void) sortingArray

Sort ascending the receiving array using the default sorting algorithm.

Exceptions:

SCCollectionException - array error detected

- (void) sortingArrayAscending

Sort ascending the receiving array using the default sorting algorithm.

Exceptions:

SCCollectionException - array error detected

- (void) sortingArrayAscendingWithMethod: (id<SCSortingProtocol>) method

Sort ascending the receiving array using the specified sorting algorithm.

Parameters:

method - sorting algoritm

Exceptions:

SCCollectionException - array error detected

- (void) sortingArrayDescending

Sort descending the receiving array using the default sorting algorithm.

Exceptions:

SCCollectionException - array error detected

- (void) sortingArrayDescendingWithMethod: (id<SCSortingProtocol>) method

Sort descending the receiving array using the specified sorting algorithm.

Parameters:

method - sorting algoritm

Exceptions:

SCCollectionException - array error detected

- (void) sortingArrayWithMethod: (id<SCSortingProtocol>) method

Sort ascending the receiving array using the specified sorting algorithm.

Parameters:

method - sorting algoritm

Exceptions:

SCCollectionException - array error detected

- (NSString *) stringAtIndex: (SCIndex) index

Returns the string located at the specified index.

Parameters:

index - required string index

Returns:: String at the specified index

Exceptions:

SCCollectionException - array error detected

- (SCUByte) uByteAtIndex: (SCIndex) index

Returns the unsigned 8-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (SCUInteger) uIntegerAtIndex: (SCIndex) index

Returns the unsigned 32-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (SCULong) uLongAtIndex: (SCIndex) index

Returns the unsigned 64-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (unichar) unicharAtIndex: (SCIndex) index

Returns the unichar value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

- (SCUShort) uShortAtIndex: (SCIndex) index

Returns the unsigned 16-bit integer value located at the specified index.

Parameters:

index - required number index

Returns:: Value at the specified index

Exceptions:

SCCollectionException - array error detected

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

SCArray.h
SCArray.m

SCArray Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation