Merge pull request #10 from shapelets/feature/clustering

Adding clustering functions and tests

.CI/travis/build-and-test.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
-# Copyright (c) 2018 Shapelets.io
+# Copyright (c) 2019 Shapelets.io
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 mvn dokka:dokka
-mvn test
+mvn test

.CI/travis/install-arrayfire.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2018 Shapelets.io
+# Copyright (c) 2019 Shapelets.io
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this

.CI/travis/install-java.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2018 Shapelets.io
+# Copyright (c) 2019 Shapelets.io
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this

.CI/travis/install-khiva.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2018 Shapelets.io
+# Copyright (c) 2019 Shapelets.io
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this

.appveyor.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018 Shapelets.io
+# Copyright (c) 2019 Shapelets.io
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this

.github/CODE_OF_CONDUCT.md

@@ -90,4 +90,4 @@ If some members of staff were angered by the incident, it is best to apologise t
 
 ## Attribution
 
-This Code of Conduct was adapted from both [Golang](https://golang.org/conduct) an the [Golang UK Conference](http://golanguk.com/conduct/).
+This Code of Conduct was adapted from both [Golang](https://golang.org/conduct) an the [Golang UK Conference](http://golanguk.com/conduct/).

.travis.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018 Shapelets.io
+# Copyright (c) 2019 Shapelets.io
 #
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this

CONTRIBUTING.md

@@ -80,4 +80,4 @@ Start a new docker container.
 ```
 # Start docker
 docker run --rm -ti shapelets/khiva-java
-```
+```

README.md

@@ -51,4 +51,4 @@ Dokka does not support the writing of mathematical formulas, therefore functions
 ## Contributing
 The rules to contribute to this project are described [here](CONTRIBUTING.md)
 
-[![Powered by Shapelets](https://img.shields.io/badge/powered%20by-Shapelets-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://shapelets.io)
+[![Powered by Shapelets](https://img.shields.io/badge/powered%20by-Shapelets-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://shapelets.io)

pom.xml

@@ -9,7 +9,7 @@
     </properties>
     <groupId>io.shapelets</groupId>
     <artifactId>khiva-kotlin</artifactId>
-    <version>0.1.0</version>
+    <version>0.2.0</version>
 
     <name>khiva-kotlin</name>
     <url>https://github.com/shapelets/khiva-kotlin</url>

src/main/kotlin/io/shapelets/khiva/Array.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Shapelets.io
+ * Copyright (c) 2019 Shapelets.io
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this

src/main/kotlin/io/shapelets/khiva/Clustering.kt

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2019 Shapelets.io
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ */
+
+package io.shapelets.khiva
+
+/**
+ * Khiva Clustering class containing several clustering methods.
+ */
+object Clustering : Library() {
+    @JvmStatic
+    private external fun kMeans(tss: Long, k: Int, tolerance: Float, maxInterations: Int): LongArray
+
+    @JvmStatic
+    private external fun kShape(tss: Long, k: Int, tolerance: Float, maxInterations: Int): LongArray
+
+    /**
+     * Calculates the KMeans algorithm.
+     *
+     * [1] S. Lloyd. 1982. Least squares quantization in PCM. IEEE Transactions on Information Theory, 28, 2,
+     * Pages 129-137.
+     *
+     * @param tss               The set of time series to be clusterized.
+     * @param k                 The number of centroids.
+     * @param tolerance         The maximum error tolerance.
+     * @param maxIterations     The maximum number of iterations.
+     *
+     * @return An Array of arrays with the resulting centroids and labels.
+     */
+    fun kMeans(tss: Array, k: Int, tolerance: Float, maxInterations: Int): kotlin.Array<Array> {
+        val refs = Clustering.kMeans(tss.reference, k, tolerance, maxInterations)
+        tss.reference = refs[0]
+        return arrayOf(Array(refs[1]), Array(refs[2]))
+    }
+
+    /**
+     * Calculates the KShape algorithm.
+     *
+     * [1] John Paparrizos and Luis Gravano. 2016. k-Shape: Efficient and Accurate Clustering of Time Series.
+     * SIGMOD Rec. 45, 1 (June 2016), 69-76.
+     *
+     * @param tss               The set of time series to be clusterized.
+     * @param k                 The number of centroids.
+     * @param tolerance         The maximum error tolerance.
+     * @param maxIterations     The maximum number of iterations.
+     *
+     * @return An Array of arrays with the resulting centroids and labels.
+     */
+    fun kShape(tss: Array, k: Int, tolerance: Float, maxInterations: Int): kotlin.Array<Array>{
+        val refs = Clustering.kShape(tss.reference, k, tolerance, maxInterations)
+        tss.reference = refs[0]
+        return arrayOf(Array(refs[1]), Array(refs[2]))
+    }
+}