Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r65930 - sandbox/chrono/libs/ratio/doc/html
From: vicente.botet_at_[hidden]
Date: 2010-10-12 16:02:40

Next message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r65931 - in sandbox/chrono/libs/ratio/doc: . html"
Previous message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r65929 - sandbox/chrono/libs/ratio/doc"

Author: viboes
Date: 2010-10-12 16:02:39 EDT (Tue, 12 Oct 2010)
New Revision: 65930
URL: http://svn.boost.org/trac/boost/changeset/65930

Log:
Ratio:
* Update doc after review
Text files modified:
sandbox/chrono/libs/ratio/doc/html/index.html | 1740 +++++++++++----------------------------
1 files changed, 481 insertions(+), 1259 deletions(-)

Modified: sandbox/chrono/libs/ratio/doc/html/index.html
==============================================================================
--- sandbox/chrono/libs/ratio/doc/html/index.html (original)
+++ sandbox/chrono/libs/ratio/doc/html/index.html 2010-10-12 16:02:39 EDT (Tue, 12 Oct 2010)
@@ -1,10 +1,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>Boost.Ratio 0.2.1</title>
+<title>Boost.Ratio 1.0.0</title>
<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Boost.Ratio 0.2.1">
+<link rel="start" href="index.html" title="Boost.Ratio 1.0.0">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -21,7 +21,7 @@
<div class="titlepage">
<div>
<div><h2 class="title">
-<a name="boost_ratio"></a>Boost.Ratio 0.2.1</h2></div>
+<a name="boost_ratio"></a>Boost.Ratio 1.0.0</h2></div>
<div><div class="authorgroup">
<div class="author"><h3 class="author">
Howard Hinnant
@@ -37,7 +37,7 @@
<div>Copyright © 2006 , 2008 Beman Dawes</div>
<div>Copyright © 2009 -2010 Vicente J. Botet Escriba</div>
<div><div class="legalnotice">
-<a name="id4986967"></a>
+<a name="id4946076"></a>
 Distributed under the Boost Software License, Version 1.0. (See accompanying
 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
@@ -53,15 +53,16 @@
<dt>Motivation</dt>
<dt>Description</dt>
</dl></dd>
-<dt> Users'Guide</dt>
+<dt> User's Guide</dt>
<dd><dl>
<dt> Getting Started</dt>
<dt>Tutorial</dt>
-<dt>Examples</dt>
+<dt> Example</dt>
<dt> External Resources</dt>
</dl></dd>
<dt> Reference </dt>
<dd><dl>
+<dt> Header <boost/ratio_fwd.hpp></dt>
<dt> Header <boost/ratio.hpp></dt>
<dt> Header <boost/ratio_io.hpp></dt>
</dl></dd>
@@ -74,9 +75,7 @@
<dt> Appendix D: FAQ</dt>
<dt><a href="index.html#boost_ratio.appendices.acknowledgements"> Appendix E:
 Acknowledgements</a></dt>
-<dt> Appendix F: Tests</dt>
-<dt> Appendix G: Tickets</dt>
-<dt> Appendix H: Future plans</dt>
+<dt> Appendix F: Future Plans</dt>
</dl></dd>
</dl>
</div>
@@ -98,7 +97,7 @@
<dt>Description</dt>
</dl></div>
<a name="boost_ratio.overview.how_to_use_this_documentation"></a><h3>
-<a name="id4948577"></a>
+<a name="id4948627"></a>
 <a href="index.html#boost_ratio.overview.how_to_use_this_documentation">How to Use
 This Documentation</a>
 </h3>
@@ -178,24 +177,23 @@
 with overflow and division by zero protection
 </li>
<li>
- It provides a textual representation of <code class="computeroutput">boost::ratio<N, D></code> in the form of a <code class="computeroutput">std::basic_string</code>.
- Other types such as <code class="computeroutput">boost::duration</code>
- can use these strings to aid in their I/O.
+ It provides a textual representation of <code class="computeroutput">boost::ratio<N, D></code> in the form of a <code class="computeroutput">std::basic_string</code>
+ which can be useful for I/O.
 </li>
</ul></div>
</div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="boost_ratio.users_guide"></a> Users'Guide
+<a name="boost_ratio.users_guide"></a> User's Guide
</h2></div></div></div>
<div class="toc"><dl>
<dt> Getting Started</dt>
<dd><dl><dt><a href="index.html#boost_ratio.users_guide.getting_started.install"> Installing
 Ratio</a></dt></dl></dd>
<dt>Tutorial</dt>
-<dt>Examples</dt>
-<dd><dl><dt>SI-units</dt></dl></dd>
+<dt> Example</dt>
+<dd><dl><dt>SI units</dt></dl></dd>
<dt> External Resources</dt>
</dl></div>
<div class="section" lang="en">
@@ -211,7 +209,7 @@
 Ratio</a>
</h4></div></div></div>
<a name="boost_ratio.users_guide.getting_started.install.getting_boost_ratio_"></a><h5>
-<a name="id4949064"></a>
+<a name="id4987247"></a>
 <a href="index.html#boost_ratio.users_guide.getting_started.install.getting_boost_ratio_">Getting
 Boost.Ratio </a>
 </h5>
@@ -226,7 +224,7 @@
 and follow the instructions there for anonymous SVN access.
 
<a name="boost_ratio.users_guide.getting_started.install.where_to_install_boost_ratio__"></a><h5>
-<a name="id4949134"></a>
+<a name="id4987317"></a>
 <a href="index.html#boost_ratio.users_guide.getting_started.install.where_to_install_boost_ratio__">Where
 to install Boost.Ratio? </a>
 </h5>
@@ -242,7 +240,7 @@
 variable. Any help is welcome.
 
<a name="boost_ratio.users_guide.getting_started.install.building_boost_ratio_"></a><h5>
-<a name="id4949171"></a>
+<a name="id4987354"></a>
 <a href="index.html#boost_ratio.users_guide.getting_started.install.building_boost_ratio_">Building
 Boost.Ratio </a>
 </h5>
@@ -251,7 +249,7 @@
 so no need to compile anything.
 
<a name="boost_ratio.users_guide.getting_started.install.requirements"></a><h5>
-<a name="id4949202"></a>
+<a name="id4987385"></a>
 <a href="index.html#boost_ratio.users_guide.getting_started.install.requirements">Requirements</a>
 </h5>

@@ -292,24 +290,24 @@
</dl>
</div>
<a name="boost_ratio.users_guide.getting_started.install.building_an_executable_that_uses__emphasis_role__bold__boost_ratio__emphasis__"></a><h5>
-<a name="id4949380"></a>
+<a name="id4987563"></a>
 <a href="index.html#boost_ratio.users_guide.getting_started.install.building_an_executable_that_uses__emphasis_role__bold__boost_ratio__emphasis__">Building
 an executable that uses Boost.Ratio </a>
 </h5>

 No link is needed.
 
-<a name="boost_ratio.users_guide.getting_started.install.exceptions_safety_"></a><h5>
-<a name="id4949413"></a>
- <a href="index.html#boost_ratio.users_guide.getting_started.install.exceptions_safety_">Exceptions
+<a name="boost_ratio.users_guide.getting_started.install.exception_safety_"></a><h5>
+<a name="id4987596"></a>
+ <a href="index.html#boost_ratio.users_guide.getting_started.install.exception_safety_">Exception
 safety </a>
 </h5>

- All functions in the library are exception-neutral and provide strong guarantee
- of exception safety as long as the underlying parameters provide it.
+ All functions in the library are exception-neutral, providing the strong
+ exception safety guarantee.
 
<a name="boost_ratio.users_guide.getting_started.install.thread_safety_"></a><h5>
-<a name="id4949441"></a>
+<a name="id4987620"></a>
 <a href="index.html#boost_ratio.users_guide.getting_started.install.thread_safety_">Thread
 safety </a>
 </h5>
@@ -317,13 +315,13 @@
 All functions in the library are thread-unsafe except when noted explicitly.
 
<a name="boost_ratio.users_guide.getting_started.install.tested_compilers_"></a><h5>
-<a name="id4949466"></a>
+<a name="id4987646"></a>
 <a href="index.html#boost_ratio.users_guide.getting_started.install.tested_compilers_">Tested
 compilers </a>
 </h5>

- The implementation will eventually work with most C++03 conforming compilers.
- Current version has been tested on:
+ Boost.Ratio should work with an C++03
+ conforming compiler. The current version has been tested on:
 

 Windows with
@@ -401,20 +399,24 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_ratio.users_guide.tutorial"></a>Tutorial
</h3></div></div></div>
+<a name="boost_ratio.users_guide.tutorial.ratio"></a><h4>
+<a name="id4987811"></a>
+ Ratio
+ </h4>

 <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a>
 is a general purpose utility inspired by Walter Brown allowing one to easily
 and safely compute rational values at compile time. The <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a> class catches all errors (such
- as divide by zero and overflow) at compile time. It is used in the <code class="computeroutput">duration</code> and <code class="computeroutput">time_point</code>
- classes to efficiently create units of time. It can also be used in other
- "quantity" libraries (both std-defined and user-defined), or anywhere
- there is a rational constant which is known at compile time. The use of this
- utility can greatly reduce the chances of run time overflow because the
- <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a>
- (and any ratios resulting from <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ as divide by zero and overflow) at compile time. It is used in the duration
+ and __timepoint_ classes to efficiently
+ create units of time. It can also be used in other "quantity" libraries
+ or anywhere there is a rational constant which is known at compile time.
+ The use of this utility can greatly reduce the chances of run time overflow
+ because the <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ ratio<>"><code class="computeroutput">ratio</code></a> (and any ratios resulting
+ from <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a> arithmetic) are always reduced
 to lowest terms.
 
