com.gs.collections.impl.bag.mutable.primitive.ByteHashBag Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gs-collections Show documentation
GS Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API and set of utility classes that work with any JDK compatible Collections, Arrays, Maps or Strings. The iteration protocol was inspired by the Smalltalk collection framework.
There is a newer version: 7.0.3
Show newest version
/*
 * Copyright 2014 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.gs.collections.impl.bag.mutable.primitive;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.NoSuchElementException;

import com.gs.collections.api.ByteIterable;
import com.gs.collections.api.bag.MutableBag;
import com.gs.collections.api.bag.primitive.ByteBag;
import com.gs.collections.api.bag.primitive.ImmutableByteBag;
import com.gs.collections.api.bag.primitive.MutableByteBag;
import com.gs.collections.api.block.function.primitive.ByteToObjectFunction;
import com.gs.collections.api.block.function.primitive.ObjectByteToObjectFunction;
import com.gs.collections.api.block.function.primitive.IntToIntFunction;
import com.gs.collections.api.block.predicate.primitive.BytePredicate;
import com.gs.collections.api.block.procedure.primitive.ByteProcedure;
import com.gs.collections.api.block.procedure.primitive.ByteIntProcedure;
import com.gs.collections.api.iterator.ByteIterator;
import com.gs.collections.api.iterator.MutableByteIterator;
import com.gs.collections.api.set.primitive.ByteSet;
import com.gs.collections.impl.Counter;
import com.gs.collections.impl.bag.mutable.HashBag;
import com.gs.collections.impl.block.factory.primitive.IntToIntFunctions;
import com.gs.collections.impl.factory.primitive.ByteBags;
import com.gs.collections.impl.map.mutable.primitive.ByteIntHashMap;
import com.gs.collections.impl.primitive.AbstractByteIterable;
import com.gs.collections.impl.set.mutable.primitive.ByteHashSet;
import net.jcip.annotations.NotThreadSafe;

/**
 * ByteHashBag is similar to {@link HashBag}, and is memory-optimized for byte primitives.
 * This file was automatically generated from template file primitiveHashBag.stg.
 *
 * @since 3.0.
 */
@NotThreadSafe
public final class ByteHashBag extends AbstractByteIterable implements MutableByteBag, Externalizable
{
    private static final long serialVersionUID = 1L;

    private ByteIntHashMap items;
    private int size;

    public ByteHashBag()
    {
        this.items = new ByteIntHashMap();
    }

    public ByteHashBag(int size)
    {
        this.items = new ByteIntHashMap(size);
    }

    public ByteHashBag(ByteIterable iterable)
    {
        this();
        this.addAll(iterable);
    }

    public ByteHashBag(byte... elements)
    {
        this();
        this.addAll(elements);
    }

    public ByteHashBag(ByteHashBag bag)
    {
        this.items = new ByteIntHashMap(bag.sizeDistinct());
        this.addAll(bag);
    }

    public static ByteHashBag newBag(int size)
    {
        return new ByteHashBag(size);
    }

    public static ByteHashBag newBagWith(byte... source)
    {
        return new ByteHashBag(source);
    }

    public static ByteHashBag newBag(ByteIterable source)
    {
        if (source instanceof ByteHashBag)
        {
            return new ByteHashBag((ByteHashBag) source);
        }
        return new ByteHashBag(source);
    }

    public static ByteHashBag newBag(ByteBag source)
    {
        return new ByteHashBag(source);
    }

    @Override
    public boolean isEmpty()
    {
        return this.items.isEmpty();
    }

    @Override
    public boolean notEmpty()
    {
        return this.items.notEmpty();
    }

    @Override
    public int size()
    {
        return this.size;
    }

    public int sizeDistinct()
    {
        return this.items.size();
    }

    public void clear()
    {
        this.items.clear();
        this.size = 0;
    }

    public ByteHashBag with(byte element)
    {
        this.add(element);
        return this;
    }

    public ByteHashBag with(byte element1, byte element2)
    {
        this.add(element1);
        this.add(element2);
        return this;
    }

    public ByteHashBag with(byte element1, byte element2, byte element3)
    {
        this.add(element1);
        this.add(element2);
        this.add(element3);
        return this;
    }

