refactor: rename Analyzer to ComponentProcessor, move to analysis module

Author: metacosm

measure/src/main/java/net/laprun/sustainability/power/measure/DescriptiveStatisticsAnalyzer.java renamed to analysis/src/main/java/net/laprun/sustainability/power/analysis/DescriptiveStatisticsComponentProcessor.java

@@ -1,12 +1,12 @@
-package net.laprun.sustainability.power.measure;
+package net.laprun.sustainability.power.analysis;
 
 import org.apache.commons.math3.stat.descriptive.DescriptiveStatistics;
 
 @SuppressWarnings("unused")
-public class DescriptiveStatisticsAnalyzer implements Analyzer {
+public class DescriptiveStatisticsComponentProcessor implements ComponentProcessor {
     private final DescriptiveStatistics statistics;
 
-    public DescriptiveStatisticsAnalyzer() {
+    public DescriptiveStatisticsComponentProcessor() {
         statistics = new DescriptiveStatistics();
     }
 

measure/src/main/java/net/laprun/sustainability/power/measure/HdrHistogramAnalyzer.java renamed to analysis/src/main/java/net/laprun/sustainability/power/analysis/HdrHistogramComponentProcessor.java

@@ -1,15 +1,15 @@
-package net.laprun.sustainability.power.measure;
+package net.laprun.sustainability.power.analysis;
 
 import org.HdrHistogram.IntCountsHistogram;
 
 @SuppressWarnings("unused")
-public class HdrHistogramAnalyzer implements Analyzer {
+public class HdrHistogramComponentProcessor implements ComponentProcessor {
     private static final int HIGHEST_TRACKABLE_VALUE = 1_000_000;
     private static final int NUMBER_OF_SIGNIFICANT_VALUE_DIGITS = 4;
     private static final int CONVERSION_FACTOR = 1000;
     private final IntCountsHistogram histogram;
 
-    public HdrHistogramAnalyzer() {
+    public HdrHistogramComponentProcessor() {
         histogram = new IntCountsHistogram(HIGHEST_TRACKABLE_VALUE, NUMBER_OF_SIGNIFICANT_VALUE_DIGITS);
     }
 

measure/pom.xml

@@ -19,14 +19,10 @@
       <version>${project.version}</version>
     </dependency>
     <dependency>
-      <groupId>org.apache.commons</groupId>
-      <artifactId>commons-math3</artifactId>
-      <version>3.6.1</version>
-    </dependency>
-    <dependency>
-      <groupId>org.hdrhistogram</groupId>
-      <artifactId>HdrHistogram</artifactId>
-      <version>2.2.2</version>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <version>3.26.3</version>
+      <scope>test</scope>
     </dependency>
   </dependencies>
 

measure/src/main/java/net/laprun/sustainability/power/analysis/Analyzers.java

@@ -0,0 +1,4 @@
+package net.laprun.sustainability.power.analysis;
+
+public interface Analyzers {
+}

measure/src/main/java/net/laprun/sustainability/power/analysis/ComponentProcessor.java

@@ -0,0 +1,6 @@
+package net.laprun.sustainability.power.analysis;
+
+public interface ComponentProcessor {
+    default void recordComponentValue(double value, long timestamp) {
+    }
+}

measure/src/main/java/net/laprun/sustainability/power/measure/Analyzer.java

@@ -6,6 +6,7 @@
 import java.util.Optional;
 
 import net.laprun.sustainability.power.SensorMetadata;
+import net.laprun.sustainability.power.analysis.ComponentProcessor;
 
 public class OngoingPowerMeasure implements PowerMeasure {
     private static final int DEFAULT_SIZE = 32;
@@ -21,9 +22,9 @@ public class OngoingPowerMeasure implements PowerMeasure {
     private int samples;
     private final double[][] measures;
     private long[] timestamps;
-    private final Analyzer[] analyzers;
+    private final ComponentProcessor[] analyzers;
 
-    public OngoingPowerMeasure(SensorMetadata sensorMetadata, Analyzer... analyzers) {
+    public OngoingPowerMeasure(SensorMetadata sensorMetadata, ComponentProcessor... analyzers) {
         this.sensorMetadata = sensorMetadata;
         startedAt = System.currentTimeMillis();
 
@@ -37,7 +38,7 @@ public OngoingPowerMeasure(SensorMetadata sensorMetadata, Analyzer... analyzers)
         // we don't need to record the total component as a non-zero component since it's almost never zero and we compute the std dev separately
         nonZeroComponents = new BitSet(numComponents);
         totalComponents = sensorMetadata.totalComponents();
-        this.analyzers = Objects.requireNonNullElseGet(analyzers, () -> new Analyzer[0]);
+        this.analyzers = Objects.requireNonNullElseGet(analyzers, () -> new ComponentProcessor[0]);
     }
 
     @Override
@@ -135,7 +136,7 @@ public Optional<double[]> getMeasuresFor(int component) {
     }
 
     @Override
-    public Analyzer[] analyzers() {
+    public ComponentProcessor[] analyzers() {
         return analyzers;
     }
 }

measure/src/main/java/net/laprun/sustainability/power/measure/OngoingPowerMeasure.java

@@ -4,6 +4,7 @@
 import java.util.Optional;
 
 import net.laprun.sustainability.power.SensorMetadata;
+import net.laprun.sustainability.power.analysis.ComponentProcessor;
 
 public interface PowerMeasure {
     private static double sumOfComponents(double[] recorded) {
@@ -61,15 +62,5 @@ default double average() {
 
     Optional<double[]> getMeasuresFor(int component);
 
-    Analyzer[] analyzers();
-
-    /**
-     * Records the standard deviations for the aggregated energy comsumption value (as returned by {@link #total()}) and
-     * per component
-     *
-     * @param aggregate
-     * @param perComponent
-     */
-    record StdDev(double aggregate, double[] perComponent) {
-    }
+    ComponentProcessor[] analyzers();
 }

measure/src/main/java/net/laprun/sustainability/power/measure/PowerMeasure.java

@@ -4,6 +4,7 @@
 import java.util.Optional;
 
 import net.laprun.sustainability.power.SensorMetadata;
+import net.laprun.sustainability.power.analysis.ComponentProcessor;
 
 @SuppressWarnings("unused")
 public class StoppedPowerMeasure implements PowerMeasure {
@@ -15,7 +16,7 @@ public class StoppedPowerMeasure implements PowerMeasure {
     private final double max;
     private final double[] averages;
     private final double[][] measures;
-    private final Analyzer[] analyzers;
+    private final ComponentProcessor[] processors;
 
     public StoppedPowerMeasure(PowerMeasure powerMeasure) {
         this.sensorMetadata = powerMeasure.metadata();
@@ -30,7 +31,7 @@ public StoppedPowerMeasure(PowerMeasure powerMeasure) {
         for (int i = 0; i < cardinality; i++) {
             measures[i] = powerMeasure.getMeasuresFor(i).orElse(null);
         }
-        analyzers = powerMeasure.analyzers();
+        processors = powerMeasure.analyzers();
     }
 
     @Override
@@ -74,7 +75,7 @@ public Optional<double[]> getMeasuresFor(int component) {
     }
 
     @Override
-    public Analyzer[] analyzers() {
-        return analyzers;
+    public ComponentProcessor[] analyzers() {
+        return processors;
     }
 }