1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
|
/*
* Copyright (C) 2014-2021 Brian L. Browning
*
* This file is part of Beagle
*
* Beagle 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.
*
* Beagle 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 <http://www.gnu.org/licenses/>.
*/
package vcf;
import blbutil.BitArray;
import java.util.stream.IntStream;
/**
* <p>Class {@code BitArrayGT} represents genotypes for a list of samples
* at a single marker. Instances of class {@code BitArrayGTRec} store
* haplotype alleles and flags to indicate missing genotypes in bit sets. All
* genotypes are considered to be unphased if any sample has an
* unphased or missing genotype.t</p>
*
* <p>Instances of class {@code BitArrayGTRec} are immutable.</p>
*
* @author Brian L. Browning {@code <browning@uw.edu>}
*/
public final class BitArrayGTRec implements GTRec {
private final int bitsPerAllele;
private final Marker marker;
private final Samples samples;
private final boolean isPhased;
private final BitArray isMissing;
private final BitArray alleles;
/**
* Constructs a new {@code BitArrayGT} instance representing
* the specified VCF record's GT format field data.
*
* @param recParser the VCF record genotype data
* @throws IllegalArgumentException if a format error is detected
* in the VCF record
* @throws NullPointerException if {@code recParser == null}
*/
public BitArrayGTRec(VcfRecGTParser recParser) {
int nSamples = recParser.samples().size();
int nHaps = nSamples<<1;
this.bitsPerAllele = recParser.marker().bitsPerAllele();
this.marker = recParser.marker();
this.samples = recParser.samples();
BitArray alleleList = new BitArray(nHaps*bitsPerAllele);
BitArray isMissingList = new BitArray(nSamples);
this.isPhased = recParser.storeAlleles(alleleList, isMissingList);
this.isMissing = isMissingList;
this.alleles = alleleList;
}
/**
* Constructs a new {@code BitArrayGT} instance representing
* the specified VCF record's GT format field data.
*
* @param hlr the VCF record genotype data
* @throws IllegalArgumentException if a format error is detected
* in the VCF record
* @throws NullPointerException if {@code hlr == null}
*/
public BitArrayGTRec(VcfRecGTParser.HapListRep hlr) {
int nSamples = hlr.samples().size();
int nHaps = nSamples<<1;
this.bitsPerAllele = hlr.marker().bitsPerAllele();
this.marker = hlr.marker();
this.samples = hlr.samples();
this.isPhased = hlr.isPhased();
this.isMissing = new BitArray(nSamples);
this.alleles = new BitArray(nHaps*bitsPerAllele);
boolean setMajorToNull = false;
int[][] hapLists = hlr.hapLists(setMajorToNull);
int[] missingSamples = hlr.missingSamples();
for (int al=0; al<hapLists.length; ++al) {
int[] list = hapLists[al];
for (int h : list) {
storeAllele(alleles, h, bitsPerAllele, al);
}
}
for (int s : missingSamples) {
isMissing.set(s);
}
}
private static void storeAllele(BitArray alleles, int hap, int bitsPerAllele,
int allele) {
int index = hap*bitsPerAllele;
int mask = 1;
for (int k=0; k<bitsPerAllele; ++k) {
if ((allele & mask)==mask) {
alleles.set(index);
}
++index;
mask <<= 1;
}
}
@Override
public Samples samples() {
return samples;
}
@Override
public int size() {
return 2*samples.size();
}
@Override
public Marker marker() {
return marker;
}
@Override
public boolean isPhased() {
return isPhased;
}
@Override
public boolean isPhased(int sample) {
return isPhased;
}
@Override
public int allele1(int sample) {
return isMissing.get(sample) ? -1 : allele(sample<<1);
}
@Override
public int allele2(int sample) {
return isMissing.get(sample) ? -1 : allele((sample<<1) | 0b1);
}
@Override
public int get(int hap) {
return isMissing.get(hap>>1) ? -1 : allele(hap);
}
private int allele(int hap) {
int start = bitsPerAllele*hap;
int end = start + bitsPerAllele;
int allele = 0;
int mask = 1;
for (int j=start; j<end; ++j) {
if (alleles.get(j)) {
allele += mask;
}
mask <<= 1;
}
return allele;
}
@Override
public int[] alleles() {
return IntStream.range(0, size())
.map(h -> get(h))
.toArray();
}
/**
* Returns the data represented by {@code this} as a VCF
* record with a GT format field. The returned VCF record
* will have missing QUAL and INFO fields, will have "PASS"
* in the filter field, and will have a GT format field.
* @return the data represented by {@code this} as a VCF
* record with a GT format field
*/
@Override
public String toString() {
return GTRec.toVcfRec(this);
}
}
|