← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/plplot/intrepid

« back to all changes in this revision

Viewing changes to doc/docbook/src/plbin.html

  • Committer: Bazaar Package Importer
  • Author(s): Rafael Laboissiere
  • Date: 2006-11-04 10:19:34 UTC
  • mfrom: (2.1.8 edgy)
  • Revision ID: james.westby@ubuntu.com-20061104101934-mlirvdg4gpwi6i5q
Tags: 5.6.1-10
* Orphaning the package
* debian/control: Changed the maintainer to the Debian QA Group

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/docbook/src/plbin.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2
2
<HTML
3
3
><HEAD
4
4
><TITLE
6
6
    </TITLE
7
7
><META
8
8
NAME="GENERATOR"
9
 
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
 
9
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
10
10
REL="HOME"
11
11
TITLE="The PLplot Plotting Library"
12
12
HREF="index.html"><LINK
60
60
WIDTH="80%"
61
61
ALIGN="center"
62
62
VALIGN="bottom"
63
 
>Chapter 16. The Common API for PLplot</TD
 
63
>Chapter 17. The Common API for PLplot</TD
64
64
><TD
65
65
WIDTH="10%"
66
66
ALIGN="right"
92
92
><P
93
93
></P
94
94
><A
95
 
NAME="AEN2925"
 
95
NAME="AEN3623"
96
96
></A
97
97
><TABLE
98
98
CLASS="funcprototype"
102
102
CLASS="FUNCDEF"
103
103
>           plbin
104
104
        </CODE
105
 
>(nbin, x, y, center);</TD
 
105
>(nbin, x, y, opt);</TD
106
106
></TR
107
107
></TABLE
108
108
><P
112
112
    </P
113
113
><P
114
114
>      Plots a histogram consisting of
115
 
      <VAR
 
115
      <TT
116
116
CLASS="literal"
117
 
><VAR
 
117
><CODE
118
118
CLASS="parameter"
119
 
>nbin</VAR
120
 
></VAR
 
119
>nbin</CODE
 
120
></TT
121
121
> bins.  The value
122
 
      associated with the <VAR
 
122
      associated with the <TT
123
123
CLASS="literal"
124
 
>i</VAR
 
124
>i</TT
125
125
>'th bin is placed in
126
 
      <VAR
 
126
      <TT
127
127
CLASS="literal"
128
 
><VAR
 
128
><CODE
129
129
CLASS="parameter"
130
 
>x</VAR
131
 
>[i]</VAR
 
130
>x</CODE
 
131
>[i]</TT
132
132
>, and the number of
133
133
      points in the bin is placed in
134
 
      <VAR
 
134
      <TT
135
135
CLASS="literal"
136
 
><VAR
 
136
><CODE
137
137
CLASS="parameter"
138
 
>y</VAR
139
 
>[i]</VAR
 
138
>y</CODE
 
139
>[i]</TT
140
140
>.  For proper
141
141
      operation, the values in
142
 
      <VAR
 
142
      <TT
143
143
CLASS="literal"
144
 
><VAR
 
144
><CODE
145
145
CLASS="parameter"
146
 
>x</VAR
147
 
>[i]</VAR
 
146
>x</CODE
 
147
>[i]</TT
148
148
> must form a strictly
149
 
      increasing sequence.  If
150
 
      <VAR
151
 
CLASS="literal"
152
 
><VAR
153
 
CLASS="parameter"
154
 
>center</VAR
155
 
>=0</VAR
156
 
>,
157
 
      <VAR
158
 
CLASS="literal"
159
 
><VAR
160
 
CLASS="parameter"
161
 
>x</VAR
162
 
>[i]</VAR
 
149
      increasing sequence.  By default,
 
150
      <TT
 
151
CLASS="literal"
 
152
><CODE
 
153
CLASS="parameter"
 
154
>x</CODE
 
155
>[i]</TT
163
156
> is the left-hand edge
164
 
      of the <VAR
165
 
CLASS="literal"
166
 
