diff options
Diffstat (limited to 'libs/math/doc/html/math_toolkit/jacobi/jacobi_cs.html')
| -rw-r--r-- | libs/math/doc/html/math_toolkit/jacobi/jacobi_cs.html | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/libs/math/doc/html/math_toolkit/jacobi/jacobi_cs.html b/libs/math/doc/html/math_toolkit/jacobi/jacobi_cs.html new file mode 100644 index 0000000000..d2a9812b99 --- /dev/null +++ b/libs/math/doc/html/math_toolkit/jacobi/jacobi_cs.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Jacobi Elliptic Function cs</title> +<link rel="stylesheet" href="../../math.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="../../index.html" title="Math Toolkit 2.1.0"> +<link rel="up" href="../jacobi.html" title="Jacobi Elliptic Functions"> +<link rel="prev" href="jacobi_cn.html" title="Jacobi Elliptic Function cn"> +<link rel="next" href="jacobi_dc.html" title="Jacobi Elliptic Function dc"> +</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="jacobi_cn.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_dc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="math_toolkit.jacobi.jacobi_cs"></a><a class="link" href="jacobi_cs.html" title="Jacobi Elliptic Function cs">Jacobi Elliptic Function + cs</a> +</h3></div></div></div> +<h5> +<a name="math_toolkit.jacobi.jacobi_cs.h0"></a> + <span class="phrase"><a name="math_toolkit.jacobi.jacobi_cs.synopsis"></a></span><a class="link" href="jacobi_cs.html#math_toolkit.jacobi.jacobi_cs.synopsis">Synopsis</a> + </h5> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</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">></span> +</pre> +<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> + + <span class="keyword">template</span> <span class="special"><</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> + <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_cs</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">template</span> <span class="special"><</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">></span> + <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_cs</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">&</span> <span class="identifier">pol</span><span class="special">);</span> + +<span class="special">}}</span> <span class="comment">// namespaces</span> +</pre> +<h5> +<a name="math_toolkit.jacobi.jacobi_cs.h1"></a> + <span class="phrase"><a name="math_toolkit.jacobi.jacobi_cs.description"></a></span><a class="link" href="jacobi_cs.html#math_toolkit.jacobi.jacobi_cs.description">Description</a> + </h5> +<p> + This function returns the Jacobi elliptic function <span class="emphasis"><em>cs</em></span>. + </p> +<p> + The final <a class="link" href="../../policy.html" title="Chapter 14. Policies: Controlling Precision, Error Handling etc">Policy</a> argument is optional and can + be used to control the behaviour of the function: how it handles errors, + what level of precision to use etc. Refer to the <a class="link" href="../../policy.html" title="Chapter 14. Policies: Controlling Precision, Error Handling etc">policy + documentation for more details</a>. + </p> +<p> + This function is a trivial wrapper around <a class="link" href="jacobi_elliptic.html" title="Jacobi Elliptic SN, CN and DN">jacobi_elliptic</a>, + with: + </p> +<p> + <span class="emphasis"><em>cs(u, k) = cn(u, k) / sn(u, k)</em></span> + </p> +<p> + <span class="inlinemediaobject"><img src="../../../graphs/jacobi_cs.png" align="middle"></span> + </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-2014 Nikhar Agrawal, + Anton Bikineev, Paul A. Bristow, Marco Guazzone, 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="jacobi_cn.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_dc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |