Merge pull request #22 from TravisWheelerLab/addSeqCount

add getNumSequences function
TravisWheelerLab · Nov 22, 2023 · b7cb72e · b7cb72e
2 parents bdf75b9 + a8e1ae8
commit b7cb72e
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/src/AwFmIndex.h b/src/AwFmIndex.h
@@ -560,4 +560,19 @@ bool awFmReturnCodeIsFailure(const enum AwFmReturnCode rc);
  */
 bool awFmReturnCodeIsSuccess(const enum AwFmReturnCode rc);
 
+
+/*
+ * Function:  awFmGetNumSequences
+ * --------------------
+ * Returns the number of sequences used to generate the awfmIndex. 
+ * When this index is built from a fasta, this will be equal to the number 
+ *  of sequences in that fasta. When built from a text string, this will be one.
+ *  Inputs:
+ *    index: AwFmIndex to query.
+ *
+ *  Returns:
+ *    Number of sequences contained inside the index.
+ */
+uint32_t awFmGetNumSequences(const struct AwFmIndex *_RESTRICT_ const index);
+
 #endif /* end of include guard: AW_FM_INDEX_STRUCTS_H */
diff --git a/src/AwFmIndexStruct.c b/src/AwFmIndexStruct.c
@@ -148,3 +148,13 @@ inline bool awFmReturnCodeIsFailure(const enum AwFmReturnCode rc){
 inline bool awFmReturnCodeIsSuccess(const enum AwFmReturnCode rc){
 	return !awFmReturnCodeIsFailure(rc);
 }
+
+
+uint32_t awFmGetNumSequences(const struct AwFmIndex *_RESTRICT_ const index){
+	if(index->fastaVector){
+		return index->fastaVector->metadata.count;
+	}
+	else{
+		return 1;
+	}
+}