Add support for ordering results of Benchmarks. Update sample

Author: T-Spoon

app/src/main/AndroidManifest.xml

@@ -5,6 +5,7 @@
     <uses-permission android:name="android.permission.READ_LOGS"/>
 
     <application
+        android:name=".App"
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"

app/src/main/java/com/tspoon/benchit/sample/App.java

@@ -0,0 +1,14 @@
+package com.tspoon.benchit.sample;
+
+import android.app.Application;
+
+import timber.log.Timber;
+
+public class App extends Application {
+
+    @Override
+    public void onCreate() {
+        super.onCreate();
+        Timber.plant(new Timber.DebugTree());
+    }
+}

app/src/main/java/com/tspoon/benchit/sample/comparisons/ArrayListComparison.java

@@ -1,5 +1,6 @@
 package com.tspoon.benchit.sample.comparisons;
 
+import com.tspoon.benchit.Benchit;
 import com.tspoon.benchit.sample.data.Data;
 
 import java.util.ArrayList;
@@ -15,6 +16,11 @@ public void setup() {
         mBenchmarks.add(new BenchmarkArrayListFast());
     }
 
+    @Override
+    public Benchit.Precision getPrecision() {
+        return Benchit.Precision.MILLI;
+    }
+
     class BenchmarkArrayListNaive extends Benchmark {
 
         private ArrayList<Integer> mData = Data.getInstance().getSampleArrayList();

app/src/main/java/com/tspoon/benchit/sample/comparisons/Benchmark.java

@@ -14,12 +14,12 @@ public void setup() {
         mResults = new ArrayList<>();
     }
 
-    public final void runBenchmarks() {
+    public final void runBenchmarks(Benchit.Precision precision) {
         String name = getBenchmarkName();
         for (int i = 0; i < Config.NUM_TESTS; i++) {
             Benchit.begin(name);
             benchmark();
-            Benchit.end(name);
+            Benchit.end(name).precision(precision);
         }
         mResults.add(Benchit.analyze(name).log());
     }

app/src/main/java/com/tspoon/benchit/sample/comparisons/Comparison.java

@@ -1,5 +1,7 @@
 package com.tspoon.benchit.sample.comparisons;
 
+import com.tspoon.benchit.Benchit;
+
 import java.util.List;
 
 import timber.log.Timber;
@@ -14,12 +16,16 @@ public final void runComparisons() {
         Timber.d("Begin Comparison: " + getName());
         for (Benchmark benchmark : mBenchmarks) {
             benchmark.setup();
-            benchmark.runBenchmarks();
+            benchmark.runBenchmarks(getPrecision());
         }
         Timber.d("End Comparison: " + getName());
+        Benchit.compare(Benchit.Stat.STANDARD_DEVIATION).log();
+        Benchit.clear();
     }
 
     public String getName() {
         return getClass().getSimpleName();
     }
+
+    public abstract Benchit.Precision getPrecision();
 }

app/src/main/java/com/tspoon/benchit/sample/comparisons/InternalGetterComparison.java

@@ -1,5 +1,7 @@
 package com.tspoon.benchit.sample.comparisons;
 
+import com.tspoon.benchit.Benchit;
+
 import java.util.ArrayList;
 
 public class InternalGetterComparison extends Comparison {
@@ -13,6 +15,11 @@ public void setup() {
         mBenchmarks.add(new BenchmarkInternalGetter());
     }
 
+    @Override
+    public Benchit.Precision getPrecision() {
+        return Benchit.Precision.MICRO;
+    }
+
 
     private class BenchmarkInternalAccess extends Benchmark {
 

app/src/main/res/layout/activity_sample.xml

@@ -1,6 +1,5 @@
 <LinearLayout
     xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:app="http://schemas.android.com/apk/res-auto"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     android:orientation="vertical">
@@ -9,7 +8,7 @@
         android:id="@+id/toolbar"
         android:layout_width="match_parent"
         android:layout_height="wrap_content"
-        app:theme="@style/AppTheme.Toolbar"/>
+        android:theme="@style/AppTheme.Toolbar"/>
 
     <ListView
         android:id="@+id/benchmarks_list"

app/src/main/res/values/styles.xml

@@ -27,6 +27,7 @@
         <item name="android:listSelector">@android:color/transparent</item>
         <item name="android:dividerHeight">8dp</item>
         <item name="android:divider">@null</item>
+        <item name="android:scrollbars">none</item>
     </style>
 
     <style name="Benchit.ListView.ListItem" parent="android:Widget">

library/src/main/java/com/tspoon/benchit/Benchit.java

@@ -63,11 +63,15 @@ public static Benchit clear() {
         return singleton.clearInternal();
     }
 
-    public static ComparisonResult compare(Stat orderBy, String... tags) {
+    public static ComparisonResult compare(Stat orderBy, Order order, String... tags) {
         if (singleton == null) {
             singleton = get();
         }
-        return singleton.compareInternal(orderBy, tags);
+        return singleton.compareInternal(orderBy, order, tags);
+    }
+
+    public static ComparisonResult compare(Stat orderBy, String... tags) {
+        return compare(orderBy, Order.ASCENDING, tags);
     }
 
     public static void setDefaultPrecision(Precision precision) {
@@ -112,13 +116,24 @@ private Benchit clearInternal() {
         return this;
     }
 
-    private ComparisonResult compareInternal(Stat orderBy, String... tags) {
+    private ComparisonResult compareInternal(Stat orderBy, Order order, String... tags) {
         ArrayList<Result> results = new ArrayList<>();
-        for (String tag : tags) {
-            results.add(analyzeInternal(tag));
+
+        if (tags.length == 0) {
+            for (String tag : benchmarks.keySet()) {
+                results.add(analyzeInternal(tag));
+            }
+        } else {
+            for (String tag : tags) {
+                results.add(analyzeInternal(tag));
+            }
         }
 
-        return new ComparisonResult(results);
+        return new ComparisonResult(orderBy, order, results);
+    }
+
+    static void log(String message) {
+        Log.d(TAG, message);
     }
 
     static void log(String type, String tag, String result) {
@@ -141,6 +156,10 @@ public static enum Stat {
         AVERAGE, RANGE, STANDARD_DEVIATION
     }
 
+    public static enum Order {
+        ASCENDING, DESCENDING
+    }
+
     public static enum Precision {
         NANO("ns", 1),
         MICRO("µs", 1000),

library/src/main/java/com/tspoon/benchit/Benchmark.java

@@ -11,7 +11,7 @@ public class Benchmark {
         this.tag = tag;
         times = new ArrayList<>();
         times.add(time);
-        precision = Benchit.Precision.MILLI;
+        precision = Benchit.DEFAULT_PRECISION;
     }
 
     public Benchmark precision(Benchit.Precision precision) {

library/src/main/java/com/tspoon/benchit/ComparisonResult.java

@@ -1,12 +1,46 @@
 package com.tspoon.benchit;
 
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.List;
 
 public class ComparisonResult {
 
     List<Result> results;
+    Benchit.Stat orderBy;
+    Benchit.Order order;
 
-    public ComparisonResult(List<Result> results) {
+    public ComparisonResult(Benchit.Stat orderBy, Benchit.Order order, List<Result> results) {
+        this.orderBy = orderBy;
+        this.order = order;
         this.results = results;
+
+        sort();
+    }
+
+    private void sort() {
+        Collections.sort(results, new Comparator<Result>() {
+            @Override
+            public int compare(Result lhs, Result rhs) {
+
+                double statOne = lhs.getStat(orderBy);
+                double statTwo = rhs.getStat(orderBy);
+                if (order == Benchit.Order.ASCENDING) {
+                    return Double.compare(statOne, statTwo);
+                } else {
+                    return Double.compare(statTwo, statOne);
+                }
+            }
+        });
+    }
+
+    public void log() {
+        Benchit.log("------");
+        Benchit.log("Comparison Results: Number of Benchmarks[" + results.size() + "], Ordered By[" + orderBy.name() + " " + order.name() + "]");
+        Benchit.log("------");
+        for (Result result : results) {
+            result.log();
+        }
+        Benchit.log("------");
     }
 }

library/src/main/java/com/tspoon/benchit/Result.java

@@ -31,7 +31,7 @@ public class Result {
         max = minMax[1];
     }
 
-    double average() {
+    private double average() {
         int size = times.size();
         long total = 0;
         for (int i = 0; i < size; i++) {
@@ -40,7 +40,7 @@ public class Result {
         return total / (double) size;
     }
 
-    long[] range() {
+    private long[] range() {
         int size = times.size();
         long min = times.get(0);
         long max = times.get(0);
@@ -56,7 +56,7 @@ long[] range() {
         return new long[]{min, max};
     }
 
-    double deviation() {
+    private double deviation() {
         double mean = average();
         double temp = 0;
 
@@ -68,6 +68,19 @@ long[] range() {
         return Math.sqrt(temp / size);
     }
 
+    double getStat(Benchit.Stat stat) {
+        switch (stat) {
+            case AVERAGE:
+                return average;
+            case STANDARD_DEVIATION:
+                return deviation;
+            case RANGE:
+                return max - min;
+            default:
+                throw new IllegalArgumentException("Stat not implemented yet: " + stat);
+        }
+    }
+
     public Result log() {
         List<Pair<String, String>> stats = new ArrayList<>();