scilab/modules/elementary_functions/help/en_US/elementarymatrices/logspace.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" xmlns:scilab="http://www.scilab.org" xml:id="logspace" xml:lang="en">
  14     <refnamediv>
  15         <refname>logspace</refname>
  16         <refpurpose>logarithmically spaced vector</refpurpose>
  17     </refnamediv>
  18     <refsynopsisdiv>
  19         <title>Calling Sequence</title>
  20         <synopsis>logspace(d1,d2, [n])</synopsis>
  21     </refsynopsisdiv>
  22     <refsection>
  23         <title>Arguments</title>
  24         <variablelist>
  25             <varlistentry>
  26                 <term>d1,d2</term>
  27                 <listitem>
  28                     <para>real or complex scalar (special meaning for
  29                         <literal>%pi</literal>)
  30                     </para>
  31                 </listitem>
  32             </varlistentry>
  33             <varlistentry>
  34                 <term>n</term>
  35                 <listitem>
  36                     <para>integer: number of requested values. It must be greater or equal to 2  (default value = 50)</para>
  37                 </listitem>
  38             </varlistentry>
  39         </variablelist>
  40     </refsection>
  41     <refsection>
  42         <title>Description</title>
  43         <para>
  44             returns a row vector of <literal>n</literal> logarithmically equally
  45             spaced points between <latex>10^{d1}</latex> and
  46             <latex>10^{d2}</latex>. If <literal>d2=%pi</literal> then the points are
  47             between <latex>10^{d1}</latex> and <latex>\pi</latex>.
  48         </para>
  49     </refsection>
  50     <refsection>
  51         <title>Examples</title>
  52         <programlisting role="example"><![CDATA[
  53 logspace(1,2,10)
  54  ]]></programlisting>
  55     </refsection>
  56     <refsection role="see also">
  57         <title>See Also</title>
  58         <simplelist type="inline">
  59             <member>
  60                 <link linkend="linspace">linspace</link>
  61             </member>
  62         </simplelist>
  63     </refsection>
  64     <refsection>
  65         <title>History</title>
  66         <revhistory>
  67             <revision>
  68                 <revnumber>5.4.0</revnumber>
  69                 <revremark>The logspace function accepts column vectors as input argument for the two first input arguments.</revremark>
  70             </revision>
  71         </revhistory>
  72     </refsection>
  73 </refentry>