aae390acb1fad885459cc996f963bc6110ecffd8
[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             <literal>imult(x)</literal> is a more efficient way to multiply x by
32             i than y = %i*x, without the problems occurring when x comprises "special"
33             floating point numbers as %inf and %nan.
34         </para>
35     </refsection>
36     <refsection>
37         <title>Examples</title>
38         <programlisting role="example"><![CDATA[ 
39 z1 = imult(%inf)
40 z2 = %i * %inf
41  ]]></programlisting>
42     </refsection>
43 </refentry>