benchmark module

chartfx-bench/pom.xml

@@ -0,0 +1,25 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>io.fair-acc</groupId>
+        <artifactId>chartfx-parent</artifactId>
+        <version>${revision}${sha1}${changelist}</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+
+    <artifactId>bench</artifactId>
+    <name>chartfx-bench</name>
+
+    <properties>
+        <project.moduleName>io.fair_acc.bench</project.moduleName>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
+    </properties>
+
+    <description>
+		Utilities for benchmarking during live operations.
+	</description>
+
+</project>

chartfx-dataset/src/main/java/io/fair_acc/dataset/benchmark/AggregateDurationMeasure.java → chartfx-bench/src/main/java/io/fair_acc/bench/AggregateDurationMeasure.java

@@ -1,4 +1,4 @@
-package io.fair_acc.dataset.benchmark;
+package io.fair_acc.bench;
 
 /**
  * A measure that performs some aggregate function on durations, e.g., min / max / sum / mean

chartfx-dataset/src/main/java/io/fair_acc/dataset/benchmark/BenchLevel.java → chartfx-bench/src/main/java/io/fair_acc/bench/BenchLevel.java

@@ -1,4 +1,4 @@
-package io.fair_acc.dataset.benchmark;
+package io.fair_acc.bench;
 
 import java.util.function.IntSupplier;
 

chartfx-dataset/src/main/java/io/fair_acc/dataset/benchmark/DurationMeasure.java → chartfx-bench/src/main/java/io/fair_acc/bench/DurationMeasure.java

@@ -1,4 +1,4 @@
-package io.fair_acc.dataset.benchmark;
+package io.fair_acc.bench;
 
 /**
  * Determines a duration based on the elapsed time between start and stop.

chartfx-bench/src/main/java/io/fair_acc/bench/Measurable.java

@@ -0,0 +1,23 @@
+package io.fair_acc.bench;
+
+/**
+ * An interface for classes that contain measurable actions
+ *
+ * @author ennerf
+ */
+public interface Measurable {
+
+    /**
+     * @param recorder records benchmark measurements
+     */
+    void setRecorder(MeasurementRecorder recorder);
+
+    /**
+     * Adds an empty default method for Measurable
+     * classes where the implementation is optional.
+     */
+    public interface EmptyDefault {
+        default void setRecorder(MeasurementRecorder recorder) {};
+    }
+
+}

chartfx-dataset/src/main/java/io/fair_acc/dataset/benchmark/MeasurementRecorder.java → chartfx-bench/src/main/java/io/fair_acc/bench/MeasurementRecorder.java

@@ -1,4 +1,4 @@
-package io.fair_acc.dataset.benchmark;
+package io.fair_acc.bench;
 
 import java.util.Locale;
 import java.util.function.Consumer;
@@ -84,7 +84,7 @@ public static MeasurementRecorder printRecorder() {
      */
     public static MeasurementRecorder printRecorder(Consumer<String> log) {
         return (tag, level) -> (TimeMeasure) (unit, time) -> {
-            log.accept(String.format(Locale.ENGLISH, "%s finished in %.2f ms", tag, unit.toMicros(time) * 1E-3));
+            log.accept(String.format(Locale.ENGLISH, "%s finished in %.3f ms", tag, unit.toMicros(time) * 1E-3));
         };
     }
 
@@ -169,4 +169,6 @@ default MeasurementRecorder removePostfix() {
         return (tag, level) -> newTime(tag.substring(tag.lastIndexOf('-') + 1), level);
     }
 
+    public static final MeasurementRecorder DISABLED = (tag, level) -> TimeMeasure.DISABLED;
+
 }

chartfx-dataset/src/main/java/io/fair_acc/dataset/benchmark/RecordingDurationMeasure.java → chartfx-bench/src/main/java/io/fair_acc/bench/RecordingDurationMeasure.java

