gem-graph-client/doc/docbook/db/d08/pile_8c.xml

182 lines
7.1 KiB
XML

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_pile_8c" xml:lang="en-US">
<title>src/util/pile.c File Reference</title>
<indexterm><primary>src/util/pile.c</primary></indexterm>
<para>
<para>simple pile </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>int <link linkend="_pile_8c_1ae7f894b6d7e9fb168fa601fdfd8345ec">util_pile_push</link> (<link linkend="_structpile">pile</link> **p, int value)</para>
</listitem>
<listitem><para>int <link linkend="_pile_8c_1a0e06a04510db610ca0097c34dd1df8e8">util_pile_pop</link> (<link linkend="_structpile">pile</link> **p)</para>
</listitem>
<listitem><para>void <link linkend="_pile_8c_1aaed89bf98ca82bcc01de237563c84e4e">util_pile_clear</link> (<link linkend="_structpile">pile</link> **p)</para>
</listitem>
<listitem><para>int <link linkend="_pile_8c_1afbb61183d866a834bdf9cae2be6c84f5">util_pile_length</link> (<link linkend="_structpile">pile</link> *p)</para>
</listitem>
<listitem><para>void <link linkend="_pile_8c_1adfb08d2ce5a4ad53e4d0b873e993cd91">util_pile_view</link> (<link linkend="_structpile">pile</link> *p)</para>
</listitem>
</itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>
<para>simple pile </para>
<para>This file is part of Gem-graph. It implements a simple pile functions. </para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_pile_8c_1aaed89bf98ca82bcc01de237563c84e4e"/><section>
<title>util_pile_clear()</title>
<indexterm><primary>util_pile_clear</primary><secondary>pile.c</secondary></indexterm>
<indexterm><primary>pile.c</primary><secondary>util_pile_clear</secondary></indexterm>
<para><computeroutput>void util_pile_clear (<link linkend="_structpile">pile</link> ** p)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>**p</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
<anchor xml:id="_pile_8c_1afbb61183d866a834bdf9cae2be6c84f5"/><section>
<title>util_pile_length()</title>
<indexterm><primary>util_pile_length</primary><secondary>pile.c</secondary></indexterm>
<indexterm><primary>pile.c</primary><secondary>util_pile_length</secondary></indexterm>
<para><computeroutput>int util_pile_length (<link linkend="_structpile">pile</link> * p)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>**p</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>length </para>
</formalpara>
</para>
</section>
<anchor xml:id="_pile_8c_1a0e06a04510db610ca0097c34dd1df8e8"/><section>
<title>util_pile_pop()</title>
<indexterm><primary>util_pile_pop</primary><secondary>pile.c</secondary></indexterm>
<indexterm><primary>pile.c</primary><secondary>util_pile_pop</secondary></indexterm>
<para><computeroutput>int util_pile_pop (<link linkend="_structpile">pile</link> ** p)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>**p</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>value </para>
</formalpara>
</para>
</section>
<anchor xml:id="_pile_8c_1ae7f894b6d7e9fb168fa601fdfd8345ec"/><section>
<title>util_pile_push()</title>
<indexterm><primary>util_pile_push</primary><secondary>pile.c</secondary></indexterm>
<indexterm><primary>pile.c</primary><secondary>util_pile_push</secondary></indexterm>
<para><computeroutput>int util_pile_push (<link linkend="_structpile">pile</link> ** p, int value)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>**p</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>value</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>value </para>
</formalpara>
</para>
</section>
<anchor xml:id="_pile_8c_1adfb08d2ce5a4ad53e4d0b873e993cd91"/><section>
<title>util_pile_view()</title>
<indexterm><primary>util_pile_view</primary><secondary>pile.c</secondary></indexterm>
<indexterm><primary>pile.c</primary><secondary>util_pile_view</secondary></indexterm>
<para><computeroutput>void util_pile_view (<link linkend="_structpile">pile</link> * p)</computeroutput></para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>**p</entry><entry>
<para></para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
</section>
</section>
</section>