    public ByteHashBag withAll(ByteIterable iterable)
    {
        this.addAll(iterable);
        return this;
    }

    public ByteHashBag without(byte element)
    {
        this.remove(element);
        return this;
    }

    public ByteHashBag withoutAll(ByteIterable iterable)
    {
        this.removeAll(iterable);
        return this;
    }

    public boolean contains(byte value)
    {
        return this.items.containsKey(value);
    }

    public int occurrencesOf(byte item)
    {
        return this.items.get(item);
    }

    public void forEachWithOccurrences(ByteIntProcedure procedure)
    {
        this.items.forEachKeyValue(procedure);
    }

    public boolean add(byte item)
    {
        this.items.updateValue(item, 0, IntToIntFunctions.increment());
        this.size++;
        return true;
    }

    public boolean remove(byte item)
    {
        int newValue = this.items.updateValue(item, 0, IntToIntFunctions.decrement());
        if (newValue <= 0)
        {
            this.items.removeKey(item);
            if (newValue == 0)
            {
                this.size--;
            }
            return newValue == 0;
        }
        this.size--;
        return true;
    }

    public boolean addAll(byte... source)
    {
        if (source.length == 0)
        {
            return false;
        }

        for (byte each : source)
        {
            this.add(each);
        }
        return true;
    }

    public boolean addAll(ByteIterable source)
    {
        if (source.isEmpty())
        {
            return false;
        }
        if (source instanceof ByteBag)
        {
            ByteBag otherBag = (ByteBag) source;
            otherBag.forEachWithOccurrences(new ByteIntProcedure()
            {
                public void value(byte each, int occurrences)
                {
                    ByteHashBag.this.addOccurrences(each, occurrences);
                }
            });
        }
        else
        {
            ByteIterator iterator = source.byteIterator();
            while (iterator.hasNext())
            {
                byte each = iterator.next();
                this.add(each);
            }
        }
        return true;
    }

    public boolean removeAll(byte... source)
    {
        if (source.length == 0)
        {
            return false;
        }
        int oldSize = this.size();
        for (byte each : source)
        {
            int occurrences = this.items.removeKeyIfAbsent(each, 0);
            this.size -= occurrences;
        }
        return this.size() != oldSize;
    }

    public boolean removeAll(ByteIterable source)
    {
        if (source.isEmpty())
        {
            return false;
        }
        int oldSize = this.size();
        if (source instanceof ByteBag)
        {
            ByteBag otherBag = (ByteBag) source;
            otherBag.forEachWithOccurrences(new ByteIntProcedure()
            {
                public void value(byte each, int occurrences)
                {
                    int oldOccurrences = ByteHashBag.this.items.removeKeyIfAbsent(each, 0);
                    ByteHashBag.this.size -= oldOccurrences;
                }
            });
        }
        else
        {
            ByteIterator iterator = source.byteIterator();
            while (iterator.hasNext())
            {
                byte each = iterator.next();
                int occurrences = this.items.removeKeyIfAbsent(each, 0);
                this.size -= occurrences;
            }
        }
        return this.size() != oldSize;
    }

    public boolean retainAll(ByteIterable source)
    {
        int oldSize = this.size();
        final ByteSet sourceSet = source instanceof ByteSet ? (ByteSet) source : source.toSet();
        ByteHashBag retained = this.select(new BytePredicate()
        {
            public boolean accept(byte key)
            {
                return sourceSet.contains(key);
            }
        });
        if (retained.size() != oldSize)
        {
            this.items = retained.items;
            this.size = retained.size;
            return true;
        }
        return false;
    }

    public boolean retainAll(byte... source)
    {
        return this.retainAll(ByteHashSet.newSetWith(source));
    }

    public void addOccurrences(byte item, final int occurrences)
    {
        if (occurrences < 0)
        {
            throw new IllegalArgumentException("Cannot add a negative number of occurrences");
        }
        if (occurrences > 0)
        {
            this.items.updateValue(item, 0, new IntToIntFunction()
            {
                public int valueOf(int intParameter)
                {
                    return intParameter + occurrences;
                }
            });
            this.size += occurrences;
        }
    }