@@ -422,7 +424,7 @@
 <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a>
 is a template taking two intmax_ts, with the second defaulted to 1. In addition
- to copy constructors and assignement, it only has two public members, both
+ to copy constructors and assignment, it only has two public members, both
 of which are static const intmax_t. One is the numerator of the <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a> and the other is the denominator.
 The <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
@@ -451,7 +453,8 @@
 recognized definitions (in terms of <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a>). This is a tremendous syntactic
 convenience. It will prevent errors in specifying constants as one no longer
- has to double count the number of zeros when trying to write million or billion.
+ has to double count the number of zeros when trying to write millions or
+ billions.
 

 Example:
@@ -464,28 +467,122 @@
 ratio<>"><code class="computeroutput">ratio</code></a><5>, nano>::type _5nano;
// _5nano::num == 1, _5nano::den == 200000000
</pre>
+<a name="boost_ratio.users_guide.tutorial.ratio_i_o"></a><h4>
+<a name="id4942502"></a>
+ Ratio I/O
+ </h4>
+
+ For each <code class="computeroutput">ratio<N, D></code> there exists a <code class="computeroutput">ratio_string<ratio<N,
+ D>,
+ CharT></code>
+ for which you can query two strings: <code class="computeroutput">short_name</code>
+ and <code class="computeroutput">long_name</code>. For those
+ <code class="computeroutput">ratio</code>'s that correspond to
+ an <a href="http://en.wikipedia.org/wiki/SI_prefix#List_of_SI_prefixes" target="_top">SI
+ prefix</a> long_name corresponds to the internationally recognized prefix,
+ stored as a <code class="computeroutput">basic_string<CharT></code>. For example <code class="computeroutput">ratio_string<mega, char>::long_name()</code>
+ returns <code class="computeroutput">string("mega")</code>.
+ For those <code class="computeroutput">ratio</code>'s that correspond
+ to an <a href="http://en.wikipedia.org/wiki/SI_prefix#List_of_SI_prefixes" target="_top">SI
+ prefix</a> <code class="computeroutput">short_name</code>
+ corresponds to the internationally recognized symbol, stored as a <code class="computeroutput">basic_string<CharT></code>.
+ For example <code class="computeroutput">ratio_string<mega, char>::short_name()</code>
+ returns <code class="computeroutput">string("M")</code>.
+ For all other <code class="computeroutput">ratio</code>'s, both
+ <code class="computeroutput">long_name()</code>
+ and <code class="computeroutput">short_name()</code>
+ return a <code class="computeroutput">basic_string</code> containing
+ "[<code class="computeroutput">ratio::num/ratio::den</code>]".
+ 
+
+ <code class="computeroutput">ratio_string<ratio<N, D>, CharT></code> is only defined for four character types:
+ 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="computeroutput">char</code>: UTF-8
+ </li>
+<li>
+ <code class="computeroutput">char16_t</code>: UTF-16
+ </li>
+<li>
+ <code class="computeroutput">char32_t</code>: UTF-32
+ </li>
+<li>
+ <code class="computeroutput">wchar_t</code>: UTF-16 (if wchar_t
+ is 16 bits) or UTF-32
+ </li>
+</ul></div>
+
+ When the character is char, UTF-8 will be used to encode the names. When
+ the character is <code class="computeroutput">char16_t</code>,
+ UTF-16 will be used to encode the names. When the character is <code class="computeroutput">char32_t</code>, UTF-32 will be used to encode
+ the names. When the character is <code class="computeroutput">wchar_t</code>,
+ the encoding will be UTF-16 if <code class="computeroutput">wchar_t</code>
+ is 16 bits, and otherwise UTF-32.
+ 
+
+ The <code class="computeroutput">short_name</code> for micro
+ is defined by Unicode
+ to be U+00B5.
+ 
+
+ Examples:
+ 
+<pre class="programlisting">#include <boost/ratio/ratio_io.hpp>
+#include <iostream>
+
+int main()
+{
+ using namespace std;
+ using namespace boost;
+
+ cout << "ratio_string<deca, char>::long_name() = "
+ << ratio_string<deca, char>::long_name() << '\n';
+ cout << "ratio_string<deca, char>::short_name() = "
+ << ratio_string<deca, char>::short_name() << '\n';
+
+ cout << "ratio_string<giga, char>::long_name() = "
+ << ratio_string<giga, char>::long_name() << '\n';
+ cout << "ratio_string<giga, char>::short_name() = "
+ << ratio_string<giga, char>::short_name() << '\n';
+
+ cout << "ratio_string<ratio<4, 6>, char>::long_name() = "
+ << ratio_string<ratio<4, 6>, char>::long_name() << '\n';
+ cout << "ratio_string<ratio<4, 6>, char>::short_name() = "
+ << ratio_string<ratio<4, 6>, char>::short_name() << '\n';
+}
+</pre>
+
+ The output will be
+ 
+<pre class="programlisting">ratio_string<deca, char>::long_name() = deca
+ratio_string<deca, char>::short_name() = da
+ratio_string<giga, char>::long_name() = giga
+ratio_string<giga, char>::short_name() = G
+ratio_string<ratio<4, 6>, char>::long_name() = [2/3]
+ratio_string<ratio<4, 6>, char>::short_name() = [2/3]
+</pre>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_ratio.users_guide.examples"></a>Examples
+<a name="boost_ratio.users_guide.Examples"></a> Example
</h3></div></div></div>
-<div class="toc"><dl><dt>SI-units</dt></dl></div>
+<div class="toc"><dl><dt>SI units</dt></dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_ratio.users_guide.examples.si_units"></a>SI-units
+<a name="boost_ratio.users_guide.Examples.si_units"></a>SI units
</h4></div></div></div>

- Type-safe "physics" code interoperating with boost::chrono::
- <code class="computeroutput">duration</code> types and taking
- advantage of the boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a> infrastructure and design
+ This example illustrates the use of type-safe physics code interoperating
+ with <code class="computeroutput">boost::chrono::duration</code> types, taking advantage of the
+ Boost.Ratio infrastructure and design
 philosophy.
 

- length - mimics boost::chrono:: <code class="computeroutput">duration</code>
- except restricts representation to double. Uses boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a> facilities for length units
- conversions.
+ Let's start by defining a <code class="computeroutput">length</code>
+ class template that mimics <code class="computeroutput">boost::chrono::duration</code>,
+ which represents a time duration in various units, but restricts the representation
+ to <code class="computeroutput">double</code> and uses Boost.Ratio for length unit conversions:
 
<pre class="programlisting">template <class Ratio>
class length {
@@ -514,21 +611,21 @@
};
</pre>

- Sparse sampling of length units
+ Here's a small sampling of length units:
 
<pre class="programlisting">typedef length<boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><1> > meter; // set meter as "unity"
-typedef length<boost:: <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+typedef length<boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">centi</code></a>> centimeter; // 1/100 meter
-typedef length<boost:: <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+typedef length<boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">kilo</code></a>> kilometer; // 1000 meters
typedef length<boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><254, 10000> > inch; // 254/10000 meters
</pre>

- length takes <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a> instead of two integral
- types so that definitions can be made like so:
+ Note that since <code class="computeroutput">length</code>'s
+ template parameter is actually a generic ratio type, so we can use boost::ratio
+ allowing for more complex length units:
 
<pre class="programlisting">typedef length<boost::ratio_multiply<boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><12>, inch::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
@@ -538,23 +635,23 @@
 ratio<>"><code class="computeroutput">ratio</code></a>>::type> mile; // 5280 feet
