package com.carrotsearch.hppc;

import com.carrotsearch.hppc.predicates.IntPredicate;

A collection allows basic, efficient operations on sets of elements
(difference and intersection).
/**
 * A collection allows basic, efficient operations on sets of elements
 * (difference and intersection).
 */
 @com.carrotsearch.hppc.Generated(
    date = "2018-05-21T12:24:05+0200",
    value = "KTypeCollection.java") 
public interface IntCollection extends IntContainer {
  
Removes all occurrences of e from this collection.
Params:
e – 
         Element to be removed from this collection, if present.
Returns:
The number of removed elements as a result of this call./**
   * Removes all occurrences of <code>e</code> from this collection.
   * 
   * @param e
   *          Element to be removed from this collection, if present.
   * @return The number of removed elements as a result of this call.
   */
  public int removeAll(int e);

  
Removes all elements in this collection that are present in c.
Returns:
Returns the number of removed elements./**
   * Removes all elements in this collection that are present in <code>c</code>.
   * 
   * @return Returns the number of removed elements.
   */
  public int removeAll(IntLookupContainer c);

  
Removes all elements in this collection for which the given predicate
returns true.
Returns:
Returns the number of removed elements./**
   * Removes all elements in this collection for which the given predicate
   * returns <code>true</code>.
   * 
   * @return Returns the number of removed elements.
   */
  public int removeAll(IntPredicate predicate);

  
Keeps all elements in this collection that are present in c.
Runs in time proportional to the number of elements in this collection.
Equivalent of sets intersection.
Returns:
Returns the number of removed elements./**
   * Keeps all elements in this collection that are present in <code>c</code>.
   * Runs in time proportional to the number of elements in this collection.
   * Equivalent of sets intersection.
   * 
   * @return Returns the number of removed elements.
   */
  public int retainAll(IntLookupContainer c);

  
Keeps all elements in this collection for which the given predicate returns
true.
Returns:
Returns the number of removed elements./**
   * Keeps all elements in this collection for which the given predicate returns
   * <code>true</code>.
   * 
   * @return Returns the number of removed elements.
   */
  public int retainAll(IntPredicate predicate);

  
Removes all elements from this collection.
See Also:
release()/**
   * Removes all elements from this collection.
   * 
   * @see #release()
   */
  public void clear();

  
Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple clear() should be a better alternative since it'll avoid reallocation. 
See Also:
clear()/**
   * Removes all elements from the collection and additionally releases any
   * internal buffers. Typically, if the object is to be reused, a simple
   * {@link #clear()} should be a better alternative since it'll avoid
   * reallocation.
   * 
   * @see #clear()
   */
  public void release();
}