# MatchingPair

## Discussion

class for a matching pair.

## Methods

`-contains:`
  returns YES if a matching pair contains anothers ocurrences (abcd.abcd contains .bc...bc.).
`-distanceBetweenStrings`
  returns the distance between the two string ocurrences.
`-distanceFromFirstLocationToSecondLocation`
  returns the distance from the first to the second location.
`-equals:`
  returns YES if the matching pairs are identical in string and ocurrences.
`-firstLocation`
  returns the first location of the repeated string.
`-firstRange`
  returns the range of the first string ocurrence.
`-initWithString:firstLocation:secondLocation:`
  initialises a new matching pair.
`-length`
  returns the matching pair's spanning length.
`-printToLog`
  prints the matching pair to the NSLog.
`-secondLocation`
  returns the second location of the repeated string.
`-secondRange`
  returns the range of the second string ocurrence.
`-string`
  returns the repeted string.
`-stringLength`
  returns the length of the repeated string.

### contains:

returns YES if a matching pair contains anothers ocurrences (abcd.abcd contains .bc...bc.).

>     - (BOOL)contains:(MatchingPair *)aMatchingPair;

### distanceBetweenStrings

returns the distance between the two string ocurrences.

>     - (int)distanceBetweenStrings;

### distanceFromFirstLocationToSecondLocation

returns the distance from the first to the second location.

>     - (int)distanceFromFirstLocationToSecondLocation;

### equals:

returns YES if the matching pairs are identical in string and ocurrences.

>     - (BOOL)equals:(MatchingPair *)aMatchingPair;

### firstLocation

returns the first location of the repeated string.

>     - (int)firstLocation;

### firstRange

returns the range of the first string ocurrence.

>     - (NSRange)firstRange;

### initWithString:firstLocation:secondLocation:

initialises a new matching pair.

>     - (id)initWithString:(NSString *)aString firstLocation:(int)aFirstLocation
>             secondLocation:(int)aSecondLocation;

##### Parameter Descriptions

> `aString`
>   repeated string.
> `aFirstLocation`
>   first location of the string (0 ... n-1).
> `aSecondLocation`
>   second location of the string (0 ... n-1).

### length

returns the matching pair's spanning length.

>     - (int)length;

### printToLog

prints the matching pair to the NSLog.

>     - (void)printToLog;

### secondLocation

returns the second location of the repeated string.

>     - (int)secondLocation;

### secondRange

returns the range of the second string ocurrence.

>     - (NSRange)secondRange;

### string

returns the repeted string.

>     - (NSString *)string;

### stringLength

returns the length of the repeated string.

>     - (int)stringLength;

(Last Updated M/D/Y)