</pre>

- Need a floating point definition of seconds
+ Now we need a floating point-based definition of seconds:
 
-<pre class="programlisting">typedef boost::chrono:: <code class="computeroutput">duration</code><double> seconds; // unity
+<pre class="programlisting">typedef boost::chrono::duration<double> seconds; // unity
</pre>

- Demo of (scientific) support for sub-nanosecond resolutions
+ We can even support sub-nanosecond durations:
 
-<pre class="programlisting">typedef boost::chrono:: <code class="computeroutput">duration</code><double, boost:: <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+<pre class="programlisting">typedef boost::chrono::duration<double, boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">pico</code></a>> picosecond; // 10^-12 seconds
-typedef boost::chrono:: <code class="computeroutput">duration</code><double, boost:: <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+typedef boost::chrono::duration<double, boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">femto</code></a>> femtosecond; // 10^-15 seconds
-typedef boost::chrono:: <code class="computeroutput">duration</code><double, boost:: <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+typedef boost::chrono::duration<double, boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">atto</code></a>> attosecond; // 10^-18 seconds
</pre>

- A very brief proof-of-concept for SIUnits-like library. Hard-wired to floating
- point seconds and meters, but accepts other units.
+ Finally, we can write a proof-of-concept of an SI units library, hard-wired
+ for meters and floating point seconds, though it will accept other units:
 
<pre class="programlisting">template <class R1, class R2>
class quantity
@@ -612,7 +709,7 @@
};
</pre>

- Example of SI-Units
+ That allows us to create some useful SI-based unit types:
 
<pre class="programlisting">typedef quantity<boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><0>, boost::<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
@@ -631,7 +728,7 @@
 ratio<>"><code class="computeroutput">ratio</code></a><1> > Acceleration; // meter/second^2
</pre>

- Quantity arithmetics
+ To make quantity useful, we need to be able to do arithmetic:
 
<pre class="programlisting">template <class R1, class R2, class R3, class R4>
quantity<typename boost::ratio_subtract<R1, R3>::type,
@@ -678,7 +775,8 @@
}
</pre>

- Example type-safe physics function
+ With all of the foregoing scaffolding, we can now write an exemplar of
+ a type-safe physics function:
 
<pre class="programlisting">Distance
compute_distance(Speed v0, Time t, Acceleration a)
@@ -687,10 +785,11 @@
}
</pre>

- Exercise example type-safe physics function and show interoperation of
- custom time durations (User1::seconds) and standard time durations (boost::hours).
- Though input can be arbitrary (but type-safe) units, output is always in
- SI-units (a limitation of the simplified Units lib demoed here).
+ Finally, we can exercise what we've created, even using custom time durations
+ (<code class="computeroutput">User1::seconds</code>) as well as Boost time durations
+ (<code class="computeroutput">boost::chrono::hours</code>). The input can be in arbitrary,
+ though type-safe, units, the output is always in SI units. (A complete
+ Units library would support other units, of course.)
 
<pre class="programlisting">int main()
{
@@ -712,7 +811,7 @@
 std::cout << "* testUser1 *\n";
 std::cout << "*************\n";
 User1::Distance d( User1::mile(110) );
- User1::Time t( boost::chrono:: <code class="computeroutput">hours</code>(2) );
+ User1::Time t( boost::chrono::__hours__(2) );

 RR r=d / t;
 //r.set(d.get() / t.get());
@@ -744,11 +843,11 @@
 std::cout << "1 second is " << as.count() << " attoseconds\n";
 std::cout << "as = sec; // compiles\n";
 std::cout << "\n";
- return 0;
+ return 0;
}
</pre>

- See the source file test/ratio_test.cpp
+ See the source file example/si_physics.cpp
 
</div>
</div>
@@ -763,9 +862,8 @@
 Standards Committee's current Working Paper</a></dt>
<dd>
 The most authoritative reference material for the library is the C++
- Standards Committee's current Working Paper (WP). 20.9 Time utilities
- "time", 20.4 Compile-time rational arithmetic "ratio",
- 20.6.7 Other transformations "meta.trans.other"
+ Standards Committee's current Working Paper (WP). 20.6 Compile-time
+ rational arithmetic "ratio"
 </dd>
<dt>N2661 - A Foundation to Sleep On</dt>
<dd>
@@ -777,10 +875,6 @@
<dd>
 From Vicente Juan Botet Escriba.
 </dd>
-<dt>N3131: Compile-time rational arithmetic and overflow</dt>
-<dd>
- From Anthony Williams.
- </dd>
</dl>
</div>
</div>
@@ -790,16 +884,17 @@
<a name="boost_ratio.reference"></a> Reference
</h2></div></div></div>
<div class="toc"><dl>
+<dt> Header <boost/ratio_fwd.hpp></dt>
<dt> Header <boost/ratio.hpp></dt>
<dd><dl>
<dt><a href="index.html#boost_ratio.reference.ratio_hpp.conf"> Configuration
- macros</a></dt>
+ Macros</a></dt>
<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio"> Class Template
 <code class="computeroutput">ratio<></code></a></dt>
<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic">
- <code class="computeroutput">ratio</code> arithmetic</a></dt>
+ <code class="computeroutput">ratio</code> Arithmetic</a></dt>
<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison">
- <code class="computeroutput">ratio</code> comparison</a></dt>
+ <code class="computeroutput">ratio</code> Comparison</a></dt>
<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs">
 SI typedefs</a></dt>
<dt><a href="index.html#boost_ratio.reference.ratio_hpp.limitations"> Limitations
@@ -809,111 +904,120 @@
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_ratio.reference.ratio_hpp"></a> Header <boost/ratio.hpp>
+<a name="boost_ratio.reference.ratio_fwdhpp"></a> Header <boost/ratio_fwd.hpp>
</h3></div></div></div>
-<div class="toc"><dl>
-<dt><a href="index.html#boost_ratio.reference.ratio_hpp.conf"> Configuration
- macros</a></dt>
-<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio"> Class Template
- <code class="computeroutput">ratio<></code></a></dt>
-<dd><dl><dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio.ca"> Construction
- and assignment</a></dt></dl></dd>
-<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic">
- <code class="computeroutput">ratio</code> arithmetic</a></dt>
-<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison">
- <code class="computeroutput">ratio</code> comparison</a></dt>
-<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs">
- SI typedefs</a></dt>
-<dt><a href="index.html#boost_ratio.reference.ratio_hpp.limitations"> Limitations
- and Extensions</a></dt>
-</dl></div>

- <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a>
- is a facility which is useful in specifying compile time rational constants.
- Compile time rational arithmetic is supported with protection against overflow
- and divide by zero. Such a facility is very handy when needing to efficiently
- represent 1/3 of a nanosecond, or specifying an inch in terms of meters (for
- example 254/10000 meters - which <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a> will reduce to 127/5000 meters).
+ This header provides forward declarations for the <code class="computeroutput"><boost/ratio.hpp></code>
+ file.
 
