• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Jacobi Elliptic Function ns</title>
5<link rel="stylesheet" href="../../math.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../index.html" title="Math Toolkit 2.12.0">
8<link rel="up" href="../jacobi.html" title="Jacobi Elliptic Functions">
9<link rel="prev" href="jacobi_nd.html" title="Jacobi Elliptic Function nd">
10<link rel="next" href="jacobi_sc.html" title="Jacobi Elliptic Function sc">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="jacobi_nd.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../jacobi.html"><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="jacobi_sc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h3 class="title">
27<a name="math_toolkit.jacobi.jacobi_ns"></a><a class="link" href="jacobi_ns.html" title="Jacobi Elliptic Function ns">Jacobi Elliptic Function
28      ns</a>
29</h3></div></div></div>
30<h5>
31<a name="math_toolkit.jacobi.jacobi_ns.h0"></a>
32        <span class="phrase"><a name="math_toolkit.jacobi.jacobi_ns.synopsis"></a></span><a class="link" href="jacobi_ns.html#math_toolkit.jacobi.jacobi_ns.synopsis">Synopsis</a>
33      </h5>
34<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">math</span><span class="special">/</span><span class="identifier">special_functions</span><span class="special">/</span><span class="identifier">jacobi_elliptic</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
35</pre>
36<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">math</span> <span class="special">{</span>
37
38 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">&gt;</span>
39 <a class="link" href="../result_type.html" title="Calculation of the Type of the Result"><span class="emphasis"><em>calculated-result-type</em></span></a> <span class="identifier">jacobi_ns</span><span class="special">(</span><span class="identifier">T</span> <span class="identifier">k</span><span class="special">,</span> <span class="identifier">U</span> <span class="identifier">u</span><span class="special">);</span>
40
41 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Policy</span><span class="special">&gt;</span>
42 <a class="link" href="../result_type.html" title="Calculation of the Type of the Result"><span class="emphasis"><em>calculated-result-type</em></span></a> <span class="identifier">jacobi_ns</span><span class="special">(</span><span class="identifier">T</span> <span class="identifier">k</span><span class="special">,</span> <span class="identifier">U</span> <span class="identifier">u</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Policy</span><span class="special">&amp;</span> <span class="identifier">pol</span><span class="special">);</span>
43
44<span class="special">}}</span> <span class="comment">// namespaces</span>
45</pre>
46<h5>
47<a name="math_toolkit.jacobi.jacobi_ns.h1"></a>
48        <span class="phrase"><a name="math_toolkit.jacobi.jacobi_ns.description"></a></span><a class="link" href="jacobi_ns.html#math_toolkit.jacobi.jacobi_ns.description">Description</a>
49      </h5>
50<p>
51        This function returns the Jacobi elliptic function <span class="emphasis"><em>ns</em></span>.
52      </p>
53<p>
54        The final <a class="link" href="../../policy.html" title="Chapter 21. Policies: Controlling Precision, Error Handling etc">Policy</a> argument is optional and can
55        be used to control the behaviour of the function: how it handles errors,
56        what level of precision to use etc. Refer to the <a class="link" href="../../policy.html" title="Chapter 21. Policies: Controlling Precision, Error Handling etc">policy
57        documentation for more details</a>.
58      </p>
59<p>
60        This function is a trivial wrapper around <a class="link" href="jacobi_elliptic.html" title="Jacobi Elliptic SN, CN and DN">jacobi_elliptic</a>,
61        with:
62      </p>
63<div class="blockquote"><blockquote class="blockquote"><p>
64          <span class="serif_italic"><span class="emphasis"><em>ns(u, k) = 1 / sn(u, k)</em></span></span>
65        </p></blockquote></div>
66<div class="blockquote"><blockquote class="blockquote"><p>
67          <span class="inlinemediaobject"><img src="../../../graphs/jacobi_ns.svg" align="middle"></span>
68
69        </p></blockquote></div>
70</div>
71<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
72<td align="left"></td>
73<td align="right"><div class="copyright-footer">Copyright © 2006-2019 Nikhar
74      Agrawal, Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos,
75      Hubert Holin, Bruno Lalande, John Maddock, Jeremy Murphy, Matthew Pulver, Johan
76      Råde, Gautam Sewani, Benjamin Sobotta, Nicholas Thompson, Thijs van den Berg,
77      Daryle Walker and Xiaogang Zhang<p>
78        Distributed under the Boost Software License, Version 1.0. (See accompanying
79        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>)
80      </p>
81</div></td>
82</tr></table>
83<hr>
84<div class="spirit-nav">
85<a accesskey="p" href="jacobi_nd.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../jacobi.html"><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="jacobi_sc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
86</div>
87</body>
88</html>
89