diff options
Diffstat (limited to 'doc/gutenprint/html/group__array.html')
| -rw-r--r-- | doc/gutenprint/html/group__array.html | 97 |
1 files changed, 55 insertions, 42 deletions
diff --git a/doc/gutenprint/html/group__array.html b/doc/gutenprint/html/group__array.html index 109dfec..03ca85b 100644 --- a/doc/gutenprint/html/group__array.html +++ b/doc/gutenprint/html/group__array.html @@ -3,6 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> <title>libgutenprint API Reference: array</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> @@ -17,7 +18,7 @@ <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libgutenprint API Reference -  <span id="projectnumber">5.2.9</span> +  <span id="projectnumber">5.2.10-pre1</span> </div> </td> </tr> @@ -25,7 +26,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.1 --> +<!-- Generated by Doxygen 1.8.6 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> @@ -48,40 +49,52 @@ <p>The array is a simple "two-dimensional array of numbers" data structure. <a href="#details">More...</a></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <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> +<tr class="memdesc:ga26a474575a39c1c36ad520b95aa813b0"><td class="mdescLeft"> </td><td class="mdescRight">The array opaque data type. <a href="#ga26a474575a39c1c36ad520b95aa813b0">More...</a><br/></td></tr> +<tr class="separator:ga26a474575a39c1c36ad520b95aa813b0"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2><a name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></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="memdesc:gaa3d385d3e2f248b1c1ac88d5f103e9a2"><td class="mdescLeft"> </td><td class="mdescRight">Create a new array. <a href="#gaa3d385d3e2f248b1c1ac88d5f103e9a2">More...</a><br/></td></tr> +<tr class="separator:gaa3d385d3e2f248b1c1ac88d5f103e9a2"><td class="memSeparator" colspan="2"> </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="memdesc:gaafb2573df35220ef9be3f6ba4b8c871b"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an array. <a href="#gaafb2573df35220ef9be3f6ba4b8c871b">More...</a><br/></td></tr> +<tr class="separator:gaafb2573df35220ef9be3f6ba4b8c871b"><td class="memSeparator" colspan="2"> </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="memdesc:gaaa9bf798890e01b4bbce8cda45615021"><td class="mdescLeft"> </td><td class="mdescRight">Copy an array. <a href="#gaaa9bf798890e01b4bbce8cda45615021">More...</a><br/></td></tr> +<tr class="separator:gaaa9bf798890e01b4bbce8cda45615021"><td class="memSeparator" colspan="2"> </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="memdesc:gad0b50228ca40df79196197f9c21f4b56"><td class="mdescLeft"> </td><td class="mdescRight">Copy and allocate an array. <a href="#gad0b50228ca40df79196197f9c21f4b56">More...</a><br/></td></tr> +<tr class="separator:gad0b50228ca40df79196197f9c21f4b56"><td class="memSeparator" colspan="2"> </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="memdesc:gae6fb91b246ef5abd388927cb9674503e"><td class="mdescLeft"> </td><td class="mdescRight">Resize an array. <a href="#gae6fb91b246ef5abd388927cb9674503e">More...</a><br/></td></tr> +<tr class="separator:gae6fb91b246ef5abd388927cb9674503e"><td class="memSeparator" colspan="2"> </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="memdesc:gafe61db801ab3b0326646178e536dd161"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of an array. <a href="#gafe61db801ab3b0326646178e536dd161">More...</a><br/></td></tr> +<tr class="separator:gafe61db801ab3b0326646178e536dd161"><td class="memSeparator" colspan="2"> </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="memdesc:gaea0493f5bec9c5c185679adfde3edc9a"><td class="mdescLeft"> </td><td class="mdescRight">Set the data in an array. <a href="#gaea0493f5bec9c5c185679adfde3edc9a">More...</a><br/></td></tr> +<tr class="separator:gaea0493f5bec9c5c185679adfde3edc9a"><td class="memSeparator" colspan="2"> </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="memdesc:gae0d44ee80048189d244b16f231c54b80"><td class="mdescLeft"> </td><td class="mdescRight">Get the data in an array. <a href="#gae0d44ee80048189d244b16f231c54b80">More...</a><br/></td></tr> +<tr class="separator:gae0d44ee80048189d244b16f231c54b80"><td class="memSeparator" colspan="2"> </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="memdesc:gad6b95b2efd500007b098594826f4467f"><td class="mdescLeft"> </td><td class="mdescRight">Set the data at a single point in the array. <a href="#gad6b95b2efd500007b098594826f4467f">More...</a><br/></td></tr> +<tr class="separator:gad6b95b2efd500007b098594826f4467f"><td class="memSeparator" colspan="2"> </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="memdesc:ga9078af984a5e1ec80a6068bdb51c9a6d"><td class="mdescLeft"> </td><td class="mdescRight">Get the data at a single point in the array. <a href="#ga9078af984a5e1ec80a6068bdb51c9a6d">More...</a><br/></td></tr> +<tr class="separator:ga9078af984a5e1ec80a6068bdb51c9a6d"><td class="memSeparator" colspan="2"> </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> +<tr class="memdesc:gae05ba5cfe8c03e2435348d6c5488d87e"><td class="mdescLeft"> </td><td class="mdescRight">Get the underlying stp_sequence_t. <a href="#gae05ba5cfe8c03e2435348d6c5488d87e">More...</a><br/></td></tr> +<tr class="separator:gae05ba5cfe8c03e2435348d6c5488d87e"><td class="memSeparator" colspan="2"> </td></tr> </table> -<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<a name="details" id="details"></a><h2 class="groupheader">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> +<h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="ga26a474575a39c1c36ad520b95aa813b0"></a> <div class="memitem"> <div class="memproto"> @@ -96,7 +109,7 @@ Functions</h2></td></tr> </div> </div> -<hr/><h2>Function Documentation</h2> +<h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="gaaa9bf798890e01b4bbce8cda45615021"></a> <div class="memitem"> <div class="memproto"> @@ -122,8 +135,8 @@ Functions</h2></td></tr> </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 class="params"><dt>Parameters:</dt><dd> +<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 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> @@ -159,14 +172,14 @@ Functions</h2></td></tr> <p>Create a new array. </p> <p>The total size of the array will be (x_size * y_size). </p> -<dl class="params"><dt>Parameters:</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="section return"><dt>Returns:</dt><dd>the newly created array. </dd></dl> +<dl class="section return"><dt>Returns</dt><dd>the newly created array. </dd></dl> </div> </div> @@ -185,14 +198,14 @@ Functions</h2></td></tr> </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 class="params"><dt>Parameters:</dt><dd> +<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 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="section return"><dt>Returns:</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> @@ -212,7 +225,7 @@ Functions</h2></td></tr> <p>Destroy an array. </p> <p>It is an error to destroy the array more than once. </p> -<dl class="params"><dt>Parameters:</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> @@ -252,14 +265,14 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Get the data in an array. </p> -<dl class="params"><dt>Parameters:</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"><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> + <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">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">stp_array_get_data</a>(array, &size, &data);</div> </div><!-- fragment --> </td></tr> </table> </dd> @@ -304,7 +317,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Get the data at a single point in the array. </p> -<dl class="params"><dt>Parameters:</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,7 +326,7 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns:</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> @@ -332,13 +345,13 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Get the underlying stp_sequence_t. </p> -<dl class="params"><dt>Parameters:</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="section return"><dt>Returns:</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> @@ -374,7 +387,7 @@ Functions</h2></td></tr> <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 class="params"><dt>Parameters:</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> @@ -410,7 +423,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Set the data in an array. </p> -<dl class="params"><dt>Parameters:</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<ul> @@ -460,7 +473,7 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Set the data at a single point in the array. </p> -<dl class="params"><dt>Parameters:</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> @@ -469,7 +482,7 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section return"><dt>Returns:</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> @@ -505,7 +518,7 @@ Functions</h2></td></tr> <p>Resize an array. </p> <p>Resizing an array will destroy all data stored in the array. </p> -<dl class="params"><dt>Parameters:</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> @@ -521,7 +534,7 @@ Functions</h2></td></tr> <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 +</a> 1.8.6 </small></address> </body> </html> |