ProgressBar: fix number of prints if number of iterations is lower than

the wanted number of information prints

Author: BerndDoser

src/Pink/main_generic.h

@@ -56,7 +56,7 @@ void main_generic(InputData const& input_data)
         auto&& iter_data_cur = DataIteratorShuffled<DataLayout, T>(ifs, static_cast<uint64_t>(input_data.seed), input_data.shuffle_data_input);
         auto&& iter_data_end = DataIteratorShuffled<DataLayout, T>(ifs, true);
 
-        ProgressBar progress_bar(iter_data_cur.get_number_of_entries() * input_data.numIter, 70, input_data.number_of_progress_prints);
+        ProgressBar progress_bar(iter_data_cur.get_number_of_entries() * input_data.numIter, 70, input_data.max_number_of_progress_prints);
         uint32_t count = 0;
         for (int i = 0; i < input_data.numIter; ++i)
         {
@@ -154,7 +154,7 @@ void main_generic(InputData const& input_data)
 #endif
         );
 
-        ProgressBar progress_bar(iter_data_cur.get_number_of_entries(), 70, input_data.number_of_progress_prints);
+        ProgressBar progress_bar(iter_data_cur.get_number_of_entries(), 70, input_data.max_number_of_progress_prints);
         for (; iter_data_cur != iter_data_end; ++iter_data_cur, ++progress_bar)
         {
             auto result = mapper(*iter_data_cur);

src/UtilitiesLib/InputData.cpp

@@ -33,7 +33,7 @@ InputData::InputData()
    number_of_threads(-1),
    init(SOMInitialization::ZERO),
    numIter(1),
-   number_of_progress_prints(10),
+   max_number_of_progress_prints(10),
    use_flip(true),
    use_gpu(true),
    number_of_data_entries(0),
@@ -153,7 +153,7 @@ InputData::InputData(int argc, char **argv)
             }
             case 'p':
             {
-                number_of_progress_prints = atof(optarg);
+                max_number_of_progress_prints = atof(optarg);
                 break;
             }
             case 'n':
@@ -461,7 +461,7 @@ void InputData::print_parameters() const
               << "  Number of iterations = " << numIter << "\n"
               << "  Neuron dimension = " << neuron_dim << "x" << neuron_dim << "\n"
               << "  Euclidean distance dimension = " << euclidean_distance_dim << "x" << euclidean_distance_dim << "\n"
-              << "  Number of progress information prints = " << number_of_progress_prints << "\n"
+              << "  Maximal number of progress information prints = " << max_number_of_progress_prints << "\n"
               << "  Intermediate storage of SOM = " << intermediate_storage << "\n"
               << "  Layout = " << layout << "\n"
               << "  Initialization type = " << init;
@@ -524,7 +524,7 @@ void InputData::print_usage() const
                  "    --numthreads, -t <int>                        Number of CPU threads (default = auto).\n"
                  "    --num-iter <int>                              Number of iterations (default = 1).\n"
                  "    --pbc                                         Use periodic boundary conditions for SOM.\n"
-                 "    --progress, -p <int>                          Number of progress information prints (default = 10).\n"
+                 "    --progress, -p <int>                          Maximal number of progress information prints (default = 10).\n"
                  "    --seed, -s <int>                              Seed for random number generator (default = 1234).\n"
                  "    --store-rot-flip <string>                     Store the rotation and flip information of the best match of mapping.\n"
                  "    --som-width <int>                             Width dimension of SOM (default = 10).\n"

src/UtilitiesLib/InputData.h

@@ -63,7 +63,7 @@ struct InputData
     int number_of_threads;
     SOMInitialization init;
     int numIter;
-    int number_of_progress_prints;
+    int max_number_of_progress_prints;
     bool use_flip;
     bool use_gpu;
     uint32_t number_of_data_entries;

src/UtilitiesLib/ProgressBar.h

@@ -17,10 +17,11 @@ class ProgressBar
 {
 public:
 
-    ProgressBar(int number_of_iterations, int width, int number_of_progress_prints = 10, std::ostream& os = std::cout)
+    ProgressBar(int number_of_iterations, int width, int max_number_of_progress_prints, std::ostream& os = std::cout)
      : number_of_iterations(number_of_iterations < 1 ? throw pink::exception("ProgressBar: number_of_iterations must be larger than 0") : number_of_iterations),
+       max_number_of_progress_prints(max_number_of_progress_prints < 1 ? throw pink::exception("ProgressBar: max number of progress prints must be larger than 0") : max_number_of_progress_prints),
+	   number_of_progress_prints(std::min(number_of_iterations, max_number_of_progress_prints)),
        width(width < number_of_progress_prints ? throw pink::exception("ProgressBar: width must be equal or larger than number of progress prints") : width),
-       number_of_progress_prints(number_of_progress_prints < 1 ? throw pink::exception("ProgressBar: number of progress prints must be larger than 0") : number_of_progress_prints),
        number_of_ticks_in_section(number_of_iterations / number_of_progress_prints),
        remaining_ticks_in_section(number_of_iterations % number_of_progress_prints),
        os(os),
@@ -74,12 +75,15 @@ class ProgressBar
     /// Number_of_iterations
     int number_of_iterations;
 
-    /// Number of characters of progress bar
-    int width;
+    /// Maximal number of progress information prints, must be larger than 0
+    int max_number_of_progress_prints;
 
-    /// Number of progress informations should be printed
+    /// Number of progress informations prints
     int number_of_progress_prints;
 
+    /// Number of characters of progress bar
+    int width;
+
     /// Number of ticks between progress stages
     int number_of_ticks_in_section;