← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/eng/graphics/xarrows.xml

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/eng/graphics/xarrows.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>xarrows</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>April 1993</DATE>
 
8
  <SHORT_DESCRIPTION name="xarrows"> draw a set of arrows</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>xarrows(nx,ny,[arsize,style])  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <PARAM>
 
13
    <PARAM_INDENT>
 
14
      <PARAM_ITEM>
 
15
        <PARAM_NAME>nx,ny</PARAM_NAME>
 
16
        <PARAM_DESCRIPTION>
 
17
          <SP>: real vectors or matrices of same size.</SP>
 
18
        </PARAM_DESCRIPTION>
 
19
      </PARAM_ITEM>
 
20
      <PARAM_ITEM>
 
21
        <PARAM_NAME>arsize</PARAM_NAME>
 
22
        <PARAM_DESCRIPTION>
 
23
          <SP>: real scalar, size of the arrow head. The default value can be obtained  by setting arsize to -1.</SP>
 
24
        </PARAM_DESCRIPTION>
 
25
      </PARAM_ITEM>
 
26
      <PARAM_ITEM>
 
27
        <PARAM_NAME>style</PARAM_NAME>
 
28
        <PARAM_DESCRIPTION>
 
29
          <SP>: matrix or scalar. If <VERB>style</VERB> is a positive scalar  it gives the color to use for all arrows. If it is a negative scalar  then the current color is used. If it is a vector <VERB>style(i)</VERB> gives the color to use for arrow <VERB>i</VERB>.</SP>
 
30
        </PARAM_DESCRIPTION>
 
31
      </PARAM_ITEM>
 
32
    </PARAM_INDENT>
 
33
  </PARAM>
 
34
  <DESCRIPTION>
 
35
    <P><VERB>xarrows</VERB> draws a set of arrows given by <VERB>nx</VERB> and <VERB>ny</VERB>.
 
36
    If <VERB>nx</VERB> and <VERB>ny</VERB> are vectors,
 
37
    the ith arrow is defined by
 
38
    <VERB>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</VERB>.
 
39
    If <VERB>nx</VERB> and <VERB>ny</VERB> are matrices:</P>
 
40
    <VERBATIM>
 
41
<![CDATA[
 
42
nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
 
43
ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
 
44
   ]]>
 
45
    </VERBATIM>
 
46
    <P>
 
47
    the <VERB>k</VERB> th arrow is defined by <VERB>(xi_k,yi_k)--&gt;(xf_k,yf_k)</VERB>.</P>
 
48
    <P><VERB>xarrows</VERB> uses the current graphics scale 
 
49
    which can be set by calling a high level drawing function such as <VERB>plot2d</VERB>.</P>
 
50
  </DESCRIPTION>
 
51
  <EXAMPLE>
 
52
<![CDATA[
 
53
x=2*%pi*(0:9)/8;
 
54
x1=[sin(x);9*sin(x)];
 
55
y1=[cos(x);9*cos(x)];
 
56
plot2d([-10,10],[-10,10],[-1,-1],"022")
 
57
xset("clipgrf")
 
58
xarrows(x1,y1,1,1:10)
 
59
xset("clipoff")
 
60
 ]]>
 
61
  </EXAMPLE>
 
62
  <AUTHOR>J.Ph.C.  </AUTHOR>
 
63
</MAN>