Organize imports and rename packages for consistency

didalgolab · didalgolab · commit 87193b7ee9a4 · 2024-09-22T22:32:33.000+02:00
Renamed and moved several classes from `one.chartsy.base` and `one.chartsy.collections` to `one.chartsy.data.structures` and `one.chartsy.math` for better categorization. Updated import paths and refactored comments to improve clarity.
diff --git a/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferBenchmark.java b/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferBenchmark.java
@@ -5,8 +5,8 @@
 package one.chartsy.benchmarking;
 
 import one.chartsy.Candle;
-import one.chartsy.base.RingBuffer;
 import one.chartsy.base.function.IndexedConsumer;
+import one.chartsy.data.structures.RingBuffer;
 import org.openjdk.jmh.annotations.*;
 import org.openjdk.jmh.infra.Blackhole;
 
diff --git a/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferOfDoubleAddAndGetBenchmark.java b/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferOfDoubleAddAndGetBenchmark.java
@@ -4,7 +4,7 @@
  */
 package one.chartsy.benchmarking;
 
-import one.chartsy.base.RingBuffer;
+import one.chartsy.data.structures.RingBuffer;
 import org.openjdk.jmh.annotations.Benchmark;
 import org.openjdk.jmh.annotations.BenchmarkMode;
 import org.openjdk.jmh.annotations.Level;
diff --git a/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferOfIntAddAndGetBenchmark.java b/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferOfIntAddAndGetBenchmark.java
@@ -4,7 +4,7 @@
  */
 package one.chartsy.benchmarking;
 
-import one.chartsy.base.RingBuffer;
+import one.chartsy.data.structures.RingBuffer;
 import org.openjdk.jmh.annotations.Benchmark;
 import org.openjdk.jmh.annotations.BenchmarkMode;
 import org.openjdk.jmh.annotations.Level;
diff --git a/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferOfLongAddAndGetBenchmark.java b/chartsy-benchmarking/src/main/java/one/chartsy/benchmarking/RingBufferOfLongAddAndGetBenchmark.java
@@ -4,7 +4,7 @@
  */
 package one.chartsy.benchmarking;
 
-import one.chartsy.base.RingBuffer;
+import one.chartsy.data.structures.RingBuffer;
 import org.openjdk.jmh.annotations.Benchmark;
 import org.openjdk.jmh.annotations.BenchmarkMode;
 import org.openjdk.jmh.annotations.Level;
