← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/graphics/xarrows.cat

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2002-03-21 16:57:43 UTC
  • Revision ID: james.westby@ubuntu.com-20020321165743-e9mv12c1tb1plztg
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/graphics/xarrows.cat
 
1
xarrows           Scilab Group           Scilab Function            xarrows
 
2
NAME
 
3
   xarrows - draw a set of arrows
 
4
  
 
5
CALLING SEQUENCE
 
6
 xarrows(nx,ny,[arsize,style])
 
7
PARAMETERS
 
8
 nx,ny    : real vectors or matrices of same size.
 
9
          
 
10
 arsize   : real scalar, size of the arrow head. The default value can be
 
11
          obtained  by setting arsize to -1.
 
12
          
 
13
 style    : matrix or scalar. If style is a positive scalar  it gives the
 
14
          dash style to use for all arrows. If it is a negative scalar 
 
15
          then the current dash style is used. If it is a vector style(i)
 
16
          gives the style to use for arrow i.
 
17
          
 
18
DESCRIPTION
 
19
   xarrows draws a set of arrows given by nx and ny. If nx and ny are
 
20
  vectors, the ith arrow is defined by (nx(i),ny(i))-->(nx(i+1),ny(i+1)).
 
21
  If nx and ny are matrices:
 
22
  
 
23
 nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
 
24
 ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
 
25
   the k th arrow is defined by (xi_k,yi_k)-->(xf_k,yf_k).
 
26
  
 
27
   xarrows uses the current graphics scale  which can be set by calling a
 
28
  high level drawing function such as plot2d.
 
29
  
 
30
EXAMPLE
 
31
 x=2*%pi*(0:9)/8;
 
32
 x1=[sin(x);9*sin(x)];
 
33
 y1=[cos(x);9*cos(x)];
 
34
 plot2d([-10,10],[-10,10],[-1,-1],"022")
 
35
 xset("clipgrf")
 
36
 xarrows(x1,y1,1,1:10)
 
37
 xset("clipoff")
 
38
AUTHOR
 
39
   J.Ph.C.
 
40