1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
|
<HTML>
<HEAD>
<!-- refpage -->
<TITLE>queue</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<A HREF="http://www.erlang.se"><IMG BORDER=0 ALT="[Erlang Systems]" SRC="min_head.gif"></A>
<H1>queue</H1>
</CENTER>
<H3>MODULE</H3>
<UL>
queue</UL>
<H3>MODULE SUMMARY</H3>
<UL>
Abstract Data Type for FIFO Queues</UL>
<H3>DESCRIPTION</H3>
<UL>
<P>This module implements FIFO queues in an efficient manner.
</UL>
<H3>EXPORTS</H3>
<P><A NAME="new%0"><STRONG><CODE>new() -> Queue</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Queue = queue()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns an empty queue.
</UL>
<P><A NAME="in%2"><STRONG><CODE>in(Item, Q1) -> Q2</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Item = term()</CODE></STRONG><BR>
<STRONG><CODE>Q1 = Q2 = queue()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Inserts <CODE>Item</CODE> into the queue <CODE>Q1</CODE>. Returns a new queue <CODE>Q2</CODE>.
</UL>
<P><A NAME="out%1"><STRONG><CODE>out(Q) -> Result</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Result = {{value, Item}, Q1} | {empty, Q1}</CODE></STRONG><BR>
<STRONG><CODE>Q = Q1 = queue()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Removes the oldest element from the queue <CODE>Q</CODE>.
Returns the tuple <CODE>{{value, Item}, Q1}</CODE>, where <CODE>Item</CODE> is
the element removed and <CODE>Q1</CODE> is an identifier for the new queue.
If <CODE>Q</CODE> is empty, the tuple <CODE>{empty, Q}</CODE> is returned.
</UL>
<P><A NAME="to_list%1"><STRONG><CODE>to_list(Q) -> list()</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Q = queue()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns a list of the elements in the queue, with the oldest
element first.
</UL>
<H3>AUTHORS</H3>
<UL>
Claes Wikström - support@erlang.ericsson.se<BR>
</UL>
<CENTER>
<HR>
<FONT SIZE=-1>stdlib 1.10<BR>
Copyright © 1991-2001
<A HREF="http://www.erlang.se">Ericsson Utvecklings AB</A><BR>
<!--#include virtual="/ssi/otp_footer.html"-->
</FONT>
</CENTER>
</BODY>
</HTML>
|