@@ -1,6 +1,4 @@
-package io.fair_acc.dataset.benchmark;
-
-import io.fair_acc.dataset.utils.AssertUtils;
+package io.fair_acc.bench;
 
 import java.util.concurrent.TimeUnit;
 import java.util.function.LongSupplier;
@@ -21,9 +19,16 @@ public static AggregateDurationMeasure newNanoTimeSum(TimeMeasure recorder) {
     }
 
     public RecordingDurationMeasure(TimeUnit clockUnit, LongSupplier clock, TimeMeasure recorder) {
-        this.clock = AssertUtils.notNull("clock", clock);
-        this.clockUnit = AssertUtils.notNull("clockUnit", clockUnit);
-        this.recorder = AssertUtils.notNull("recorder", recorder);
+        this.clock = checkNotNull("clock", clock);
+        this.clockUnit = checkNotNull("clockUnit", clockUnit);
+        this.recorder = checkNotNull("recorder", recorder);
+    }
+
+    private static <T> T checkNotNull(String name, T object) {
+        if (object == null) {
+            throw new NullPointerException(name);
+        }
+        return object;
     }
 
     protected void recordDuration(TimeUnit unit, long duration) {

chartfx-dataset/src/main/java/io/fair_acc/dataset/benchmark/TimeMeasure.java → chartfx-bench/src/main/java/io/fair_acc/bench/TimeMeasure.java

@@ -1,4 +1,4 @@
-package io.fair_acc.dataset.benchmark;
+package io.fair_acc.bench;
 
 import java.util.concurrent.TimeUnit;
 import java.util.function.Function;

chartfx-chart/src/main/java/io/fair_acc/chartfx/Chart.java

@@ -5,9 +5,9 @@
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
-import io.fair_acc.dataset.benchmark.DurationMeasure;
-import io.fair_acc.dataset.benchmark.Measurable;
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
+import io.fair_acc.bench.DurationMeasure;
+import io.fair_acc.bench.Measurable;
+import io.fair_acc.bench.MeasurementRecorder;
 import io.fair_acc.chartfx.ui.css.*;
 import io.fair_acc.chartfx.ui.layout.TitleLabel;
 import io.fair_acc.chartfx.ui.layout.ChartPane;

chartfx-chart/src/main/java/io/fair_acc/chartfx/XYChart.java

@@ -5,9 +5,9 @@
 import io.fair_acc.chartfx.renderer.spi.ErrorDataSetRenderer;
 import io.fair_acc.chartfx.ui.css.DataSetNode;
 import io.fair_acc.chartfx.utils.PropUtil;
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
+import io.fair_acc.bench.MeasurementRecorder;
 import io.fair_acc.dataset.events.ChartBits;
-import io.fair_acc.dataset.benchmark.DurationMeasure;
+import io.fair_acc.bench.DurationMeasure;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.SimpleBooleanProperty;

chartfx-chart/src/main/java/io/fair_acc/chartfx/axes/Axis.java

@@ -1,6 +1,6 @@
 package io.fair_acc.chartfx.axes;
 
-import io.fair_acc.dataset.benchmark.Measurable;
+import io.fair_acc.bench.Measurable;
 import io.fair_acc.chartfx.ui.css.LineStyle;
 import io.fair_acc.chartfx.ui.css.TextStyle;
 import javafx.beans.property.BooleanProperty;
@@ -18,7 +18,7 @@
 import io.fair_acc.chartfx.ui.geometry.Side;
 import io.fair_acc.dataset.AxisDescription;
 
-public interface Axis extends AxisDescription, Measurable {
+public interface Axis extends AxisDescription, Measurable.EmptyDefault {
     /**
      * This is true when the axis determines its range from the data automatically
      *

chartfx-chart/src/main/java/io/fair_acc/chartfx/axes/spi/AbstractAxis.java

@@ -4,9 +4,9 @@
 import java.util.Objects;
 
 import io.fair_acc.chartfx.axes.AxisLabelOverlapPolicy;
-import io.fair_acc.dataset.benchmark.DurationMeasure;
-import io.fair_acc.dataset.benchmark.Measurable;
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
+import io.fair_acc.bench.DurationMeasure;
+import io.fair_acc.bench.Measurable;
+import io.fair_acc.bench.MeasurementRecorder;
 import io.fair_acc.chartfx.ui.css.LineStyle;
 import io.fair_acc.chartfx.ui.css.TextStyle;
 import io.fair_acc.chartfx.utils.FXUtils;

chartfx-chart/src/main/java/io/fair_acc/chartfx/benchmark/CircularDoubleDataSet2D.java → chartfx-chart/src/main/java/io/fair_acc/chartfx/bench/CircularDoubleDataSet2D.java

@@ -1,4 +1,4 @@
-package io.fair_acc.chartfx.benchmark;
+package io.fair_acc.chartfx.bench;
 
 import io.fair_acc.chartfx.utils.FXUtils;
 import io.fair_acc.dataset.AxisDescription;

chartfx-chart/src/main/java/io/fair_acc/chartfx/benchmark/HdrHistogramDataSet.java → chartfx-chart/src/main/java/io/fair_acc/chartfx/bench/HdrHistogramDataSet.java

@@ -1,4 +1,4 @@
-package io.fair_acc.chartfx.benchmark;
+package io.fair_acc.chartfx.bench;
 
 import io.fair_acc.chartfx.utils.FXUtils;
 import io.fair_acc.dataset.AxisDescription;

chartfx-chart/src/main/java/io/fair_acc/chartfx/benchmark/HdrHistogramRecorder.java → chartfx-chart/src/main/java/io/fair_acc/chartfx/bench/HdrHistogramRecorder.java

@@ -1,7 +1,7 @@
-package io.fair_acc.chartfx.benchmark;
+package io.fair_acc.chartfx.bench;
 
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
-import io.fair_acc.dataset.benchmark.TimeMeasure;
+import io.fair_acc.bench.MeasurementRecorder;
+import io.fair_acc.bench.TimeMeasure;
 import io.fair_acc.dataset.utils.AssertUtils;
 import org.HdrHistogram.Histogram;
 import org.HdrHistogram.HistogramLogWriter;

chartfx-chart/src/main/java/io/fair_acc/chartfx/benchmark/LiveDisplayRecorder.java → chartfx-chart/src/main/java/io/fair_acc/chartfx/bench/LiveDisplayRecorder.java

@@ -1,4 +1,4 @@
-package io.fair_acc.chartfx.benchmark;
+package io.fair_acc.chartfx.bench;
 
 import io.fair_acc.chartfx.Chart;
 import io.fair_acc.chartfx.XYChart;
@@ -10,8 +10,8 @@
 import io.fair_acc.chartfx.renderer.Renderer;
 import io.fair_acc.chartfx.renderer.spi.AbstractRendererXY;
 import io.fair_acc.chartfx.renderer.spi.ErrorDataSetRenderer;
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
-import io.fair_acc.dataset.benchmark.TimeMeasure;
+import io.fair_acc.bench.MeasurementRecorder;
+import io.fair_acc.bench.TimeMeasure;
 import io.fair_acc.dataset.events.BitState;
 import io.fair_acc.dataset.events.ChartBits;
 import io.fair_acc.dataset.spi.fastutil.DoubleArrayList;
@@ -48,7 +48,7 @@ public static LiveDisplayRecorder showInNewStage(String title) {
         });
     }
 
-    private static LiveDisplayRecorder createChart(String title, Consumer<Parent> onChart) {
+    public static LiveDisplayRecorder createChart(String title, Consumer<Parent> onChart) {
         // Top chart w/ time series
         var timeChart = new XYChart(createTimeAxisX(), createValueAxisY());
         timeChart.setTitle("Benchmark: " + title);
@@ -103,15 +103,15 @@ private static DefaultNumericAxis createTimeAxisX() {
     private static DefaultNumericAxis createValueAxisY() {
         var axis = new DefaultNumericAxis();
         axis.setForceZeroInRange(true);
-        axis.setName("Latency");
+        axis.setName("value");
         axis.setUnit("s");
         axis.setAutoUnitScaling(true);
         return axis;
     }
 
     private static DefaultNumericAxis createPercentileAxisX() {
         var axis = new PercentileAxis();
-        axis.setName("Percentile");
+        axis.setName("percentile");
         axis.setUnit("%");
         return axis;
     }

chartfx-chart/src/main/java/io/fair_acc/chartfx/benchmark/MeasurementRecorders.java → chartfx-chart/src/main/java/io/fair_acc/chartfx/bench/MeasurementRecorders.java

@@ -1,4 +1,4 @@
-package io.fair_acc.chartfx.benchmark;
+package io.fair_acc.chartfx.bench;
 
 import java.util.concurrent.TimeUnit;
 

chartfx-chart/src/main/java/io/fair_acc/chartfx/benchmark/PercentileAxis.java → chartfx-chart/src/main/java/io/fair_acc/chartfx/bench/PercentileAxis.java

@@ -1,4 +1,4 @@
-package io.fair_acc.chartfx.benchmark;
+package io.fair_acc.chartfx.bench;
 
 import io.fair_acc.chartfx.axes.AxisLabelOverlapPolicy;
 import io.fair_acc.chartfx.axes.spi.AxisRange;

chartfx-chart/src/main/java/io/fair_acc/chartfx/plugins/ChartPlugin.java

@@ -3,7 +3,7 @@
 import java.util.LinkedList;
 import java.util.List;
 
-import io.fair_acc.dataset.benchmark.Measurable;
+import io.fair_acc.bench.Measurable;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ObjectProperty;
 import javafx.beans.property.SimpleBooleanProperty;
@@ -41,7 +41,7 @@
  * @author braeun - modified to be able to use XYChart class
  * @author rstein - modified to new Chart, XYChart API
  */
-public abstract class ChartPlugin implements Measurable {
+public abstract class ChartPlugin implements Measurable.EmptyDefault {
     private static final Logger LOGGER = LoggerFactory.getLogger(ChartPlugin.class);
     private final ObservableList<Node> chartChildren = FXCollections.observableArrayList();
     private final List<Pair<EventType<? extends InputEvent>, EventHandler<? extends InputEvent>>> mouseEventHandlers = new LinkedList<>();

chartfx-chart/src/main/java/io/fair_acc/chartfx/renderer/Renderer.java

@@ -2,7 +2,7 @@
 
 import io.fair_acc.chartfx.Chart;
 import io.fair_acc.chartfx.axes.spi.AxisRange;
-import io.fair_acc.dataset.benchmark.Measurable;
+import io.fair_acc.bench.Measurable;
 import io.fair_acc.chartfx.ui.css.DataSetNode;
 import javafx.beans.property.BooleanProperty;
 import javafx.collections.ObservableList;
@@ -18,7 +18,7 @@
  * @author braeun
  * @author rstein
  */
-public interface Renderer extends Measurable {
+public interface Renderer extends Measurable.EmptyDefault {
     /**
      * @param style the data set node for which the representative icon should be generated
      * @param canvas the canvas in which the representative icon should be drawn

chartfx-chart/src/main/java/io/fair_acc/chartfx/renderer/spi/AbstractRendererXY.java

@@ -4,9 +4,9 @@
 import io.fair_acc.chartfx.XYChart;
 import io.fair_acc.chartfx.axes.Axis;
 import io.fair_acc.chartfx.axes.spi.AxisRange;
-import io.fair_acc.dataset.benchmark.DurationMeasure;
-import io.fair_acc.dataset.benchmark.Measurable;
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
+import io.fair_acc.bench.DurationMeasure;
+import io.fair_acc.bench.Measurable;
+import io.fair_acc.bench.MeasurementRecorder;
 import io.fair_acc.chartfx.ui.css.DataSetNode;
 import io.fair_acc.dataset.DataSet;
 import io.fair_acc.dataset.utils.AssertUtils;

chartfx-chart/src/main/java/io/fair_acc/chartfx/renderer/spi/BasicDataSetRenderer.java

@@ -6,8 +6,8 @@
 import io.fair_acc.chartfx.ui.css.DataSetStyleParser;
 import io.fair_acc.chartfx.utils.FastDoubleArrayCache;
 import io.fair_acc.dataset.DataSet;
-import io.fair_acc.dataset.benchmark.AggregateDurationMeasure;
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
+import io.fair_acc.bench.AggregateDurationMeasure;
+import io.fair_acc.bench.MeasurementRecorder;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.ObjectProperty;
 import javafx.scene.canvas.GraphicsContext;

chartfx-chart/src/main/java/io/fair_acc/chartfx/renderer/spi/GridRenderer.java

@@ -4,8 +4,8 @@
 
 import io.fair_acc.chartfx.axes.spi.AxisRange;
 import io.fair_acc.chartfx.ui.css.*;
-import io.fair_acc.dataset.benchmark.DurationMeasure;
-import io.fair_acc.dataset.benchmark.MeasurementRecorder;
+import io.fair_acc.bench.DurationMeasure;
+import io.fair_acc.bench.MeasurementRecorder;
 import io.fair_acc.dataset.utils.AssertUtils;
 import javafx.beans.property.BooleanProperty;
 import javafx.collections.FXCollections;

chartfx-dataset/pom.xml

@@ -20,6 +20,11 @@
 	</description>
 
     <dependencies>
+        <dependency>
+            <groupId>io.fair-acc</groupId>
+            <artifactId>bench</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <!-- micro-benchmarking framework -->
         <dependency>
             <groupId>org.openjdk.jmh</groupId>

chartfx-dataset/src/main/java/io/fair_acc/dataset/DataSet.java

@@ -6,7 +6,7 @@
 import io.fair_acc.dataset.event.EventSource;
 import io.fair_acc.dataset.events.ChartBits;
 import io.fair_acc.dataset.locks.DataSetLock;
-import io.fair_acc.dataset.benchmark.Measurable;
+import io.fair_acc.bench.Measurable;
 import io.fair_acc.dataset.utils.IndexedStringConsumer;
 
 /**
@@ -16,7 +16,7 @@
  * @author braeun
  * @author rstein
  */
-public interface DataSet extends EventSource, Serializable, Measurable {
+public interface DataSet extends EventSource, Serializable, Measurable.EmptyDefault {
     int DIM_X = 0;
     int DIM_Y = 1;
     int DIM_Z = 2;

chartfx-dataset/src/main/java/io/fair_acc/dataset/locks/DataSetLock.java

@@ -4,7 +4,7 @@
 import java.util.function.Supplier;
 
 import io.fair_acc.dataset.DataSet;
-import io.fair_acc.dataset.benchmark.Measurable;
+import io.fair_acc.bench.Measurable;
 
 /**
  * A Simple ReadWriteLock for the DataSet interface and its fluent-design approach
@@ -46,7 +46,7 @@
  * @param <D> generics reference, usually to <code>&lt;? extends DataSet&gt;</code>
  */
 @SuppressWarnings({ "PMD.DoNotUseThreads", "PMD.CommentSize" }) // Runnable used as functional interface
-public interface DataSetLock<D extends DataSet> extends Serializable, Measurable {
+public interface DataSetLock<D extends DataSet> extends Serializable, Measurable.EmptyDefault {
 
     /**
      * reentrant read-lock