← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gutenprint/quantal

« back to all changes in this revision

Viewing changes to doc/gutenprint/html/group__array.html

  • Committer: Package Import Robot
  • Author(s): Till Kamppeter
  • Date: 2012-06-19 17:12:48 UTC
  • mfrom: (1.1.15)
  • Revision ID: package-import@ubuntu.com-20120619171248-cbil10m2dqnc71rr
Tags: 5.2.8-0ubuntu1
https://launchpad.net/bugs/932882
* New upstream release
   - Added support for Canon PIXMA DS700, DS810, 50i, 80i, 450i, 455i, 470PD,
     475PD, 550i, 560i, 850i, 860i, 865R, 900PD, 950i, 960i, 990i, 6100i,
     6500i, 9100i, 9900i, i450X, i455X, i475D, i550X, i560X, i905D, i965,
     i990, i9950, iP90, iP90v, iP100, iP6320D, MP260, MX320, MX370, MX430,
     MX510, MX710, MX890, E500, E600, PIXUS iP2700, iP3100, iP4100,
     EPSON Stylus NX420, SX420, TX420
   - CD printing on many Canon printers.
   - Non-working Canon's removed.
   - More Japanese models supported.
   - Printer modes for most printer models are now determined by the
     media, based on information from the corresponding Windows
     driver. If an incompatible mode is selected by the user, a
     suitable mode is substituted, based on the other active
     parameters and quality setting. Modes are also substituted
     based on cartridge selection and duplex selection. Inktype is
     then automatically adjusted.
   - Added support for 8-bit inks to Canon backend, and modes using
     them.
   - Adjusted margins and page sizes of Canon printers.
   - Added borderless functionality to most Canon printers.
   - A problem whereby printing did not work at all on some Linux
     distributions has been fixed.
   - Printing on the Epson Stylus NX200, SX200, and SX205 is believed
     to be corrected.
* debian/patches/0002-genppd-don-t-write-color-profile-information-with-br.patch,
  debian/patches/0003-upgrade-getopt.patch,
  debian/patches/0004-no-data-dumper-needed.patch,
  debian/patches/0005-use-dnointerpolate-in-ghostscript-command-lines.patch:
  Removed, change applied upstream.
