de.tum.in.naturals.set.AbstractBoundedNatBitSet 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) 2017 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.set;

import it.unimi.dsi.fastutil.ints.IntCollection;
import java.util.Collection;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;

public abstract class AbstractBoundedNatBitSet extends AbstractNatBitSet implements BoundedNatBitSet {
    @Nonnegative
    private final int domainSize;

    protected AbstractBoundedNatBitSet(@Nonnegative int domainSize) {
        this.domainSize = domainSize;
    }

    @Override
    @Nonnegative
    public int domainSize() {
        return domainSize;
    }

    @Override
    public boolean add(int index) {
        checkInDomain(index);
        return super.add(index);
    }

    @Override
    public boolean addAll(@Nonnull Collection c) { // NOPMD Added for annotation
        return super.addAll(c);
    }

    @Override
    public void clearFrom(int from) {
        if (from >= domainSize) {
            return;
        }
        clear(from, domainSize);
    }

    @Override
    public void orNot(IntCollection indices) {
        if (indices.isEmpty()) {
            set(0, domainSize);
        } else {
            for (int i = 0; i < domainSize(); i++) {
                if (!indices.contains(i)) {
                    set(i);
                }
            }
        }
    }

    @Override
    public AbstractBoundedNatBitSet clone() {
        return (AbstractBoundedNatBitSet) super.clone();
    }

    @Override
    public String toString() {
        return domainSize + (isComplement() ? "(C)" : "") + super.toString();
    }

    abstract boolean isComplement();

    protected boolean inDomain(int index) {
        return 0 <= index && index < domainSize;
    }

    protected void checkInDomain(int from, int to) {
        NatBitSetsUtil.checkInDomain(domainSize, from, to);
    }

    protected void checkInDomain(int index) {
        NatBitSetsUtil.checkInDomain(domainSize, index);
    }
}