File: speye.man

package info (click to toggle)
scilab 2.4-1
  • links: PTS
  • area: non-free
  • in suites: potato, slink
  • size: 55,196 kB
  • ctags: 38,019
  • sloc: ansic: 231,970; fortran: 148,976; tcl: 7,099; makefile: 4,585; sh: 2,978; csh: 154; cpp: 101; asm: 39; sed: 5
file content (39 lines) | stat: -rw-r--r-- 897 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
37
38
39
.TH speye 1 "January 1995" "Scilab Group" "Scilab Function"
.so ../sci.an
.SH NAME
speye -  sparse identity matrix
.SH CALING SEQUENCE
.nf
Isp=speye(nrows,ncols)
Isp=speye(A)
.fi
.SH PARAMETERS
.TP 8
nrows
: integer (number of rows)
.TP
ncols
: integer (number os columns)
.TP
A
: sparse matrix
.TP
sp
: sparse identity matrix
.SH DESCRIPTION
\fVIsp=speye(nrows,ncols)\fR returns a sparse identity matrix \fVIsp\fR 
with \fVnrows\fR rows, \fVncols\fR columns. (Non square identity matrix
have a maximal number of ones along the main diagonal).
.LP
\fVIsp=speye(A)\fR returns a sparse identity matrix with same
dimensions as \fVA\fR. If \fV[m,n]=size(A)\fR, \fVspeye(m,n)\fR and
\fVspeye(A)\fR are equivalent. In particular \fVspeye(3)\fR is not
equivalent to \fVspeye(3,3)\fR.
.SH EXAMPLE
.nf
eye(3,3)-full(speye(3,3))
.fi
.SH SEE ALSO
sparse, full, eye, spzeros, spones