org.javimmutable.collections.tree.TreeCollisionSet Maven / Gradle / Ivy

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2019, 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.tree;

import org.javimmutable.collections.Proc1;
import org.javimmutable.collections.Proc1Throws;
import org.javimmutable.collections.Sum1;
import org.javimmutable.collections.Sum1Throws;
import org.javimmutable.collections.common.CollisionSet;
import org.javimmutable.collections.iterators.GenericIterator;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import java.util.Comparator;

import static java.lang.Boolean.TRUE;

/**
 * CollisionSet implementation that stores values in Node objects (balanced trees).
 * Usable with keys that implement Comparable.  Will fail with any other
 * type of key.
 */
@Immutable
public class TreeCollisionSet
    implements CollisionSet
{
    @SuppressWarnings("rawtypes,unchecked")
    private static final TreeCollisionSet EMPTY = new TreeCollisionSet(ComparableComparator.of());

    private final Comparator comparator;

    private TreeCollisionSet(@Nonnull Comparator comparator)
    {
        this.comparator = comparator;
    }

    @SuppressWarnings("unchecked")
    public static  TreeCollisionSet instance()
    {
        return EMPTY;
    }

    @SuppressWarnings("unchecked")
    private AbstractNode root(@Nonnull Node node)
    {
        return (AbstractNode)node;
    }

    @Nonnull
    @Override
    public Node empty()
    {
        return FringeNode.instance();
    }

    @Nonnull
    @Override
    public Node single(@Nonnull T value)
    {
        return ValueNode.instance(value, TRUE);
    }

    @Override
    public int size(@Nonnull Node node)
    {
        return root(node).size();
    }

    @Override
    public boolean contains(@Nonnull Node node,
                            @Nonnull T value)
    {
        return root(node).containsKey(comparator, value);
    }

    @Nonnull
    @Override
    public Node insert(@Nonnull Node node,
                       @Nonnull T value)
    {
        return root(node).assign(comparator, value, TRUE);
    }

    @Nonnull
    @Override
    public Node delete(@Nonnull Node node,
                       @Nonnull T value)
    {
        return root(node).delete(comparator, value);
    }

    @Nullable
    @Override
    public GenericIterator.State iterateOverRange(@Nonnull Node node,
                                                     @Nullable GenericIterator.State parent,
                                                     int offset,
                                                     int limit)
    {
        return GenericIterator.transformState(parent, root(node).iterateOverRange(null, offset, limit), e -> e.getKey());
    }

    @Override
    public void forEach(@Nonnull Node node,
                        @Nonnull Proc1 proc)
    {
        root(node).forEach((k, v) -> proc.apply(k));
    }

    @Override
    public  void forEachThrows(@Nonnull Node node,
                                                    @Nonnull Proc1Throws proc)
        throws E
    {
        root(node).forEachThrows((k, v) -> proc.apply(k));
    }

    @Override
    public  R reduce(@Nonnull Node node,
                        R sum,
                        @Nonnull Sum1 proc)
    {
        return root(node).reduce(sum, (s, k, v) -> proc.apply(s, k));
    }

    @Override
    public  R reduceThrows(@Nonnull Node node,
                                                   R sum,
                                                   @Nonnull Sum1Throws proc)
        throws E
    {
        return root(node).reduceThrows(sum, (s, k, v) -> proc.apply(s, k));
    }
}