org.javimmutable.collections.array.trie32.TrieNode Maven / Gradle / Ivy

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2017, Burton Computer Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//
//     Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//
//     Neither the name of the Burton Computer Corporation nor the names
//     of its contributors may be used to endorse or promote products
//     derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package org.javimmutable.collections.array.trie32;

import org.javimmutable.collections.Cursor;
import org.javimmutable.collections.Holder;
import org.javimmutable.collections.Indexed;
import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.SplitableIterator;
import org.javimmutable.collections.common.MutableDelta;

import javax.annotation.concurrent.Immutable;

@Immutable
public abstract class TrieNode
{
    public static final int ROOT_SHIFT = 30;

    public abstract boolean isEmpty();

    public abstract T getValueOr(int shift,
                                 int index,
                                 T defaultValue);

    public abstract  V getValueOr(int shift,
                                        int index,
                                        K key,
                                        Transforms transforms,
                                        V defaultValue);

    public abstract Holder find(int shift,
                                   int index);

    public abstract  Holder find(int shift,
                                          int index,
                                          K key,
                                          Transforms transforms);

    public abstract TrieNode assign(int shift,
                                       int index,
                                       T value,
                                       MutableDelta sizeDelta);

    public abstract  TrieNode assign(int shift,
                                              int index,
                                              K key,
                                              V value,
                                              Transforms transforms,
                                              MutableDelta sizeDelta);

    public abstract TrieNode delete(int shift,
                                       int index,
                                       MutableDelta sizeDelta);

    public abstract  TrieNode delete(int shift,
                                              int index,
                                              K key,
                                              Transforms transforms,
                                              MutableDelta sizeDelta);

    public abstract int getShift();

    public abstract boolean isLeaf();

    public TrieNode trimmedToMinimumDepth()
    {
        return this;
    }

    public TrieNode paddedToMinimumDepthForShift(int shift)
    {
        TrieNode node = this;
        int nodeShift = node.getShift();
        while (nodeShift < shift) {
            nodeShift += 5;
            node = SingleBranchTrieNode.forBranchIndex(nodeShift, 0, node);
        }
        return node;
    }

    public Cursor> signedOrderEntryCursor()
    {
        return anyOrderEntryCursor();
    }

    public  Cursor> signedOrderEntryCursor(Transforms transforms)
    {
        return anyOrderEntryCursor(transforms);
    }

    public Cursor signedOrderValueCursor()
    {
        return anyOrderValueCursor();
    }

    public abstract Cursor> anyOrderEntryCursor();

    public abstract  Cursor> anyOrderEntryCursor(Transforms transforms);

    public abstract Cursor anyOrderValueCursor();

    public SplitableIterator> signedOrderEntryIterator()
    {
        return anyOrderEntryIterator();
    }

    public  SplitableIterator> signedOrderEntryIterator(Transforms transforms)
    {
        return anyOrderEntryIterator(transforms);
    }

    public SplitableIterator signedOrderValueIterator()
    {
        return anyOrderValueIterator();
    }

    public abstract SplitableIterator> anyOrderEntryIterator();

    public abstract  SplitableIterator> anyOrderEntryIterator(Transforms transforms);

    public abstract SplitableIterator anyOrderValueIterator();

    public static  TrieNode of()
    {
        return EmptyTrieNode.instance();
    }

    public static  TrieNode fromSource(int index,
                                             Indexed source,
                                             int offset,
                                             int limit)
    {
        final int size = Math.min(32, limit - offset);
        if (size < 0) {
            throw new IllegalArgumentException();
        }

        switch (size) {
        case 0:
            return of();

        case 1:
            return LeafTrieNode.of(index, source.get(offset));

        case 32:
            return FullBranchTrieNode.fromSource(index, source, offset);

        default:
            return MultiBranchTrieNode.forSource(index, size, source, offset);
        }
    }

    public static int shiftForIndex(int index)
    {
        switch (Integer.numberOfLeadingZeros(index)) {
        case 0:
        case 1:
            return 30;

        case 2:
        case 3:
        case 4:
        case 5:
        case 6:
            return 25;

        case 7:
        case 8:
        case 9:
        case 10:
        case 11:
            return 20;

        case 12:
        case 13:
        case 14:
        case 15:
        case 16:
            return 15;

        case 17:
        case 18:
        case 19:
        case 20:
        case 21:
            return 10;

        case 22:
        case 23:
        case 24:
        case 25:
        case 26:
            return 5;

        case 27:
        case 28:
        case 29:
        case 30:
        case 31:
        case 32:
            return 0;
        }
        throw new IllegalArgumentException();
    }
}