mirror of
https://github.com/boostorg/math.git
synced 2026-01-30 08:02:11 +00:00
67 lines
4.9 KiB
HTML
67 lines
4.9 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>GCD Function Object</title>
|
|
<link rel="stylesheet" href="../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
|
<link rel="home" href="../index.html" title="Math Toolkit">
|
|
<link rel="up" href="../gcd_lcm.html" title="Chapter 10. Integer Utilities (Greatest Common Divisor and Least Common Multiple)">
|
|
<link rel="prev" href="synopsis1.html" title="Synopsis">
|
|
<link rel="next" href="lcm_function_object.html" title="LCM Function Object">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="synopsis1.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../gcd_lcm.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="lcm_function_object.html"><img src="../images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section math_toolkit_gcd_function_object">
|
|
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
|
<a name="math_toolkit.gcd_function_object"></a><a class="link" href="gcd_function_object.html" title="GCD Function Object">GCD Function Object</a>
|
|
</h2></div></div></div>
|
|
<p>
|
|
<span class="bold"><strong>Header: </strong></span> <a href="../../../../boost/math/common_factor_rt.hpp" target="_top"><boost/math/common_factor_rt.hpp></a>
|
|
</p>
|
|
<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">IntegerType</span> <span class="special">></span>
|
|
<span class="keyword">class</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">math</span><span class="special">::</span><span class="identifier">gcd_evaluator</span>
|
|
<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="identifier">IntegerType</span> <span class="identifier">result_type</span><span class="special">;</span>
|
|
<span class="keyword">typedef</span> <span class="identifier">IntegerType</span> <span class="identifier">first_argument_type</span><span class="special">;</span>
|
|
<span class="keyword">typedef</span> <span class="identifier">IntegerType</span> <span class="identifier">second_argument_type</span><span class="special">;</span>
|
|
|
|
<span class="comment">// Function object interface</span>
|
|
<span class="identifier">result_type</span> <span class="keyword">operator</span> <span class="special">()(</span> <span class="identifier">first_argument_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">a</span><span class="special">,</span>
|
|
<span class="identifier">second_argument_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="identifier">b</span> <span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
|
|
<span class="special">};</span>
|
|
</pre>
|
|
<p>
|
|
The boost::math::gcd_evaluator class template defines a function object class
|
|
to return the greatest common divisor of two integers. The template is parameterized
|
|
by a single type, called IntegerType here. This type should be a numeric type
|
|
that represents integers. The result of the function object is always nonnegative,
|
|
even if either of the operator arguments is negative.
|
|
</p>
|
|
<p>
|
|
This function object class template is used in the corresponding version of
|
|
the GCD function template. If a numeric type wants to customize evaluations
|
|
of its greatest common divisors, then the type should specialize on the gcd_evaluator
|
|
class template.
|
|
</p>
|
|
</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 © 2006-2010, 2012, 2013 Paul A. Bristow, Christopher Kormanyos,
|
|
Hubert Holin, Bruno Lalande, John Maddock, Johan Råde, Gautam Sewani, Benjamin
|
|
Sobotta, Thijs van den Berg, Daryle Walker and Xiaogang Zhang<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="synopsis1.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../gcd_lcm.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="lcm_function_object.html"><img src="../images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|