>i</VAR
167
 
>'th bin, and if
168
 
      <VAR
169
 
CLASS="literal"
170
 
><VAR
171
 
CLASS="parameter"
172
 
>center</VAR
173
 
>=1</VAR
174
 
>, the bin
175
 
      boundaries are placed midway between the values in the
176
 
      <VAR
177
 
CLASS="literal"
178
 
><VAR
179
 
CLASS="parameter"
180
 
>x</VAR
181
 
></VAR
 
157
      of the <TT
 
158
CLASS="literal"
 
159
>i</TT
 
160
>'th bin. If
 
161
      <TT
 
162
CLASS="literal"
 
163
><CODE
 
164
CLASS="parameter"
 
165
>opt</CODE
 
166
>=PL_BIN_CENTRED</TT
 
167
> is
 
168
      used, the bin boundaries are placed midway between the values in the
 
169
      <TT
 
170
CLASS="literal"
 
171
><CODE
 
172
CLASS="parameter"
 
173
>x</CODE
 
174
></TT
182
175
> array.  Also see <A
183
176
HREF="plhist.html"
184
177
><CODE
194
187
><TD
195
188
><DL
196
189
><DT
197
 
><VAR
 
190
><CODE
198
191
CLASS="parameter"
199
 
>nbin</VAR
 
