Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelbull/kotlin-itertools
Multiplatform combinatoric sequences for Kotlin, inspired by python-itertools.
https://github.com/michaelbull/kotlin-itertools
android functional functional-programming ios iterator js jvm kotlin kotlin-multiplatform linux python-itertools sequence
Last synced: 4 days ago
JSON representation
Multiplatform combinatoric sequences for Kotlin, inspired by python-itertools.
- Host: GitHub
- URL: https://github.com/michaelbull/kotlin-itertools
- Owner: michaelbull
- License: isc
- Created: 2024-03-03T00:30:17.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-03-05T05:38:40.000Z (7 months ago)
- Last Synced: 2024-09-26T01:41:13.640Z (7 days ago)
- Topics: android, functional, functional-programming, ios, iterator, js, jvm, kotlin, kotlin-multiplatform, linux, python-itertools, sequence
- Language: Kotlin
- Homepage:
- Size: 96.7 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kotlin-itertools
[](https://search.maven.org/search?q=g:com.michael-bull.kotlin-itertools)
[](https://github.com/michaelbull/kotlin-itertools/actions/workflows/ci.yaml)
[](https://github.com/michaelbull/kotlin-itertools/blob/master/LICENSE)
![badge][badge-android]
![badge][badge-jvm]
![badge][badge-js]
![badge][badge-nodejs]
![badge][badge-linux]
![badge][badge-windows]
![badge][badge-wasm]
![badge][badge-ios]
![badge][badge-mac]
![badge][badge-tvos]
![badge][badge-watchos]
![badge][badge-js-ir]
![badge][badge-android-native]
![badge][badge-apple-silicon]
Multiplatform combinatoric sequences for Kotlin, inspired by [python-itertools][python-itertools].
Initially built as part of my solutions for [Advent of Code 2023][advent-2023].
## Installation
```groovy
repositories {
mavenCentral()
}
dependencies {
implementation("com.michael-bull.kotlin-itertools:kotlin-itertools:1.0.0")
}
```
## Usage
### Combinations
Returns a sequence that yields `length`-sized combinations from this list.
The combination tuples are emitted in lexicographic order according to the order of this list.
```kotlin
fun List.combinations(length: Int = size): Sequence>
fun List.pairCombinations(): Sequence>
fun List.tripleCombinations(): Sequence>
```
Examples
```kotlin
import com.github.michaelbull.itertools.combinations
import com.github.michaelbull.itertools.pairCombinations
import com.github.michaelbull.itertools.tripleCombinations
// [[A, B], [A, C], [A, D], [B, C], [B, D], [C, D]]
fun example1(): List> {
return "ABCD".toList()
.combinations(length = 2)
.toList()
}
// [(A, B), (A, D), (A, C), (B, D), (B, C), (D, C)]
fun example2(): List> {
return "ABDC".toList()
.pairCombinations()
.toList()
}
// [(0, 1, 2), (0, 1, 3), (0, 2, 3), (1, 2, 3)]
fun example3(): List> {
return (0..3).toList()
.tripleCombinations()
.toList()
}
```
### Permutations
Returns a sequence that yields `length`-sized permutations from this list.
The permutation tuples are emitted in lexicographic order according to the order of this list.
```kotlin
fun List.permutations(length: Int = size): Sequence>
fun List.pairPermutations(): Sequence>
fun List.triplePermutations(): Sequence>
```
Examples
```kotlin
import com.github.michaelbull.itertools.permutations
import com.github.michaelbull.itertools.pairPermutations
import com.github.michaelbull.itertools.triplePermutations
// [[A, B], [A, C], [A, D], [B, A], [B, C], [B, D], [C, A], [C, B], [C, D], [D, A], [D, B], [D, C]]
fun example1(): List> {
return "ABCD".toList()
.permutations(length = 2)
.toList()
}
// [(0, 1), (0, 2), (1, 0), (1, 2), (2, 0), (2, 1)]
fun example2(): List> {
return (0..2).toList()
.pairPermutations()
.toList()
}
// [(0, 1, 2), (0, 2, 1), (1, 0, 2), (1, 2, 0), (2, 0, 1), (2, 1, 0)]
fun example3(): List> {
return (0..2).toList()
.triplePermutations()
.toList()
}
```
### Cartesian Product
Returns a sequence that yields the Cartesian product of the input iterables/lists.
The product tuples are emitted in lexicographic order according to the order of this iterable/list.
```kotlin
fun Iterable.product(other: Iterable): Sequence>
fun Iterable.product(first: Iterable, second: Iterable): Sequence>
fun Pair, Iterable>.product(): Sequence>
fun Triple, Iterable, Iterable>.product(): Sequence>
fun List>.product(): Sequence>
```
Examples
```kotlin
import com.github.michaelbull.itertools.product
// [(A, x), (A, y), (B, x), (B, y), (C, x), (C, y), (D, x), (D, y)]
fun example1(): List> {
val a = "ABCD".toList()
val b = "xy".toList()
return a.product(b).toList()
}
// [(A, C, E), (A, C, F), (A, D, E), (A, D, F), (B, C, E), (B, C, F), (B, D, E), (B, D, F)]
fun example2(): List> {
val a = "AB".toList()
val b = "CD".toList()
val c = "EF".toList()
return Triple(a, b, c)
.product()
.toList()
}
// [[A, x], [A, y], [B, x], [B, y], [C, x], [C, y], [D, x], [D, y]]
fun example3(): List> {
val a = "ABCD".toList()
val b = "xy".toList()
return listOf(a, b)
.product()
.toList()
}
```
## Contributing
Bug reports and pull requests are welcome on [GitHub][github].
## License
This project is available under the terms of the ISC license. See the
[`LICENSE`](LICENSE) file for the copyright information and licensing terms.
[python-itertools]: https://docs.python.org/3/library/itertools.html
[advent-2023]: https://github.com/michaelbull/advent-2023
[github]: https://github.com/michaelbull/kotlin-itertools
[badge-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
[badge-android-native]: http://img.shields.io/badge/support-[AndroidNative]-6EDB8D.svg?style=flat
[badge-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat
[badge-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat
[badge-js-ir]: https://img.shields.io/badge/support-[IR]-AAC4E0.svg?style=flat
[badge-nodejs]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat
[badge-linux]: http://img.shields.io/badge/-linux-2D3F6C.svg?style=flat
[badge-windows]: http://img.shields.io/badge/-windows-4D76CD.svg?style=flat
[badge-wasm]: https://img.shields.io/badge/-wasm-624FE8.svg?style=flat
[badge-apple-silicon]: http://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg?style=flat
[badge-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat
[badge-mac]: http://img.shields.io/badge/-macos-111111.svg?style=flat
[badge-watchos]: http://img.shields.io/badge/-watchos-C0C0C0.svg?style=flat
[badge-tvos]: http://img.shields.io/badge/-tvos-808080.svg?style=flat