de.tum.in.naturals.bitset.RoaringBitmaps Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of naturals-util Show documentation
Datastructures and utility classes for non-negative integers
The newest version!
/*
 * Copyright (C) 2018 Tobias Meggendorfer
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package de.tum.in.naturals.bitset;

import de.tum.in.naturals.set.NatBitSet;
import de.tum.in.naturals.set.NatBitSets;
import it.unimi.dsi.fastutil.ints.IntIterable;
import it.unimi.dsi.fastutil.ints.IntIterator;
import java.util.BitSet;
import java.util.PrimitiveIterator;
import java.util.function.IntConsumer;
import org.roaringbitmap.RoaringBitmap;

/**
 * Utility class to help interacting with {@link org.roaringbitmap.RoaringBitmap}.
 */
public final class RoaringBitmaps {
    private RoaringBitmaps() {}

    public static RoaringBitmap of(IntIterable iterable) {
        if (iterable instanceof NatBitSet) {
            return NatBitSets.toRoaringBitmap((NatBitSet) iterable);
        }

        RoaringBitmap bitmap = new RoaringBitmap();
        iterable.forEach((IntConsumer) bitmap::add);
        return bitmap;
    }

    public static RoaringBitmap of(Iterable iterable) {
        if (iterable instanceof IntIterable) {
            return of((IntIterable) iterable);
        }

        RoaringBitmap bitmap = new RoaringBitmap();
        for (Integer integer : iterable) {
            bitmap.add(integer);
        }
        return bitmap;
    }

    @SuppressWarnings("TypeMayBeWeakened")
    public static RoaringBitmap of(PrimitiveIterator.OfInt iterator) {
        RoaringBitmap bitmap = new RoaringBitmap();
        iterator.forEachRemaining((IntConsumer) bitmap::add);
        return bitmap;
    }

    public static RoaringBitmap of(BitSet bitSet) {
        RoaringBitmap bitmap = new RoaringBitmap();
        BitSets.forEach(bitSet, bitmap::add);
        return bitmap;
    }

    public static IntIterator iterator(RoaringBitmap bitmap) {
        return new RoaringIterator(bitmap.getIntIterator());
    }

    public static RoaringBitmap subset(RoaringBitmap bitmap, long from, long to) {
        RoaringBitmap selector = new RoaringBitmap();
        selector.add(from, to);
        return RoaringBitmap.and(bitmap, selector);
    }
}