enumlike

Memory efficient enum-like map and key implementations

License	Apache License 2.0
Categories	UML Business Logic Libraries Documents Processing
GroupId	org.marid
ArtifactId	enumlike
Last Version	0.1.4
Release Date	Aug 9, 2015
Type	jar
Description	enumlike Memory efficient enum-like map and key implementations
Project URL	https://github.com/dimitrovchi/enum-like
Source Code Management	https://github.com/dimitrovchi/enum-like.git

Download enumlike

Filename	Size
enumlike-0.1.4.pom
enumlike-0.1.4.jar	26 KB
enumlike-0.1.4-tests.jar	198 KB
enumlike-0.1.4-sources.jar	19 KB
enumlike-0.1.4-javadoc.jar	124 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.marid/enumlike/ -->
<dependency>
    <groupId>org.marid</groupId>
    <artifactId>enumlike</artifactId>
    <version>0.1.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.marid/enumlike/
implementation 'org.marid:enumlike:0.1.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.marid/enumlike/
implementation ("org.marid:enumlike:0.1.4")

Apache Buildr

'org.marid:enumlike:jar:0.1.4'

Apache Ivy

<dependency org="org.marid" name="enumlike" rev="0.1.4">
  <artifact name="enumlike" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.marid', module='enumlike', version='0.1.4')
)

Scala SBT

libraryDependencies += "org.marid" % "enumlike" % "0.1.4"

Leiningen

[org.marid/enumlike "0.1.4"]

Dependencies

provided (2)

Group / Artifact	Type	Version
org.checkerframework : checker	jar	1.9.3
net.sf.ehcache : ehcache	jar	2.10.0

test (4)

Group / Artifact	Type	Version
junit : junit	jar	4.12
org.openjdk.jmh : jmh-generator-annprocess	jar	1.10.3
org.slf4j : slf4j-simple	jar	1.7.12
com.google.guava : guava	jar	18.0

Project Modules

There are no modules declared in this project.

Usage

Maven-dependency

<dependency>
    <groupId>org.marid</groupId>
    <artifactId>enumlike</artifactId>
    <version>0.1.4</version>
</dependency>

Demo

public class TypedEnumMapDemoTest {

    /**
     * Enum-like typed key.
     *
     * We need different enum-key classes for each TypedEnumMap to provide ordinal-based enum
     * uniqueness.
     *
     * @param <T> Key type.
     */
    public static class MyKey<T> extends EnumMapKey<T> {

        public MyKey(Class<T> type) {
            super(type);
        }
    }

    /**
     * Enum-like class.
     */
    public interface MyEnum {

        MyKey<Integer> ENUM_INT_KEY = new MyKey<>(Integer.class);
        MyKey<String> ENUM_STR_KEY = new MyKey<>(String.class);
        MyKey<BigDecimal> ENUM_BD_KEY = new MyKey<BigDecimal>(BigDecimal.class) {
            @Override
            public String name() {
                return "K";
            }
        };
    }

    /**
     * Enum container to construct TypedEnumMap instances.
     */
    public static final EnumMapKeyContainer<MyKey> CONTAINER =
            new DefaultEnumMapKeyContainer<>(MyKey.class, MyEnum.class);

    @Test
    public void testEnumContainer() {
        assertEquals(3, CONTAINER.getElements().size());
        assertEquals(ImmutableSet.of("ENUM_INT_KEY", "ENUM_STR_KEY", "K"),
                CONTAINER.getElements().stream().map(EnumMapKey::name).collect(Collectors.toSet()));
        assertEquals(MyKey.class, CONTAINER.getElementClass());
        assertEquals(CONTAINER.getElements().size() - 1, CONTAINER.getMaxOrdinal());
    }

    @Test
    public void testTypedEnumMap() {
        final TypedEnumMap map = new TypedEnumMap(CONTAINER);
        map.put(MyEnum.ENUM_INT_KEY, 1);
        //map.put(MyEnum.ENUM_INT_KEY, "x");  // compile error
        map.put(MyEnum.ENUM_BD_KEY, BigDecimal.TEN);
        assertEquals(1, map.get(MyEnum.ENUM_INT_KEY).intValue());
        assertEquals(10, map.get(MyEnum.ENUM_BD_KEY).intValue());
        assertNull(map.get(MyEnum.ENUM_STR_KEY));
    }

Enum container

Typed enum map	Is an enum container needed?
ArrayTypedEnumMap	no
ConcurrentTypedEnumMap	yes
TypedEnumMap	yes
HashTypedMap	no
IdentityHashTypedMap	no
SkipListTYpedMap	no
TreeTypedMap	no

Memory consumption

Capacity	Size	Ha	Id	Ty	Co	Tr	Sk	Ar
16	9	576	472	248	264	568	600	232
64	9	768	1240	440	456	568	600	232
64	50	2992	1896	1096	1112	2864	2680	920
70	9	1024	1240	464	480	568	600	232
70	50	2992	1896	1120	1136	2864	2680	920
70	70	3952	2216	1440	1456	3984	3696	1272

Map types:

• Ha - HashMap-based
• Id - IdentityHashMap-based
• Ty - array by ordinals
• Co - concurrent array by ordinals
• Tr - TreeMap based
• Sk - ConcurrentSkipListMap-based
• Ar - sorted arrays map

Oracle JVM 1.8u51, Linux x86_64

Performance

Map	'Put' Time, ns	'Get' Time, ns
Ha	32.121	16.670
Id	N/A	16.265
Co	14.271	10.397
Sk	97.286	52.521
Tr	43.881	36.639
Ty	7.180	9.509
Ar	145.274	59.877

• Oracle JVM 1.8u51, Linux x86_64, Kernel V3.19
• CPU: AMD FX-8350 4.0 GHz 8-core L1 96 KiB L2 2048 KiB L3 8192 KiB
• RAM: DDR3 16 GiB non-ECC 1866 MHz

⚠ These benchmarks were done with -DTypedEnumMap.fast flag. This flag disables domain-based ordinal id checking and so dramatically increases the performance. For example, without this flag, we have the following:

Co : get - 106 ns (vs 10 ns); Ty : get - 105 ns (vs 9.5 ns)

Versions

Version
0.1.4 Aug 9, 2015