1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../css/manpage.css" type="text/css" />
7<title>Clamp</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/math/Overview.html">math</a>::Clamp</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14template &lt;typename T&gt;
15T Clamp(
16     T x,
17     T low,
18     T high
19);
20</pre>
21    </div>
22<h2>Template Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<th>T</th>
33<td>Type representing a numerical value.</td>
34        </tr> </table>
35    </div>
36<h2>Parameters</h2>
37    <div class="section">
38      <table class="arguments">
39        <thead>
40          <tr>
41            <td width="15" />
42<th>Name</th>
43<td>Description</td>
44          </tr>
45        </thead>
46        <tr>
47<td>in</td>
48<th>x</th>
49<td>Value to operate on.</td>
50        </tr>
51        <tr>
52<td>in</td>
53<th>low</th>
54<td>Low threshold value.</td>
55        </tr>
56        <tr>
57<td>in</td>
58<th>high</th>
59<td>High threshold value.</td>
60        </tr> </table>
61    </div>
62<h2>Return Values</h2>
63<div class="section">If <SPAN class="argument">x</SPAN> is in the [<SPAN class="argument">low</SPAN>, <SPAN class="argument">high</SPAN>] range, this function returns <SPAN class="argument">x</SPAN>; if <SPAN class="argument">x</SPAN> is outside the range, this function returns either <SPAN class="argument">low</SPAN> or <SPAN class="argument">high</SPAN>. </div>
64<h2>Description</h2>
65    <div class="section">
66<p>Clamps a value to the specified range.</p><p>If <SPAN class="argument">x</SPAN> is not between <SPAN class="argument">low</SPAN> and <SPAN class="argument">high</SPAN>, this function returns the value (either <SPAN class="argument">low</SPAN> or <SPAN class="argument">high</SPAN>) that is closer to <SPAN class="argument">x</SPAN>.</p><!-- write here --></div>
67<h2>Revision History</h2>
68    <div class="section">
69      <dl class="history">
70        <dt>2011/03/01</dt>
71<dd>Initial version.<br />
72        </dd>
73      </dl>
74    </div>
75  <hr><p>CONFIDENTIAL</p></body>
76</html>
77