* debian/rules: Touch ppd-updater file(s) so that they have the time stamp
  of the build of this package The time stamp of the ppd-updater files tells
  CUPS' trigger script whether they come from different package versions or
  not (LP: #932882).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/gutenprint/html/group__array.html
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
6
<title>libgutenprint API Reference: array</title>
7
 
 
8
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
8
<script type="text/javascript" src="jquery.js"></script>
 
9
<script type="text/javascript" src="dynsections.js"></script>
9
10
<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
 
 
11
 
 
12
 
 
13
11
</head>
14
12
<body>
15
 
<div id="top"><!-- do not remove this div! -->
16
 
 
17
 
 
 
13
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
18
14
<div id="titlearea">
19
15
<table cellspacing="0" cellpadding="0">
20
16
 <tbody>
21
17
 <tr style="height: 56px;">
22
 
  
23
 
  
24
18
  <td style="padding-left: 0.5em;">
25
19
   <div id="projectname">libgutenprint API Reference
26
 
   &#160;<span id="projectnumber">5.2.8-pre1</span>
 
20
   &#160;<span id="projectnumber">5.2.8</span>
27
21
   </div>
28
 
   
29
22
  </td>
30
 
  
31
 
  
32
 
  
33
23
 </tr>
34
24
 </tbody>
35
25
</table>
36
26
</div>
37
 
 
38
 
<!-- Generated by Doxygen 1.7.6.1 -->
 
27
<!-- end header part -->
 
28
<!-- Generated by Doxygen 1.8.1 -->
39
29
  <div id="navrow1" class="tabs">
40
30
    <ul class="tablist">
41
31
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
45
35
      <li><a href="files.html"><span>Files</span></a></li>
46
36
    </ul>
47
37
  </div>
48
 
</div>
 
38
</div><!-- top -->
49
39
<div class="header">
50
40
  <div class="summary">
51
41
<a href="#typedef-members">Typedefs</a> &#124;
58
48
<p>The array is a simple "two-dimensional array of numbers" data structure.  
59
49
<a href="#details">More...</a></p>
60
50
<table class="memberdecls">
61
 
<tr><td colspan="2"><h2><a name="typedef-members"></a>
 
51
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
62
52
Typedefs</h2></td></tr>
63
 
<tr><td class="memItemLeft" align="right" valign="top">typedef struct stp_array&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a></td></tr>
64
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The array opaque data type.  <a href="#ga26a474575a39c1c36ad520b95aa813b0"></a><br/></td></tr>
65
 
<tr><td colspan="2"><h2><a name="func-members"></a>
 
53
<tr class="memitem:ga26a474575a39c1c36ad520b95aa813b0"><td class="memItemLeft" align="right" valign="top">typedef struct stp_array&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a></td></tr>
 
54
<tr class="memdesc:ga26a474575a39c1c36ad520b95aa813b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The array opaque data type.  <a href="#ga26a474575a39c1c36ad520b95aa813b0"></a><br/></td></tr>
 
55
</table><table class="memberdecls">
 
56
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
66
57
Functions</h2></td></tr>
67
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaa3d385d3e2f248b1c1ac88d5f103e9a2">stp_array_create</a> (int x_size, int y_size)</td></tr>
68
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new array.  <a href="#gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a><br/></td></tr>
69
 
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaafb2573df35220ef9be3f6ba4b8c871b">stp_array_destroy</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array)</td></tr>
70
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy an array.  <a href="#gaafb2573df35220ef9be3f6ba4b8c871b"></a><br/></td></tr>
71
 
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaaa9bf798890e01b4bbce8cda45615021">stp_array_copy</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *dest, const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *source)</td></tr>
72
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an array.  <a href="#gaaa9bf798890e01b4bbce8cda45615021"></a><br/></td></tr>
73
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gad0b50228ca40df79196197f9c21f4b56">stp_array_create_copy</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array)</td></tr>
74
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy and allocate an array.  <a href="#gad0b50228ca40df79196197f9c21f4b56"></a><br/></td></tr>
75
 
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gae6fb91b246ef5abd388927cb9674503e">stp_array_set_size</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int x_size, int y_size)</td></tr>
76
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Resize an array.  <a href="#gae6fb91b246ef5abd388927cb9674503e"></a><br/></td></tr>
77
 
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gafe61db801ab3b0326646178e536dd161">stp_array_get_size</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int *x_size, int *y_size)</td></tr>
78
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of an array.  <a href="#gafe61db801ab3b0326646178e536dd161"></a><br/></td></tr>
79
 
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaea0493f5bec9c5c185679adfde3edc9a">stp_array_set_data</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, const double *data)</td></tr>
80
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the data in an array.  <a href="#gaea0493f5bec9c5c185679adfde3edc9a"></a><br/></td></tr>
81
 
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gae0d44ee80048189d244b16f231c54b80">stp_array_get_data</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, size_t *size, const double **data)</td></tr>
82
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the data in an array.  <a href="#gae0d44ee80048189d244b16f231c54b80"></a><br/></td></tr>
83
 
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gad6b95b2efd500007b098594826f4467f">stp_array_set_point</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int x, int y, double data)</td></tr>
84
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the data at a single point in the array.  <a href="#gad6b95b2efd500007b098594826f4467f"></a><br/></td></tr>
85
 
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga9078af984a5e1ec80a6068bdb51c9a6d">stp_array_get_point</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int x, int y, double *data)</td></tr>
86
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the data at a single point in the array.  <a href="#ga9078af984a5e1ec80a6068bdb51c9a6d"></a><br/></td></tr>
87
 
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__sequence.html#ga327a46aa1d782a4cd53abf306068e272">stp_sequence_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gae05ba5cfe8c03e2435348d6c5488d87e">stp_array_get_sequence</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array)</td></tr>
88
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the underlying stp_sequence_t.  <a href="#gae05ba5cfe8c03e2435348d6c5488d87e"></a><br/></td></tr>
 
58
<tr class="memitem:gaa3d385d3e2f248b1c1ac88d5f103e9a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaa3d385d3e2f248b1c1ac88d5f103e9a2">stp_array_create</a> (int x_size, int y_size)</td></tr>
 
59
<tr class="memdesc:gaa3d385d3e2f248b1c1ac88d5f103e9a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new array.  <a href="#gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a><br/></td></tr>
 
60
<tr class="memitem:gaafb2573df35220ef9be3f6ba4b8c871b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaafb2573df35220ef9be3f6ba4b8c871b">stp_array_destroy</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array)</td></tr>
 
