From fb70eda7b8d348729b4c28c115e61b2d3c9207be Mon Sep 17 00:00:00 2001
From: Sam Millington <s.j.millington@hotmail.co.uk>
Date: Wed, 24 Apr 2019 18:53:46 +0100
Subject: [PATCH] [BAEL-2835] Added Guide to FastUtil code (#6805)

---
 fastUtil/pom.xml                              | 44 ++++++++++++++
 .../java/com/baeldung/BigArraysUnitTest.java  | 23 ++++++++
 ...FastUtilTypeSpecificBenchmarkUnitTest.java | 58 +++++++++++++++++++
 .../FastUtilTypeSpecificUnitTest.java         | 20 +++++++
 4 files changed, 145 insertions(+)
 create mode 100644 fastUtil/pom.xml
 create mode 100644 fastUtil/src/test/java/com/baeldung/BigArraysUnitTest.java
 create mode 100644 fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificBenchmarkUnitTest.java
 create mode 100644 fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificUnitTest.java

diff --git a/fastUtil/pom.xml b/fastUtil/pom.xml
new file mode 100644
index 0000000000..fcd9020747
--- /dev/null
+++ b/fastUtil/pom.xml
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+
+    <groupId>com.baeldung</groupId>
+    <artifactId>fastUtil</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <dependencies>
+<!-- https://mvnrepository.com/artifact/it.unimi.dsi/fastutil -->
+<dependency>
+    <groupId>it.unimi.dsi</groupId>
+    <artifactId>fastutil</artifactId>
+    <version>8.2.2</version>
+</dependency>
+<!-- https://mvnrepository.com/artifact/junit/junit -->
+<dependency>
+    <groupId>junit</groupId>
+    <artifactId>junit</artifactId>
+    <version>4.12</version>
+    <scope>test</scope>
+</dependency>
+<!-- https://mvnrepository.com/artifact/org.openjdk.jmh/jmh-core -->
+<dependency>
+    <groupId>org.openjdk.jmh</groupId>
+    <artifactId>jmh-core</artifactId>
+    <version>1.19</version>
+    <scope>test</scope>
+</dependency>
+<dependency>
+    <groupId>org.openjdk.jmh</groupId>
+    <artifactId>jmh-generator-annprocess</artifactId>
+    <version>1.19</version>
+    <scope>test</scope>
+</dependency>
+
+
+
+    </dependencies>
+
+
+</project>
\ No newline at end of file
diff --git a/fastUtil/src/test/java/com/baeldung/BigArraysUnitTest.java b/fastUtil/src/test/java/com/baeldung/BigArraysUnitTest.java
new file mode 100644
index 0000000000..a794d1a2f6
--- /dev/null
+++ b/fastUtil/src/test/java/com/baeldung/BigArraysUnitTest.java
@@ -0,0 +1,23 @@
+package com.baeldung;
+
+import it.unimi.dsi.fastutil.ints.IntBigArrays;
+import org.junit.Test;
+
+import static junit.framework.Assert.assertEquals;
+
+public class BigArraysUnitTest {
+
+  @Test
+  public void givenValidAray_whenWrapped_checkAccessFromIntBigArraysMethodsCorrect() {
+    int[] oneDArray = new int[] { 2, 1, 5, 2, 1, 7 };
+    int[][] twoDArray = IntBigArrays.wrap(oneDArray.clone());
+
+    int firstIndex = IntBigArrays.get(twoDArray, 0);
+    int lastIndex = IntBigArrays.get(twoDArray, IntBigArrays.length(twoDArray)-1);
+
+    assertEquals(2, firstIndex);
+    assertEquals(7, lastIndex);
+
+  }
+
+}
diff --git a/fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificBenchmarkUnitTest.java b/fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificBenchmarkUnitTest.java
new file mode 100644
index 0000000000..2c77989fe5
--- /dev/null
+++ b/fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificBenchmarkUnitTest.java
@@ -0,0 +1,58 @@
+package com.baeldung;
+
+import it.unimi.dsi.fastutil.ints.IntOpenHashSet;
+import it.unimi.dsi.fastutil.ints.IntSet;
+import org.openjdk.jmh.annotations.*;
+import org.openjdk.jmh.infra.Blackhole;
+import org.openjdk.jmh.runner.Runner;
+import org.openjdk.jmh.runner.RunnerException;
+import org.openjdk.jmh.runner.options.Options;
+import org.openjdk.jmh.runner.options.OptionsBuilder;
+
+import java.util.*;
+import java.util.concurrent.TimeUnit;
+
+@BenchmarkMode(Mode.AverageTime)
+@OutputTimeUnit(TimeUnit.MICROSECONDS)
+@State(Scope.Benchmark)
+public class FastUtilTypeSpecificBenchmarkUnitTest {
+
+  @Param({"100", "1000", "10000", "100000"})
+  public int setSize;
+
+  @Benchmark
+  public IntSet givenFastUtilsIntSetWithInitialSizeSet_whenPopulated_checkTimeTaken() {
+    IntSet intSet = new IntOpenHashSet(setSize);
+    for(int i = 0; i < setSize; i++){
+      intSet.add(i);
+    }
+    return intSet;
+  }
+
+
+  @Benchmark
+  public Set<Integer> givenCollectionsHashSetWithInitialSizeSet_whenPopulated_checkTimeTaken() {
+    Set<Integer> intSet = new HashSet<Integer>(setSize);
+    for(int i = 0; i < setSize; i++){
+      intSet.add(i);
+    }
+    return intSet;
+  }
+
+  public static void main(String... args) throws RunnerException {
+    Options opts = new OptionsBuilder()
+            .include(".*")
+            .warmupIterations(1)
+            .measurementIterations(2)
+            .jvmArgs("-Xms2g", "-Xmx2g")
+            .shouldDoGC(true)
+            .forks(1)
+            .build();
+
+    new Runner(opts).run();
+  }
+
+
+
+
+}
diff --git a/fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificUnitTest.java b/fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificUnitTest.java
new file mode 100644
index 0000000000..61295cc6f1
--- /dev/null
+++ b/fastUtil/src/test/java/com/baeldung/FastUtilTypeSpecificUnitTest.java
@@ -0,0 +1,20 @@
+package com.baeldung;
+
+import it.unimi.dsi.fastutil.doubles.Double2DoubleMap;
+import it.unimi.dsi.fastutil.doubles.Double2DoubleOpenHashMap;
+import org.junit.Test;
+
+import static junit.framework.Assert.assertEquals;
+
+
+public class FastUtilTypeSpecificUnitTest {
+
+  @Test
+  public void givenValidDouble2DoubleMap_whenContentsQueried_checkCorrect(){
+    Double2DoubleMap d2dMap = new Double2DoubleOpenHashMap();
+    d2dMap.put(2.0, 5.5);
+    d2dMap.put(3.0, 6.6);
+    assertEquals(5.5, d2dMap.get(2.0));
+  }
+
+}