ceph/src/boost/libs/chrono/doc/stopwatches/description.qbk

   1 [/
   2  / Copyright (c) 2009-20012 Vicente J. Botet Escriba
   3  /
   4  / Distributed under the Boost Software License, Version 1.0. (See accompanying
   5  / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6  /]
   7
   8
   9 [/===================]
  10 [/section Description]
  11 [/===================]
  12
  13
  14 [/ /////////////////////////////////////////////////////
  15 [heading Stopwatch/Stopclocks framework]
  16
  17 On top of the core facilities, __Boost_Chrono provides:
  18
  19 Stopwatches: Some facility to measure elapsed time with the ability to start, stop, suspend, or resume measurement.
  20
  21 * __StrictStopwatch, __Stopwatch, __SuspendableStopwatch concepts.
  22 * __strict_stopwatch, model of __StrictStopwatch capturing elapsed __Clock times.
  23 * __laps_stopwatch, model of __Stopwatch allowing in addition to start and stop the capture of elapsed __Clock times.
  24 * __suspendable_stopwatch, model of __SuspendableStopwatch allowing in addition to suspend and resume the capture of elapsed __Clock times.
  25 * __laps_stopwatch and __suspendable_stopwatch have __LapsCollector template parameter that allows to store information of the samples defined by a cycle start-stop.
  26
  27 Stopclocks: a complete time reporting package that can be invoked in a single line of code.
  28
  29 * __stopwatch_reporter`<__Stopwatch,__Formatter>`, convenient reporting to an output stream (including wide char streams) of the elapsed time of models of __Stopwatch results.
  30 * Some basic __Formatters.
  31 * `__strict_stopclock<__Clock>` shortcut of `__stopwatch_reporter<__strict_stopwatch<__Clock>>`
  32 * `__stopclock<__Clock>` shortcut of `__stopwatch_reporter<__stopwatch<__Clock>>`
  33 * `__suspendable_stopclock<__Clock>` shortcut of `__stopwatch_reporter<__suspendable_stopwatch<__Clock>>`
  34
  35 ] [/////////////////////////////////////////////////////]
  36
  37