<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template static_rational</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_units/Reference.html#header.boost.units.static_rational_hpp" title="Header <boost/units/static_rational.hpp>">
<link rel="prev" href="static_abs.html" title="Struct template static_abs">
<link rel="next" href="power_ty_idm45506851137248.html" title="Struct template power_typeof_helper<unit< Dim, System >, static_rational< N, D >>">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="static_abs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.static_rational_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="power_ty_idm45506851137248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.units.static_rational"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template static_rational</span></h2>
<p>boost::units::static_rational</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_units/Reference.html#header.boost.units.static_rational_hpp" title="Header <boost/units/static_rational.hpp>">boost/units/static_rational.hpp</a>>
</span><span class="keyword">template</span><span class="special"><</span><span class="identifier">integer_type</span> N<span class="special">,</span> <span class="identifier">integer_type</span> D <span class="special">=</span> <span class="number">1</span><span class="special">></span>
<span class="keyword">class</span> <a class="link" href="static_rational.html" title="Class template static_rational">static_rational</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.units.static_rational.tag"></a><span class="identifier">tag</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="static_rational.html" title="Class template static_rational">static_rational</a><span class="special"><</span> <span class="identifier">Numerator</span><span class="special">,</span> <span class="identifier">Denominator</span> <span class="special">></span> <a name="boost.units.static_rational.type"></a><span class="identifier">type</span><span class="special">;</span> <span class="comment">// static_rational<N,D> reduced by GCD </span>
<span class="comment">// <a class="link" href="static_rational.html#boost.units.static_rationalconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="static_rational.html#idm45506851146608-bb"><span class="identifier">static_rational</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="static_rational.html#idm45506851150288-bb">public static functions</a></span>
<span class="keyword">static</span> <span class="identifier">integer_type</span> <a class="link" href="static_rational.html#idm45506851149728-bb"><span class="identifier">numerator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">integer_type</span> <a class="link" href="static_rational.html#idm45506851148608-bb"><span class="identifier">denominator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// public data members</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">integer_type</span> <span class="identifier">Numerator</span><span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">integer_type</span> <span class="identifier">Denominator</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idm45555056212368"></a><h2>Description</h2>
<p>This is an implementation of a compile time rational number, where <code class="computeroutput">static_rational<N,D></code> represents a rational number with numerator <code class="computeroutput">N</code> and denominator <code class="computeroutput">D</code>. Because of the potential for ambiguity arising from multiple equivalent values of <code class="computeroutput"><a class="link" href="static_rational.html" title="Class template static_rational">static_rational</a></code> (e.g. <code class="computeroutput">static_rational<6,2>==static_rational<3></code>), static rationals should always be accessed through <code class="computeroutput">static_rational<N,D>::type</code>. Template specialization prevents instantiation of zero denominators (i.e. <code class="computeroutput">static_rational<N,0></code>). The following compile-time arithmetic operators are provided for <a class="link" href="static_rational.html" title="Class template static_rational">static_rational</a> variables only (no operators are defined between long and <a class="link" href="static_rational.html" title="Class template static_rational">static_rational</a>):</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><code class="computeroutput">mpl::negate</code> </p></li>
<li class="listitem"><p><code class="computeroutput">mpl::plus</code> </p></li>
<li class="listitem"><p><code class="computeroutput">mpl::minus</code> </p></li>
<li class="listitem"><p><code class="computeroutput">mpl::times</code> </p></li>
<li class="listitem"><p><code class="computeroutput">mpl::divides</code> </p></li>
</ul></div>
<p>
</p>
<p>Neither <code class="computeroutput"><a class="link" href="static_power.html" title="Struct template static_power">static_power</a></code> nor <code class="computeroutput"><a class="link" href="static_root.html" title="Struct template static_root">static_root</a></code> are defined for <code class="computeroutput"><a class="link" href="static_rational.html" title="Class template static_rational">static_rational</a></code>. This is because template types may not be floating point values, while powers and roots of rational numbers can produce floating point values. </p>
<div class="refsect2">
<a name="idm45555056194656"></a><h3>
<a name="boost.units.static_rationalconstruct-copy-destruct"></a><code class="computeroutput">static_rational</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45506851146608-bb"></a><span class="identifier">static_rational</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
</div>
<div class="refsect2">
<a name="idm45555056188720"></a><h3>
<a name="idm45506851150288-bb"></a><code class="computeroutput">static_rational</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">integer_type</span> <a name="idm45506851149728-bb"></a><span class="identifier">numerator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">integer_type</span> <a name="idm45506851148608-bb"></a><span class="identifier">denominator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2008 Matthias Christian Schabel<br>Copyright © 2007-2010 Steven
Watanabe<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="static_abs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.static_rational_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="power_ty_idm45506851137248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
