diff options
| author | Roger Leigh <rleigh@debian.org> | 2012-06-21 23:30:20 +0100 |
|---|---|---|
| committer | Roger Leigh <rleigh@debian.org> | 2012-06-21 23:30:20 +0100 |
| commit | 3514df18b289ec827cb6e4c446419feab1813231 (patch) | |
| tree | 0fe6a3d1afbe720aac197918c6f4fb3583b240e1 /doc/gutenprint/html/group__array.html | |
| parent | 15578e218035547ca17e25ef351fbe56bc55a4ae (diff) | |
Imported Upstream version 5.2.8
Diffstat (limited to 'doc/gutenprint/html/group__array.html')
| -rw-r--r-- | doc/gutenprint/html/group__array.html | 189 |
1 files changed, 95 insertions, 94 deletions
diff --git a/doc/gutenprint/html/group__array.html b/doc/gutenprint/html/group__array.html index 9d7a81d..d13eac6 100644 --- a/doc/gutenprint/html/group__array.html +++ b/doc/gutenprint/html/group__array.html @@ -2,24 +2,30 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>libgutenprint API Reference: array</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> -<link href="doxygen.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> -<!-- Generated by Doxygen 1.7.4 --> -<div id="top"> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> - <div id="projectname">libgutenprint API Reference <span id="projectnumber">5.2.7</span></div> + <div id="projectname">libgutenprint API Reference +  <span id="projectnumber">5.2.8</span> + </div> </td> </tr> </tbody> </table> </div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> @@ -29,53 +35,54 @@ <li><a href="files.html"><span>Files</span></a></li> </ul> </div> -</div> +</div><!-- top --> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">array</div> </div> -</div> +</div><!--header--> <div class="contents"> <p>The array is a simple "two-dimensional array of numbers" data structure. <a href="#details">More...</a></p> <table class="memberdecls"> -<tr><td colspan="2"><h2><a name="typedef-members"></a> +<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">typedef struct stp_array </td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">The array opaque data type. <a href="#ga26a474575a39c1c36ad520b95aa813b0"></a><br/></td></tr> -<tr><td colspan="2"><h2><a name="func-members"></a> +<tr class="memitem:ga26a474575a39c1c36ad520b95aa813b0"><td class="memItemLeft" align="right" valign="top">typedef struct stp_array </td><td class="memItemRight" valign="bottom"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a></td></tr> +<tr class="memdesc:ga26a474575a39c1c36ad520b95aa813b0"><td class="mdescLeft"> </td><td class="mdescRight">The array opaque data type. <a href="#ga26a474575a39c1c36ad520b95aa813b0"></a><br/></td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> * </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new array. <a href="#gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy an array. <a href="#gaafb2573df35220ef9be3f6ba4b8c871b"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy an array. <a href="#gaaa9bf798890e01b4bbce8cda45615021"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> * </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy and allocate an array. <a href="#gad0b50228ca40df79196197f9c21f4b56"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Resize an array. <a href="#gae6fb91b246ef5abd388927cb9674503e"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of an array. <a href="#gafe61db801ab3b0326646178e536dd161"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data in an array. <a href="#gaea0493f5bec9c5c185679adfde3edc9a"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the data in an array. <a href="#gae0d44ee80048189d244b16f231c54b80"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">int </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data at a single point in the array. <a href="#gad6b95b2efd500007b098594826f4467f"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">int </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the data at a single point in the array. <a href="#ga9078af984a5e1ec80a6068bdb51c9a6d"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__sequence.html#ga327a46aa1d782a4cd53abf306068e272">stp_sequence_t</a> * </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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the underlying stp_sequence_t. <a href="#gae05ba5cfe8c03e2435348d6c5488d87e"></a><br/></td></tr> +<tr class="memitem:gaa3d385d3e2f248b1c1ac88d5f103e9a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> * </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> +<tr class="memdesc:gaa3d385d3e2f248b1c1ac88d5f103e9a2"><td class="mdescLeft"> </td><td class="mdescRight">Create a new array. <a href="#gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a><br/></td></tr> +<tr class="memitem:gaafb2573df35220ef9be3f6ba4b8c871b"><td class="memItemLeft" align="right" valign="top">void </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> +<tr class="memdesc:gaafb2573df35220ef9be3f6ba4b8c871b"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an array. <a href="#gaafb2573df35220ef9be3f6ba4b8c871b"></a><br/></td></tr> +<tr class="memitem:gaaa9bf798890e01b4bbce8cda45615021"><td class="memItemLeft" align="right" valign="top">void </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> +<tr class="memdesc:gaaa9bf798890e01b4bbce8cda45615021"><td class="mdescLeft"> </td><td class="mdescRight">Copy an array. <a href="#gaaa9bf798890e01b4bbce8cda45615021"></a><br/></td></tr> +<tr class="memitem:gad0b50228ca40df79196197f9c21f4b56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> * </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> +<tr class="memdesc:gad0b50228ca40df79196197f9c21f4b56"><td class="mdescLeft"> </td><td class="mdescRight">Copy and allocate an array. <a href="#gad0b50228ca40df79196197f9c21f4b56"></a><br/></td></tr> +<tr class="memitem:gae6fb91b246ef5abd388927cb9674503e"><td class="memItemLeft" align="right" valign="top">void </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> +<tr class="memdesc:gae6fb91b246ef5abd388927cb9674503e"><td class="mdescLeft"> </td><td class="mdescRight">Resize an array. <a href="#gae6fb91b246ef5abd388927cb9674503e"></a><br/></td></tr> +<tr class="memitem:gafe61db801ab3b0326646178e536dd161"><td class="memItemLeft" align="right" valign="top">void </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> +<tr class="memdesc:gafe61db801ab3b0326646178e536dd161"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of an array. <a href="#gafe61db801ab3b0326646178e536dd161"></a><br/></td></tr> +<tr class="memitem:gaea0493f5bec9c5c185679adfde3edc9a"><td class="memItemLeft" align="right" valign="top">void </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> +<tr class="memdesc:gaea0493f5bec9c5c185679adfde3edc9a"><td class="mdescLeft"> </td><td class="mdescRight">Set the data in an array. <a href="#gaea0493f5bec9c5c185679adfde3edc9a"></a><br/></td></tr> +<tr class="memitem:gae0d44ee80048189d244b16f231c54b80"><td class="memItemLeft" align="right" valign="top">void </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> +<tr class="memdesc:gae0d44ee80048189d244b16f231c54b80"><td class="mdescLeft"> </td><td class="mdescRight">Get the data in an array. <a href="#gae0d44ee80048189d244b16f231c54b80"></a><br/></td></tr> +<tr class="memitem:gad6b95b2efd500007b098594826f4467f"><td class="memItemLeft" align="right" valign="top">int </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> +<tr class="memdesc:gad6b95b2efd500007b098594826f4467f"><td class="mdescLeft"> </td><td class="mdescRight">Set the data at a single point in the array. <a href="#gad6b95b2efd500007b098594826f4467f"></a><br/></td></tr> +<tr class="memitem:ga9078af984a5e1ec80a6068bdb51c9a6d"><td class="memItemLeft" align="right" valign="top">int </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> +<tr class="memdesc:ga9078af984a5e1ec80a6068bdb51c9a6d"><td class="mdescLeft"> </td><td class="mdescRight">Get the data at a single point in the array. <a href="#ga9078af984a5e1ec80a6068bdb51c9a6d"></a><br/></td></tr> +<tr class="memitem:gae05ba5cfe8c03e2435348d6c5488d87e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__sequence.html#ga327a46aa1d782a4cd53abf306068e272">stp_sequence_t</a> * </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> +<tr class="memdesc:gae05ba5cfe8c03e2435348d6c5488d87e"><td class="mdescLeft"> </td><td class="mdescRight">Get the underlying stp_sequence_t. <a href="#gae05ba5cfe8c03e2435348d6c5488d87e"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <p>The array is a simple "two-dimensional array of numbers" data structure. </p> <p>array "inherits" from the sequence data structure (implemented via containment). </p> <hr/><h2>Typedef Documentation</h2> -<a class="anchor" id="ga26a474575a39c1c36ad520b95aa813b0"></a><!-- doxytag: member="array.h::stp_array_t" ref="ga26a474575a39c1c36ad520b95aa813b0" args="" --> +<a class="anchor" id="ga26a474575a39c1c36ad520b95aa813b0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -83,15 +90,14 @@ Functions</h2></td></tr> <td class="memname">typedef struct stp_array <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>The array opaque data type. </p> </div> </div> <hr/><h2>Function Documentation</h2> -<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)" --> +<a class="anchor" id="gaaa9bf798890e01b4bbce8cda45615021"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -113,12 +119,11 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Copy an array. </p> <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> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">dest</td><td>the destination array. </td></tr> <tr><td class="paramname">source</td><td>the source array. </td></tr> @@ -128,7 +133,7 @@ Functions</h2></td></tr> </div> </div> -<a class="anchor" id="gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a><!-- doxytag: member="array.h::stp_array_create" ref="gaa3d385d3e2f248b1c1ac88d5f103e9a2" args="(int x_size, int y_size)" --> +<a class="anchor" id="gaa3d385d3e2f248b1c1ac88d5f103e9a2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -150,23 +155,22 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Create a new array. </p> <p>The total size of the array will be (x_size * y_size). </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">x_size</td><td>the number of "columns". </td></tr> <tr><td class="paramname">y_size</td><td>the number of "rows". </td></tr> </table> </dd> </dl> -<dl class="return"><dt><b>Returns:</b></dt><dd>the newly created array. </dd></dl> +<dl class="section return"><dt>Returns:</dt><dd>the newly created array. </dd></dl> </div> </div> -<a class="anchor" id="gad0b50228ca40df79196197f9c21f4b56"></a><!-- doxytag: member="array.h::stp_array_create_copy" ref="gad0b50228ca40df79196197f9c21f4b56" args="(const stp_array_t *array)" --> +<a class="anchor" id="gad0b50228ca40df79196197f9c21f4b56"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -178,22 +182,21 @@ Functions</h2></td></tr> <td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Copy and allocate an array. </p> <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> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the source array. </td></tr> </table> </dd> </dl> -<dl class="return"><dt><b>Returns:</b></dt><dd>the new copy of the array. </dd></dl> +<dl class="section return"><dt>Returns:</dt><dd>the new copy of the array. </dd></dl> </div> </div> -<a class="anchor" id="gaafb2573df35220ef9be3f6ba4b8c871b"></a><!-- doxytag: member="array.h::stp_array_destroy" ref="gaafb2573df35220ef9be3f6ba4b8c871b" args="(stp_array_t *array)" --> +<a class="anchor" id="gaafb2573df35220ef9be3f6ba4b8c871b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -205,12 +208,11 @@ Functions</h2></td></tr> <td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Destroy an array. </p> <p>It is an error to destroy the array more than once. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to destroy. </td></tr> </table> @@ -219,7 +221,7 @@ Functions</h2></td></tr> </div> </div> -<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)" --> +<a class="anchor" id="gae0d44ee80048189d244b16f231c54b80"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -247,26 +249,25 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Get the data in an array. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to get the data from. </td></tr> <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> - <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; - <span class="keywordtype">size_t</span> size; - <span class="keywordtype">double</span> *data; - <a class="code" href="group__array.html#gae0d44ee80048189d244b16f231c54b80" title="Get the data in an array.">stp_array_get_data</a>(array, &size, &data); -</pre></div> </td></tr> + <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> +<div class="line"> <span class="keywordtype">size_t</span> size;</div> +<div class="line"> <span class="keywordtype">double</span> *data;</div> +<div class="line"> <a class="code" href="group__array.html#gae0d44ee80048189d244b16f231c54b80" title="Get the data in an array.">stp_array_get_data</a>(array, &size, &data);</div> +</div><!-- fragment --> </td></tr> </table> </dd> </dl> </div> </div> -<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)" --> +<a class="anchor" id="ga9078af984a5e1ec80a6068bdb51c9a6d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -300,11 +301,10 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Get the data at a single point in the array. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to use. </td></tr> <tr><td class="paramname">x</td><td>the x location. </td></tr> @@ -313,11 +313,11 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="return"><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl> +<dl class="section return"><dt>Returns:</dt><dd>1 on success, 0 on failure. </dd></dl> </div> </div> -<a class="anchor" id="gae05ba5cfe8c03e2435348d6c5488d87e"></a><!-- doxytag: member="array.h::stp_array_get_sequence" ref="gae05ba5cfe8c03e2435348d6c5488d87e" args="(const stp_array_t *array)" --> +<a class="anchor" id="gae05ba5cfe8c03e2435348d6c5488d87e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -329,21 +329,20 @@ Functions</h2></td></tr> <td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Get the underlying stp_sequence_t. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to use. </td></tr> </table> </dd> </dl> -<dl class="return"><dt><b>Returns:</b></dt><dd>the (constant) stp_sequence_t. </dd></dl> +<dl class="section return"><dt>Returns:</dt><dd>the (constant) stp_sequence_t. </dd></dl> </div> </div> -<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)" --> +<a class="anchor" id="gafe61db801ab3b0326646178e536dd161"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -371,12 +370,11 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Get the size of an array. </p> <p>The current x and y sizes are stored in the integers pointed to by x_size and y_size. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to get the size of. </td></tr> <tr><td class="paramname">x_size</td><td>a pointer to an integer to store the x size in. </td></tr> @@ -387,7 +385,7 @@ Functions</h2></td></tr> </div> </div> -<a class="anchor" id="gaea0493f5bec9c5c185679adfde3edc9a"></a><!-- doxytag: member="array.h::stp_array_set_data" ref="gaea0493f5bec9c5c185679adfde3edc9a" args="(stp_array_t *array, const double *data)" --> +<a class="anchor" id="gaea0493f5bec9c5c185679adfde3edc9a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -409,21 +407,23 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Set the data in an array. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to set. </td></tr> - <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> + <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> +<li>y_size). </li> +</ul> +</td></tr> </table> </dd> </dl> </div> </div> -<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)" --> +<a class="anchor" id="gad6b95b2efd500007b098594826f4467f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -457,11 +457,10 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Set the data at a single point in the array. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to use. </td></tr> <tr><td class="paramname">x</td><td>the x location. </td></tr> @@ -470,11 +469,11 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="return"><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure. </dd></dl> +<dl class="section return"><dt>Returns:</dt><dd>1 on success, 0 on failure. </dd></dl> </div> </div> -<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)" --> +<a class="anchor" id="gae6fb91b246ef5abd388927cb9674503e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -502,12 +501,11 @@ Functions</h2></td></tr> <td></td><td></td> </tr> </table> -</div> -<div class="memdoc"> +</div><div class="memdoc"> <p>Resize an array. </p> <p>Resizing an array will destroy all data stored in the array. </p> -<dl><dt><b>Parameters:</b></dt><dd> +<dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>the array to resize. </td></tr> <tr><td class="paramname">x_size</td><td>the new number of "columns". </td></tr> @@ -518,9 +516,12 @@ Functions</h2></td></tr> </div> </div> -</div> -<hr class="footer"/><address class="footer"><small>Generated by  -<a href="http://www.doxygen.org/index.html"> -<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.1 +</small></address> </body> </html> |