-<pre class="programlisting">// configuration macros
-#define <a href="index.html#boost_ratio.reference.ratio_hpp.conf" title=" Configuration
- macros"><code class="computeroutput">BOOST_RATIO_USES_STATIC_ASSERT</code></a>
-#define <a href="index.html#boost_ratio.reference.ratio_hpp.conf" title=" Configuration
- macros"><code class="computeroutput">BOOST_RATIO_USES_MPL_ASSERT</code></a>
-#define <a href="index.html#boost_ratio.reference.ratio_hpp.conf" title=" Configuration
- macros"><code class="computeroutput">BOOST_RATIO_USES_ARRAY_ASSERT</code></a>
-
-namespace boost {
+<pre class="programlisting">namespace boost {

 template <boost::intmax_t N, boost::intmax_t D = 1> class <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a>;

 // ratio arithmetic
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
- ratio arithmetic"><code class="computeroutput">ratio_add</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
- ratio arithmetic"><code class="computeroutput">ratio_subtract</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
- ratio arithmetic"><code class="computeroutput">ratio_multiply</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
- ratio arithmetic"><code class="computeroutput">ratio_divide</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
+ ratio Arithmetic"><code class="computeroutput">ratio_add</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
+ ratio Arithmetic"><code class="computeroutput">ratio_subtract</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
+ ratio Arithmetic"><code class="computeroutput">ratio_multiply</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
+ ratio Arithmetic"><code class="computeroutput">ratio_divide</code></a>;

 // ratio comparison
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
- ratio comparison"><code class="computeroutput">ratio_equal</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
- ratio comparison"><code class="computeroutput">ratio_not_equal</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
- ratio comparison"><code class="computeroutput">ratio_less</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
- ratio comparison"><code class="computeroutput">ratio_less_equal</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
- ratio comparison"><code class="computeroutput">ratio_greater</code></a>;
- template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
- ratio comparison"><code class="computeroutput">ratio_greater_equal</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
+ ratio Comparison"><code class="computeroutput">ratio_equal</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
+ ratio Comparison"><code class="computeroutput">ratio_not_equal</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
+ ratio Comparison"><code class="computeroutput">ratio_less</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
+ ratio Comparison"><code class="computeroutput">ratio_less_equal</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
+ ratio Comparison"><code class="computeroutput">ratio_greater</code></a>;
+ template <class R1, class R2> struct <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
+ ratio Comparison"><code class="computeroutput">ratio_greater_equal</code></a>;

 // convenience SI typedefs
- typedef ratio<1LL, 1000000000000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 1000000000000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">atto</code></a>;
- typedef ratio<1LL, 1000000000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 1000000000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">femto</code></a>;
- typedef ratio<1LL, 1000000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 1000000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">pico</code></a>;
- typedef ratio<1LL, 1000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 1000000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">nano</code></a>;
- typedef ratio<1LL, 1000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 1000000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">micro</code></a>;
- typedef ratio<1LL, 1000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 1000LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">milli</code></a>;
- typedef ratio<1LL, 100LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 100LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">centi</code></a>;
- typedef ratio<1LL, 10LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1LL, 10LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">deci</code></a>;
- typedef ratio< 10LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio< 10LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">deca</code></a>;
- typedef ratio< 100LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio< 100LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">hecto</code></a>;
- typedef ratio< 1000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio< 1000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">kilo</code></a>;
- typedef ratio< 1000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio< 1000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">mega</code></a>;
- typedef ratio< 1000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio< 1000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">giga</code></a>;
- typedef ratio< 1000000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio< 1000000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">tera</code></a>;
- typedef ratio< 1000000000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio< 1000000000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">peta</code></a>;
- typedef ratio<1000000000000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
+ typedef ratio<1000000000000000000LL, 1LL> <a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs" title="
 SI typedefs"><code class="computeroutput">exa</code></a>;
}
</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_ratio.reference.ratio_hpp"></a> Header <boost/ratio.hpp>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="index.html#boost_ratio.reference.ratio_hpp.conf"> Configuration
+ Macros</a></dt>
+<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio"> Class Template
+ <code class="computeroutput">ratio<></code></a></dt>
+<dd><dl><dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio.ca"> Construction
+ and Assignment</a></dt></dl></dd>
+<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic">
+ <code class="computeroutput">ratio</code> Arithmetic</a></dt>
+<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison">
+ <code class="computeroutput">ratio</code> Comparison</a></dt>
+<dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_si_typedefs">
+ SI typedefs</a></dt>
+<dt><a href="index.html#boost_ratio.reference.ratio_hpp.limitations"> Limitations
+ and Extensions</a></dt>
+</dl></div>
+
+ <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ ratio<>"><code class="computeroutput">ratio</code></a>
+ is a facility which is useful in specifying compile time rational constants.
+ Compile time rational arithmetic is supported with protection against overflow
+ and divide by zero. Such a facility is very handy when needing to efficiently
+ represent 1/3 of a nanosecond, or specifying an inch in terms of meters (for
+ example 254/10000 meters - which <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ ratio<>"><code class="computeroutput">ratio</code></a> will reduce to 127/5000 meters).
+ 
+<pre class="programlisting">// configuration macros
+#define <a href="index.html#boost_ratio.reference.ratio_hpp.conf" title=" Configuration
+ Macros"><code class="computeroutput">BOOST_RATIO_USES_STATIC_ASSERT</code></a>
+#define <a href="index.html#boost_ratio.reference.ratio_hpp.conf" title=" Configuration
+ Macros"><code class="computeroutput">BOOST_RATIO_USES_MPL_ASSERT</code></a>
+#define <a href="index.html#boost_ratio.reference.ratio_hpp.conf" title=" Configuration
+ Macros"><code class="computeroutput">BOOST_RATIO_USES_ARRAY_ASSERT</code></a>
+</pre>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_ratio.reference.ratio_hpp.conf"></a><a href="index.html#boost_ratio.reference.ratio_hpp.conf" title=" Configuration
- macros"> Configuration
- macros</a>
+ Macros"> Configuration
+ Macros</a>
</h4></div></div></div>

 When BOOST_NO_STATIC_ASSERT is defined, the user can select the way static
@@ -921,35 +1025,34 @@
 
<div class="itemizedlist"><ul type="disc">
<li>
- BOOST_RATIO_USES_STATIC_ASSERT: define it if you want to use Boost.StaticAssert
+ BOOST_RATIO_USES_STATIC_ASSERT to use Boost.StaticAssert
 </li>
<li>
- BOOST_RATIO_USES_MPL_ASSERT: define it if you want to use Boost.MPL
- static asertions
+ BOOST_RATIO_USES_MPL_ASSERT to use Boost.MPL static assertions
 </li>
<li>
- BOOST_RATIO_USES_ARRAY_ASSERT: define it if you want to use internal
- static asertions
+ BOOST_RATIO_USES_RATIO_ASSERT to use Boost.Ratio
+ static assertions
 </li>
</ul></div>

- The default behavior is as BOOST_RATIO_USES_ARRAY_ASSERT was defined.
+ The default behavior is as if BOOST_RATIO_USES_ARRAY_ASSERT is defined.
 

 When BOOST_RATIO_USES_MPL_ASSERT is not defined the following symbols are
- defined as
+ defined as shown:
 
<pre class="programlisting">#define BOOST_RATIO_OVERFLOW_IN_ADD "overflow in ratio add"
#define BOOST_RATIO_OVERFLOW_IN_SUB "overflow in ratio sub"
#define BOOST_RATIO_OVERFLOW_IN_MUL "overflow in ratio mul"
#define BOOST_RATIO_OVERFLOW_IN_DIV "overflow in ratio div"
-#define BOOST_RATIO_RATIO_NUMERATOR_IS_OUT_OF_RANGE "ratio numerator is out of range"
-#define BOOST_RATIO_RATIO_DIVIDE_BY_0 "ratio divide by 0"
-#define BOOST_RATIO_RATIO_DENOMINATOR_IS_OUT_OF_RANGE "ratio denominator is out of range"
+#define BOOST_RATIO_NUMERATOR_IS_OUT_OF_RANGE "ratio numerator is out of range"
+#define BOOST_RATIO_DIVIDE_BY_0 "ratio divide by 0"
+#define BOOST_RATIO_DENOMINATOR_IS_OUT_OF_RANGE "ratio denominator is out of range"
</pre>

- Depending on the static assertion used system you will have an hint of
- the failing assertion either through the symbol or through the texte.
+ Depending upon the static assertion system used, a hint as to the failing
+ assertion will appear in some form in the compiler diagnostic output.
 
</div>
<div class="section" lang="en">
@@ -959,7 +1062,7 @@
 <code class="computeroutput">ratio<></code></a>
</h4></div></div></div>
<div class="toc"><dl><dt><a href="index.html#boost_ratio.reference.ratio_hpp.ratio.ca"> Construction
- and assignment</a></dt></dl></div>
+ and Assignment</a></dt></dl></div>
<pre class="programlisting">template <boost::intmax_t N, boost::intmax_t D>
class ratio {
public:
@@ -985,10 +1088,11 @@
 In a two's complement representation, this excludes the most negative value.
 

- Let <code class="computeroutput">gcd</code> denote the greatest
- common divisor of <code class="computeroutput">N</code>'s absolute
- value and of <code class="computeroutput">D</code>'s absolute
- value.
+ The members num and den will be normalized values of the template arguments
+ N and D computed as follows. Let <code class="computeroutput">gcd</code>
+ denote the greatest common divisor of <code class="computeroutput">N</code>'s
+ absolute value and of <code class="computeroutput">D</code>'s
+ absolute value. Then:
 
<div class="itemizedlist"><ul type="disc">
<li>
@@ -1004,7 +1108,8 @@
 The nested typedef <code class="computeroutput">type</code>
 denotes the normalized form of this <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a> type. It should be used
- when the template parameters doesn't give a normalized form.
+ when the normalized form of the template arguments are required, since
+ the arguments are not necessarily normalized.
 

 Two <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
@@ -1017,8 +1122,8 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_ratio.reference.ratio_hpp.ratio.ca"></a><a href="index.html#boost_ratio.reference.ratio_hpp.ratio.ca" title=" Construction
- and assignment"> Construction
- and assignment</a>
+ and Assignment"> Construction
+ and Assignment</a>
</h5></div></div></div>
<pre class="programlisting">template <intmax_t N2, intmax_t D2>
 ratio(const <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
@@ -1055,16 +1160,20 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_ratio.reference.ratio_hpp.ratio_arithmetic"></a><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_arithmetic" title="
- ratio arithmetic">
- <code class="computeroutput">ratio</code> arithmetic</a>
+ ratio Arithmetic">
+ <code class="computeroutput">ratio</code> Arithmetic</a>
</h4></div></div></div>

- For each of the class templates in this clause, each template parameter
+ For each of the class templates in this section, each template parameter
 refers to a <code class="computeroutput">ratio</code>. If the
 implementation is unable to form the indicated <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a> due to overflow, a diagnostic
 will be issued.
 
+<a name="boost_ratio.reference.ratio_hpp.ratio_arithmetic._code__phrase_role__identifier__ratio_add__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5007880"></a>
+ ratio_add<>
+ </h5>
<pre class="programlisting">template <class R1, class R2> struct ratio_add {
 typedef [/see below] type;
};
@@ -1074,6 +1183,10 @@
 is a synonym for <code class="computeroutput"><a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><R1::num * R2::den + R2::num * R1::den, R1::den * R2::den>::type</code>.
 
+<a name="boost_ratio.reference.ratio_hpp.ratio_arithmetic._code__phrase_role__identifier__ratio_subtract__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5008186"></a>
+ ratio_subtract<>
+ </h5>
<pre class="programlisting">template <class R1, class R2> struct ratio_subtract {
 typedef [/see below] type;
};
@@ -1083,6 +1196,10 @@
 is a synonym for <code class="computeroutput"><a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><R1::num * R2::den - R2::num * R1::den, R1::den * R2::den>::type</code>.
 
+<a name="boost_ratio.reference.ratio_hpp.ratio_arithmetic._code__phrase_role__identifier__ratio_multiply__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5008492"></a>
+ ratio_multiply<>
+ </h5>
<pre class="programlisting">template <class R1, class R2> struct ratio_multiply {
 typedef [/see below] type;
};
@@ -1092,6 +1209,10 @@
 is a synonym for <code class="computeroutput"><a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><R1::num * R2::num, R1::den * R2::den>::type</code>.
 
+<a name="boost_ratio.reference.ratio_hpp.ratio_arithmetic._code__phrase_role__identifier__ratio_divide__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5008759"></a>
+ ratio_divide<>
+ </h5>
<pre class="programlisting">template <class R1, class R2> struct ratio_divide {
 typedef [/see below] type;
};
@@ -1105,9 +1226,13 @@
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_ratio.reference.ratio_hpp.ratio_comparison"></a><a href="index.html#boost_ratio.reference.ratio_hpp.ratio_comparison" title="
- ratio comparison">
- <code class="computeroutput">ratio</code> comparison</a>
+ ratio Comparison">
+ <code class="computeroutput">ratio</code> Comparison</a>
</h4></div></div></div>
+<a name="boost_ratio.reference.ratio_hpp.ratio_comparison._code__phrase_role__identifier__ratio_equal__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5009054"></a>
+ ratio_equal<>
+ </h5>
<pre class="programlisting">template <class R1, class R2> struct ratio_equal
 : public boost::integral_constant<bool, [/see below] > {};
</pre>
@@ -1115,6 +1240,17 @@
 If R1::num <code class="literal">= R2::num && R1::den =</code> R2::den, ratio_equal
 derives from true_type, else derives from false_type.
 
+<a name="boost_ratio.reference.ratio_hpp.ratio_comparison._code__phrase_role__identifier__ratio_not_equal__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5009237"></a>
+ ratio_not_equal<>
+ </h5>
+<pre class="programlisting">template <class R1, class R2> struct ratio_not_equal
+ : public boost::integral_constant<bool, !ratio_equal<R1, R2>::value> {};
+</pre>
+<a name="boost_ratio.reference.ratio_hpp.ratio_comparison._code__phrase_role__identifier__ratio_less__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5009426"></a>
+ ratio_less<>
+ </h5>
<pre class="programlisting">template <class R1, class R2>
struct ratio_less
 : public boost::integral_constant<bool, [/see below] > {};
@@ -1123,16 +1259,25 @@
 If R1::num * R2::den < R2::num * R1::den, ratio_less derives from true_type,
 else derives from false_type.
 
-<pre class="programlisting">template <class R1, class R2> struct ratio_not_equal
- : public boost::integral_constant<bool, !ratio_equal<R1, R2>::value> {};
-
-template <class R1, class R2> struct ratio_less_equal
+<a name="boost_ratio.reference.ratio_hpp.ratio_comparison._code__phrase_role__identifier__ratio_less_equal__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5009605"></a>
+ ratio_less_equal<>
+ </h5>
+<pre class="programlisting">template <class R1, class R2> struct ratio_less_equal
 : public boost::integral_constant<bool, !ratio_less<R2, R1>::value> {};
-
-template <class R1, class R2> struct ratio_greater
+</pre>
+<a name="boost_ratio.reference.ratio_hpp.ratio_comparison._code__phrase_role__identifier__ratio_greater__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5009794"></a>
+ ratio_greater<>
+ </h5>
+<pre class="programlisting">template <class R1, class R2> struct ratio_greater
 : public boost::integral_constant<bool, ratio_less<R2, R1>::value> {};
-
-template <class R1, class R2> struct ratio_greater_equal
+</pre>
+<a name="boost_ratio.reference.ratio_hpp.ratio_comparison._code__phrase_role__identifier__ratio_greater_equal__phrase__phrase_role__special___lt__gt___phrase___code_"></a><h5>
+<a name="id5009980"></a>
+ ratio_greater_equal<>
+ </h5>
+<pre class="programlisting">template <class R1, class R2> struct ratio_greater_equal
 : public boost::integral_constant<bool, !ratio_less<R1, R2>::value> {};
</pre>
</div>
@@ -1142,6 +1287,13 @@
 SI typedefs">
 SI typedefs</a>
</h4></div></div></div>
+
+ The <a href="http://en.wikipedia.org/wiki/SI_prefix#List_of_SI_prefixes" target="_top">International
+ System of Units</a> specifies twenty SI prefixes. Boost.Ratio
+ defines all except <code class="computeroutput">yocto</code>,
+ <code class="computeroutput">zepto</code>, <code class="computeroutput">zetta</code>,
+ and <code class="computeroutput">yotta</code>
+ 
<pre class="programlisting">// convenience SI typedefs
typedef <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><1LL, 1000000000000000000LL> atto;
@@ -1184,44 +1336,35 @@
 and Extensions</a>
</h4></div></div></div>

- Next follows limitation respect to the C++0x recomendations:
+ The following are limitations of Boost.Ratio relative to the specification
+ in the C++0x draft standard:
 
-<div class="itemizedlist"><ul type="disc"><li>
- Four of the typedefs in the recomendation which can be conditionally
- supported are not supported: <code class="computeroutput">yocto</code>,
- <code class="computeroutput">zepto</code>, <code class="computeroutput">zetta</code> and <code class="computeroutput">yotta</code>.
- </li></ul></div>
-<pre class="programlisting">typedef <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a><1, 1000000000000000000000000> yocto; // conditionally supported
-typedef <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a><1, 1000000000000000000000> zepto; // conditionally supported
-typedef <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a>< 1000000000000000000000, 1> zetta; // conditionally supported
-typedef <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a><1000000000000000000000000, 1> yotta; // conditionally supported
-</pre>
<div class="itemizedlist"><ul type="disc">
<li>
- <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3135.html#1121" target="_top">Ratio
- values should be constexpr</a>: <code class="computeroutput">constexpr</code>
- don't used as no compiler supports it today. <code class="computeroutput">const</code>
- is used instead when appropiated.
+ Four of the SI units typedefs -- <code class="computeroutput">yocto</code>,
+ <code class="computeroutput">zepto</code>, <code class="computeroutput">zetta</code>, and <code class="computeroutput">yotta</code>
+ -- are to be conditionally supported, if the range of <code class="computeroutput">intmax_t</code> allows, but are not supported
+ by Boost.Ratio.
+ </li>
+<li>
+ Ratio values should be of type static <code class="computeroutput">constexpr
+ intmax_t</code> (see <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3135.html#1121" target="_top">Ratio
+ values should be constexpr</a>), but no compiler supports <code class="computeroutput">constexpr</code> today, so Boost.Ratio
+ uses <code class="computeroutput">static const
+ intmax_t</code> instead.
 </li>
<li>
- <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3134.html#921" target="_top">Rational
- Arithmetic should use template aliases</a>: In the absence of compiler
- support of template aliases the C++03 emulation define a nested typedef
- <code class="computeroutput">type</code>.
+ Rational arithmetic should use template aliases (see <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3134.html#921" target="_top">Rational
+ Arithmetic should use template aliases</a>), but those are not
+ available in C++03, so inheritance is used instead.
 </li>
</ul></div>

- The current implementation provides in addition:
+ The current implementation extends the requirements of the C++0x draft
+ standard by making the copy constructor and copy assignment operator have
+ the same normalized form (see <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3133.html#1281" target="_top">copy
+ constructor and assignment between ratios having the same normalized form</a>).
 
-<div class="itemizedlist"><ul type="disc"><li>
- the <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3133.html#1281" target="_top">copy
- constructor and assignement between ratios having the same normalized
- form</a>.
- </li></ul></div>
</div>
</div>
<div class="section" lang="en">
@@ -1229,246 +1372,98 @@
<a name="boost_ratio.reference.ratio_io_hpp"></a> Header <boost/ratio_io.hpp>
</h3></div></div></div>

- It provides a textual representation of <code class="computeroutput">boost::ratio<N,
- D></code>
- in the form of a <code class="computeroutput">std::basic_string</code>. Other types such as <code class="computeroutput">boost::duration</code> can use these strings to aid in
- their I/O.
- 
-
- This source has been adapted from the experimental header <code class="computeroutput"><ratio_io></code>
- from Howard Hinnant. Porting to Boost has been trivial.
+ This header provides <code class="computeroutput">ratio_string<></code> which can generate a textual representation
+ of a <code class="computeroutput">ratio<></code>
+ in the form of a <code class="computeroutput">std::basic_string<></code>.
+ These strings can be useful for I/O."
 
<pre class="programlisting">namespace boost {

 template <class Ratio, class CharT>
 struct ratio_string
 {
- static std::basic_string<CharT> short_name() {return long_name();}
+ static std::basic_string<CharT> short_name();
 static std::basic_string<CharT> long_name();
 };

}
</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_ratio.appendices"></a>Appendices
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt> Appendix A: History</dt>
+<dd><dl><dt>Version 1.0.0, ?? ??, 2010 </dt></dl></dd>
+<dt> Appendix B: Rationale</dt>
+<dt><a href="index.html#boost_ratio.appendices.implementation"> Appendix C: Implementation
+ Notes</a></dt>
+<dt> Appendix D: FAQ</dt>
+<dt><a href="index.html#boost_ratio.appendices.acknowledgements"> Appendix E:
+ Acknowledgements</a></dt>
+<dt> Appendix F: Future Plans</dt>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_ratio.appendices.history"></a> Appendix A: History
+</h3></div></div></div>
+<div class="toc"><dl><dt>Version 1.0.0, ?? ??, 2010 </dt></dl></div>
+<div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title">
+<a name="boost_ratio.appendices.history.__version_1_0_0_________2010__"></a>Version 1.0.0, ?? ??, 2010
+</h4></div></div></div></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_ratio.appendices.rationale"></a> Appendix B: Rationale
+</h3></div></div></div>
+<a name="boost_ratio.appendices.rationale.why_ratio_needs_copyconstruction_and_assignment_from_ratios_having_the_same_normalized_form"></a><h4>
+<a name="id5011704"></a>
+ <a href="index.html#boost_ratio.appendices.rationale.why_ratio_needs_copyconstruction_and_assignment_from_ratios_having_the_same_normalized_form">Why
+ ratio needs CopyConstruction and Assignment from ratios having the same normalized
+ form</a>
+ </h4>

- For each <code class="computeroutput">ratio<N, D></code> there exists a <code class="computeroutput">ratio_string<ratio<N,
- D>,
- CharT></code>
- for which you can query two strings: <code class="computeroutput">short_name</code>
- and <code class="computeroutput">long_name</code>. For those
- <code class="computeroutput">ratio</code>'s that correspond to
- an <a href="http://en.wikipedia.org/wiki/SI_prefix#List_of_SI_prefixes" target="_top">SI
- prefix</a> long_name corresponds to the internationally recognized prefix,
- stored as a <code class="computeroutput">basic_string<CharT></code>. For example <code class="computeroutput">ratio_string<mega, char>::long_name()</code>
- returns <code class="computeroutput">string("mega")</code>.
- For those <code class="computeroutput">ratio</code>'s that correspond
- to an <a href="http://en.wikipedia.org/wiki/SI_prefix#List_of_SI_prefixes" target="_top">SI
- prefix</a> <code class="computeroutput">short_name</code>
- corresponds to the internationally recognized symbol, stored as a <code class="computeroutput">basic_string<CharT></code>.
- For example <code class="computeroutput">ratio_string<mega, char>::short_name()</code>
- returns <code class="computeroutput">string("M")</code>.
- For all other <code class="computeroutput">ratio</code>'s, both
- <code class="computeroutput">long_name()</code>
- and <code class="computeroutput">short_name()</code>
- return a <code class="computeroutput">basic_string</code> containing
- "[<code class="computeroutput">ratio::num/ratio::den</code>]".
+ Current N3000 doesn't allows to copy-construct or
+ assign ratio instances of ratio classes having the same normalized form.
 

- <code class="computeroutput">ratio_string<ratio<N, D>, CharT></code> is only defined for four character types:
+ This simple example
 
-<div class="itemizedlist"><ul type="disc">
-<li>
- <code class="computeroutput">char</code>
- </li>
-<li>
- <code class="computeroutput">char16_t</code>
- </li>
-<li>
- <code class="computeroutput">char32_t</code>
- </li>
-<li>
- <code class="computeroutput">wchar_t</code>
- </li>
-</ul></div>
+<pre class="programlisting"><a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ ratio<>"><code class="computeroutput">ratio</code></a><1,3> r1;
+<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ ratio<>"><code class="computeroutput">ratio</code></a><3,9> r2;
+r1 = r2; // (1)
+</pre>

- When the character is char, UTF-8 will be used to encode the names. When
- the character is <code class="computeroutput">char16_t</code>,
- UTF-16 will be used to encode the names. When the character is <code class="computeroutput">char32_t</code>, UTF-32 will be used to encode
- the names. When the character is <code class="computeroutput">wchar_t</code>,
- the encoding will be UTF-16 if <code class="computeroutput">wchar_t</code>
- is 16 bits, and otherwise UTF-32.
- 
-
- The <code class="computeroutput">short_name</code> for micro
- is defined by Unicode
- to be U+00B5.
- 
-
- Examples:
- 
-<pre class="programlisting">#include <boost/ratio/ratio_io.hpp>
-#include <iostream>
-
-int main()
-{
- using namespace std;
- using namespace boost;
-
- cout << "ratio_string<deca, char>::long_name() = "
- << ratio_string<deca, char>::long_name() << '\n';
- cout << "ratio_string<deca, char>::short_name() = "
- << ratio_string<deca, char>::short_name() << '\n';
-
- cout << "ratio_string<giga, char>::long_name() = "
- << ratio_string<giga, char>::long_name() << '\n';
- cout << "ratio_string<giga, char>::short_name() = "
- << ratio_string<giga, char>::short_name() << '\n';
-
- cout << "ratio_string<ratio<4, 6>, char>::long_name() = "
- << ratio_string<ratio<4, 6>, char>::long_name() << '\n';
- cout << "ratio_string<ratio<4, 6>, char>::short_name() = "
- << ratio_string<ratio<4, 6>, char>::short_name() << '\n';
-}
-</pre>
-
- The output will be
- 
-<pre class="programlisting">ratio_string<deca, char>::long_name() = deca
-ratio_string<deca, char>::short_name() = da
-ratio_string<giga, char>::long_name() = giga
-ratio_string<giga, char>::short_name() = G
-ratio_string<ratio<4, 6>, char>::long_name() = [2/3]
-ratio_string<ratio<4, 6>, char>::short_name() = [2/3]
-</pre>
-</div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="boost_ratio.appendices"></a>Appendices
-</h2></div></div></div>
-<div class="toc"><dl>
-<dt> Appendix A: History</dt>
-<dd><dl>
-<dt>Version 0.2.1, September 27, 2010 </dt>
-<dt>Version 0.2.0, September 22, 2010 </dt>
-<dt>Version 0.1.0, September 10, 2010 </dt>
-</dl></dd>
-<dt> Appendix B: Rationale</dt>
-<dt><a href="index.html#boost_ratio.appendices.implementation"> Appendix C: Implementation
- Notes</a></dt>
-<dt> Appendix D: FAQ</dt>
-<dt><a href="index.html#boost_ratio.appendices.acknowledgements"> Appendix E:
- Acknowledgements</a></dt>
-<dt> Appendix F: Tests</dt>
-<dd><dl>
-<dt>ratio</dt>
-<dt>comparison</dt>
-<dt>arithmetic</dt>
-</dl></dd>
-<dt> Appendix G: Tickets</dt>
-<dt> Appendix H: Future plans</dt>
-</dl></div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_ratio.appendices.history"></a> Appendix A: History
-</h3></div></div></div>
-<div class="toc"><dl>
-<dt>Version 0.2.1, September 27, 2010 </dt>
-<dt>Version 0.2.0, September 22, 2010 </dt>
-<dt>Version 0.1.0, September 10, 2010 </dt>
-</dl></div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_ratio.appendices.history.__version_0_2_1__september_27__2010__"></a>Version 0.2.1, September 27, 2010
-</h4></div></div></div>
-
- Fixes:
- 
-<div class="itemizedlist"><ul type="disc"><li>
- Removal of LLVM adapted files due to incompatible License issue.
- </li></ul></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_ratio.appendices.history.__version_0_2_0__september_22__2010__"></a>Version 0.2.0, September 22, 2010
-</h4></div></div></div>
-
- Featurs:
- 
-<div class="itemizedlist"><ul type="disc"><li>
- Added ratio_string traits.
- </li></ul></div>
-
- Fixes:
- 
-<div class="itemizedlist"><ul type="disc"><li>
- ratio_less overflow avoided following the algorithm from libc++.
- </li></ul></div>
-
- Test:
- 
-<div class="itemizedlist"><ul type="disc"><li>
- A more complete test has been included adapted from the test of from
- libc++/ratio.
- </li></ul></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_ratio.appendices.history.__version_0_1_0__september_10__2010__"></a>Version 0.1.0, September 10, 2010
-</h4></div></div></div>
-
- Features:
- 
-<div class="itemizedlist"><ul type="disc"><li>
- Ratio has been extracted from Boost.Chrono.
- </li></ul></div>
-</div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_ratio.appendices.rationale"></a> Appendix B: Rationale
-</h3></div></div></div>
-<a name="boost_ratio.appendices.rationale.why_ratio_needs_copyconstruction_and_assignment_from_ratios_having_the_same_normalized_form"></a><h4>
-<a name="id5011468"></a>
- <a href="index.html#boost_ratio.appendices.rationale.why_ratio_needs_copyconstruction_and_assignment_from_ratios_having_the_same_normalized_form">Why
- ratio needs CopyConstruction and Assignment from ratios having the same normalized
- form</a>
- </h4>
-
- Current N3000 doesn't allows to copy-construct or
- assign ratio instances of ratio classes having the same normalized form.
- 
-
- This simple example
- 
-<pre class="programlisting"><a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a><1,3> r1;
-<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
- ratio<>"><code class="computeroutput">ratio</code></a><3,9> r2;
-r1 = r2; // (1)
-</pre>
-
- fails to compile in (1). Other example
+ fails to compile in (1). Other example
 
<pre class="programlisting"><a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><1,3> r1;
-ratio_substract<<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ratio_subtract<<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><2,3>,<a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><1,3> > r2=r1; // (2)
</pre>

- The type of ratiosubstract<ratio<2,3>,ratio_<1,3> > could be <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ The type of ratiosubtract<ratio<2,3>,ratio_<1,3> > could be <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><3,9> so the compilation
 could fail in (2). It could also be <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
 ratio<>"><code class="computeroutput">ratio</code></a><1,3> and the compilation
 succeeds.
 
<a name="boost_ratio.appendices.rationale.why_ratio_needs_the_nested_normalizer_typedef_type"></a><h4>
-<a name="id5011873"></a>
+<a name="id5012108"></a>
 <a href="index.html#boost_ratio.appendices.rationale.why_ratio_needs_the_nested_normalizer_typedef_type">Why
 ratio needs the nested normalizer typedef type</a>
 </h4>

- In N3000 20.4.2 and similar clauses
+ The current resolution of issue LWG 1281 acknowledges the need for a nested
+ type typedef, so Boost.Ratio is tracking the likely final version of std::ratio.
+ 
+
+ [/ In N3000 20.4.2 and similar clauses
 

 3 The nested typedef type shall be a synonym for <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
@@ -1493,6 +1488,13 @@
 ratio<>"><code class="computeroutput">ratio</code></a><3,9>::type r2;
r1 = r2; // compiles as both types are the same.
</pre>
+
+ <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ ratio<>"><code class="computeroutput">ratio</code></a><1,3>::type
+ r1; <a href="index.html#boost_ratio.reference.ratio_hpp.ratio" title=" Class Template
+ ratio<>"><code class="computeroutput">ratio</code></a><3,9>::type
+ r2; r1 = r2; // compiles as both types are the same. ]
+ 
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
@@ -1501,7 +1503,7 @@
 Notes</a>
</h3></div></div></div>
<a name="boost_ratio.appendices.implementation.how_boost_ratio_manage_with_compile_time_rational_arithmetic_overflow_"></a><h4>
-<a name="id5012136"></a>
+<a name="id5012416"></a>
 <a href="index.html#boost_ratio.appendices.implementation.how_boost_ratio_manage_with_compile_time_rational_arithmetic_overflow_">How
 Boost.Ratio manage with compile-time rational arithmetic overflow?</a>
 </h4>
@@ -1524,12 +1526,12 @@
 before doing the product.
 </li>
<li>
- Use some equivalences relations that avoid addition or substraction can
- overflow or underflow.
+ Use some equivalences relations that avoid addition or subtraction that
+ can overflow or underflow.
 </li>
</ul></div>

- Next follows more detail:
+ The following subsections cover each case in more detail.
 

 ratio_add
@@ -1542,48 +1544,52 @@

 either n1*d2+n2*d1 or d1*d2 can overflow.
 
-<pre class="programlisting"> ( (n1 * d2) + (n2 * d1) )
-/ (d1 * d2)
+<pre class="programlisting">( (n1 * d2) + (n2 * d1) )
+--------------------------
+ (d1 * d2)
</pre>

 Dividing by gcd(d1,d2) on both num and den
 
-<pre class="programlisting"> ( (n1 * (d2/gcd(d1,d2))) +
- (n2 * (d1/gcd(d1,d2)))
- )
-/ ((d1 * d2) / gcd(d1,d2))
+<pre class="programlisting">( (n1 * (d2/gcd(d1,d2))) + (n2 * (d1/gcd(d1,d2))) )
+----------------------------------------------------
+ ((d1 * d2) / gcd(d1,d2))
</pre>

 Multipliying and diving by gcd(n1,n2) in numerator
 
-<pre class="programlisting"> ( ((gcd(n1,n2)*(n1/gcd(n1,n2))) * (d2/gcd(d1,d2))) +
- ((gcd(n1,n2)*(n2/gcd(n1,n2))) * (d1/gcd(d1,d2)))
- )
-/ ( (d1 * d2) / gcd(d1,d2) )
+<pre class="programlisting">( ((gcd(n1,n2)*(n1/gcd(n1,n2))) * (d2/gcd(d1,d2))) +
+ ((gcd(n1,n2)*(n2/gcd(n1,n2))) * (d1/gcd(d1,d2)))
+)
+--------------------------------------------------
+ ( (d1 * d2) / gcd(d1,d2) )
</pre>

 Factorizing gcd(n1,n2)
 
-<pre class="programlisting"> ( gcd(n1,n2) *
- ( ((n1/gcd(n1,n2)) * (d2/gcd(d1,d2))) + ((n2/gcd(n1,n2)) * (d1/gcd(d1,d2))) )
- )
-/ ( (d1 * d2) / gcd(d1,d2) )
+<pre class="programlisting">( gcd(n1,n2) *
+ ( ((n1/gcd(n1,n2)) * (d2/gcd(d1,d2))) + ((n2/gcd(n1,n2)) * (</s
pan>d1/gcd(d1,d2))) )
+)
+-------------------------------------------------------------------------------
+ ( (d1 * d2) / gcd(d1,d2) )
</pre>

 Regrouping
 
-<pre class="programlisting"> ( gcd(n1,n2) *
- ( ((n1/gcd(n1,n2)) * (d2/gcd(d1,d2))) + ((n2/gcd(n1,n2)) * (d1/gcd(d1,d2))) )
- )
-/ ( (d1 / gcd(d1,d2)) * d2 )
+<pre class="programlisting">( gcd(n1,n2) *
+ ( ((n1/gcd(n1,n2)) * (d2/gcd(d1,d2))) + ((n2/gcd(n1,n2)) * (</s
pan>d1/gcd(d1,d2))) )
+)
+-------------------------------------------------------------------------------
+ ( (d1 / gcd(d1,d2)) * d2 )
</pre>

 Dividing by (d1 / gcd(d1,d2))
 
-<pre class="programlisting"> ( ( gcd(n1,n2) / (d1 / gcd(d1,d2)) ) *
- ( ((n1/gcd(n1,n2)) * (d2/gcd(d1,d2))) + ((n2/gcd(n1,n2)) * (d1/gcd(d1,d2))) )
- )
-/ d2
+<pre class="programlisting">( ( gcd(n1,n2) / (d1 / gcd(d1,d2)) ) *
+ ( ((n1/gcd(n1,n2)) * (d2/gcd(d1,d2))) + ((n2/gcd(n1,n2)) * (</s
pan>d1/gcd(d1,d2))) )
+)
+-------------------------------------------------------------------------------
+ d2
</pre>

 Dividing by d2
@@ -1613,14 +1619,16 @@

 Dividing by gcc(n1,d2) numerator and denominator
 
-<pre class="programlisting"> (((n1/gcc(n1,d2))*n2)
-/ (d1*(d2/gcc(n1,d2))))
+<pre class="programlisting">(((n1/gcc(n1,d2))*n2)
+---------------------
+(d1*(d2/gcc(n1,d2))))
</pre>

 Dividing by gcc(n2,d1)
 
-<pre class="programlisting"> ((n1/gcc(n1,d2))*(n2/gcc(n2,d1)))
-/ ((d1/gcc(n2,d1))*(d2/gcc(n1,d2)))
+<pre class="programlisting">((n1/gcc(n1,d2))*(n2/gcc(n2,d1)))
+---------------------------------
+((d1/gcc(n2,d1))*(d2/gcc(n1,d2)))
</pre>

 And now all the initial numerator and denominators have been reduced, avoiding
@@ -1989,824 +1997,38 @@
 Terry Golubiewski, Daniel Krugler, Anthony Williams.
 

- Thanks to Adrew Chinoff for his help polishing the documentation.
- 
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_ratio.appendices.tests"></a> Appendix F: Tests
-</h3></div></div></div>
-<div class="toc"><dl>
-<dt>ratio</dt>
-<dt>comparison</dt>
-<dt>arithmetic</dt>
-</dl></div>
-
- In order to test you need to do.
+ The ratio.hpp source has been adapted from the experimental header <code class="computeroutput"><ratio_io></code> from Howard Hinnant.
 
-<pre class="programlisting">bjam libs/ratio/test
-</pre>

- You can also run a specific suite of test by doing
+ Thanks to Adrew Chinoff for his help polishing the documentation.
 
-<pre class="programlisting">cd libs/chrono/test
-bjam ratio
-</pre>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_ratio.appendices.tests._ratio_"></a>ratio
-</h4></div></div></div>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- 
- Name
- 
- </th>
-<th>
- 
- kind
- 
- </th>
-<th>
- 
- Description
- 
- </th>
-<th>
- 
- Result
- 
- </th>
-<th>
- 
- Ticket
- 
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- 
- typedefs.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check the num/den are correct for the predefined typedefs
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check the num/den are correctly simplified
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio1.fail
- 
- </td>
-<td>
- 
- compile-fails
- 
- </td>
-<td>
- 
- The template argument D shall not be zero
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio2.fail
- 
- </td>
-<td>
- 
- compile-fails
- 
- </td>
-<td>
- 
- the absolute values of the template arguments N and D shall be
- representable by type intmax_t
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio3.fail
- 
- </td>
-<td>
- 
- compile-fails
- 
- </td>
-<td>
- 
- the absolute values of the template arguments N and D shall be
- representable by type intmax_t
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-</tbody>
-</table></div>
</div>
<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_ratio.appendices.tests._comparison_"></a>comparison
-</h4></div></div></div>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- 
- Name
- 
- </th>
-<th>
- 
- kind
- 
- </th>
-<th>
- 
- Description
- 
- </th>
-<th>
- 
- Result
- 
- </th>
-<th>
- 
- Ticket
- 
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- 
- ratio_equal.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_equal metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_not_equal.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_not_equal metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_less.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_less metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_less_equal.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_less_equal metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_greater.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_greater metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_greater_equal.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_greater_equal metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_ratio.appendices.tests._arithmetic_"></a>arithmetic
-</h4></div></div></div>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- 
- Name
- 
- </th>
-<th>
- 
- kind
- 
- </th>
-<th>
- 
- Description
- 
- </th>
-<th>
- 
- Result
- 
- </th>
-<th>
- 
- Ticket
- 
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- 
- ratio_add.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_add metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_substract.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_substract metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_multiply.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_multiply metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_divide.pass
- 
- </td>
-<td>
- 
- run
- 
- </td>
-<td>
- 
- check ratio_divide metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_add.fail
- 
- </td>
-<td>
- 
- compile-fails
- 
- </td>
-<td>
- 
- check ratio_add overflow metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_substract.fail
- 
- </td>
-<td>
- 
- compile-fails
- 
- </td>
-<td>
- 
- check ratio_substract underflow metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_multiply.fail
- 
- </td>
-<td>
- 
- compile-fails
- 
- </td>
-<td>
- 
- check ratio_multiply overflow metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- ratio_divide.fail
- 
- </td>
-<td>
- 
- compile-fails
- 
- </td>
-<td>
- 
- check ratio_divide overflow metafunction class
- 
- </td>
-<td>
- 
- Pass
- 
- </td>
-<td>
- 
- #
- 
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-</div>
-<div class="section" lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_ratio.appendices.tickets"></a> Appendix G: Tickets
-</h3></div></div></div>
-<div class="informaltable"><table class="table">
-<colgroup>
-<col>
-<col>
-<col>
-<col>
-</colgroup>
-<thead><tr>
-<th>
- 
- Ticket
- 
- </th>
-<th>
- 
- Description
- 
- </th>
-<th>
- 
- Resolution
- 
- </th>
-<th>
- 
- State
- 
- </th>
-</tr></thead>
-<tbody>
-<tr>
-<td>
- 
- 1
- 
- </td>
-<td>
- 
- result of metafunctions ratio_multiply and ratio_divide were not
- normalized ratios
- 
- </td>
-<td>
- 
- Use of the nested ratio typedef type on ratio arithmetic operations.
- 
- </td>
-<td>
- 
- Closed
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- 2
- 
- </td>
-<td>
- 
- INTMAX_C is not always defined
- 
- </td>
-<td>
- 
- Replace INTMAX_C by BOOST_INTMAX_C until boost/cstdint.hpp ensures
- INTMAX_C is always defined.
- 
- </td>
-<td>
- 
- Closed
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- 3
- 
- </td>
-<td>
- 
- MSVC reports a warning instead of an error when there is an integral
- constant overflow
- 
- </td>
-<td>
- 
- manage with MSVC reporting a warning instead of an error when there
- is an integral constant overflow
- 
- </td>
-<td>
- 
- Closed
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- 4
- 
- </td>
-<td>
- 
- ration_less overflow on cases where it can be avoided
- 
- </td>
-<td>
- 
- Change the algorithm as implemented in libc++
- 
- </td>
-<td>
- 
- Closed
- 
- </td>
-</tr>
-</tbody>
-</table></div>
-</div>
-
- [
- 
-<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
-<a name="boost_ratio.appendices.todo"></a> Appendix H: Future plans
+<a name="boost_ratio.appendices.todo"></a> Appendix F: Future Plans
</h3></div></div></div>
<a name="boost_ratio.appendices.todo.for_later_releases"></a><h4>
-<a name="id5017777"></a>
+<a name="id5016748"></a>
 <a href="index.html#boost_ratio.appendices.todo.for_later_releases">For later
 releases</a>
 </h4>
-
- Implement <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3135.html#3135" target="_top">multiple
- arguments</a> ratio arithmetic.
- 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Use constexpr on compiler providing it
+ </li>
+<li>
+ Use template aliases on compiler providing it
+ </li>
+<li>
+ Implement <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2010/n3135.html#3135" target="_top">multiple
+ arguments</a> ratio arithmetic.
+ </li>
+</ul></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: September 27, 2010 at 18:56:54 GMT</td>
+<td align="left">Last revised: October 12, 2010 at 19:59:00 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Next message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r65931 - in sandbox/chrono/libs/ratio/doc: . html"
Previous message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r65929 - sandbox/chrono/libs/ratio/doc"

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