← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/elementary/min.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/eng/elementary/min.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>min</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>April 1993</DATE>
 
8
  <SHORT_DESCRIPTION name="min"> minimum</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>[m [,k]]=min(A)  </CALLING_SEQUENCE_ITEM>
 
11
    <CALLING_SEQUENCE_ITEM>[m [,k]]=min(A,'c') or [m [,k]]=min(A,'r')  </CALLING_SEQUENCE_ITEM>
 
12
    <CALLING_SEQUENCE_ITEM>[m [,k]]=min(A1,A2,...,An)  </CALLING_SEQUENCE_ITEM>
 
13
    <CALLING_SEQUENCE_ITEM>[m [,k]]=min(list(A1,A2,...,An))  </CALLING_SEQUENCE_ITEM>
 
14
  </CALLING_SEQUENCE>
 
15
  <PARAM>
 
16
    <PARAM_INDENT>
 
17
      <PARAM_ITEM>
 
18
        <PARAM_NAME>A</PARAM_NAME>
 
19
        <PARAM_DESCRIPTION>
 
20
          <SP>: real vector or matrix.</SP>
 
21
        </PARAM_DESCRIPTION>
 
22
      </PARAM_ITEM>
 
23
      <PARAM_ITEM>
 
24
        <PARAM_NAME>A1,...,An</PARAM_NAME>
 
25
        <PARAM_DESCRIPTION>
 
26
          <SP>: a set of real vectors or matrices, all of the same size or scalar.</SP>
 
27
        </PARAM_DESCRIPTION>
 
28
      </PARAM_ITEM>
 
29
    </PARAM_INDENT>
 
30
  </PARAM>
 
31
  <DESCRIPTION>
 
32
    <P>
 
33
    For <VERB>A</VERB>, a real  vector or matrix, <VERB>min(A)</VERB> 
 
34
    is the smallest element 
 
35
    <VERB>A</VERB>. <VERB>[m,k]=min(A)</VERB> gives in addition the index of the minimum.
 
36
    A second argument of type string <VERB>'r'</VERB> or <VERB>'c'</VERB> can be used : <VERB>'r'</VERB>
 
37
    is used to get a row vector <VERB>m</VERB> such that <VERB>m(j)</VERB> contains the 
 
38
    minimum of the <VERB>j</VERB> th column of A (<VERB>A(:,j)</VERB>), <VERB>k(j)</VERB> gives the row 
 
39
    indice which contain the minimum for column <VERB>j</VERB>. <VERB>'c'</VERB> is used for the dual operation on the rows of <VERB>A</VERB>.</P>
 
40
    <P><VERB>m=min(A1,A2,...,An)</VERB>, where all the <VERB>Aj</VERB> are matrices of the same 
 
41
    sizes,returns a vector or a matrix <VERB>m</VERB> of size <VERB>size(m)=size(A1)</VERB>
 
42
    such that <VERB>m(i)= min( Aj(i)), j=1,...,n</VERB>. <VERB>[m,k]=min(A1,A2,...,An)</VERB> 
 
43
    gives in addition the vector or matrix <VERB>k</VERB>. for a fixed <VERB>i</VERB>,
 
44
    <VERB>k(i)</VERB> is the number of the first <VERB>Aj(i)</VERB> achieving the minimum.</P>
 
45
    <P><VERB>[m,k]=min(list(A1,...,An))</VERB> is an equivalent syntax of 
 
46
    <VERB>[m,k]=min(A1,A2,...,An)</VERB></P>
 
47
  </DESCRIPTION>
 
48
  <EXAMPLE>
 
49
<![CDATA[
 
50
[m,n]=min([1,3,1])
 
51
[m,n]=min([3,1,1],[1,3,1],[1,1,3])
 
52
[m,n]=min(list([3,1,1],[1,3,1],[1,1,3]))
 
53
[m,n]=min(list(1,3,1))
 
54
 ]]>
 
55
  </EXAMPLE>
 
56
  <SEE_ALSO>
 
57
    <SEE_ALSO_ITEM>
 
58
      <LINK>sort</LINK>
 
59
    </SEE_ALSO_ITEM>
 
60
    <SEE_ALSO_ITEM>
 
61
      <LINK>find</LINK>
 
62
    </SEE_ALSO_ITEM>
 
63
    <SEE_ALSO_ITEM>
 
64
      <LINK>max</LINK>
 
65
    </SEE_ALSO_ITEM>
 
66
  </SEE_ALSO>
 
67
</MAN>