Add nthroot function
[scilab.git] / scilab / modules / elementary_functions / help / en_US / nthroot.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  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="nthroot" xml:lang="en">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>nthroot</refname>
19     <refpurpose>Real nth root of real numbers</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>y=ntrhoot(x,n)</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Arguments</title>
27     <variablelist>
28       <varlistentry>
29         <term>x</term>
30         <listitem>
31           <para>real scalar or vector/matrix</para>
32         </listitem>
33       </varlistentry>
34     </variablelist>
35         <variablelist>
36       <varlistentry>
37         <term>n</term>
38         <listitem>
39           <para>real scalar</para>
40         </listitem>
41       </varlistentry>
42     </variablelist>
43   </refsection>
44   <refsection>
45     <title>Description</title>
46     <para>
47       <literal>nthroot(x,n)</literal> is the real vector/matrix of the nth root of the
48       <literal>x</literal> elements. If <literal>x</literal> has negative elements, <literal>n</literal> must be an odd.
49     </para>
50   </refsection>
51   <refsection>
52     <title>Examples</title>
53     <programlisting role="example"><![CDATA[ 
54         nthroot(2,3)    
55         nthroot(-2,3)   
56         nthroot(-2,-3)
57         nthroot(2,-3)
58  ]]></programlisting>
59   </refsection>
60   <refsection role="see also">
61     <title>See Also</title>
62     <simplelist type="inline">
63       <member>
64         <link linkend="hat">hat</link>
65       </member>
66           <member>
67         <link linkend="sqrt">sqrt</link>
68       </member>
69       <member>
70         <link linkend="sqrtm">sqrtm</link>
71       </member>
72     </simplelist>
73   </refsection>
74 </refentry>