Added TextStorage class
[SXSI/TextCollection.git] / TCImplementation.cpp
index 5a754c7..5959e6a 100644 (file)
  *****************************************************************************/
 #include "TCImplementation.h"
 
-//#include "HeapProfiler.h" // FIXME remove
+//#define DEBUG_MEMUSAGE
+#ifdef DEBUG_MEMUSAGE
+#include "HeapProfiler.h" // FIXME remove
+#endif
 
 #include <iostream>
 #include <map>
@@ -38,7 +41,7 @@ namespace SXSI
 {
 
 // Save file version info
-const uchar TCImplementation::versionFlag = 4;
+const uchar TCImplementation::versionFlag = 6;
 
 /**
  * Constructor inits an empty dynamic FM-index.
@@ -61,10 +64,12 @@ bool TCImplementation::EmptyText(DocId k) const
     return false; // Empty texts are not indexed
 }
 
-uchar* TCImplementation::GetText(DocId k) const
+uchar * TCImplementation::GetText(DocId k) const
 {
     assert(k < (DocId)numberOfTexts);
-    TextPosition i = k;
+
+    return textStorage->GetText(k);
+/*    TextPosition i = k;
 
     string result;
     // Reserve average string length to avoid reallocs
@@ -85,7 +90,7 @@ uchar* TCImplementation::GetText(DocId k) const
     res[i] = '\0';   
     for (ulong j = 0; j < i; ++j)
         res[i-j-1] = result[j];
-    return res;
+        return res;*/
 }
 /*
  * Not supported
@@ -409,14 +414,13 @@ TextCollection::document_result TCImplementation::Suffix(uchar const * pattern)
     TextCollection::document_result result;
     result.reserve(ep-sp+1); // Try to avoid reallocation.
 
-    ulong sampled_rank_i = 0;
     // Check each occurrence
     for (; sp <= ep; ++sp)
     {
         TextPosition i = sp;
 
         uchar c = alphabetrank->access(i);
-        while (c != '\0' && !sampled->IsBitSet(i, &sampled_rank_i))
+        while (c != '\0' && !sampled->access(i))
         {
             i = C[c]+alphabetrank->rank(c,i)-1;
             c = alphabetrank->access(i);
@@ -431,7 +435,7 @@ TextCollection::document_result TCImplementation::Suffix(uchar const * pattern)
         }
         else // Sampled position
         {
-            DocId docId = (*suffixDocId)[sampled_rank_i-1]; //sampled->rank(i)-1];
+            DocId docId = (*suffixDocId)[sampled->rank1(i)-1];
             result.push_back(docId);
         }
     }
@@ -452,14 +456,13 @@ TextCollection::document_result TCImplementation::Suffix(uchar const * pattern,
     TextCollection::document_result result;
     result.reserve(ep-sp+1); // Try to avoid reallocation.
 
-    ulong sampled_rank_i = 0;
     // Check each occurrence, already within [begin, end]
     for (; sp <= ep; ++sp)
     {
         TextPosition i = sp;
 
         uchar c = alphabetrank->access(i);
-        while (c != '\0' && !sampled->IsBitSet(i, &sampled_rank_i))
+        while (c != '\0' && !sampled->access(i))
         {
             i = C[c]+alphabetrank->rank(c,i)-1;
             c = alphabetrank->access(i);
@@ -474,7 +477,7 @@ TextCollection::document_result TCImplementation::Suffix(uchar const * pattern,
         }
         else // Sampled position
         {
-            DocId docId = (*suffixDocId)[sampled_rank_i-1]; //sampled->rank(i)-1];
+            DocId docId = (*suffixDocId)[sampled->rank1(i)-1];
             result.push_back(docId);
         }
     }
@@ -525,13 +528,12 @@ TextCollection::document_result TCImplementation::Contains(uchar const * pattern
     // We want unique document indentifiers, using std::set to collect them
     std::set<DocId> resultSet;
 
-    ulong sampled_rank_i = 0;
     // Check each occurrence
     for (; sp <= ep; ++sp)
     {
         TextPosition i = sp;
         uchar c = alphabetrank->access(i);
-        while (c != '\0' && !sampled->IsBitSet(i, &sampled_rank_i))
+        while (c != '\0' && !sampled->access(i))
         {
             i = C[c]+alphabetrank->rank(c,i)-1; // LF-mapping
             c = alphabetrank->access(i);
@@ -544,7 +546,7 @@ TextCollection::document_result TCImplementation::Contains(uchar const * pattern
         }
         else
         {
-            DocId di = (*suffixDocId)[sampled_rank_i-1]; //sampled->rank(i)-1];
+            DocId di = (*suffixDocId)[sampled->rank1(i)-1];
             assert((unsigned)di < numberOfTexts);
             resultSet.insert(di);
         }
@@ -568,13 +570,12 @@ TextCollection::document_result TCImplementation::Contains(uchar const * pattern
     // We want unique document indentifiers, using std::set to collect them
     std::set<DocId> resultSet;
 
-    ulong sampled_rank_i = 0;
     // Check each occurrence
     for (; sp <= ep; ++sp)
     {
         TextPosition i = sp;
         uchar c = alphabetrank->access(i);
-        while (c != '\0' && !sampled->IsBitSet(i, &sampled_rank_i))
+        while (c != '\0' && !sampled->access(i))
         {
             i = C[c]+alphabetrank->rank(c,i)-1; // LF-mapping
             c = alphabetrank->access(i);
@@ -589,7 +590,7 @@ TextCollection::document_result TCImplementation::Contains(uchar const * pattern
         }
         else
         {
-            DocId docId = (*suffixDocId)[sampled_rank_i-1]; //sampled->rank(i)-1];
+            DocId docId = (*suffixDocId)[sampled->rank1(i)-1];
             assert((unsigned)docId < numberOfTexts);
             if (docId >= begin && docId <= end)
                 resultSet.insert(docId);
@@ -643,14 +644,13 @@ TextCollection::full_result TCImplementation::FullContains(uchar const * pattern
     full_result result;
     result.reserve(ep-sp+1); // Try to avoid reallocation.
 
-    ulong sampled_rank_i = 0;    
     // Report each occurrence
     for (; sp <= ep; ++sp)
     {
         TextPosition i = sp;
         TextPosition dist = 0;
         uchar c = alphabetrank->access(i);
-        while (c != '\0' && !sampled->IsBitSet(i, &sampled_rank_i))
+        while (c != '\0' && !sampled->access(i))
         {
             i = C[c]+alphabetrank->rank(c,i)-1;
             c = alphabetrank->access(i);
@@ -665,9 +665,8 @@ TextCollection::full_result TCImplementation::FullContains(uchar const * pattern
         }
         else
         {
-            TextPosition textPos = (*suffixes)[sampled_rank_i-1]+dist; //sampled->rank(i)-1] + dist;
-            DocId docId = (*suffixDocId)[sampled_rank_i-1]; //sampled->rank(i)-1];
-//            textPos = textPos - (*textStartPos)[docId]; // Offset inside the text
+            TextPosition textPos = (*suffixes)[sampled->rank1(i)-1] + dist;
+            DocId docId = (*suffixDocId)[sampled->rank1(i)-1];
 
             result.push_back(make_pair(docId, textPos));
         }
@@ -689,14 +688,13 @@ TextCollection::full_result TCImplementation::FullContains(uchar const * pattern
     full_result result;
     result.reserve(ep-sp+1); // Try to avoid reallocation.
 
-    ulong sampled_rank_i = 0;    
     // Report each occurrence
     for (; sp <= ep; ++sp)
     {
         TextPosition i = sp;
         TextPosition dist = 0;
         uchar c = alphabetrank->access(i);
-        while (c != '\0' && !sampled->IsBitSet(i, &sampled_rank_i))
+        while (c != '\0' && !sampled->access(i))
         {
             i = C[c]+alphabetrank->rank(c,i)-1;
             c = alphabetrank->access(i);
@@ -714,9 +712,8 @@ TextCollection::full_result TCImplementation::FullContains(uchar const * pattern
         }
         else
         {
-            TextPosition textPos = (*suffixes)[sampled_rank_i-1]+dist; //sampled->rank(i)-1] + dist;
-            DocId docId = (*suffixDocId)[sampled_rank_i-1]; //sampled->rank(i)-1];
-//            textPos = textPos - (*textStartPos)[docId]; // Offset inside the text
+            TextPosition textPos = (*suffixes)[sampled->rank1(i)-1] + dist;
+            DocId docId = (*suffixDocId)[sampled->rank1(i)-1];
 
             if (docId >= begin && docId <= end)
                 result.push_back(make_pair(docId, textPos));
@@ -765,7 +762,7 @@ void TCImplementation::Save(FILE *file) const
         throw std::runtime_error("TCImplementation::Save(): file write error (bwt end position).");
     
     alphabetrank->save(file);
-    sampled->Save(file);
+    sampled->save(file);
     suffixes->Save(file);
     suffixDocId->Save(file);
     
@@ -775,6 +772,7 @@ void TCImplementation::Save(FILE *file) const
         throw std::runtime_error("TCImplementation::Save(): file write error (maxTextLength).");
 
     Doc->save(file);
+    textStorage->Save(file);
     fflush(file);
 }
 
@@ -811,7 +809,7 @@ TCImplementation::TCImplementation(FILE *file, unsigned samplerate_)
         throw std::runtime_error("TCImplementation::Load(): file read error (bwt end position).");
 
     alphabetrank = static_sequence::load(file);
-    sampled = new BSGAP(file);
+    sampled = static_bitsequence::load(file);
     suffixes = new BlockArray(file);
     suffixDocId = new BlockArray(file);
 
@@ -821,6 +819,7 @@ TCImplementation::TCImplementation(FILE *file, unsigned samplerate_)
         throw std::runtime_error("TCImplementation::Load(): file read error (maxTextLength).");
 
     Doc = static_sequence::load(file);
+    textStorage = new TextStorage(file);
 
     // FIXME Construct data structures with new samplerate
     //maketables(); 
@@ -891,7 +890,7 @@ ulong TCImplementation::SearchLessThan(uchar const * pattern, TextPosition m, Te
     {
 //         printf("i = %lu, c = %c, sp = %lu, ep = %lu\n", i, pattern[i], sp, ep);
         c = (int)pattern[--i];
-        uint result = alphabetrank->rank(c,ep);
+        uint result = alphabetrank->rankLessThan(c,ep);
         if (result == ~0u)
             ep = 0;
         else
@@ -912,6 +911,7 @@ TCImplementation::~TCImplementation() {
     delete suffixes;
     delete suffixDocId;
     delete Doc;
+    delete textStorage;
 }
 
 void TCImplementation::makewavelet(uchar *bwt)
@@ -939,20 +939,23 @@ void TCImplementation::makewavelet(uchar *bwt)
 //    delete [] bwt;
     //alphabetrank = new RLWaveletTree(bwt, n); // Deletes bwt!
 //  std::cerr << "heap usage: " << HeapProfiler::GetHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
-//    std::cerr << "max heap usage before WT: " << HeapProfiler::GetMaxHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
 
-//    HeapProfiler::ResetMaxHeapConsumption(); // FIXME remove
+#ifdef DEBUG_MEMUSAGE
+    std::cerr << "max heap usage before WT: " << HeapProfiler::GetMaxHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
+    HeapProfiler::ResetMaxHeapConsumption(); // FIXME remove
+#endif
 
     alphabet_mapper * am = new alphabet_mapper_none();
     static_bitsequence_builder * bmb = new static_bitsequence_builder_rrr02(8); // FIXME samplerate?
-//    static_bitsequence_builder * bmb = new static_bitsequence_builder_brw32(16); // FIXME samplerate?
     wt_coder * wtc = new wt_coder_binary(bwt,n,am);
     alphabetrank = new static_sequence_wvtree(bwt,n,wtc,bmb,am);
     delete bmb;
     bwt = 0; // already deleted
    
-//    std::cerr << "heap usage: " << HeapProfiler::GetHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
-//    std::cerr << "max heap usage after WT: " << HeapProfiler::GetMaxHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
+#ifdef DEBUG_MEMUSAGE
+    std::cerr << "heap usage after WT: " << HeapProfiler::GetHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
+    std::cerr << "max heap usage after WT: " << HeapProfiler::GetMaxHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
+#endif
 }
 
 void TCImplementation::maketables()
@@ -971,25 +974,16 @@ void TCImplementation::maketables()
         this->bwtEndPos = i;
     }
 
-    // Build up arrays for text length and starting positions
-    // FIXME Temp, remove
-    //BlockArray* textLength = new BlockArray(numberOfTexts, Tools::CeilLog2(maxTextLength));
+    // Build up array for text starting positions
     BlockArray* textStartPos = new BlockArray(numberOfTexts, Tools::CeilLog2(this->n));
-    //(*textLength)[0] = l;
     (*textStartPos)[0] = 0; 
 
-    // Construct samples
-    ulong sampleLength = (n%samplerate==0) ? n/samplerate : n/samplerate+1;
-    unsigned ceilLog2n = Tools::CeilLog2(n);
-    BlockArray* positions = new BlockArray(sampleLength, ceilLog2n);
-    BlockArray* tmpSuffix = new BlockArray(sampleLength, ceilLog2n);
-
     // Mapping from end-markers to doc ID's:
-    BlockArray *endmarkerDocId = new BlockArray(numberOfTexts, Tools::CeilLog2(numberOfTexts));
+    uint *endmarkerDocId = new uint[numberOfTexts]; // FIXME Use BlockArray with static_sequence_wvtree_noptrs.
   
-    ulong *sampledpositions = new ulong[n/W+1];
-    for (ulong i=0;i<n/W+1;i++)
-        sampledpositions[i]=0lu;
+    uint *sampledpositions = new uint[n/(sizeof(uint)*8)+1];
+    for (ulong i = 0; i < n / (sizeof(uint)*8) + 1; i++)
+        sampledpositions[i] = 0;
     
     ulong x,p=bwtEndPos;
     ulong sampleCount = 0;
@@ -1000,15 +994,15 @@ void TCImplementation::maketables()
     ulongmax--;
     uint alphabetrank_i_tmp =0;
 
-    //positions:
-    for (ulong i=n-1;i<ulongmax;i--) { // TODO bad solution with ulongmax?
-      // i substitutes SA->GetPos(i)
+    /**
+     * First pass: populate tables textStartPos and sampledpositions.
+     */
+    for (ulong i=n-1;i<ulongmax;i--) {
+        // i substitutes SA->GetPos(i)
         x=(i==n-1)?0:i+1;
 
         if (x % samplerate == 0 && posOfSuccEndmarker - x > samplerate) {
-            Tools::SetField(sampledpositions,1,p,1);
-            (*positions)[sampleCount] = p; 
-            (*tmpSuffix)[sampleCount] = x; // FIXME remove
+            set_field(sampledpositions,1,p,1);
             sampleCount ++;
         }
 
@@ -1019,12 +1013,11 @@ void TCImplementation::maketables()
             
             // Record the order of end-markers in BWT:
             ulong endmarkerRank = alphabetrank_i_tmp - 1;
-            (*endmarkerDocId)[endmarkerRank] = textId;
+            endmarkerDocId[endmarkerRank] = (textId + 1) % numberOfTexts;
 
             // Store text length and text start position:
             if (textId < (DocId)numberOfTexts - 1)
             {
-                //(*textLength)[textId + 1] = posOfSuccEndmarker - x;
                 (*textStartPos)[textId + 1] = x;  // x is the position of end-marker.
                 posOfSuccEndmarker = x;
             }
@@ -1032,59 +1025,71 @@ void TCImplementation::maketables()
             // LF-mapping from '\0' does not work with this (pseudo) BWT (see details from Wolfgang's thesis).
             p = textId; // Correct LF-mapping to the last char of the previous text.
         }