diff --git a/chartsy-core/src/main/java/one/chartsy/base/Dataset.java b/chartsy-core/src/main/java/one/chartsy/base/Dataset.java
@@ -45,6 +45,13 @@ public interface Dataset<E> extends Iterable<E>, SequenceAlike {
      */
     E get(int index);
 
+    /**
+     * Returns the number of elements in this dataset.
+     *
+     * @return the dataset's size
+     */
+    @Override int length();
+
     Stream<E> stream();
 
     @Override Iterator<E> iterator();
diff --git a/chartsy-core/src/main/java/one/chartsy/base/IntDataset.java b/chartsy-core/src/main/java/one/chartsy/base/IntDataset.java
@@ -38,6 +38,13 @@ public interface IntDataset extends PrimitiveDataset<Integer, IntDataset, Splite
 	 */
 	int get(int index);
 
+	/**
+	 * Returns the number of elements in this dataset.
+	 *
+	 * @return the dataset's size
+	 */
+	@Override int length();
+
 	default IntStream stream() {
 		return StreamSupport.intStream(spliterator(), false);
 	}
diff --git a/chartsy-core/src/main/java/one/chartsy/base/LongDataset.java b/chartsy-core/src/main/java/one/chartsy/base/LongDataset.java
@@ -38,6 +38,13 @@ public interface LongDataset extends PrimitiveDataset<Long, LongDataset, Spliter
 	 */
 	long get(int index);
 
+	/**
+	 * Returns the number of elements in this dataset.
+	 *
+	 * @return the dataset's size
+	 */
+	@Override int length();
+
 	default LongStream stream() {
 		return StreamSupport.longStream(spliterator(), false);
 	}
diff --git a/chartsy-core/src/main/java/one/chartsy/data/structures/AbstractRingBuffer.java b/chartsy-core/src/main/java/one/chartsy/data/structures/AbstractRingBuffer.java
@@ -2,7 +2,9 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.base;
+package one.chartsy.data.structures;
+
+import one.chartsy.base.SequenceAlike;
 
 public abstract class AbstractRingBuffer implements SequenceAlike {
 
diff --git a/chartsy-core/src/main/java/one/chartsy/data/structures/BufferTooSmallException.java b/chartsy-core/src/main/java/one/chartsy/data/structures/BufferTooSmallException.java
@@ -2,7 +2,7 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.base;
+package one.chartsy.data.structures;
 
 public class BufferTooSmallException extends IndexOutOfBoundsException {
 	private final int actualCapacity;
diff --git a/chartsy-core/src/main/java/one/chartsy/data/structures/DoubleWindowSummaryStatistics.java b/chartsy-core/src/main/java/one/chartsy/data/structures/DoubleWindowSummaryStatistics.java
@@ -3,8 +3,6 @@
  */
 package one.chartsy.data.structures;
 
-import one.chartsy.collections.IntArrayDeque;
-
 import java.util.Arrays;
 import java.util.DoubleSummaryStatistics;
 import java.util.Locale;
diff --git a/chartsy-core/src/main/java/one/chartsy/data/structures/IntArrayDeque.java b/chartsy-core/src/main/java/one/chartsy/data/structures/IntArrayDeque.java
@@ -2,7 +2,7 @@
  * Copyright 2022 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.collections;
+package one.chartsy.data.structures;
 
 import java.util.NoSuchElementException;
 import java.util.PrimitiveIterator;
diff --git a/chartsy-core/src/main/java/one/chartsy/data/structures/RingBuffer.java b/chartsy-core/src/main/java/one/chartsy/data/structures/RingBuffer.java
@@ -2,7 +2,12 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.base;
+package one.chartsy.data.structures;
+
+import one.chartsy.base.Dataset;
+import one.chartsy.base.DoubleDataset;
+import one.chartsy.base.IntDataset;
+import one.chartsy.base.LongDataset;
 
 import java.util.ArrayList;
 import java.util.Arrays;
diff --git a/chartsy-core/src/main/java/one/chartsy/financial/indicators/FramaTrendEquilibrium.java b/chartsy-core/src/main/java/one/chartsy/financial/indicators/FramaTrendEquilibrium.java
@@ -3,7 +3,7 @@
  */
 package one.chartsy.financial.indicators;
 
-import one.chartsy.base.RingBuffer;
+import one.chartsy.data.structures.RingBuffer;
 import one.chartsy.financial.ValueIndicator;
 
 import java.util.ArrayList;
diff --git a/chartsy-core/src/main/java/one/chartsy/math/AbstractMovingMedian.java b/chartsy-core/src/main/java/one/chartsy/math/AbstractMovingMedian.java
@@ -1,8 +1,12 @@
-package one.chartsy.data.structures;
+/* Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
+ * SPDX-License-Identifier: Apache-2.0 */
+package one.chartsy.math;
 
 /**
  * An abstract class for computing the moving median over a sliding window of values.
  * This class contains the common logic and structure for different data types.
+ *
+ * @author Mariusz Bernacki
  */
 abstract class AbstractMovingMedian {
     /** The index into the heap for each value. */
diff --git a/chartsy-core/src/main/java/one/chartsy/math/MathHelper.java b/chartsy-core/src/main/java/one/chartsy/math/MathHelper.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: Apache-2.0 */
 package one.chartsy.math;
 
-import one.chartsy.collections.IntArrayDeque;
+import one.chartsy.data.structures.IntArrayDeque;
 
 public final class MathHelper {
 
diff --git a/chartsy-core/src/main/java/one/chartsy/math/MovingMedian.java b/chartsy-core/src/main/java/one/chartsy/math/MovingMedian.java
@@ -1,4 +1,6 @@
-package one.chartsy.data.structures;
+/* Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
+ * SPDX-License-Identifier: Apache-2.0 */
+package one.chartsy.math;
 
 import java.util.NoSuchElementException;
 import java.util.function.BiFunction;
@@ -10,6 +12,7 @@
  * This class provides specialized implementations for different data types.
  *
  * @param <T> the type of elements maintained by this median calculator
+ * @author Mariusz Bernacki
  */
 public class MovingMedian<T extends Comparable<? super T>> extends AbstractMovingMedian implements Consumer<T> {
     /** The circular queue of values. */
@@ -39,7 +42,8 @@ public MovingMedian(int windowSize, BiFunction<? super T, ? super T, ? extends T
      * {@code windowSize} elements, using the natural order comparator and no mean function.
      *
      * @param windowSize the size of the moving median window
-     * @throws IllegalArgumentException if {@code windowSize} is less than 1, or if {@code windowSize} is even and {@code meanFunction} is null
+     * @throws IllegalArgumentException if {@code windowSize} is less than 1, or if {@code windowSize} is even and,
+     *         as a direct result of using this small constructor, the internally used {@code meanFunction} is null
      */
     public MovingMedian(int windowSize) {
         this(windowSize, null);
diff --git a/chartsy-core/src/test/java/one/chartsy/ModernDirectoryTraversal.java b/chartsy-core/src/test/java/one/chartsy/ModernDirectoryTraversal.java
@@ -0,0 +1,34 @@
+package one.chartsy;
+
+import java.io.IOException;
+import java.nio.file.*;
+import java.nio.file.attribute.BasicFileAttributes;
+
+public class ModernDirectoryTraversal {
+
+    public static void main(String[] args) {
+        // Get the current working directory
+        Path currentDirectory = Paths.get(System.getProperty("user.dir")).resolve("../chartsy");
+        System.out.println(currentDirectory);
+
+        // Define the subpath we are looking for
+        String targetSubpath = "src/main/java";
+
+        try {
+            // Traverse and print directories containing the target subpath
+            Files.walkFileTree(currentDirectory, new SimpleFileVisitor<>() {
+                @Override
+                public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) {
+                    // Convert to relative path and check if it contains the subpath
+                    Path relativePath = currentDirectory.relativize(dir);
+                    if (relativePath.toString().replace('\\', '/').contains(targetSubpath)) {
+                        System.out.println(relativePath);
+                    }
+                    return FileVisitResult.CONTINUE;
+                }
+            });
+        } catch (IOException e) {
+            e.printStackTrace();
+        }
+    }
+}
diff --git a/chartsy-core/src/test/java/one/chartsy/data/structures/IntArrayDequeTest.java b/chartsy-core/src/test/java/one/chartsy/data/structures/IntArrayDequeTest.java
@@ -2,7 +2,7 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.collections;
+package one.chartsy.data.structures;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
diff --git a/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferOfDoubleTest.java b/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferOfDoubleTest.java
@@ -2,7 +2,7 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.base;
+package one.chartsy.data.structures;
 
 import org.junit.jupiter.api.Test;
 
diff --git a/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferOfIntTest.java b/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferOfIntTest.java
@@ -2,7 +2,7 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.base;
+package one.chartsy.data.structures;
 
 import org.junit.jupiter.api.Test;
 
diff --git a/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferOfLongTest.java b/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferOfLongTest.java
@@ -2,7 +2,7 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.base;
+package one.chartsy.data.structures;
 
 import org.junit.jupiter.api.Test;
 
diff --git a/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferTest.java b/chartsy-core/src/test/java/one/chartsy/data/structures/RingBufferTest.java
@@ -2,7 +2,7 @@
  * Copyright 2024 Mariusz Bernacki <consulting@didalgo.com>
  * SPDX-License-Identifier: Apache-2.0
  */
-package one.chartsy.base;
+package one.chartsy.data.structures;
 
 import org.junit.jupiter.api.Test;
 
diff --git a/chartsy-core/src/test/java/one/chartsy/math/MovingMedianTest.java b/chartsy-core/src/test/java/one/chartsy/math/MovingMedianTest.java
@@ -1,4 +1,4 @@
-package one.chartsy.data.structures;
+package one.chartsy.math;
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -24,8 +24,8 @@ private static Stream<Integer> windowSizes() {
     }
 
     private <T extends Comparable<T>> void testMedian(AbstractMovingMedian medianCalculator, Consumer<T> acceptFunction,
-                                Supplier<T> getMedianFunction, List<T> dataStream,
-                                BiFunction<T, T, T> meanFunction) {
+                                                      Supplier<T> getMedianFunction, List<T> dataStream,
+                                                      BiFunction<T, T, T> meanFunction) {
         var window = new LinkedList<T>();
 
         for (T data : dataStream) {
