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

« back to all changes in this revision

Viewing changes to man/elementary/min.man

  • 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
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH min G "April 1993" "Scilab Group" "Scilab Function"
2
 
.so ../sci.an
3
 
.SH NAME
4
 
min - minimum
5
 
.SH CALLING SEQUENCE
6
 
.nf
7
 
[m [,k]]=min(A)
8
 
[m [,k]]=min(A,'c') or [m [,k]]=min(A,'r')
9
 
[m [,k]]=min(A1,A2,...,An)
10
 
[m [,k]]=min(list(A1,A2,...,An))
11
 
.fi
12
 
.SH PARAMETERS
13
 
.TP 10
14
 
A
15
 
: real vector or matrix.
16
 
.TP 10
17
 
A1,...,An
18
 
: a set of real vectors or matrices, all of the same size or scalar.
19
 
.SH DESCRIPTION
20
 
 
21
 
For \fVA\fR, a real  vector or matrix, \fVmin(A)\fR 
22
 
is the smallest element 
23
 
\fVA\fR. \fV[m,k]=min(A)\fR gives in addition the index of the minimum.
24
 
A second argument of type string \fV'r'\fR or \fV'c'\fR can be used : \fV'r'\fR
25
 
is used to get a row vector \fVm\fR such that \fVm(j)\fR contains the 
26
 
minimum of the \fVj\fR th column of A (\fVA(:,j)\fR), \fVk(j)\fR gives the row 
27
 
indice which contain the minimum for column \fVj\fR. \fV'c'\fR is used for the dual operation on the rows of \fVA\fR.
28
 
 
29
 
\fVm=min(A1,A2,...,An)\fR, where all the \fVAj\fR are matrices of the same 
30
 
sizes,returns a vector or a matrix \fVm\fR of size \fVsize(m)=size(A1)\fR
31
 
such that \fVm(i)= min( Aj(i)), j=1,...,n\fR. \fV[m,k]=min(A1,A2,...,An)\fR 
32
 
gives in addition the vector or matrix \fVk\fR. for a fixed \fVi\fR,
33
 
\fVk(i)\fR is the number of the first \fVAj(i)\fR achieving the minimum.
34
 
 
35
 
\fV[m,k]=min(list(A1,...,An))\fR is an equivalent syntax of 
36
 
\fV[m,k]=min(A1,A2,...,An)\fR
37
 
.SH EXAMPLE
38
 
.nf
39
 
[m,n]=min([1,3,1])
40
 
[m,n]=min([3,1,1],[1,3,1],[1,1,3])
41
 
[m,n]=min(list([3,1,1],[1,3,1],[1,1,3]))
42
 
[m,n]=min(list(1,3,1))
43
 
.fi
44
 
.SH SEE ALSO
45
 
sort, find, max
46
 
 
47
 
 
48