03a71a913ae2a705806361a26969d19b119e9cf8
tdreszer
  Tue Feb 5 18:39:22 2013 -0800
Updated the file comment in vcfBits.c/.h.  No code change.
diff --git src/lib/vcfBits.c src/lib/vcfBits.c
index 358e60c..dbe6736 100644
--- src/lib/vcfBits.c
+++ src/lib/vcfBits.c
@@ -1,19 +1,22 @@
-/* VCF: Variant Call Format, version 4.0 / 4.1
- * http://www.1000genomes.org/wiki/Analysis/Variant%20Call%20Format/vcf-variant-call-format-version-40
- * http://www.1000genomes.org/wiki/Analysis/Variant%20Call%20Format/vcf-variant-call-format-version-41
- */
+/* vcfBits.c/.h: Variant Call Format, analysis by bit maps.
+ * The routines found here are dependent upon vcf.c/.h for accessing vcf records.
+ * They allow analysis of a set of vcf records by bit maps with one bit map per variant
+ * location and where each haplotype covered by the vcf record is represented by a single
+ * bit (or pair of bits). Additional analysis can be performed by creating haplotype based
+ * bit maps from variant bit maps.  There is one haplotype bit map for each haplotype
+ * (subject chromosome) with one (or two) bits for each variant location in the set of records. */
 
 #include "common.h"
 #include "dnautil.h"
 #include "errabort.h"
 #include <limits.h>
 #include "localmem.h"
 #include "net.h"
 #include "regexHelper.h"
 #include "vcf.h"
 #include "vcfBits.h"
 
 
 static struct variantBits *vcfOneRecordToVariantBits(struct vcfFile *vcff,struct vcfRecord *record,
                                                      boolean phasedOnly, boolean homozygousOnly)
 // Returns bit array covering all genotypes/haplotype/alleles per record.  One slot per genotype