← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/eng/graphics/champ.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/champ.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
 
 
6
  <TITLE>champ</TITLE>
 
7
 
 
8
  <TYPE>Scilab Function</TYPE>
 
9
 
 
10
  <DATE>April 1993</DATE>
 
11
 
 
12
  <SHORT_DESCRIPTION name="champ">2D vector field plot</SHORT_DESCRIPTION>
 
13
 
 
14
  <CALLING_SEQUENCE>
 
15
    <CALLING_SEQUENCE_ITEM>champ(x,y,fx,fy,[arfact,rect,strf])</CALLING_SEQUENCE_ITEM>
 
16
 
 
17
    <CALLING_SEQUENCE_ITEM>champ(x,y,fx,fy,&lt;opt_args&gt;)</CALLING_SEQUENCE_ITEM>
 
18
  </CALLING_SEQUENCE>
 
19
 
 
20
  <PARAM>
 
21
    <PARAM_INDENT>
 
22
      <PARAM_ITEM>
 
23
        <PARAM_NAME>x,y</PARAM_NAME>
 
24
 
 
25
        <PARAM_DESCRIPTION>
 
26
          <SP>: two vectors which define the grid.</SP>
 
27
        </PARAM_DESCRIPTION>
 
28
      </PARAM_ITEM>
 
29
 
 
30
      <PARAM_ITEM>
 
31
        <PARAM_NAME>fx</PARAM_NAME>
 
32
 
 
33
        <PARAM_DESCRIPTION>
 
34
          <SP>: a matrix which describes the x component of the vector field.
 
35
          <VERB>fx(i,j)</VERB> is the x component of the vector field at point
 
36
          <VERB>(x(i),y(j))</VERB>.</SP>
 
37
        </PARAM_DESCRIPTION>
 
38
      </PARAM_ITEM>
 
39
 
 
40
      <PARAM_ITEM>
 
41
        <PARAM_NAME>fy</PARAM_NAME>
 
42
 
 
43
        <PARAM_DESCRIPTION>
 
44
          <SP>: a matrix which describes the y component of the vector field.
 
45
          <VERB>fy(i,j)</VERB> is the y component of the vector field at point
 
46
          <VERB>(x(i),y(j))</VERB>.</SP>
 
47
        </PARAM_DESCRIPTION>
 
48
      </PARAM_ITEM>
 
49
 
 
50
      <PARAM_ITEM>
 
51
        <PARAM_NAME>&lt;opt_args&gt;</PARAM_NAME>
 
52
 
 
53
        <PARAM_DESCRIPTION>
 
54
          <SP>: This represents a sequence of statements <VERB>key1=value1,
 
55
          key2=value2</VERB>,... where <VERB>key1</VERB>,
 
56
          <VERB>key2,...</VERB> can be one of the following: arfact, rect,
 
57
          strf (see below).</SP>
 
58
        </PARAM_DESCRIPTION>
 
59
      </PARAM_ITEM>
 
60
 
 
61
      <PARAM_ITEM>
 
62
        <PARAM_NAME>arfact</PARAM_NAME>
 
63
 
 
64
        <PARAM_DESCRIPTION>
 
65
          <SP>: an optional argument of type real which gives a scale factor
 
66
          for the display of the arrow heads on the plot (default value is
 
67
          1.0).</SP>
 
68
        </PARAM_DESCRIPTION>
 
69
      </PARAM_ITEM>
 
70
 
 
71
      <PARAM_ITEM>
 
72
        <PARAM_NAME>rect</PARAM_NAME>
 
73
 
 
74
        <PARAM_DESCRIPTION>
 
75
          <SP>: a vector <VERB>rect=[xmin,ymin,xmax,ymax]</VERB> which gives
 
76
          the boundaries of the graphics frame to use.</SP>
 
77
        </PARAM_DESCRIPTION>
 
78
      </PARAM_ITEM>
 
79
 
 
80
      <PARAM_ITEM>
 
81
        <PARAM_NAME>strf</PARAM_NAME>
 
82
 
 
83
        <PARAM_DESCRIPTION>
 
84
          <SP>: a string of length 3 "xyz" which has the same meaning as the
 
85
          <VERB>strf</VERB> parameter of <VERB>plot2d</VERB>. The first
 
86
          character x has no effect with <VERB>champ</VERB>.</SP>
 
87
        </PARAM_DESCRIPTION>
 
88
      </PARAM_ITEM>
 
89
    </PARAM_INDENT>
 
90
  </PARAM>
 
91
 
 
92
  <DESCRIPTION>
 
93
    <P><VERB>champ</VERB> draws a 2D vector field. The length of the arrows is
 
94
    proportional to the intensity of the field.</P>
 
95
 
 
96
    <P>If you want colored arrows with the color of the arrows depending on
 
97
    the intensity of the field, use <VERB>champ1</VERB>.</P>
 
98
 
 
99
    <P>Enter the command <VERB>champ()</VERB> to see a demo.</P>
 
100
  </DESCRIPTION>
 
101
 
 
102
  <EXAMPLE><![CDATA[
 
103
 
 
104
// using rect as plot boundaries 
 
105
champ(-5:5,-5:5,rand(11,11),rand(11,11),rect=[-10,-10,10,10],arfact=2)
 
106
// using (x,y) to get boundaries 
 
107
clf()
 
108
champ(-5:5,-5:5,rand(11,11),rand(11,11),2,[-10,-10,10,10],"021")
 
109
 
 
110
  ]]></EXAMPLE>
 
111
 
 
112
  <SEE_ALSO>
 
113
    <SEE_ALSO_ITEM>
 
114
      <LINK>champ1</LINK>
 
115
    </SEE_ALSO_ITEM>
 
116
 
 
117
    <SEE_ALSO_ITEM>
 
118
      <LINK>fchamp</LINK>
 
119
    </SEE_ALSO_ITEM>
 
120
 
 
121
    <SEE_ALSO_ITEM>
 
122
      <LINK>plot2d</LINK>
 
123
    </SEE_ALSO_ITEM>
 
124
  </SEE_ALSO>
 
125
 
 
126
  <AUTHOR>J.Ph.C.</AUTHOR>
 
127
</MAN>
 
 
b'\\ No newline at end of file'