Update bwt/wavelet.go

Doc improvement. Co-authored-by: Willow Carretero Chavez <sandiegobutterflies@gmail.com>
bebop · Dec 21, 2023 · 92ed9da · 92ed9da
1 parent 9e02f5d
commit 92ed9da
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/bwt/wavelet.go b/bwt/wavelet.go
@@ -83,6 +83,9 @@ a characters path encoding and which character we'd like to Rank, Select, and Ac
 
 ### Rank Example
 
+WaveletTree.Rank(c, n) returns the rank of character c at index n in a sequence, i.e. how many
+times c has occurred in a sequence before index n.
+
 To get WaveletTree.Rank(a, 4) of bananas where a's encoding is 00
 1. root.Rank(0, 4) of 0010101 is 2
 2. Visit Left Child