192
>nbin</CODE
200
193
>
201
 
          (<VAR
 
194
          (<TT
202
195
CLASS="literal"
203
 
>PLINT</VAR
 
196
>PLINT</TT
204
197
>, input)</DT
205
198
><DD
206
199
><P
207
200
>           Number of bins (i.e., number of values in
208
 
            <VAR
 
201
            <TT
209
202
CLASS="literal"
210
 
><VAR
 
203
><CODE
211
204
CLASS="parameter"
212
 
>x</VAR
213
 
></VAR
 
205
>x</CODE
 
206
></TT
214
207
> and
215
 
            <VAR
 
208
            <TT
216
209
CLASS="literal"
217
 
><VAR
 
210
><CODE
218
211
CLASS="parameter"
219
 
>y</VAR
220
 
></VAR
 
212
>y</CODE
 
213
></TT
221
214
> arrays.)
222
215
          </P
223
216
></DD
224
217
><DT
225
 
><VAR
 
218
><CODE
226
219
CLASS="parameter"
227
 
>x</VAR
 
220
>x</CODE
228
221
>
229
 
          (<VAR
 
222
          (<TT
230
223
CLASS="literal"
231
 
>PLFLT *</VAR
 
224
>PLFLT *</TT
232
225
>, input)</DT
233
226
><DD
234
227
><P
237
230
          </P
238
231
></DD
239
232
><DT
240
 
><VAR
 
233
><CODE
241
234
CLASS="parameter"
242
 
>y</VAR
 
235
>y</CODE
243
236
>
244
 
          (<VAR
 
237
          (<TT
245
238
CLASS="literal"
246
 
>PLFLT *</VAR
 
239
>PLFLT *</TT
247
240
>, input)</DT
248
241
><DD
249
242
><P
250
243
>           Pointer to array containing number of points in bin.  This is a
251
 
            <VAR
252
 
CLASS="literal"
253
 
>PLFLT</VAR
254
 
> (instead of <VAR
255
 
CLASS="literal"
256
 
>PLINT</VAR
 
244
            <TT
 
245
CLASS="literal"
 
246
>PLFLT</TT
 
247
> (instead of <TT
 
248
CLASS="literal"
 
249
>PLINT</TT
257
250
>)
258
251
            array so as to allow histograms of probabilities, etc.
259
252
          </P
260
253
></DD
261
254
><DT
262
 
><VAR
 
255
><CODE
263
256
CLASS="parameter"
264
 
>center</VAR
 
257
>opt</CODE
265
258
>
266
 
          (<VAR
 
259
          (<TT
267
260
CLASS="literal"
268
 
>PLINT</VAR
 
261
>PLINT</TT
269
262
>, input)</DT
270
263
><DD
271
264
><P
272
 
>           Indicates whether the values in
273
 
            <VAR
274
 
CLASS="literal"
275
 
><VAR
276
 
CLASS="parameter"
277
 
>x</VAR
278
 
></VAR
 
265
>           Is a combination of several flags:
 
266
            <P
 
267
></P
 
268
><UL
 
269
><LI
 
270
><P
 
271
>                 <TT
 
272
CLASS="literal"
 
273
><CODE
 
274
CLASS="parameter"
 
275
>opt</CODE
 
276
>=PL_BIN_DEFAULT</TT
 
277
>:
 
278
                    The <TT
 
279
CLASS="literal"
 
280
><CODE
 
281
CLASS="parameter"
 
282
>x</CODE
 
283
></TT
279
284
> represent the lower
280
 
            bin boundaries
281
 
            (<VAR
282
 
CLASS="literal"
283
 
><VAR
284
 
CLASS="parameter"
285
 
>center</VAR
286
 
>=0</VAR
287
 
>) or whether
288
 
            the bin boundaries are to be midway between the
289
 
            <VAR
290
 
CLASS="literal"
291
 
><VAR
292
 
CLASS="parameter"
293
 
>x</VAR
294
 
></VAR
295
 
> values
296
 
            (<VAR
297
 
CLASS="literal"
298
 
><VAR
299
 
CLASS="parameter"
300
 
>center</VAR
301
 
>=1</VAR
302
 
>).  If the
303
 
            values in <VAR
304
 
CLASS="literal"
305
 
><VAR
306
 
CLASS="parameter"
307
 
>x</VAR
308
 
></VAR
 
285
                    bin boundaries, the outer bins are expanded to fill up the
 
286
                    entire x-axis and bins of zero height are simply drawn.
 
287
                </P
 
288
></LI
 
289
><LI
 
290
><P
 
291
>                 <TT
 
292
CLASS="literal"
 
293
><CODE
 
294
CLASS="parameter"
 
295
>opt</CODE
 
296
>=PL_BIN_CENTRED|...</TT
 
297
>:
 
298
                    The bin boundaries are to be midway between the
 
299
                    <TT
 
300
CLASS="literal"
 
301
><CODE
 
302
CLASS="parameter"
 
303
>x</CODE
 
304
></TT
 
305
> values. If the
 
306
                    values in <TT
 
307
CLASS="literal"
 
308
><CODE
 
309
CLASS="parameter"
 
310
>x</CODE
 
311
></TT
309
312
> are
310
 
            equally spaced and
311
 
            <VAR
312
 
CLASS="literal"
313
 
><VAR
314
 
CLASS="parameter"
315
 
>center</VAR
316
 
>=1</VAR
317
 
>, the values
318
 
            in <VAR
319
 
CLASS="literal"
320
 
><VAR
321
 
CLASS="parameter"
322
 
>x</VAR
323
 
></VAR
324
 
> are the center
325
 
            values of the bins.
 
313
                    equally spaced, the values are the center values of the bins.
 
314
                </P
 
315
></LI
 
316
><LI
 
317
><P
 
318
>                 <TT
 
319
CLASS="literal"
 
320
><CODE
 
321
CLASS="parameter"
 
322
>opt</CODE
 
323
>=PL_BIN_NOEXPAND|...</TT
 
324
>:
 
325
                    The outer bins are drawn with equal size as the ones inside.
 
326
                </P
 
327
></LI
 
328
><LI
 
329
><P
 
330
>                 <TT
 
331
CLASS="literal"
 
332
><CODE
 
333
CLASS="parameter"
 
334
>opt</CODE
 
335
>=PL_BIN_NOEMPTY|...</TT
 
336
>:
 
337
                    Bins with zero height are not drawn (there is a gap for
 
338
                    such bins).
 
339
                </P
 
340
></LI
 
341
></UL
 
342
>
326
343
          </P
327
344
></DD
328
345
></DL