Merge pull request #52 from ie3-institute/ck/v1.4-release

Preparing v 1.4 release

Author: johanneshiry

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased/Snapshot]
+## [1.4]
 
 ### Added
 -   Introduction of EmptyQuantity, a representation for null value Quantities
@@ -14,7 +14,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   Improved implementation of `StandardUnits.PU`
 -   BREAKING: replaced Unit API 1.0 (JSR 363, tec.uom.se) with Unit API 2.0 (JSR 385, tech.units.indriya)
 
-### Fixed
+### Removed
+-   Deprecated methods in `GeoUtils`
+-   Deprecated `TimeTools`
 
 ## [1.3.2]
 
@@ -40,3 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 -   fixes + extensions in StandardUnits
+
+[1.4]: https://github.com/ie3-institute/powersystemutils/compare/v1.3.2...v1.4
+[1.3.2]: https://github.com/ie3-institute/powersystemutils/compare/v1.3.1...v1.3.2
+[1.3.1]: https://github.com/ie3-institute/powersystemutils/compare/64283b769d1faeac0a6468b0f225f5e995741cdd...v1.3.1

build.gradle

@@ -1,29 +1,29 @@
 plugins {
-	id "com.jfrog.artifactory" version "4.9.7"
+	id "com.jfrog.artifactory" version "4.18.0"
 	id 'groovy' // groovy support
 	id 'java' // java support
 	id 'maven-publish'
 	id 'signing'
 	id 'pmd' //code check, working on source code
-	id 'com.github.spotbugs' version '2.0.0' //code check, working on byte code
-	id 'com.diffplug.gradle.spotless' version '3.27.1'//code format
-	id 'com.simonharrer.modernizer' version '1.6.0-1' //detect deprecated APIs
+	id 'com.github.spotbugs' version '4.6.0' //code check, working on byte code
+	id 'com.diffplug.spotless' version '5.7.0'//code format
+	id 'com.simonharrer.modernizer' version '2.1.0-1' //detect deprecated APIs
 	id 'com.github.onslip.gradle-one-jar' version '1.0.5' // pack a self contained jar
 	id 'jacoco' // java code coverage plugin
-	id "org.sonarqube" version "2.7.1" // sonarqube
+	id "org.sonarqube" version "3.0" // sonarqube
 }
 
 ext {
 	// version (changing these should be considered thoroughly!)
 	hibernateVersion = '5.3.3.Final'
-	slf4jVersion = '1.7.26'
+	slf4jVersion = '1.7.30'
 	javaVersion = JavaVersion.VERSION_1_8
 
 	scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }
 
 group = 'com.github.ie3-institute'
-version = '1.4-SNAPSHOT'
+version = '1.4'
 description = 'PowerSystemUtils'
 sourceCompatibility = javaVersion
 targetCompatibility = javaVersion
@@ -67,7 +67,6 @@ dependencies {
 	testCompile 'org.spockframework:spock-core:1.3-groovy-+'
 
 	spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:+' // find bugs in java programs
-
 }
 
 wrapper {

gradle/scripts/spotless.gradle

@@ -18,7 +18,6 @@ spotless {
 	groovy {
 		licenseHeader ie3LicHead
 		excludeJava() // excludes all Java sources within the Groovy source dirs from formatting
-		paddedCell() // Avoid cyclic ambiguities
 		// the Groovy Eclipse formatter extends the Java Eclipse formatter,
 		// so it formats Java files by default (unless `excludeJava` is used).
 		greclipse()

src/main/java/edu/ie3/util/ArrayHelper.java

@@ -8,11 +8,13 @@
 import org.apache.commons.math3.complex.Complex;
 
 /**
- * Contains convenience methos for arrays
+ * Contains convenience methods for arrays
  *
  * @author roemer
  */
 public class ArrayHelper {
+  private static final String ARRAY_DIMENSION_MISMATCH_MESSAGE =
+      "Both arrays may have the same dimension.";
 
   private ArrayHelper() {}
 
@@ -45,12 +47,12 @@ public static boolean arrayContainsValue(int[] arr, int value) {
   /**
    * Element wise addition of two double arrays
    *
-   * @param a Array of double values for the first summand
-   * @param b Array of double values for the second summand
+   * @param a Array of double values for the first addend
+   * @param b Array of double values for the second addend
    * @return c Double array with the summation of a and b
    */
   public static double[] add(double[] a, double[] b) {
-    assert a.length == b.length : "Both arrays may have the same dimension.";
+    if (a.length != b.length) throw new IllegalArgumentException(ARRAY_DIMENSION_MISMATCH_MESSAGE);
     double[] c = new double[a.length];
     for (int i = 0; i < c.length; i++) {
       c[i] = a[i] + b[i];
@@ -61,12 +63,12 @@ public static double[] add(double[] a, double[] b) {
   /**
    * Element wise addition of two double arrays
    *
-   * @param a Array of {@link Complex} values for the first summand
-   * @param b Array of {@link Complex} values for the second summand
+   * @param a Array of {@link Complex} values for the first addend
+   * @param b Array of {@link Complex} values for the second addend
    * @return c Double array with the summation of a and b
    */
   public static Complex[] add(Complex[] a, Complex[] b) {
-    assert a.length == b.length : "Both arrays may have the same dimension.";
+    if (a.length != b.length) throw new IllegalArgumentException(ARRAY_DIMENSION_MISMATCH_MESSAGE);
     Complex[] c = new Complex[a.length];
     for (int i = 0; i < c.length; i++) {
       c[i] = a[i].add(b[i]);
@@ -82,7 +84,7 @@ public static Complex[] add(Complex[] a, Complex[] b) {
    * @return The Array of double values built by subtraction
    */
   public static double[] subtract(double[] a, double[] b) {
-    assert a.length == b.length : "Both arrays may have the same dimension.";
+    if (a.length != b.length) throw new IllegalArgumentException(ARRAY_DIMENSION_MISMATCH_MESSAGE);
     double[] c = new double[a.length];
     for (int i = 0; i < c.length; i++) {
       c[i] = a[i] - b[i];
@@ -98,7 +100,7 @@ public static double[] subtract(double[] a, double[] b) {
    * @return The Array of {@link Complex} values built by subtraction
    */
   public static Complex[] subtract(Complex[] a, Complex[] b) {
-    assert a.length == b.length : "Both arrays may have the same dimension.";
+    if (a.length != b.length) throw new IllegalArgumentException(ARRAY_DIMENSION_MISMATCH_MESSAGE);
     Complex[] c = new Complex[a.length];
     for (int i = 0; i < c.length; i++) {
       c[i] = a[i].subtract(b[i]);