Added documentation and examples for fuzzy search in Help > New Features > Module Fuzzy

 Search. Fuzzy search no longer searches permutations because the cost was
 factorial(!). Instead, it now searches every word once(linear cost) which has the side effect of ignoring redundancy.

Author: tpat

src/Interface/Application/SCIRunMainWindow.cc

@@ -205,6 +205,7 @@ SCIRunMainWindow::SCIRunMainWindow()
   connect(actionCreateToolkitFromDirectory_, SIGNAL(triggered()), this, SLOT(helpWithToolkitCreation()));
 
   connect(helpActionPythonAPI_, SIGNAL(triggered()), this, SLOT(loadPythonAPIDoc()));
+  connect(helpActionModuleFuzzySearch_, SIGNAL(triggered()), this, SLOT(showModuleFuzzySearchHelp()));
   connect(helpActionSnippets_, SIGNAL(triggered()), this, SLOT(showSnippetHelp()));
   connect(helpActionClipboard_, SIGNAL(triggered()), this, SLOT(showClipboardHelp()));
 	connect(helpActionTagLayer_, SIGNAL(triggered()), this, SLOT(showTagHelp()));

src/Interface/Application/SCIRunMainWindow.h

@@ -280,6 +280,7 @@ private Q_SLOTS:
   void showSnippetHelp();
   void showTagHelp();
   void showTriggerHelp();
+  void showModuleFuzzySearchHelp();
   void switchMouseMode();
   void toggleFullScreen();
   void toggleMetadataLayer(bool toggle);

src/Interface/Application/SCIRunMainWindow.ui

@@ -183,6 +183,7 @@
       <string>Learn About New Features</string>
      </property>
      <addaction name="helpActionSnippets_"/>
+     <addaction name="helpActionModuleFuzzySearch_"/>
      <addaction name="helpActionMetadataLayer_"/>
      <addaction name="helpActionTagLayer_"/>
      <addaction name="helpActionPythonInterpreter_"/>
@@ -1054,6 +1055,11 @@
     <string>*Import 4.x network file...</string>
    </property>
   </action>
+  <action name="helpActionModuleFuzzySearch_">
+   <property name="text">
+    <string>Module Fuzzy Search</string>
+   </property>
+  </action>
   <action name="helpActionSnippets_">
    <property name="text">
     <string>Snippets</string>

src/Interface/Application/SCIRunMainWindowSlotsPrivate.cc

@@ -773,6 +773,20 @@ void SCIRunMainWindow::showTriggerHelp()
      );
 }
 
+void SCIRunMainWindow::showModuleFuzzySearchHelp()
+{
+  QMessageBox::information(this, "Module Selector Fuzzy Search",
+                           "\nFuzzy search lets you skip characters as long as the are in order."
+                           "\nExample: Searching 'rdfl' will find the module 'ReadField'."
+                           "\n\nSearches are case insensitive except when you type an upper case character."
+                           "\nExample: Searching 'RdFl' or 'Rdfl' will reduce total matches while still finding 'ReadField'."
+                           "\nTip: Type the first letters of words in capitals, such as 'SFG' to find 'ShowFieldGlyphs'."
+                           "\n\nSpaces between words will do multiple searches to further reduce matched modules."
+                           "\nExample: Search 'mesh get' to search both 'mesh' and 'get' in the same module name."
+                           "\n\nAll symbols are igonred except *'s which will make the search switch to the wildcards option instead of fuzzy search."
+    );
+}
+
 void SCIRunMainWindow::toolkitDownload()
 {
   auto action = qobject_cast<QAction*>(sender());

src/Interface/Application/TreeViewCollaborators.cc

@@ -86,10 +86,10 @@ bool HideItemsNotMatchingString::shouldHide(QTreeWidgetItem* item)
           || boost::contains(start_, "*"))
     return !match_.exactMatch(text);
   else
-    return !fuzzySearch(text, start_);
+    return !fuzzySearchAllPatterns(text, start_);
 }
 
-bool HideItemsNotMatchingString::fuzzySearch(QString text, QString pattern)
+bool HideItemsNotMatchingString::fuzzySearchAllPatterns(const QString& text, const QString& pattern)
 {
   std::string pattern_str = removeAllSpecialCharacters(pattern.toStdString());
   std::vector<std::string> pattern_split;
@@ -103,13 +103,43 @@ bool HideItemsNotMatchingString::fuzzySearch(QString text, QString pattern)
     if(pattern_split[i].empty())
       pattern_split.erase(pattern_split.begin() + i);
   }