    public boolean removeOccurrences(byte item, final int occurrences)
    {
        if (occurrences < 0)
        {
            throw new IllegalArgumentException("Cannot remove a negative number of occurrences");
        }

        if (occurrences == 0)
        {
            return false;
        }

        int newValue = this.items.updateValue(item, 0, new IntToIntFunction()
        {
            public int valueOf(int intParameter)
            {
                return intParameter - occurrences;
            }
        });

        if (newValue <= 0)
        {
            this.size -= occurrences - newValue;
            this.items.removeKey(item);
            return newValue + occurrences != 0;
        }

        this.size -= occurrences;
        return true;
    }

    public void forEach(final ByteProcedure procedure)
    {
        this.each(procedure);
    }

    /**
     * @since 7.0.
     */
    public void each(final ByteProcedure procedure)
    {
        this.items.forEachKeyValue(new ByteIntProcedure()
        {
            public void value(byte key, int occurrences)
            {
                for (int i = 0; i < occurrences; i++)
                {
                    procedure.value(key);
                }
            }
        });
    }

    public ByteHashBag select(final BytePredicate predicate)
    {
        final ByteHashBag result = new ByteHashBag();
        this.forEachWithOccurrences(new ByteIntProcedure()
        {
            public void value(byte each, int occurrences)
            {
                if (predicate.accept(each))
                {
                    result.addOccurrences(each, occurrences);
                }
            }
        });
        return result;
    }

    public ByteHashBag reject(final BytePredicate predicate)
    {
        final ByteHashBag result = new ByteHashBag();
        this.forEachWithOccurrences(new ByteIntProcedure()
        {
            public void value(byte each, int occurrences)
            {
                if (!predicate.accept(each))
                {
                    result.addOccurrences(each, occurrences);
                }
            }
        });
        return result;
    }

    public  T injectInto(T injectedValue, ObjectByteToObjectFunction function)
    {
        T result = injectedValue;
        ByteIterator it = this.byteIterator();
        while (it.hasNext())
        {
            result = function.valueOf(result, it.next());
        }
        return result;
    }

    @Override
    public boolean equals(Object otherBag)
    {
        if (otherBag == this)
        {
            return true;
        }
        if (!(otherBag instanceof ByteBag))
        {
            return false;
        }
        final ByteBag bag = (ByteBag) otherBag;
        if (this.sizeDistinct() != bag.sizeDistinct())
        {
            return false;
        }

        return this.items.keysView().allSatisfy(new BytePredicate()
        {
            public boolean accept(byte key)
            {
                return ByteHashBag.this.occurrencesOf(key) == bag.occurrencesOf(key);
            }
        });
    }

    @Override
    public int hashCode()
    {
        final Counter result = new Counter();
        this.forEachWithOccurrences(new ByteIntProcedure()
        {
            public void value(byte eachItem, int occurrences)
            {
                result.add((int) eachItem ^ occurrences);
            }
        });
        return result.getCount();
    }

    public void appendString(
            final Appendable appendable,
            String start,
            final String separator,
            String end)
    {
        final boolean[] firstItem = {true};
        try
        {
            appendable.append(start);
            this.items.forEachKeyValue(new ByteIntProcedure()
            {
                public void value(byte each, int occurrences)
                {
                    try
                    {
                        for (int i = 0; i < occurrences; i++)
                        {
                            if (!firstItem[0])
                            {
                                appendable.append(separator);
                            }
                            appendable.append(String.valueOf(each));
                            firstItem[0] = false;
                        }
                    }
                    catch (IOException e)
                    {
                        throw new RuntimeException(e);
                    }
                }
            });
            appendable.append(end);
        }
        catch (IOException e)
        {
            throw new RuntimeException(e);
        }
    }

    public int count(final BytePredicate predicate)
    {
        final Counter result = new Counter();
        this.forEachWithOccurrences(new ByteIntProcedure()
        {
            public void value(byte each, int occurrences)
            {
                if (predicate.accept(each))
                {
                    result.add(occurrences);
                }
            }
        });
        return result.getCount();
    }