-        else
+        else // Now c != '\0', do LF-mapping:
             p = C[c]+alphabetrank_i_tmp-1;
     }
     assert(textId == 0);
     
-    sampled = new BSGAP(sampledpositions,n,true);
-    sampleLength = sampled->rank(n-1);
+    sampled = new static_bitsequence_rrr02(sampledpositions, n, 16);
+    delete [] sampledpositions;
+    ulong sampleLength = sampled->rank1(n-1);
     assert(sampleCount == sampleLength);
 
     // Suffixes store an offset from the text start position
     suffixes = new BlockArray(sampleLength, Tools::CeilLog2(maxTextLength));
     suffixDocId = new BlockArray(sampleLength, Tools::CeilLog2(numberOfTexts));
 
-    for(ulong i=0; i<sampleLength; i++) {
-        assert((*positions)[i] < n);
-        ulong j = sampled->rank((*positions)[i]);
-        if (j==0) j=sampleLength;
-        TextPosition textPos = (*tmpSuffix)[i];
-        (*suffixDocId)[j-1] = DocIdAtTextPos(textStartPos, textPos);
-
-        assert((unsigned)DocIdAtTextPos(textStartPos, textPos) < numberOfTexts);
-        assert((*suffixDocId)[j-1] < numberOfTexts);
-        // calculate offset from text start:
-        (*suffixes)[j-1] = textPos - (*textStartPos)[(*suffixDocId)[j-1]];
+    p=bwtEndPos;
+    textId = numberOfTexts;
+
+    TextStorageBuilder tsbuilder(n);
+
+    /**
+     * Second pass: populate tables suffixes and suffixDocId.
+     */
+    for (ulong i=n-1;i<ulongmax;i--) {
+        x=(i==n-1)?0:i+1;
+
+        if (sampled->access(p)) {
+            ulong j = sampled->rank1(p)-1;
+
+            (*suffixDocId)[j] = DocIdAtTextPos(textStartPos, x);
+
+            // calculate offset from text start:
+            (*suffixes)[j] = x - (*textStartPos)[(*suffixDocId)[j]];
+        }
+
+        uchar c = alphabetrank->access(p, alphabetrank_i_tmp);
+        tsbuilder[i] = c;
+
+        if (c == '\0')
+        {
+            --textId;
+            // LF-mapping from '\0' does not work with this (pseudo) BWT (see details from Wolfgang's thesis).
+            p = textId; // Correct LF-mapping to the last char of the previous text.
+        }
+        else // Now c != '\0', do LF-mapping:
+            p = C[c]+alphabetrank_i_tmp-1;
     }
-    // FIXME Temp, remove
-    delete tmpSuffix;
-    delete positions;
-//    delete textLength;
+    assert(textId == 0);
     delete textStartPos;
 
+    textStorage = tsbuilder.InitTextStorage();
+
+#ifdef DEBUG_MEMUSAGE
+    std::cerr << "max heap usage before Doc: " << HeapProfiler::GetMaxHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
+    HeapProfiler::ResetMaxHeapConsumption();
+#endif
 
-    uint *tmp = new uint[numberOfTexts]; // FIXME Silly...
-//    cout << "Doc: ";
-    for (unsigned i = 0; i < numberOfTexts; ++i)
-    {
-        tmp[i] = ((*endmarkerDocId)[i] + 1) % numberOfTexts;
-        //      cout << tmp[i] << ", ";
-    }
-//    cout << endl;
-    delete endmarkerDocId;
     alphabet_mapper * am = new alphabet_mapper_none();
     static_bitsequence_builder * bmb = new static_bitsequence_builder_brw32(16); // FIXME samplerate?
-    wt_coder * wtc = new wt_coder_binary(tmp, numberOfTexts, am);
-    Doc = new static_sequence_wvtree(tmp, numberOfTexts, wtc, bmb, am);
+    Doc = new static_sequence_wvtree_noptrs(endmarkerDocId, numberOfTexts, bmb, am, true);
     delete bmb;
-    delete [] tmp;
+    // delete [] endmarkerDocId; // already deleted in static_sequence_wvtree_noptrs!
 
-    /*    document_result res = Doc->access(1, 2, 0, 1);
-    cout << "result: ";
-    for (document_result::iterator it = res.begin(); it != res.end(); ++it)
-        cout << *it << ", ";
-        cout << endl;*/
+#ifdef DEBUG_MEMUSAGE
+    std::cerr << "max heap usage after Doc: " << HeapProfiler::GetMaxHeapConsumption()/(1024*1024) << " Mbytes" << std::endl;
+#endif
 }