61
<tr class="memdesc:gaafb2573df35220ef9be3f6ba4b8c871b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy an array.  <a href="#gaafb2573df35220ef9be3f6ba4b8c871b"></a><br/></td></tr>
 
62
<tr class="memitem:gaaa9bf798890e01b4bbce8cda45615021"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaaa9bf798890e01b4bbce8cda45615021">stp_array_copy</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *dest, const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *source)</td></tr>
 
63
<tr class="memdesc:gaaa9bf798890e01b4bbce8cda45615021"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an array.  <a href="#gaaa9bf798890e01b4bbce8cda45615021"></a><br/></td></tr>
 
64
<tr class="memitem:gad0b50228ca40df79196197f9c21f4b56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gad0b50228ca40df79196197f9c21f4b56">stp_array_create_copy</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array)</td></tr>
 
65
<tr class="memdesc:gad0b50228ca40df79196197f9c21f4b56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy and allocate an array.  <a href="#gad0b50228ca40df79196197f9c21f4b56"></a><br/></td></tr>
 
66
<tr class="memitem:gae6fb91b246ef5abd388927cb9674503e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gae6fb91b246ef5abd388927cb9674503e">stp_array_set_size</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int x_size, int y_size)</td></tr>
 
67
<tr class="memdesc:gae6fb91b246ef5abd388927cb9674503e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resize an array.  <a href="#gae6fb91b246ef5abd388927cb9674503e"></a><br/></td></tr>
 
68
<tr class="memitem:gafe61db801ab3b0326646178e536dd161"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gafe61db801ab3b0326646178e536dd161">stp_array_get_size</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int *x_size, int *y_size)</td></tr>
 
69
<tr class="memdesc:gafe61db801ab3b0326646178e536dd161"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of an array.  <a href="#gafe61db801ab3b0326646178e536dd161"></a><br/></td></tr>
 
70
<tr class="memitem:gaea0493f5bec9c5c185679adfde3edc9a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gaea0493f5bec9c5c185679adfde3edc9a">stp_array_set_data</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, const double *data)</td></tr>
 
71
<tr class="memdesc:gaea0493f5bec9c5c185679adfde3edc9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the data in an array.  <a href="#gaea0493f5bec9c5c185679adfde3edc9a"></a><br/></td></tr>
 
72
<tr class="memitem:gae0d44ee80048189d244b16f231c54b80"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gae0d44ee80048189d244b16f231c54b80">stp_array_get_data</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, size_t *size, const double **data)</td></tr>
 
73
<tr class="memdesc:gae0d44ee80048189d244b16f231c54b80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the data in an array.  <a href="#gae0d44ee80048189d244b16f231c54b80"></a><br/></td></tr>
 
74
<tr class="memitem:gad6b95b2efd500007b098594826f4467f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gad6b95b2efd500007b098594826f4467f">stp_array_set_point</a> (<a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int x, int y, double data)</td></tr>
 
75
<tr class="memdesc:gad6b95b2efd500007b098594826f4467f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the data at a single point in the array.  <a href="#gad6b95b2efd500007b098594826f4467f"></a><br/></td></tr>
 
76
<tr class="memitem:ga9078af984a5e1ec80a6068bdb51c9a6d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga9078af984a5e1ec80a6068bdb51c9a6d">stp_array_get_point</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array, int x, int y, double *data)</td></tr>
 
77
<tr class="memdesc:ga9078af984a5e1ec80a6068bdb51c9a6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the data at a single point in the array.  <a href="#ga9078af984a5e1ec80a6068bdb51c9a6d"></a><br/></td></tr>
 
78
<tr class="memitem:gae05ba5cfe8c03e2435348d6c5488d87e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__sequence.html#ga327a46aa1d782a4cd53abf306068e272">stp_sequence_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#gae05ba5cfe8c03e2435348d6c5488d87e">stp_array_get_sequence</a> (const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *array)</td></tr>
 
