Merge pull request #3030 from tautschnig/format-number-range

Rewrite format_number_range

Author: tautschnig

src/util/format_number_range.cpp

@@ -10,107 +10,62 @@ Author: Daniel Kroening, [email protected]
 /// Format vector of numbers into a compressed range
 
 #include <algorithm>
-#include <cassert>
+#include <sstream>
 #include <string>
 
+#include "invariant.h"
+
 #include "format_number_range.h"
 
 /// create shorter representation for output
-/// \param parameters: vector of numbers
+/// \param input_numbers: vector of numbers
 /// \return string of compressed number range representation
-std::string format_number_range(std::vector<unsigned> &numbers)
+std::string format_number_range(const std::vector<unsigned> &input_numbers)
 {
-  std::string number_range;
+  PRECONDITION(!input_numbers.empty());
+
+  std::vector<unsigned> numbers(input_numbers);
   std::sort(numbers.begin(), numbers.end());
   unsigned end_number=numbers.back();
   if(numbers.front()==end_number)
-    number_range=std::to_string(end_number); // only single number
-  else
+    return std::to_string(end_number); // only single number
+
+  std::stringstream number_range;
+
+  auto start_number = numbers.front();
+
+  for(std::vector<unsigned>::const_iterator it = numbers.begin();
+      it != numbers.end();
+      ++it)
   {
-    bool next=true;
-    bool first=true;
-    bool range=false;
-    unsigned start_number=numbers.front();
-    unsigned last_number=start_number;
+    const auto number = *it;
+    const auto next = std::next(it);
+
+    // advance one forward
+    if(next != numbers.end() && *next <= number + 1)
+      continue;
+
+    // end this block range
+    if(start_number != numbers.front())
+      number_range << ',';
 
-    for(const auto &number : numbers)
+    if(number == start_number)
     {
-      if(next)
-      {
-        next=false;
-        start_number=number;
-        last_number=number;
-      }
-      // advance one forward
-      else
-      {
-        if(number==last_number+1 && !(number==end_number))
-        {
-          last_number++;
-          if(last_number>start_number+1)
-            range=true;
-        }
-        // end this block range
-        else
-        {
-          if(first)
-            first=false;
-          else
-            number_range+=",";
-          if(last_number>start_number)
-          {
-            if(range)
-            {
-              if(number==end_number && number==last_number+1)
-                number_range+=
-                  std::to_string(start_number)+"-"+std::to_string(end_number);
-              else if(number==end_number)
-                number_range+=
-                  std::to_string(start_number)+"-"+std::to_string(last_number)+
-                  ","+std::to_string(end_number);
-              else
-                number_range+=
-                  std::to_string(start_number)+"-"+std::to_string(last_number);
-            }
-            else
-            {
-              if(number!=end_number)
-                number_range+=
-                  std::to_string(start_number)+","+std::to_string(last_number);
-              else
-              {
-                if(start_number+1==last_number && last_number+1==number)
-                  number_range+=
-                    std::to_string(start_number)+"-"+std::to_string(end_number);
-                else
-                  number_range+=
-                    std::to_string(start_number)+
-                    ","+std::to_string(last_number)+
-                    ","+std::to_string(end_number);
-              }
-            }
-            start_number=number;
-            last_number=number;
-            range=false;
-            continue;
-          }
-          else
-          {
-            if(number!=end_number)
-              number_range+=std::to_string(start_number);
-            else
-              number_range+=std::to_string(start_number)+","+
-                std::to_string(end_number);
-            start_number=number;
-            last_number=number;
-            range=false;
-            continue; // already set next start number
-          }
-          next=true;
-        }
-      }
+      number_range << number;
     }
+    else if(number == start_number + 1)
+    {
+      number_range << start_number << ',' << number;
+    }
+    else
+    {
+      number_range << start_number << '-' << number;
+    }
+
+    if(next != numbers.end())
+      start_number = *next;
   }
-  assert(!number_range.empty());
-  return number_range;
+
+  CHECK_RETURN(!number_range.str().empty());
+  return number_range.str();
 }

src/util/format_number_range.h

@@ -15,6 +15,6 @@ Author: Daniel Kroening, [email protected]
 #include <string>
 #include <vector>
 
-std::string format_number_range(std::vector<unsigned> &);
+std::string format_number_range(const std::vector<unsigned> &);
 
 #endif // CPROVER_UTIL_FORMAT_NUMBER_RANGE_H

unit/Makefile

@@ -32,6 +32,7 @@ SRC += analyses/ai/ai.cpp \
        util/expr_cast/expr_cast.cpp \
        util/expr.cpp \
        util/file_util.cpp \
+       util/format_number_range.cpp \
        util/get_base_name.cpp \
        util/graph.cpp \
        util/irep.cpp \

unit/util/format_number_range.cpp

@@ -0,0 +1,37 @@
+/*******************************************************************\
+
+ Module: format_number_range unit tests
+
+ Author: Michael Tautschnig
+
+\*******************************************************************/
+
+#include <testing-utils/catch.hpp>
+
+#include <util/format_number_range.h>
+
+TEST_CASE(
+  "Format a range of unsigned numbers",
+  "[core][util][format_number_range]")
+{
+  const std::vector<unsigned> singleton = {1u};
+  REQUIRE(format_number_range(singleton) == "1");
+
+  const std::vector<unsigned> r1 = {0u, 42u};
+  REQUIRE(format_number_range(r1) == "0,42");
+
+  const std::vector<unsigned> r2 = {0u, 1u};
+  REQUIRE(format_number_range(r2) == "0,1");
+
+  const std::vector<unsigned> r3 = {1u, 2u, 3u};
+  REQUIRE(format_number_range(r3) == "1-3");
+
+  const std::vector<unsigned> r4 = {1u, 3u, 4u, 5u};
+  REQUIRE(format_number_range(r4) == "1,3-5");
+
+  const std::vector<unsigned> r5 = {1u, 10u, 11u, 12u, 42u};
+  REQUIRE(format_number_range(r5) == "1,10-12,42");
+
+  const std::vector<unsigned> r6 = {1u, 10u, 11u, 12u, 42u, 43u, 44u};
+  REQUIRE(format_number_range(r6) == "1,10-12,42-44");
+}