-  // Checks permutations of the first 8 words given
-  if(pattern_split.size() > 8)
-    pattern_split.resize(8);
 
-  std::vector<bool> visited(pattern_split.size(), false);
+  // Every word in the pattern must match
+  for(std::string str : pattern_split)
+  {
+    if(!fuzzySearch(text.toStdString(), str))
+    {
+      return false;
+    }
+  }
 
-  return fuzzySearchRemainingPatterns(visited, pattern_split, text, 0);
+  return true;
+}
+
+bool HideItemsNotMatchingString::fuzzySearch(const std::string& text, const std::string& pattern)
+{
+  int patternIndex = 0;
+
+  for(int t = 0; t < text.length(); t++)
+  {
+    bool isUpperChar = pattern[patternIndex] < 97;
+
+    // Counts as a match if letter found. Only case sensitive if search char is upper case
+    if((isUpperChar && (text[t] == pattern[patternIndex]))
+       || (!isUpperChar && (std::tolower(text[t]) == std::tolower(pattern[patternIndex]))))
+    {
+      ++patternIndex;
+    }
+
+    // Matched if pattern reaches end of string
+    if(patternIndex >= pattern.length())
+    {
+      return true;
+    }
+  }
+
+  // Return false if all the letters did not match
+  return false;
 }
 
 std::string HideItemsNotMatchingString::removeAllSpecialCharacters(const std::string& str)
@@ -127,65 +157,6 @@ std::string HideItemsNotMatchingString::removeAllSpecialCharacters(const std::st
   return newStr;
 }
 
-bool HideItemsNotMatchingString::fuzzySearchRemainingPatterns(std::vector<bool>& visited,
-                                                              std::vector<std::string>& patternSplit,
-                                                              QString& text,
-                                                              int textIndex)
-{
-  // Find current pattern
-  std::string currentPattern;
-  for(int i = 0; i < visited.size(); i++)
-  {
-    if(!visited[i])
-    {
-      visited[i] = true;
-      currentPattern = patternSplit[i];
-
-      // Do search
-      int patternIndex = 0;
-      int currentTextIndex = textIndex;
-      bool matched = false;
-
-      for(int t = currentTextIndex; t < text.length(); t++)
-      {
-        bool isUpperChar = currentPattern[patternIndex] < 97;
-
-        // Counts as a match if letter found
-        if((isUpperChar && (text[t] == currentPattern[patternIndex]))
-           || (!isUpperChar && (text[t].toLower() == std::tolower(currentPattern[patternIndex]))))
-        {
-          ++patternIndex;
-          currentTextIndex = t;
-        }
-
-        if(patternIndex >= currentPattern.length())
-        {
-          matched = true;
-          break;
-        }
-      }
-
-      // If current matched, check the rest of remaining permutations
-      bool remainingMatched = false;
-      if(matched)
-      {
-        remainingMatched = fuzzySearchRemainingPatterns(visited, patternSplit, text, currentTextIndex);
-        if(remainingMatched)
-          return true;
-      }
-      visited[i] = false;
-    }
-  }
-
-  for(int i = 0; i < visited.size(); i++)
-  {
-    if(!visited[i])
-      return false;
-  }
-
-  return true;
-}
-
 void ShowAll::operator()(QTreeWidgetItem* item)
 {
   item->setHidden(false);

src/Interface/Application/TreeViewCollaborators.h

@@ -71,12 +71,9 @@ namespace Gui {
 
     void operator()(QTreeWidgetItem* item);
     bool shouldHide(QTreeWidgetItem* item);
-    bool fuzzySearch(QString text, QString pattern);
+    bool fuzzySearchAllPatterns(const QString& text, const QString& pattern);
+    bool fuzzySearch(const std::string& text, const std::string& pattern);
     std::string removeAllSpecialCharacters(const std::string& str);
-    bool fuzzySearchRemainingPatterns(std::vector<bool>& visited,
-                                      std::vector<std::string>& patternSplit,
-                                      QString& text,
-                                      int textIndex);
   };
 
   struct ShowAll