79
<tr class="memdesc:gae05ba5cfe8c03e2435348d6c5488d87e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the underlying stp_sequence_t.  <a href="#gae05ba5cfe8c03e2435348d6c5488d87e"></a><br/></td></tr>
89
80
</table>
90
81
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
91
82
<p>The array is a simple "two-dimensional array of numbers" data structure. </p>
92
83
<p>array "inherits" from the sequence data structure (implemented via containment). </p>
93
84
<hr/><h2>Typedef Documentation</h2>
94
 
<a class="anchor" id="ga26a474575a39c1c36ad520b95aa813b0"></a><!-- doxytag: member="array.h::stp_array_t" ref="ga26a474575a39c1c36ad520b95aa813b0" args="" -->
 
85
<a class="anchor" id="ga26a474575a39c1c36ad520b95aa813b0"></a>
95
86
<div class="memitem">
96
87
<div class="memproto">
97
88
      <table class="memname">
99
90
          <td class="memname">typedef struct stp_array <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a></td>
100
91
        </tr>
101
92
      </table>
102
 
</div>
103
 
<div class="memdoc">
 
93
</div><div class="memdoc">
104
94
 
105
95
<p>The array opaque data type. </p>
106
96
 
107
97
</div>
108
98
</div>
109
99
<hr/><h2>Function Documentation</h2>
110
 
<a class="anchor" id="gaaa9bf798890e01b4bbce8cda45615021"></a><!-- doxytag: member="array.h::stp_array_copy" ref="gaaa9bf798890e01b4bbce8cda45615021" args="(stp_array_t *dest, const stp_array_t *source)" -->
 
100
<a class="anchor" id="gaaa9bf798890e01b4bbce8cda45615021"></a>
111
101
<div class="memitem">
112
102
<div class="memproto">
113
103
      <table class="memname">
114
104
        <tr>
115
 
          <td class="memname">void <a class="el" href="group__array.html#gaaa9bf798890e01b4bbce8cda45615021">stp_array_copy</a> </td>
 
105
          <td class="memname">void stp_array_copy </td>
