com.carrotsearch.hppcrt.ShortSet Maven / Gradle / Ivy

Go to download
package com.carrotsearch.hppcrt;

import com.carrotsearch.hppcrt.ShortCollection;

/**
 * A set of shorts.
 */
// 
 @javax.annotation.Generated(date = "2014-10-25T20:54:14+0200", value = "HPPC-RT generated from: ShortSet.java") 
public interface ShortSet extends ShortCollection
{
    /**
     * Adds k to the set.
     * 
     * @return Returns true if this element was not part of the set before. Returns
     * false if an equal element is already part of the set, and leaves the set unchanged. .
     */
    public boolean add(short k);

    /**
     * Compares the specified object with this set for equality. Returns
     * true if and only if the specified object is also a
     * {@link ShortSet} and both objects contains exactly the same objects.
     */
    @Override
    public boolean equals(Object obj);

    /**
     * @return A hash code of elements stored in the set. The hash code
     * is defined identically to {@link ShortSet#hashCode()} (sum of hash codes of elements
     * within the set). Because sum is commutative, this ensures that different order
     * of elements in a set does not affect the hash code.
     */
    @Override
    public int hashCode();
}