[doc] misc. fix & improvements
[scilab.git] / scilab / modules / statistics / help / en_US / 3_dispersion_widths / strange.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) 2000 - INRIA - Carlos Klimann
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="strange">
17     <refnamediv>
18         <refname>strange</refname>
19         <refpurpose>range</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>[r]=strange(x)
24             [r]=strange(x,'r') (or, equivalently, [r]=strange(x,1))
25             [r]=strange(x,'c') (or, equivalently, [r]=strange(x,2))
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>x</term>
33                 <listitem>
34                     <para>real or complex vector or matrix</para>
35                 </listitem>
36             </varlistentry>
37         </variablelist>
38     </refsection>
39     <refsection>
40         <title>Description</title>
41         <para>
42             The  range  is the  distance   between  the largest  and
43             smallest value,  [r]=strange(x) computes   the  range of
44             vector or matrix x.
45         </para>
46         <para>
47             [r]=strange(x,'r')  (or   equivalently [r]=strange(x,1))
48             give a row vector with the range of each column.
49         </para>
50         <para>
51             [r]=strange(x,'c') (or  equivalently   [r]=strange(x,2))
52             give a column vector with the range of each row.
53         </para>
54     </refsection>
55     <refsection>
56         <title>Examples</title>
57         <programlisting role="example"><![CDATA[
58 x  = [22    63    57    24    31
59       76    85    67    24    94
60       1     69    73    22    22
61       34    88    20    89    32
62       67    7     55    66    37 ];
63
64 strange(x)       // 94-1 = 93
65 strange(x, 'r')  // [ 76-1=75   88-7=81   73-20=53   89-22=67   94-22=72 ]
66 strange(x, 'c')  // [ 63-22=41 ;  94-24=70 ;  73-1=72 ;  89-20=69 ;  67-7=60 ]
67    ]]></programlisting>
68     </refsection>
69     <refsection>
70         <title>References</title>
71         <para>
72             Wonacott, T.H. &amp; Wonacott, R.J.; Introductory Statistics, J.Wiley &amp; Sons, 1990.
73         </para>
74     </refsection>
75 </refentry>