net.maizegenetics.dna.snp.MaskTaxaMatrix Maven / Gradle / Ivy

/*
 *  MaskTaxaMatrix
 * 
 *  Created on Dec 12, 2016
 */
package net.maizegenetics.dna.snp;

import net.maizegenetics.util.BitSet;
import net.maizegenetics.util.OpenBitSet;
import net.maizegenetics.util.UnmodifiableBitSet;

/**
 *
 * @author Terry Casstevens
 */
public class MaskTaxaMatrix implements MaskMatrix {

    private final BitSet[] myBitSets;
    private final int myNumTaxa;
    private final int myNumSites;

    /**
     * Constructs a MaskMatrix for use with components of a GenotypeTable.
     *
     * @param bitSets set bits to indicate which are masked
     */
    MaskTaxaMatrix(BitSet[] bitSets, int numTaxa, int numSites) {
        myBitSets = bitSets;
        myNumTaxa = numTaxa;
        myNumSites = numSites;
    }

    @Override
    public boolean get(int taxon, int site) {
        return myBitSets[taxon].fastGet(site);
    }

    /**
     * Returns false if specified taxon is definitely not masked. Otherwise
     * returns true. A true returned doesn't necessarily mean this taxon is
     * masked. This can be used to optimize performance of masked genotype table
     * components. If false returned, checking for masking can be skipped.
     *
     * @param taxon taxon
     *
     * @return false if taxon definitely not masked, true otherwise
     */
    @Override
    public boolean isTaxonMaskedHint(int taxon) {
        return myBitSets[taxon].cardinality() != 0;
    }

    /**
     * Mask for specified taxon
     *
     * @param taxon taxon
     *
     * @return mask
     */
    @Override
    public BitSet maskForTaxon(int taxon) {
        return UnmodifiableBitSet.getInstance(myBitSets[taxon]);
    }

    /**
     * Returns false if specified site is definitely not masked. Otherwise
     * returns true. A true returned doesn't necessarily mean this site is
     * masked. This can be used to optimize performance of masked genotype table
     * components. If false returned, checking for masking can be skipped.
     *
     * @param site site
     *
     * @return false if site definitely not masked, true otherwise
     */
    @Override
    public boolean isSiteMaskedHint(int site) {
        for (int t = 0; t < myNumTaxa; t++) {
            if (myBitSets[t].fastGet(site)) {
                return true;
            }
        }
        return false;
    }

    /**
     * Mask for specified site
     *
     * @param site site
     *
     * @return mask
     */
    @Override
    public BitSet maskForSite(int site) {
        BitSet result = new OpenBitSet(myNumTaxa);
        for (int t = 0; t < myNumTaxa; t++) {
            if (myBitSets[t].fastGet(site)) {
                result.fastSet(t);
            }
        }
        return result;
    }

    @Override
    public int numTaxa() {
        return myNumTaxa;
    }

    @Override
    public int numSites() {
        return myNumSites;
    }

    @Override
    public boolean isSiteOptimized() {
        return false;
    }

}