cirkle

Circularly-addressable `List` and `MutableList` for Kotlin.

License	MIT License
Categories	SBE Data Data Structures
GroupId	com.ginsberg
ArtifactId	cirkle
Last Version	1.0.1
Release Date	Jan 1, 2018
Type	jar
Description	cirkle Circularly-addressable `List` and `MutableList` for Kotlin.
Project URL	https://github.com/tginsberg/cirkle
Source Code Management	https://github.com/tginsberg/cirkle

Download cirkle

Filename	Size
cirkle-1.0.1.pom
cirkle-1.0.1.jar	5 KB
cirkle-1.0.1-sources.jar	4 KB
cirkle-1.0.1-javadoc.jar	21 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.ginsberg/cirkle/ -->
<dependency>
    <groupId>com.ginsberg</groupId>
    <artifactId>cirkle</artifactId>
    <version>1.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.ginsberg/cirkle/
implementation 'com.ginsberg:cirkle:1.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.ginsberg/cirkle/
implementation ("com.ginsberg:cirkle:1.0.1")

Apache Buildr

'com.ginsberg:cirkle:jar:1.0.1'

Apache Ivy

<dependency org="com.ginsberg" name="cirkle" rev="1.0.1">
  <artifact name="cirkle" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.ginsberg', module='cirkle', version='1.0.1')
)

Scala SBT

libraryDependencies += "com.ginsberg" % "cirkle" % "1.0.1"

Leiningen

[com.ginsberg/cirkle "1.0.1"]

Dependencies

test (4)

Group / Artifact	Type	Version
org.jetbrains.kotlin : kotlin-stdlib-jdk8	jar	1.2.10
org.assertj : assertj-core	jar	3.8.0
org.junit.jupiter : junit-jupiter-api	jar	5.0.2
org.junit.jupiter : junit-jupiter-engine	jar	5.0.2

Project Modules

There are no modules declared in this project.

Cirkle

Cirkle is a circularly-addressable List and MutableList for Kotlin.

Any negative index will wrap around from the end of the List, and any overly positive index will continue wrapping around back to the start of the List. This is partially inspired by Python and all of the times I could have used this during Advent of Code 2017.

Quick Start

Copy the following into your build.gradle or build.xml, cirkle has no additional dependencies.

Gradle

compile 'com.ginsberg:cirkle:1.0.1'

Maven

<dependency>
    <groupId>com.ginsberg</groupId>
    <artifactId>cirkle</artifactId>
    <version>1.0.1</version>
</dependency>

Usage

Convert a List to a circularly-addressable list:

val cirkle = listOf("a", "b", "c").circular()

Convert a MutableList to a circularly-addressable list:

val cirkle = mutableListOf("a", "b", "c").circular()

Examples

Get with negative index

val cirkle = listOf("a", "b", "c").circular()
cirkle[-1]  // "c"
cirkle[-4]  // "c"

Get with overly positive index

val cirkle = listOf("a", "b", "c").circular()
cirkle[3]  // "a"
cirkle[6]  // "a"

Set with negative index

val cirkle = mutableListOf("a", "b", "c").circular()
cirkle[-1] = "d"  // ["a", "b", "d"] or...
cirkle[-4] = "d"  // ["a", "b", "d"]

Set with overly positive index

val cirkle = mutableListOf("a", "b", "c").circular()
cirkle[3] = "d"  // ["d", "b", "c"] or...
cirkle[6] = "d"  // ["d", "b", "c"]

SubList with negative indexes

val cirkle = listOf("a", "b", "c").circular()
cirkle.subList(-3, -1)  // ["a", "b"]

SubList with overly positive indexes

val cirkle = listOf("a", "b", "c").circular()
cirkle.subList(3, 5)  // ["a", "b"]

Add with negative index

val cirkle = mutableListOf("a", "b", "c").circular()
cirkle.add(-1, "d")   // ["a", "b", "d", "c"] or...
cirkle.add(-4, "d")   // ["a", "b", "d", "c"]

Add with overly positive index

val cirkle = mutableListOf("a", "b", "c").circular()
cirkle.add(3, "d")   // ["d", "a", "b", "c"] or...
cirkle.add(6, "d")   // ["d", "a", "b", "c"]

Contributing and Issues

Please feel free to file issues for change requests or bugs. If you would like to contribute new functionality, please contact me first!

Copyright © 2018 by Todd Ginsberg

Versions

Version
1.0.1 Jan 1, 2018
1.0.0 Jan 1, 2018