Class BitSetBackedSelection

  • All Implemented Interfaces:
    it.unimi.dsi.fastutil.ints.IntIterable, Iterable<Integer>, Selection

    public class BitSetBackedSelection
    extends Object
    implements Selection
    A Selection implemented using java.util.BitSet
    • Constructor Summary

      Constructors 
      Constructor Description
      BitSetBackedSelection()
      Constructs an empty Selection
      BitSetBackedSelection​(int size)
      Returns a selection initialized from 0 to the given size, which cane be used for queries that exclude certain items, by first selecting the items to exclude, then flipping the bits.
      BitSetBackedSelection​(int[] arr)
      Constructs a selection containing the elements in the given array
      BitSetBackedSelection​(BitSet bitmap)
      Constructs a selection containing the elements in the given bitmap
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      BitSetBackedSelection add​(int... ints)
      Adds the given integers to the Selection if it is not already present, and does nothing otherwise
      Selection addRange​(int start, int end)
      Adds to the current bitmap all integers in [rangeStart,rangeEnd)
      Selection and​(Selection otherSelection)
      Intersects the receiver and otherSelection, updating the receiver
      Selection andNot​(Selection otherSelection)
      Implements the set difference operation between the receiver and otherSelection, after updating the receiver
      Selection clear()
      Returns this selection with all its values cleared
      boolean contains​(int i)
      Returns true if the index i is selected in this object
      boolean equals​(Object o)  
      BitSetBackedSelection flip​(int rangeStart, int rangeEnd)
      Returns a selection with the bits from this selection flipped over the given range
      int get​(int indexToFind)
      Returns the value of the ith element.
      int hashCode()  
      boolean isEmpty()
      Returns true if this selection has no values, and false otherwise
      it.unimi.dsi.fastutil.ints.IntIterator iterator()
      Returns a fastUtil intIterator that wraps a bitmap intIterator
      Selection or​(Selection otherSelection)
      Implements the union of the receiver and otherSelection, updating the receiver
      BitSetBackedSelection removeRange​(long start, long end)
      Removes from the current bitmap from all integers in [rangeStart,rangeEnd)
      protected static BitSetBackedSelection selectNRowsAtRandom​(int n, int max)
      Returns an randomly generated selection of size N where Max is the largest possible value
      int size()
      Returns the number of integers represented by this Selection
      int[] toArray()
      Returns the elements of this selection as an array of ints
      String toString()  
      static BitSetBackedSelection with​(int... rows)
      Returns a Selection containing all indexes in the array
      protected static Selection withoutRange​(int totalRangeStart, int totalRangeEnd, int excludedRangeStart, int excludedRangeEnd)
      Returns a Selection containing all values from totalRangeStart to totalRangeEnd, except for those in the range from excludedRangeStart to excludedRangeEnd.
      static BitSetBackedSelection withRange​(int start, int end)
      Returns a Selection containing all indexes in the range start (inclusive) to end (exclusive),
      • Methods inherited from interface it.unimi.dsi.fastutil.ints.IntIterable

        forEach, forEach, forEach, intIterator, intSpliterator, spliterator
    • Constructor Detail

      • BitSetBackedSelection

        public BitSetBackedSelection​(int size)
        Returns a selection initialized from 0 to the given size, which cane be used for queries that exclude certain items, by first selecting the items to exclude, then flipping the bits.
        Parameters:
        size - The size The end point, exclusive
      • BitSetBackedSelection

        public BitSetBackedSelection​(int[] arr)
        Constructs a selection containing the elements in the given array
      • BitSetBackedSelection

        public BitSetBackedSelection​(BitSet bitmap)
        Constructs a selection containing the elements in the given bitmap
      • BitSetBackedSelection

        public BitSetBackedSelection()
        Constructs an empty Selection
    • Method Detail

      • removeRange

        public BitSetBackedSelection removeRange​(long start,
                                                 long end)
        Removes from the current bitmap from all integers in [rangeStart,rangeEnd)
        Specified by:
        removeRange in interface Selection
        Parameters:
        start - inclusive beginning of range
        end - exclusive ending of range
      • flip

        public BitSetBackedSelection flip​(int rangeStart,
                                          int rangeEnd)
        Returns a selection with the bits from this selection flipped over the given range
        Specified by:
        flip in interface Selection
      • add

        public BitSetBackedSelection add​(int... ints)
        Adds the given integers to the Selection if it is not already present, and does nothing otherwise
        Specified by:
        add in interface Selection
      • size

        public int size()
        Returns the number of integers represented by this Selection
        Specified by:
        size in interface Selection
      • toArray

        public int[] toArray()
        Returns the elements of this selection as an array of ints
        Specified by:
        toArray in interface Selection
      • and

        public Selection and​(Selection otherSelection)
        Intersects the receiver and otherSelection, updating the receiver
        Specified by:
        and in interface Selection
      • or

        public Selection or​(Selection otherSelection)
        Implements the union of the receiver and otherSelection, updating the receiver
        Specified by:
        or in interface Selection
      • andNot

        public Selection andNot​(Selection otherSelection)
        Implements the set difference operation between the receiver and otherSelection, after updating the receiver
        Specified by:
        andNot in interface Selection
      • isEmpty

        public boolean isEmpty()
        Returns true if this selection has no values, and false otherwise
        Specified by:
        isEmpty in interface Selection
      • clear

        public Selection clear()
        Returns this selection with all its values cleared
        Specified by:
        clear in interface Selection
      • contains

        public boolean contains​(int i)
        Returns true if the index i is selected in this object
        Specified by:
        contains in interface Selection
      • addRange

        public Selection addRange​(int start,
                                  int end)
        Adds to the current bitmap all integers in [rangeStart,rangeEnd)
        Specified by:
        addRange in interface Selection
        Parameters:
        start - inclusive beginning of range
        end - exclusive ending of range
      • get

        public int get​(int indexToFind)
        Returns the value of the ith element. For example, if there are three ints {4, 32, 71} in the selection, get(0) returns 4, get(1) returns 32, and get(2) returns 71

        It can be useful if you need to iterate over the data, although there is also an iterator

        Specified by:
        get in interface Selection
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • iterator

        public it.unimi.dsi.fastutil.ints.IntIterator iterator()
        Returns a fastUtil intIterator that wraps a bitmap intIterator
        Specified by:
        iterator in interface it.unimi.dsi.fastutil.ints.IntIterable
        Specified by:
        iterator in interface Iterable<Integer>
      • with

        public static BitSetBackedSelection with​(int... rows)
        Returns a Selection containing all indexes in the array
      • withRange

        public static BitSetBackedSelection withRange​(int start,
                                                      int end)
        Returns a Selection containing all indexes in the range start (inclusive) to end (exclusive),
      • withoutRange

        protected static Selection withoutRange​(int totalRangeStart,
                                                int totalRangeEnd,
                                                int excludedRangeStart,
                                                int excludedRangeEnd)
        Returns a Selection containing all values from totalRangeStart to totalRangeEnd, except for those in the range from excludedRangeStart to excludedRangeEnd. Start values are inclusive, end values exclusive.
      • selectNRowsAtRandom

        protected static BitSetBackedSelection selectNRowsAtRandom​(int n,
                                                                   int max)
        Returns an randomly generated selection of size N where Max is the largest possible value