blob: 37964a31fcff79cc13b98a56bdfe231362c618cf [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1999-2015 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "Funding Free Software", the Front-Cover
Texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below). A copy of the license is included in the section entitled
"GNU Free Documentation License".
(a) The FSF's Front-Cover Text is:
A GNU Manual
(b) The FSF's Back-Cover Text is:
You have freedom to copy and modify this GNU Manual, like GNU
software. Copies published by the Free Software Foundation raise
funds for GNU development. -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>The GNU Fortran Compiler: NEAREST</title>
<meta name="description" content="The GNU Fortran Compiler: NEAREST">
<meta name="keywords" content="The GNU Fortran Compiler: NEAREST">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Intrinsic-Procedures.html#Intrinsic-Procedures" rel="up" title="Intrinsic Procedures">
<link href="NEW_005fLINE.html#NEW_005fLINE" rel="next" title="NEW_LINE">
<link href="MVBITS.html#MVBITS" rel="prev" title="MVBITS">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="NEAREST"></a>
<div class="header">
<p>
Next: <a href="NEW_005fLINE.html#NEW_005fLINE" accesskey="n" rel="next">NEW_LINE</a>, Previous: <a href="MVBITS.html#MVBITS" accesskey="p" rel="prev">MVBITS</a>, Up: <a href="Intrinsic-Procedures.html#Intrinsic-Procedures" accesskey="u" rel="up">Intrinsic Procedures</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="NEAREST-_002d_002d_002d-Nearest-representable-number"></a>
<h3 class="section">9.195 <code>NEAREST</code> &mdash; Nearest representable number</h3>
<a name="index-NEAREST"></a>
<a name="index-real-number_002c-nearest-different"></a>
<a name="index-floating-point_002c-nearest-different"></a>
<dl compact="compact">
<dt><em>Description</em>:</dt>
<dd><p><code>NEAREST(X, S)</code> returns the processor-representable number nearest
to <code>X</code> in the direction indicated by the sign of <code>S</code>.
</p>
</dd>
<dt><em>Standard</em>:</dt>
<dd><p>Fortran 95 and later
</p>
</dd>
<dt><em>Class</em>:</dt>
<dd><p>Elemental function
</p>
</dd>
<dt><em>Syntax</em>:</dt>
<dd><p><code>RESULT = NEAREST(X, S)</code>
</p>
</dd>
<dt><em>Arguments</em>:</dt>
<dd><table>
<tr><td width="15%"><var>X</var></td><td width="70%">Shall be of type <code>REAL</code>.</td></tr>
<tr><td width="15%"><var>S</var></td><td width="70%">Shall be of type <code>REAL</code> and
not equal to zero.</td></tr>
</table>
</dd>
<dt><em>Return value</em>:</dt>
<dd><p>The return value is of the same type as <code>X</code>. If <code>S</code> is
positive, <code>NEAREST</code> returns the processor-representable number
greater than <code>X</code> and nearest to it. If <code>S</code> is negative,
<code>NEAREST</code> returns the processor-representable number smaller than
<code>X</code> and nearest to it.
</p>
</dd>
<dt><em>Example</em>:</dt>
<dd><div class="smallexample">
<pre class="smallexample">program test_nearest
real :: x, y
x = nearest(42.0, 1.0)
y = nearest(42.0, -1.0)
write (*,&quot;(3(G20.15))&quot;) x, y, x - y
end program test_nearest
</pre></div>
</dd>
</dl>
</body>
</html>