    public boolean anySatisfy(BytePredicate predicate)
    {
        return this.items.keysView().anySatisfy(predicate);
    }

    public boolean allSatisfy(BytePredicate predicate)
    {
        return this.items.keysView().allSatisfy(predicate);
    }

    public boolean noneSatisfy(BytePredicate predicate)
    {
        return this.items.keysView().noneSatisfy(predicate);
    }

    public byte detectIfNone(BytePredicate predicate, byte ifNone)
    {
        return this.items.keysView().detectIfNone(predicate, ifNone);
    }

    public  MutableBag collect(final ByteToObjectFunction function)
    {
        final HashBag result = HashBag.newBag(this.items.size());
        this.forEachWithOccurrences(new ByteIntProcedure()
        {
            public void value(byte each, int occurrences)
            {
                result.addOccurrences(function.valueOf(each), occurrences);
            }
        });
        return result;
    }

    public byte max()
    {
        if (this.isEmpty())
        {
            throw new NoSuchElementException();
        }
        return this.items.keysView().max();
    }

    public byte min()
    {
        if (this.isEmpty())
        {
            throw new NoSuchElementException();
        }
        return this.items.keysView().min();
    }

    public long sum()
    {
        final long[] result = {0L};
        this.forEachWithOccurrences(new ByteIntProcedure()
        {
            public void value(byte each, int occurrences)
            {
                result[0] += (long) each * occurrences;
            }
        });
        return result[0];
    }

    public byte[] toArray()
    {
        final byte[] array = new byte[this.size()];
        final int[] index = {0};

        this.forEachWithOccurrences(new ByteIntProcedure()
        {
            public void value(byte each, int occurrences)
            {
                for (int i = 0; i < occurrences; i++)
                {
                    array[index[0]] = each;
                    index[0]++;
                }
            }
        });
        return array;
    }

    public MutableByteBag asUnmodifiable()
    {
        return new UnmodifiableByteBag(this);
    }

    public MutableByteBag asSynchronized()
    {
        return new SynchronizedByteBag(this);
    }

    public ImmutableByteBag toImmutable()
    {
        return ByteBags.immutable.withAll(this);
    }

    public MutableByteIterator byteIterator()
    {
        return new InternalIterator();
    }

    public void writeExternal(final ObjectOutput out) throws IOException
    {
        out.writeInt(this.items.size());
        try
        {
            this.items.forEachKeyValue(new ByteIntProcedure()
            {
                public void value(byte each, int occurrences)
                {
                    try
                    {
                        out.writeByte(each);
                        out.writeInt(occurrences);
                    }
                    catch (IOException e)
                    {
                        throw new RuntimeException(e);
                    }
                }
            });
        }
        catch (RuntimeException e)
        {
            if (e.getCause() instanceof IOException)
            {
                throw (IOException) e.getCause();
            }
            throw e;
        }
    }

    public void readExternal(ObjectInput in) throws IOException
    {
        int size = in.readInt();
        this.items = new ByteIntHashMap(size);
        for (int i = 0; i < size; i++)
        {
            this.addOccurrences(in.readByte(), in.readInt());
        }
    }

    private class InternalIterator implements MutableByteIterator
    {
        private final MutableByteIterator byteIterator = ByteHashBag.this.items.keySet().byteIterator();

        private byte currentItem;
        private int occurrences;
        private boolean canRemove;

        public boolean hasNext()
        {
            return this.occurrences > 0 || this.byteIterator.hasNext();
        }

        public byte next()
        {
            if (this.occurrences == 0)
            {
                this.currentItem = this.byteIterator.next();
                this.occurrences = ByteHashBag.this.occurrencesOf(this.currentItem);
            }
            this.occurrences--;
            this.canRemove = true;
            return this.currentItem;
        }

        public void remove()
        {
            if (!this.canRemove)
            {
                throw new IllegalStateException();
            }
            if (this.occurrences == 0)
            {
                this.byteIterator.remove();
                ByteHashBag.this.size--;
            }
            else
            {
                ByteHashBag.this.remove(this.currentItem);
            }
            this.canRemove = false;
        }
    }
}