03a71a913ae2a705806361a26969d19b119e9cf8
tdreszer
  Tue Feb 5 18:39:22 2013 -0800
Updated the file comment in vcfBits.c/.h.  No code change.
diff --git src/inc/vcfBits.h src/inc/vcfBits.h
index c7f62f6..774cec7 100644
--- src/inc/vcfBits.h
+++ src/inc/vcfBits.h
@@ -1,20 +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
- * The vcfFile object borrows many memory handling and error reporting tricks from MarkD's
- * gff3File; any local deficiencies are not to reflect poorly on Mark's fine work! :) */
+/* 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. */
 
 #ifndef vcfBits_h
 #define vcfBits_h
 
 #include "vcf.h"
 #include "bits.h"
 #include "elmTree.h"
 
 struct variantBits
 // all genotypes/haplotypes/alleles for one record are converted to a bit map
 // One struct per variant record in vcff->records.  One slot per genotype containing
 // 2 slots for haplotypes and then 1 or 2 bits per allele.
     {
     struct variantBits *next;
     struct vcfRecord *record;     // keep track of record for later interpretation