https://github.com/yockow/swiftranges

`SwiftRanges` provides some kinds of range that are not implemented in Swift Standard Library.
https://github.com/yockow/swiftranges

range swift

Last synced: 24 days ago
JSON representation

`SwiftRanges` provides some kinds of range that are not implemented in Swift Standard Library.

• Host: GitHub
• URL: https://github.com/yockow/swiftranges
• Owner: YOCKOW
• License: mit
• Created: 2018-07-03T01:11:34.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-06T08:37:02.000Z (about 1 month ago)
• Last Synced: 2024-10-14T12:35:23.820Z (about 1 month ago)
• Topics: range, swift
• Language: Swift
• Size: 229 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# What is `SwiftRanges`?

`SwiftRanges` provides some kinds of range that are not implemented in Swift Standard Library.  

It was originally written as a part of [SwiftCGIResponder](https://github.com/YOCKOW/SwiftCGIResponder).

## Ranges

| Name                    | Lower Bound | Upper Bound | Implemented in         |

|-------------------------|-------------|-------------|------------------------|

| ClosedRange             | Included    | Included    | Swift Standard Library |

| LeftOpenRange           | Excluded    | Included    | This Library           |

| OpenRange               | Excluded    | Excluded    | This Library           |

| Range                   | Included    | Excluded    | Swift Standard Library |

| PartialRangeFrom        | Included    | (Pos. Inf.) | Swift Standard Library |

| PartialRangeGreaterThan | Excluded    | (Pos. Inf.) | This Library           |

| PartialRangeThrough     | (Neg. Inf.) | Included    | Swift Standard Library |

| PartialRangeUpTo        | (Neg. Inf.) | Excluded    | Swift Standard Library |

| UnboundedRange          | (Neg. Inf.) | (Pos. Inf.) | Swift Standard Library |

### Other `struct`s implemented in this library

* `AnyRange`: A type-erased range.

* `RangeDictionary`: A collection like `Dictionary` whose key is a range.

* `MultipleRanges`: A set that can contain multiple types of ranges.

# Requirements

- Swift 4.2, 5, 6

- macOS or Linux

# Usage

## Left-Open Ranges

```Swift

import Ranges

let leftOpenRange: LeftOpenRange = 10<..20

print(leftOpenRange.contains(10)) // -> false

print(leftOpenRange.contains(15)) // -> true

print(leftOpenRange.contains(20)) // -> true

let openRange: OpenRange = 10<..<20

print(openRange.contains(10)) // -> false

print(openRange.contains(15)) // -> true

print(openRange.contains(20)) // -> false

let greaterThan: PartialRangeGreaterThan = 10<..

print(greaterThan.contains(10)) // -> false

print(greaterThan.contains(Int.max)) // -> true

print(greaterThan.overlaps(...11)) // -> true

print(greaterThan.overlaps(..<11)) // -> false

                                   // Because there is no integer in "10<..<11"

```

## Type-erased Range: `AnyRange`

```Swift

import Ranges

// Original operators are implemented for `AnyRange`.

// Some of them are below:

let leftOpenRange: LeftOpenRange = 10<..20

let typeErasedLeftOpenRange: AnyRange = 10<...20

print(leftOpenRange == typeErasedLeftOpenRange) // -> true

let openRange: OpenRange = 10<..<20

let typeErasedOpenRange: AnyRange = 19<...<30

print(openRange.overlaps(typeErasedOpenRange)) // -> false

let greaterThan: PartialRangeGreaterThan = 10<..

let typeErasedGreaterThan: AnyRange = 20<...

print(greaterThan.contains(15)) // -> true

print(typeErasedGreaterThan.contains(15)) // -> false

```

## `RangeDictionary` 

```Swift

var dic: RangeDictionary = [

  1....2: "Index",

  3....10: "Chapter 01",

  11....40: "Chapter 02"

]

print(dic[1]) // Prints "Index"

print(dic[5]) // Prints "Chapter 01"

print(dic[15]) // Prints "Chapter 02"

print(dic[100]) // Prints "nil"

dic.insert("Prologue", forRange: 2....5)

print(dic[5]) // Prints "Prologue"

```

## `MultipleRanges`

```Swift

import Ranges

var multi = MultipleRanges()

multi.insert(10...20) 

multi.insert(30...40)

print(multi.contains(15)) // -> true

print(multi.contains(25)) // -> false

print(multi.contains(35)) // -> true

multi.subtract(15...35)

print(multi.ranges) // -> [10..<15, 35<..40]

```

Other methods like `Set` are also implemented in `MultipleRanges`:

* `intersection(_:)`

* `union(_:)`

* `symmetricDifference(_:)`

# License

MIT License.  

See "LICENSE.txt" for more information.