1d28e44869db1cecb8e9b820a1bea3a821e631f5
[scilab.git] / scilab / modules / special_functions / help / en_US / amell.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="amell">
17     <refnamediv>
18         <refname>amell</refname>
19         <refpurpose>Jacobi's am function</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>[sn]=amell(u,k)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>u</term>
30                 <listitem>
31                     <para>real scalar or vector</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>k</term>
36                 <listitem>
37                     <para>scalar</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>sn</term>
42                 <listitem>
43                     <para>real scalar or vector</para>
44                 </listitem>
45             </varlistentry>
46         </variablelist>
47     </refsection>
48     <refsection>
49         <title>Description</title>
50         <para>
51             Computes Jacobi's elliptic function <literal>am(u,k)</literal>
52             where <literal>k</literal> is the parameter and <literal>u</literal> is the argument. If <literal>u</literal>
53             is a vector <literal>sn</literal> is the vector of the (element wise) computed values.
54             Used in function <literal>%sn</literal>.
55         </para>
56     </refsection>
57     <refsection role="see also">
58         <title>See also</title>
59         <simplelist type="inline">
60             <member>
61                 <link linkend="delip">delip</link>
62             </member>
63             <member>
64                 <link linkend="ellipj">ellipj</link>
65             </member>
66             <member>
67                 <link linkend="percentsn">%sn</link>
68             </member>
69         </simplelist>
70     </refsection>
71 </refentry>