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

« back to all changes in this revision

Viewing changes to man/elementary/squarewave.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 squarewave G "Sept 1999" "Scilab Group" "Scilab Function"
2
 
.so ../sci.an
3
 
.SH NAME
4
 
squarewave -  generates a square wave with period 2*%pi
5
 
.SH CALLING SEQUENCE
6
 
.nf
7
 
x=squarewave(t [,%])
8
 
.fi
9
 
.SH PARAMETERS
10
 
.TP 10
11
 
t
12
 
: real vector, time discretization
13
 
.TP
14
 
x
15
 
: real vector, the wave value at each time point in set (-1,+1)
16
 
.TP
17
 
%
18
 
: real positive scalar, the percent of the period in which the signal
19
 
is positive. Defaut value is 50
20
 
.SH DESCRIPTION
21
 
\fVsquarewave(t)\fR generates the vector of the values of the square
22
 
wave with period 2*%pi at each date given in the \fVt\fR vector.
23
 
 
24
 
\fVsquarewave(t,%)\fR generates a square wave such that \fV%\fR  is
25
 
the percent of the period in which the signal is positive.
26
 
 
27
 
.SH EXAMPLE
28
 
.nf
29
 
t=(0:0.1:5*%pi)';
30
 
plot2d1('onn',t,[2*sin(t),1.5*squarewave(t),squarewave(t,10)])
31
 
.fi
32
 
.SH SEE ALSO
33
 
sin, cos
34
 
 
35