summaryrefslogtreecommitdiffstats
path: root/scilab/modules/compatibility_functions/help/en_US/firstnonsingleton.xml
blob: 144d5b121db220e6451166fd070ed8b576e83ff0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) 2004-2007 - INRIA - Vincent COUVERT 
    * 
    * This file must be used under the terms of the CeCILL.
    * This source file is licensed as described in the file COPYING, which
    * you should have received as part of this distribution.  The terms
    * are also available at    
    * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
    *
    -->
<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" version="5.0-subset Scilab" xml:lang="en" xml:id="firstnonsingleton">
  <info>
    <pubdate>$LastChangedDate$</pubdate>
  </info>
  <refnamediv>
    <refname>firstnonsingleton</refname>
    <refpurpose>Finds first dimension which is not 1</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>[dim]=firstnonsingleton(A[,opt])</synopsis>
  </refsynopsisdiv>
  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>dim</term>
        <listitem>
          <para>first dimension of A which is not 1</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>A</term>
        <listitem>
          <para>a variable of any Scilab data type</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>opt</term>
        <listitem>
          <para>a character string giving the type of output we want</para>
          <variablelist>
            <varlistentry>
              <term>"num"</term>
              <listitem>
                <para>returned value is a numerical value</para>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>"str"</term>
              <listitem>
                <para>returned value is a character string if possible ("r" instead of 1 and "c" instead of 2)</para>
              </listitem>
            </varlistentry>
          </variablelist>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <title>Description</title>
    <para>
    This function is used by <literal>mfile2sci</literal> to emulate Matlab behavior under Scilab, particularly
    for functions which treat the values along the first non-singleton dimension of A in Matlab
    while in Scilab they treat all values of A.
    </para>
  </refsection>
  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[

A = [1 2 3;4 5 6];
// Scilab max
M = max(A)
// Matlab max emulation
M = max(A,firstnonsingleton(A))
 
  ]]></programlisting>
  </refsection>
  <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>V.C.</member>
    </simplelist>
  </refsection>
</refentry>