Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r65378 - sandbox/chrono/libs/chrono/doc
From: vicente.botet_at_[hidden]
Date: 2010-09-11 03:14:07

Author: viboes
Date: 2010-09-11 03:14:01 EDT (Sat, 11 Sep 2010)
New Revision: 65378
URL: http://svn.boost.org/trac/boost/changeset/65378

Log:
rename old doc
Added:
   sandbox/chrono/libs/chrono/doc/old_index.html
      - copied unchanged from r65245, /sandbox/chrono/libs/chrono/doc/index.html
Removed:
   sandbox/chrono/libs/chrono/doc/index.html

Deleted: sandbox/chrono/libs/chrono/doc/index.html
==============================================================================
--- sandbox/chrono/libs/chrono/doc/index.html 2010-09-11 03:14:01 EDT (Sat, 11 Sep 2010)
+++ (empty file)
@@ -1,200 +0,0 @@
-<html>
-
-<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
-<meta name="ProgId" content="FrontPage.Editor.Document">
-<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
-<title>Boost System Library</title>
-<link rel="stylesheet" type="text/css" href="../../../doc/html/minimal.css">
-</head>
-
-<body>
-
-<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111">
- <tr>
- <td width="277">
-<a href="../../../index.html">
-<img src="../../../boost.png" alt="boost.png (6897 bytes)" align="middle" width="277" height="86" border="0"></a></td>
- <td width="337" align="middle">
- <font size="7">Chrono Library</font>
- </td>
- </tr>
-</table>
-
-<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%">
- <tr>
- <td>Boost Home    <a href="index.html">
- Library Home</a>    <a href="process_times.html">Process
- Times Docs </a></td>
- </tr>
-</table>
-
-<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" align="right">
- <tr>
- <td width="100%" bgcolor="#D7EEFF" align="center">
- <i><b>Contents</b></i></td>
- </tr>
- <tr>
- <td width="100%" bgcolor="#E8F5FF">
- Introduction<br>
- Getting started<br>
- Caveat emptor<br>
- Examples<br>
- Reference material<br>
- Acknowledgements
- </td>
- </tr>
- <tr>
- <td width="100%" bgcolor="#D7EEFF" align="center">
- <b><i>Headers</i></b></td>
- </tr>
- <tr>
- <td width="100%" bgcolor="#E8F5FF">
- <boost/chrono/chrono.hpp><br>
- <boost/chrono/timer.hpp><br>
- <a href="../../../boost/chrono/process_times.hpp">
- <boost/chrono/process_times.hpp></a><br>
- <boost/ratio.hpp></td>
- </tr>
-</table>
-
-<h2><a name="Introduction">Introduction</a></h2>
-
-<p>The Boost Chrono library provides:</p>
-
-<ul>
- <li> The C++0x Standard Library's time utilities, including:<ul>
- <li>Class template duration</li>
- <li>Class template time_point</li>
- <li>Clocks:<ul>
- <li><code>system_clock</code></li>
- <li><code>monotonic_clock</code></li>
- <li><code>high_resolution_clock</code><br>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- <li>Class template <code>timer</code>, with typedefs:<ul>
- <li><code>system_timer</code></li>
- <li><code>monotonic_timer</code></li>
- <li><code>high_resolution_timer</code><br>
- </li>
- </ul>
- </li>
- <li>Process clocks and timers:<ul>
- <li><code>process_clock</code>, capturing real, user-CPU, and system-CPU
- times.</li>
- <li><code>process_timer</code>, capturing elapsed real, user-CPU, and
- system-CPU times.</li>
- <li><code>run_timer</code>, convenient reporting of <code>process_timer</code>
- results.<br>
- </li>
- </ul>
- </li>
- <li> The C++0x Standard Library's compile-time rational arithmetic.</li>
-</ul>
-
-<p>The implementation will eventually work with most C++03 conforming compilers.
-Initial tests have been run on Windows with VC++ 9.0 SP1 and Intel 11.0, and on
-Ubuntu Linux with GCC 4.2.4.</p>
-
-<h2><a name="Getting-started">Getting started</a></h2>
-
-<p>If all you want to do is to time a program's execution:</p>
-
-<blockquote>
- <pre>#include <boost/chrono/process_times.hpp>
-
-...
-
-// add this in the scope you want to time,
-// at the point you want the timer to start.
-boost::chrono::run_timer rt;</pre>
-</blockquote>
-<p>Here is a complete program (run_timer_example.cpp):</p>
-<blockquote>
- <pre>#include <boost/chrono/process_times.hpp>
-#include <cmath>
-
-int main()
-{
- boost::chrono::run_timer t;
-
- for ( long i = 0; i < 10000000; ++i )
- std::sqrt( 123.456L ); // burn some time
-
- return 0;
-}</pre>
-</blockquote>
-<p>Debug build output was:</p>
-<blockquote>
- <pre>real 0.832s, cpu 0.813s (97.7%), user 0.813s, system 0.000s</pre>
-</blockquote>
-<p>In other words, the program took 0.832 real-time (i.e. wall clock) seconds to
-execute, while the operating system (Windows in this case) charged 0.813 seconds
-of CPU time to the user and 0 seconds to the system. The total CPU time reported
-was 0.813 seconds, and that represented utilization of 97.7% of the real-time
-seconds.</p>
-<h2><a name="Caveat">Caveat</a> emptor</h2>
-<p>The underlying clocks provided by operating systems are subject to many
-seemingly arbitrary policies and implementation irregularities. That's a polite
-way of saying they tend to be flakey, and each operating system or even each
-clock has its own cruel and unusual forms of flakiness. Don't bet the farm on
-their accuracy, unless you have become deeply familiar with exactly what the
-specific operating system is guaranteeing, which is often very little.</p>
-<h2>FAQ</h2>
-<p><b>Why does run_timer only display millisecond place precision when the
-underlying timer has nanosecond precision?</b>  To avoid giving the
-impression of precision where none exists. See Caveat emptor.
-You can always specify additional decimal places if you want to live
-dangerously.</p>
-<p><b>Why does run_timer sometimes report more cpu seconds than real seconds?</b>
-Ask your operating system supplier. The results have been inspected with a
-debugger, and both for Windows and Linux, that's what the OS appears to be
-reporting at times.</p>
-<h2><a name="Examples">Examples</a></h2>
-<ul>
- <li>await_keystroke.cpp - A tiny
- program that times how long until a key is struck.</li>
- <li>time2_demo.cpp - Howard Hinnant's
- original demonstration program.</li>
-</ul>
-<h2><a name="Reference">Reference</a> material</h2>
-<p>The most authoritative reference material for the library is the C++
-Standards Committee's current Working Paper (WP). Found on the
-WG21 web site.</p>
-<p>See sections:</p>
-<ul>
- <li>20.9 Time utilities [time]</li>
- <li>20.4 Compile-time rational arithmetic [ratio]</li>
- <li>20.6.7 Other transformations [meta.trans.other]</li>
-</ul>
-<p>The C++ Standards Committee proposal for the library,
-<a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2661.htm">
-N2661 - A Foundation to Sleep On</a>, is very informative and provides
-motivation for key design decisions.</p>
-<h2><a name="Acknowledgements">Acknowledgements</a></h2>
-<p>The library's code was derived from Howard Hinnant's
-time2_demo prototype. Many thanks to Howard for
-making his code available under the Boost license. The original code was
-modified by Beman Dawes to conform to Boost conventions.</p>
-<p>time2_demo contained this comment:</p>
-<blockquote>
-<p>Much thanks to Andrei Alexandrescu, Walter Brown, Peter Dimov, Jeff Garland,
-Terry Golubiewski, Daniel Krügler, Anthony Williams.</p>
-</blockquote>
-<hr>
-
-<p>Revised
-November 18, 2008 </font>
-</p>
-
-<p>© Copyright Beman Dawes, 2008</p>
-
-<p>Distributed under the Boost Software License, Version 1.0. (See www.boost.org/LICENSE_1_0.txt) </p>
-
-</body>
-
-</html>
\ No newline at end of file

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk