Revision of help pages for imult function.
[scilab.git] / scilab / modules / elementary_functions / help / en_US / complex / imult.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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" xmlns:scilab="http://www.scilab.org" xml:id="imult" xml:lang="en">
3     <refnamediv>
4         <refname>imult</refname>
5         <refpurpose>multiplication by i the imaginary unitary</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>y = imult(x)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>x</term>
16                 <listitem>
17                     <para>real or complex scalar, vector or matrix</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>y</term>
22                 <listitem>
23                     <para>complex scalar, vector or matrix</para>
24                 </listitem>
25             </varlistentry>
26         </variablelist>
27     </refsection>
28     <refsection>
29         <title>Description</title>
30         <para>
31             <code>imult(x)</code> is a more efficient way to multiply <varname>x</varname> by
32             <literal>i</literal> than <code>y = %i*x</code>, without the problems occurring
33             when <varname>x</varname> comprises "special" floating point numbers as
34             <constant>%inf</constant> and <constant>%nan</constant>.
35         </para>
36     </refsection>
37     <refsection>
38         <title>Examples</title>
39         <programlisting role="example"><![CDATA[ 
40 z1 = imult(%inf)
41 z2 = %i * %inf
42  ]]></programlisting>
43     </refsection>
44 </refentry>