116
106
          <td>(</td>
117
107
          <td class="paramtype"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
118
108
          <td class="paramname"><em>dest</em>, </td>
129
119
          <td></td><td></td>
130
120
        </tr>
131
121
      </table>
132
 
</div>
133
 
<div class="memdoc">
 
122
</div><div class="memdoc">
134
123
 
135
124
<p>Copy an array. </p>
136
125
<p>Both dest and source must be valid arrays previously created with <a class="el" href="group__array.html#gaa3d385d3e2f248b1c1ac88d5f103e9a2" title="Create a new array.">stp_array_create()</a>. </p>
137
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
126
<dl class="params"><dt>Parameters:</dt><dd>
138
127
  <table class="params">
139
128
    <tr><td class="paramname">dest</td><td>the destination array. </td></tr>
140
129
    <tr><td class="paramname">source</td><td>the source array. </td></tr>
144
133
 
145
134
</div>
146
135
</div>
147
 
<a class="anchor" id="gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a><!-- doxytag: member="array.h::stp_array_create" ref="gaa3d385d3e2f248b1c1ac88d5f103e9a2" args="(int x_size, int y_size)" -->
 
136
<a class="anchor" id="gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a>
148
137
<div class="memitem">
149
138
<div class="memproto">
150
139
      <table class="memname">
151
140
        <tr>
152
 
          <td class="memname"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a>* <a class="el" href="group__array.html#gaa3d385d3e2f248b1c1ac88d5f103e9a2">stp_array_create</a> </td>
 
141
          <td class="memname"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a>* stp_array_create </td>
153
142
          <td>(</td>
154
143
          <td class="paramtype">int&#160;</td>
155
144
          <td class="paramname"><em>x_size</em>, </td>
166
155
          <td></td><td></td>
167
156
        </tr>
168
157
      </table>
169
 
</div>
170
 
<div class="memdoc">
 
158
</div><div class="memdoc">
171
159
 
172
160
<p>Create a new array. </p>
173
161
<p>The total size of the array will be (x_size * y_size). </p>
174
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
162
<dl class="params"><dt>Parameters:</dt><dd>
175
163
  <table class="params">
176
164
    <tr><td class="paramname">x_size</td><td>the number of "columns". </td></tr>
177
165
    <tr><td class="paramname">y_size</td><td>the number of "rows". </td></tr>
178
166
  </table>
179
167
  </dd>
180
168
</dl>
181
 
<dl class="return"><dt><b>Returns:</b></dt><dd>the newly created array. </dd></dl>
 
169
<dl class="section return"><dt>Returns:</dt><dd>the newly created array. </dd></dl>
182
170
 
183
171
</div>
184
172
</div>
185
 
<a class="anchor" id="gad0b50228ca40df79196197f9c21f4b56"></a><!-- doxytag: member="array.h::stp_array_create_copy" ref="gad0b50228ca40df79196197f9c21f4b56" args="(const stp_array_t *array)" -->
 
173
<a class="anchor" id="gad0b50228ca40df79196197f9c21f4b56"></a>
186
174
<div class="memitem">
187
175
<div class="memproto">
188
176
      <table class="memname">
189
177
        <tr>
190
 
          <td class="memname"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a>* <a class="el" href="group__array.html#gad0b50228ca40df79196197f9c21f4b56">stp_array_create_copy</a> </td>
 
178
          <td class="memname"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a>* stp_array_create_copy </td>
191
179
          <td>(</td>
192
180
          <td class="paramtype">const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
193
181
          <td class="paramname"><em>array</em></td><td>)</td>
194
182
          <td></td>
195
183
        </tr>
196
184
      </table>
197
 
</div>
198
 
<div class="memdoc">
 
185
</div><div class="memdoc">
199
186
 
200
187
<p>Copy and allocate an array. </p>
201
188
<p>dest will be created, and then the contents of source will be copied into it. dest must not have been previously allocated with <a class="el" href="group__array.html#gaa3d385d3e2f248b1c1ac88d5f103e9a2" title="Create a new array.">stp_array_create()</a>. </p>
202
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
189
<dl class="params"><dt>Parameters:</dt><dd>
203
190
  <table class="params">
204
191
    <tr><td class="paramname">array</td><td>the source array. </td></tr>
205
192
  </table>
206
193
  </dd>
207
194
</dl>
208
 
<dl class="return"><dt><b>Returns:</b></dt><dd>the new copy of the array. </dd></dl>
 
195
<dl class="section return"><dt>Returns:</dt><dd>the new copy of the array. </dd></dl>
209
196
 
210
197
</div>
211
198
</div>
212
 
<a class="anchor" id="gaafb2573df35220ef9be3f6ba4b8c871b"></a><!-- doxytag: member="array.h::stp_array_destroy" ref="gaafb2573df35220ef9be3f6ba4b8c871b" args="(stp_array_t *array)" -->
 
199
<a class="anchor" id="gaafb2573df35220ef9be3f6ba4b8c871b"></a>
213
200
<div class="memitem">
214
201
<div class="memproto">
215
202
      <table class="memname">
216
203
        <tr>
217
 
          <td class="memname">void <a class="el" href="group__array.html#gaafb2573df35220ef9be3f6ba4b8c871b">stp_array_destroy</a> </td>
 
204
          <td class="memname">void stp_array_destroy </td>
218
205
          <td>(</td>
219
206
          <td class="paramtype"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
220
207
          <td class="paramname"><em>array</em></td><td>)</td>
221
208
          <td></td>
222
209
        </tr>
223
210
      </table>
224
 
</div>
225
 
<div class="memdoc">
 
211
</div><div class="memdoc">
226
212
 
227
213
<p>Destroy an array. </p>
228
214
<p>It is an error to destroy the array more than once. </p>
229
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
215
<dl class="params"><dt>Parameters:</dt><dd>
230
216
  <table class="params">
231
217
    <tr><td class="paramname">array</td><td>the array to destroy. </td></tr>
232
218
  </table>
235
221
 
236
222
</div>
237
223
</div>
238
 
<a class="anchor" id="gae0d44ee80048189d244b16f231c54b80"></a><!-- doxytag: member="array.h::stp_array_get_data" ref="gae0d44ee80048189d244b16f231c54b80" args="(const stp_array_t *array, size_t *size, const double **data)" -->
 
224
<a class="anchor" id="gae0d44ee80048189d244b16f231c54b80"></a>
239
225
<div class="memitem">
240
226
<div class="memproto">
241
227
      <table class="memname">
242
228
        <tr>
243
 
          <td class="memname">void <a class="el" href="group__array.html#gae0d44ee80048189d244b16f231c54b80">stp_array_get_data</a> </td>
 
229
          <td class="memname">void stp_array_get_data </td>
244
230
          <td>(</td>
245
231
          <td class="paramtype">const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
246
232
          <td class="paramname"><em>array</em>, </td>
263
249
          <td></td><td></td>
264
250
        </tr>
265
251
      </table>
266
 
</div>
267
 
<div class="memdoc">
 
252
</div><div class="memdoc">
268
253
 
269
254
<p>Get the data in an array. </p>
270
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
255
<dl class="params"><dt>Parameters:</dt><dd>
271
256
  <table class="params">
272
257
    <tr><td class="paramname">array</td><td>the array to get the data from. </td></tr>
273
258
    <tr><td class="paramname">size</td><td>the number of elements in the array (x_size * y_size) are stored in the size_t pointed to. </td></tr>
274
 
    <tr><td class="paramname">data</td><td>a pointer to the first element of an array of doubles is stored in a pointer to double*. <div class="fragment"><pre class="fragment"> <a class="code" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0" title="The array opaque data type.">stp_array_t</a> *array;
275
 
 <span class="keywordtype">size_t</span> size;
276
 
 <span class="keywordtype">double</span> *data;
277
 
 <a class="code" href="group__array.html#gae0d44ee80048189d244b16f231c54b80" title="Get the data in an array.">stp_array_get_data</a>(array, &amp;size, &amp;data);
278
 
</pre></div> </td></tr>
 
259
    <tr><td class="paramname">data</td><td>a pointer to the first element of an array of doubles is stored in a pointer to double*. <div class="fragment"><div class="line"> <a class="code" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0" title="The array opaque data type.">stp_array_t</a> *array;</div>
 
260
<div class="line"> <span class="keywordtype">size_t</span> size;</div>
 
261
<div class="line"> <span class="keywordtype">double</span> *data;</div>
 
262
<div class="line"> <a class="code" href="group__array.html#gae0d44ee80048189d244b16f231c54b80" title="Get the data in an array.">stp_array_get_data</a>(array, &amp;size, &amp;data);</div>
 
263
</div><!-- fragment --> </td></tr>
279
264
  </table>
280
265
  </dd>
281
266
</dl>
282
267
 
283
268
</div>
284
269
</div>
285
 
<a class="anchor" id="ga9078af984a5e1ec80a6068bdb51c9a6d"></a><!-- doxytag: member="array.h::stp_array_get_point" ref="ga9078af984a5e1ec80a6068bdb51c9a6d" args="(const stp_array_t *array, int x, int y, double *data)" -->
 
270
<a class="anchor" id="ga9078af984a5e1ec80a6068bdb51c9a6d"></a>
286
271
<div class="memitem">
287
272
<div class="memproto">
288
273
      <table class="memname">
289
274
        <tr>
290
 
          <td class="memname">int <a class="el" href="group__array.html#ga9078af984a5e1ec80a6068bdb51c9a6d">stp_array_get_point</a> </td>
 
275
          <td class="memname">int stp_array_get_point </td>
291
276
          <td>(</td>
292
277
          <td class="paramtype">const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
293
278
          <td class="paramname"><em>array</em>, </td>
316
301
          <td></td><td></td>
317
302
        </tr>
318
303
      </table>
319
 
</div>
320
 
<div class="memdoc">
 
304
</div><div class="memdoc">
321
305
 
322
306
<p>Get the data at a single point in the array. </p>
323
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
307
<dl class="params"><dt>Parameters:</dt><dd>
324
308
  <table class="params">
325
309
    <tr><td class="paramname">array</td><td>the array to use. </td></tr>
326
310
    <tr><td class="paramname">x</td><td>the x location. </td></tr>
329
313
  </table>
330
314
  </dd>
331
315
</dl>
332
 
<dl class="return"><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl>
 
316
<dl class="section return"><dt>Returns:</dt><dd>1 on success, 0 on failure. </dd></dl>
333
317
 
334
318
</div>
335
319
</div>
336
 
<a class="anchor" id="gae05ba5cfe8c03e2435348d6c5488d87e"></a><!-- doxytag: member="array.h::stp_array_get_sequence" ref="gae05ba5cfe8c03e2435348d6c5488d87e" args="(const stp_array_t *array)" -->
 
320
<a class="anchor" id="gae05ba5cfe8c03e2435348d6c5488d87e"></a>
337
321
<div class="memitem">
338
322
<div class="memproto">
339
323
      <table class="memname">
340
324
        <tr>
341
 
          <td class="memname">const <a class="el" href="group__sequence.html#ga327a46aa1d782a4cd53abf306068e272">stp_sequence_t</a>* <a class="el" href="group__array.html#gae05ba5cfe8c03e2435348d6c5488d87e">stp_array_get_sequence</a> </td>
 
325
          <td class="memname">const <a class="el" href="group__sequence.html#ga327a46aa1d782a4cd53abf306068e272">stp_sequence_t</a>* stp_array_get_sequence </td>
342
326
          <td>(</td>
343
327
          <td class="paramtype">const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
344
328
          <td class="paramname"><em>array</em></td><td>)</td>
345
329
          <td></td>
346
330
        </tr>
347
331
      </table>
348
 
</div>
349
 
<div class="memdoc">
 
332
</div><div class="memdoc">
350
333
 
351
334
<p>Get the underlying stp_sequence_t. </p>
352
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
335
<dl class="params"><dt>Parameters:</dt><dd>
353
336
  <table class="params">
354
337
    <tr><td class="paramname">array</td><td>the array to use. </td></tr>
355
338
  </table>
356
339
  </dd>
357
340
</dl>
358
 
<dl class="return"><dt><b>Returns:</b></dt><dd>the (constant) stp_sequence_t. </dd></dl>
 
341
<dl class="section return"><dt>Returns:</dt><dd>the (constant) stp_sequence_t. </dd></dl>
359
342
 
360
343
</div>
361
344
</div>
362
 
<a class="anchor" id="gafe61db801ab3b0326646178e536dd161"></a><!-- doxytag: member="array.h::stp_array_get_size" ref="gafe61db801ab3b0326646178e536dd161" args="(const stp_array_t *array, int *x_size, int *y_size)" -->
 
345
<a class="anchor" id="gafe61db801ab3b0326646178e536dd161"></a>
363
346
<div class="memitem">
364
347
<div class="memproto">
365
348
      <table class="memname">
366
349
        <tr>
367
 
          <td class="memname">void <a class="el" href="group__array.html#gafe61db801ab3b0326646178e536dd161">stp_array_get_size</a> </td>
 
350
          <td class="memname">void stp_array_get_size </td>
368
351
          <td>(</td>
369
352
          <td class="paramtype">const <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
370
353
          <td class="paramname"><em>array</em>, </td>
387
370
          <td></td><td></td>
388
371
        </tr>
389
372
      </table>
390
 
</div>
391
 
<div class="memdoc">
 
373
</div><div class="memdoc">
392
374
 
393
375
<p>Get the size of an array. </p>
394
376
<p>The current x and y sizes are stored in the integers pointed to by x_size and y_size. </p>
395
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
377
<dl class="params"><dt>Parameters:</dt><dd>
396
378
  <table class="params">
397
379
    <tr><td class="paramname">array</td><td>the array to get the size of. </td></tr>
398
380
    <tr><td class="paramname">x_size</td><td>a pointer to an integer to store the x size in. </td></tr>
403
385
 
404
386
</div>
405
387
</div>
406
 
<a class="anchor" id="gaea0493f5bec9c5c185679adfde3edc9a"></a><!-- doxytag: member="array.h::stp_array_set_data" ref="gaea0493f5bec9c5c185679adfde3edc9a" args="(stp_array_t *array, const double *data)" -->
 
388
<a class="anchor" id="gaea0493f5bec9c5c185679adfde3edc9a"></a>
407
389
<div class="memitem">
408
390
<div class="memproto">
409
391
      <table class="memname">
410
392
        <tr>
411
 
          <td class="memname">void <a class="el" href="group__array.html#gaea0493f5bec9c5c185679adfde3edc9a">stp_array_set_data</a> </td>
 
393
          <td class="memname">void stp_array_set_data </td>
412
394
          <td>(</td>
413
395
          <td class="paramtype"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
414
396
          <td class="paramname"><em>array</em>, </td>
425
407
          <td></td><td></td>
426
408
        </tr>
427
409
      </table>
428
 
</div>
429
 
<div class="memdoc">
 
410
</div><div class="memdoc">
430
411
 
431
412
<p>Set the data in an array. </p>
432
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
413
<dl class="params"><dt>Parameters:</dt><dd>
433
414
  <table class="params">
434
415
    <tr><td class="paramname">array</td><td>the array to set. </td></tr>
435
 
    <tr><td class="paramname">data</td><td>a pointer to the first member of an array containing the data to set. This array must be at least as long as (x_size * y_size). </td></tr>
 
416
    <tr><td class="paramname">data</td><td>a pointer to the first member of an array containing the data to set. This array must be at least as long as (x_size<ul>
 
417
<li>y_size). </li>
 
418
</ul>
 
419
</td></tr>
436
420
  </table>
437
421
  </dd>
438
422
</dl>
439
423
 
440
424
</div>
441
425
</div>
442
 
<a class="anchor" id="gad6b95b2efd500007b098594826f4467f"></a><!-- doxytag: member="array.h::stp_array_set_point" ref="gad6b95b2efd500007b098594826f4467f" args="(stp_array_t *array, int x, int y, double data)" -->
 
426
<a class="anchor" id="gad6b95b2efd500007b098594826f4467f"></a>
443
427
<div class="memitem">
444
428
<div class="memproto">
445
429
      <table class="memname">
446
430
        <tr>
447
 
          <td class="memname">int <a class="el" href="group__array.html#gad6b95b2efd500007b098594826f4467f">stp_array_set_point</a> </td>
 
431
          <td class="memname">int stp_array_set_point </td>
448
432
          <td>(</td>
449
433
          <td class="paramtype"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
450
434
          <td class="paramname"><em>array</em>, </td>
473
457
          <td></td><td></td>
474
458
        </tr>
475
459
      </table>
476
 
</div>
477
 
<div class="memdoc">
 
460
</div><div class="memdoc">
478
461
 
479
462
<p>Set the data at a single point in the array. </p>
480
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
463
<dl class="params"><dt>Parameters:</dt><dd>
481
464
  <table class="params">
482
465
    <tr><td class="paramname">array</td><td>the array to use. </td></tr>
483
466
    <tr><td class="paramname">x</td><td>the x location. </td></tr>
486
469
  </table>
487
470
  </dd>
488
471
</dl>
489
 
<dl class="return"><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl>
 
472
<dl class="section return"><dt>Returns:</dt><dd>1 on success, 0 on failure. </dd></dl>
490
473
 
491
474
</div>
492
475
</div>
493
 
<a class="anchor" id="gae6fb91b246ef5abd388927cb9674503e"></a><!-- doxytag: member="array.h::stp_array_set_size" ref="gae6fb91b246ef5abd388927cb9674503e" args="(stp_array_t *array, int x_size, int y_size)" -->
 
476
<a class="anchor" id="gae6fb91b246ef5abd388927cb9674503e"></a>
494
477
<div class="memitem">
495
478
<div class="memproto">
496
479
      <table class="memname">
497
480
        <tr>
498
 
          <td class="memname">void <a class="el" href="group__array.html#gae6fb91b246ef5abd388927cb9674503e">stp_array_set_size</a> </td>
 
481
          <td class="memname">void stp_array_set_size </td>
499
482
          <td>(</td>
500
483
          <td class="paramtype"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *&#160;</td>
501
484
          <td class="paramname"><em>array</em>, </td>
518
501
          <td></td><td></td>
519
502
        </tr>
520
503
      </table>
521
 
</div>
522
 
<div class="memdoc">
 
504
</div><div class="memdoc">
523
505
 
524
506
<p>Resize an array. </p>
525
507
<p>Resizing an array will destroy all data stored in the array. </p>
526
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
508
<dl class="params"><dt>Parameters:</dt><dd>
527
509
  <table class="params">
528
510
    <tr><td class="paramname">array</td><td>the array to resize. </td></tr>
529
511
    <tr><td class="paramname">x_size</td><td>the new number of "columns". </td></tr>
535
517
</div>
536
518
</div>
537
519
</div><!-- contents -->
538
 
 
539
 
 
 
520
<!-- start footer part -->
540
521
<hr class="footer"/><address class="footer"><small>
541
522
Generated by &#160;<a href="http://www.doxygen.org/index.html">
542
523
<img class="footer" src="doxygen.png" alt="doxygen"/>
543
 
</a> 1.7.6.1
 
524
</a> 1.8.1
544
525
</small></address>
545
 
 
546
526
</body>
547
527
</html>