Debug swcsa

[SXSI/TextCollection.git] / TextCollection.h

diff --git a/TextCollection.h b/TextCollection.h
index f41084d..98272c1 100644 (file)
--- a/TextCollection.h
+++ b/TextCollection.h
@@ -25,11 +25,9 @@
 #include <vector>
 #include <utility> // Defines std::pair.
 
-// Default samplerate for suffix array samples
-#define TEXTCOLLECTION_DEFAULT_SAMPLERATE 64
-
 namespace SXSI
 {
+
     /**
      * General interface for a text collection
      *
@@ -44,53 +42,40 @@ namespace SXSI
         // Type for text position (FIXME ulong or long?)
         typedef ulong TextPosition;
 
-        /**
-         * Init an instance of a text collection object
-         *
-         * Returns a pointer to an object implementing this interface.
-         */
-        static TextCollection * InitTextCollection(unsigned samplerate = TEXTCOLLECTION_DEFAULT_SAMPLERATE);
+        // mode flag: Default includes both the index and "naive" text
+        enum index_mode_t { index_mode_default, index_mode_text_only }; // index_mode_index_only
+
         /**
          * Load from a file
          *
+         * The second parameter is a prefix to be used for multiple
+         * files. (SWCSAWrapper uses multiple save files!)
+         *
          * New samplerate can be given, otherwise will use the one specified in the save file!
-         * Note: This is not a static method; call InitTextCollection() first to get the object handle.
          *
          * Throws an exception if std::fread() fails.
          * 
          */
-        virtual void Load(FILE *, unsigned samplerate = 0) = 0;
+        static TextCollection* Load(FILE *, char const *, index_mode_t = index_mode_default, unsigned samplerate = 0);
+
         /**
          * Save data structure into a file
-         * 
+         *
+         * The second parameter is a prefix to be used for multiple
+         * files. (SWCSAWrapper uses multiple save files!)
+         *
          * Throws an exception if std::fwrite() fails.
          */
-        virtual void Save(FILE *) const = 0;
+        virtual void Save(FILE *, char const *) const = 0;
+
         /**
          * Virtual destructor
          */
         virtual ~TextCollection() { };
-        /** 
-         * Insert text
-         *
-         * Must be a zero-terminated string from alphabet [1,255].
-         * Can not be called after makeStatic().
-         * The i'th text insertion gets an identifier value i-1.
-         * In other words, document identifiers start from 0.
-         */
-        virtual void InsertText(uchar const *) = 0;
-        /**
-         * Make static
-         *
-         * Convert to a static collection; reduces space and time complexities.
-         * New texts can not be inserted after this operation.
-         */
-        virtual void MakeStatic() = 0;
-       
+
        /**
-          tests if the string pointed to by DocId is empty
-        */
-       
+        * Tests if the string pointed to by DocId is empty
+         */
        virtual bool EmptyText(DocId) const = 0;
 
         /**
@@ -98,8 +83,22 @@ namespace SXSI
          *
          * Returns the i'th text in the collection.
          * The numbering starts from 0.
+         *
+         * Call DeleteText() for each pointer returned by GetText()
+         * to avoid possible memory leaks.
          */
         virtual uchar* GetText(DocId) const = 0;
+        virtual void DeleteText(uchar *text) const = 0;
+
+        /**
+         * Returns a pointer to the beginning of texts i, i+1, ..., j.
+         * Texts are separated by a '\0' byte.
+         *
+         * Call DeleteText() for each pointer returned by GetText()
+         * to avoid possible memory leaks.
+         */
+        virtual uchar * GetText(DocId i, DocId j) const = 0;
+
         /**
          * Returns substring [i, j] of k'th text
          *
@@ -176,7 +175,9 @@ namespace SXSI
         virtual document_result Equal(uchar const *) const = 0;
         virtual document_result Contains(uchar const *) const = 0;
         virtual document_result LessThan(uchar const *) const = 0;
-
+        virtual document_result KMismaches(uchar const *, unsigned) const = 0;
+        virtual document_result KErrors(uchar const *, unsigned) const = 0;
+    
         /**
          * Document reporting queries for given DocId interval.
          */
@@ -197,10 +198,45 @@ namespace SXSI
         // Full reporting query for given DocId interval
         virtual full_result FullContains(uchar const *, DocId, DocId) const = 0;
 
+        virtual full_result FullKMismatches(uchar const *, unsigned) const = 0;
+        virtual full_result FullKErrors(uchar const *, unsigned) const = 0;
+
+
+        virtual TextPosition getLength() const
+        {
+            std::cerr << "TextCollection::getLength() is unsupported! Use RLCSA instead." << std::endl;
+            std::exit(2);
+            return 0;
+        }
+    
+        virtual TextPosition LF(uchar c, TextPosition i) const
+        {
+            std::cerr << "TextCollection::LF() is unsupported! Use RLCSA instead." << std::endl;
+            std::exit(2);
+            return 0;
+        }
+
+        virtual uchar* getSuffix(TextPosition pos, unsigned l) const
+        {
+            std::cerr << "TextCollection::getSuffix() is unsupported! Use RLCSA instead." << std::endl;
+            std::exit(2);
+            return 0;
+        }
+    
+        virtual DocId getDoc(TextPosition i) const
+        {
+            std::cerr << "TextCollection::getDoc() is unsupported! Use RLCSA instead." << std::endl;
+            std::exit(2);
+            return 0;
+        }
+        
+
     protected:
-        // Protected constructor; call the static function InitTextCollection().
+        // Protected constructor; use TextCollectionBuilder
         TextCollection() { };
 
+//        index_mode_t indexMode;
+
         // No copy constructor or assignment
         TextCollection(TextCollection const&);
         TextCollection& operator = (TextCollection const&);