Added a Frame per second benchmark metric

Measure of FPS can now be displayed as long as experiment
provides a frame_count() member.

demo/sigmadelta/nt2/sigmadelta_nt2.cpp

@@ -24,6 +24,7 @@
 #include <iostream>
 
 #include <nt2/sdk/bench/benchmark.hpp>
+#include <nt2/sdk/bench/metric/fps.hpp>
 #include <nt2/sdk/bench/metric/cycles_per_element.hpp>
 #include <nt2/sdk/bench/protocol/max_duration.hpp>
 #include <nt2/sdk/bench/setup/geometric.hpp>
@@ -110,6 +111,7 @@ template<typename T> struct sigmadelta_nt2
   }
 
   std::size_t size() const { return size_ * nb_frames; }
+  std::size_t frame_count()  const { return nb_frames; }
 
 private:
   std::size_t height;
@@ -136,5 +138,6 @@ NT2_REGISTER_BENCHMARK( sigmadelta_nt2 )
                                                         , geometric(wmin,wmax,wstep)
                                                         )
                                                   , cycles_per_element<stats::median_>()
+                                                  , fps<stats::median_>()
                                                   );
 }

demo/sigmadelta/scalar/sigmadelta_scalar.cpp

@@ -11,6 +11,7 @@
 #include <iostream>
 
 #include <nt2/sdk/bench/benchmark.hpp>
+#include <nt2/sdk/bench/metric/fps.hpp>
 #include <nt2/sdk/bench/metric/cycles_per_element.hpp>
 #include <nt2/sdk/bench/protocol/max_duration.hpp>
 #include <nt2/sdk/bench/setup/geometric.hpp>
@@ -107,6 +108,7 @@ template<typename T> struct sigmadelta_scalar
   }
 
   std::size_t size() const { return size_ * nb_frames; }
+  std::size_t frame_count()  const { return nb_frames; }
 
   private:
   std::size_t height;
@@ -128,12 +130,13 @@ NT2_REGISTER_BENCHMARK( sigmadelta_scalar )
   std::size_t wmax  = args("wmax", 128);
   std::size_t wstep = args("wstep",  2);
 
-  run_during_with< sigmadelta_scalar<nt2::uint8_t> > ( 1.
+  run_during_with< sigmadelta_scalar<nt2::uint8_t> >( 1.
                                                      , and_( constant( frame )
                                                            , geometric(hmin,hmax,hstep)
                                                            , geometric(wmin,wmax,wstep)
                                                            )
-                                                     , cycles_per_element<stats::median_>()
-                                                     );
+                                                      , cycles_per_element<stats::median_>()
+                                                      , fps<stats::median_>()
+                                                    );
 }
 

demo/sigmadelta/simd/sigmadelta_simd.cpp

@@ -24,6 +24,7 @@
 
 #include <nt2/sdk/bench/benchmark.hpp>
 #include <nt2/sdk/bench/protocol/max_duration.hpp>
+#include <nt2/sdk/bench/metric/fps.hpp>
 #include <nt2/sdk/bench/metric/cycles_per_element.hpp>
 #include <nt2/sdk/bench/stats/median.hpp>
 #include <nt2/sdk/bench/setup/geometric.hpp>
@@ -123,7 +124,8 @@ struct sigmadelta_simd
     return os << "(" << p.height << " x " << p.width << " @" << p.nb_frames << ")";
   }
 
-  std::size_t size() const { return size_ * nb_frames; }
+  std::size_t size()         const { return size_ * nb_frames; }
+  std::size_t frame_count()  const { return nb_frames; }
 
   private:
   std::size_t height;
@@ -150,5 +152,6 @@ NT2_REGISTER_BENCHMARK( sigmadelta_simd )
                                                          , geometric(wmin,wmax,wstep)
                                                          )
                                                    , cycles_per_element<stats::median_>()
+                                                   , fps<stats::median_>()
                                                    );
 }

modules/test/benchmark/include/nt2/sdk/bench/metric/fps.hpp

@@ -0,0 +1,53 @@
+//==============================================================================
+//         Copyright 2009 - 2013 LRI    UMR 8623 CNRS/Univ Paris Sud XI
+//         Copyright 2012 - 2014 MetaScale SAS
+//
+//          Distributed under the Boost Software License, Version 1.0.
+//                 See accompanying file LICENSE.txt or copy at
+//                     http://www.boost.org/LICENSE_1_0.txt
+//==============================================================================
+#ifndef NT2_SDK_BENCH_METRIC_FPS_HPP_INCLUDED
+#define NT2_SDK_BENCH_METRIC_FPS_HPP_INCLUDED
+
+#include <nt2/sdk/bench/details/compute_stat.hpp>
+#include <nt2/sdk/bench/details/measure.hpp>
+#include <nt2/sdk/bench/metric/speedup.hpp>
+#include <nt2/sdk/timing/now.hpp>
+#include <string>
+
+namespace nt2 { namespace bench
+{
+  /*!
+    @brief Frames per second metric
+
+    This metric calculates the FPS of a benchmark.
+
+    @tparam Stat Statistic to compute over the provided samples
+  **/
+  template<typename Stat> struct fps
+  {
+    /// @brief Evaluation of the metric in GFLOPS
+    template<typename Experiment> inline
+    double operator() ( Experiment const& e
+                      , std::string const& name
+                      , nt2::details::times_set const& t
+                      , nt2::details::cycles_set const&
+                      ) const
+    {
+      typedef typename details::compute_state<Stat>::type sc_t;
+
+      double m = e.frame_count() / (sc_t::evaluate(t) * 1e-6);
+      details::measures_map[details::identify_result(name,e,*this)] = m;
+
+      return m;
+    }
+
+    /// @brief Metric display
+    inline std::string unit() const
+    {
+      return "FPS" + Stat::unit();
+    }
+  };
+} }
+
+#endif