File: clean.man

package info (click to toggle)
scilab 2.6-4
  • links: PTS
  • area: non-free
  • in suites: woody
  • size: 54,632 kB
  • ctags: 40,267
  • sloc: ansic: 267,851; fortran: 166,549; sh: 10,005; makefile: 4,119; tcl: 1,070; cpp: 233; csh: 143; asm: 135; perl: 130; java: 39
file content (36 lines) | stat: -rw-r--r-- 898 bytes parent folder | download | duplicates (2)
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
.TH clean 1 "April 1993" "Scilab Group" "Scilab Function"
.so ../sci.an 
.SH NAME
clean - cleans matrices (round to zero small entries)  
.SH CALLING SEQUENCE
.nf
[B]=clean(A [,epsa [,epsr]])
.fi
.SH PARAMETERS
.TP
A 
: a numerical matrix (scalar, polynomial, sparse...)

.TP
epsa,epsr 
: real numbers (default values resp. 1.d-10 and 1.d-10)
.SH DESCRIPTION
This function eliminates (i.e. set to zero) all the coefficients 
with absolute value < \fVepsa\fR and relative value < \fVepsr\fR 
(relative means relative w.r.t. 1-norm of coefficients)
in a polynomial (possibly matrix polynomial or rational
matrix).
.LP
Default  values are \fVepsa=1.d-10\fR and \fVepsr=1.d-10;\fR
.LP
For a constant (non polynomial) matrix \fVclean(A,epsa)\fR sets to zero all
entries of \fVA\fR smaller than \fVepsa\fR.
.SH EXAMPLE
.nf
x=poly(0,'x');
w=[x,1,2+x;3+x,2-x,x^2;1,2,3+x]/3;
w*inv(w)
clean(w*inv(w))
.fi