File: sets.html

package info (click to toggle)
erlang-doc-html 1%3A8.0-1
links: PTS
area: main
in suites: woody
size: 18,028 kB
ctags: 7,419
sloc: perl: 1,841; ansic: 323; erlang: 155
file content (202 lines) | stat: -rw-r--r-- 5,593 bytes
<HTML>
<HEAD>
<!-- refpage -->
<TITLE>sets</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>


<A HREF="http://www.erlang.se"><IMG BORDER=0 ALT="[Erlang Systems]" SRC="min_head.gif"></A>
<H1>sets</H1>
</CENTER>
<H3>MODULE</H3>
<UL>
sets</UL>
<H3>MODULE SUMMARY</H3>
<UL>
Functions for Set Manipulation
</UL>
<H3>DESCRIPTION</H3>
<UL>
<P>Sets are collections of elements with no duplicate elements.
The representation of a set is not defined.
</UL>
<H3>EXPORTS</H3>
<P><A NAME="new%0"><STRONG><CODE>new() -&#62; Set</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns a new empty ordered set.
</UL>
<P><A NAME="is_set%1"><STRONG><CODE>is_set(Set) -&#62; bool()</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set = term()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns <CODE>true</CODE> if <CODE>Set</CODE> is an ordered set of
elements, otherwise <CODE>false</CODE>.
</UL>
<P><A NAME="size%1"><STRONG><CODE>size(Set) -&#62; int()</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set = term()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns the number of elements in <CODE>Set</CODE>.
</UL>
<P><A NAME="to_list%1"><STRONG><CODE>to_list(Set) -&#62; List</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set = set()</CODE></STRONG><BR>
<STRONG><CODE>List = [term()]</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns the elements of <CODE>Set</CODE> as a list.
</UL>
<P><A NAME="from_list%1"><STRONG><CODE>from_list(List) -&#62; Set</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>List = [term()]</CODE></STRONG><BR>
<STRONG><CODE>Set = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns an ordered set of the elements in <CODE>List</CODE>.
</UL>
<P><A NAME="is_element%2"><STRONG><CODE>is_element(Element, Set) -&#62; bool()</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Element = term()</CODE></STRONG><BR>
<STRONG><CODE>Set = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns <CODE>true</CODE> if <CODE>Element</CODE> is an element of
<CODE>Set</CODE>, otherwise <CODE>false</CODE>.
</UL>
<P><A NAME="add_element%2"><STRONG><CODE>add_element(Element, Set1) -&#62; Set2</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Element = term()</CODE></STRONG><BR>
<STRONG><CODE>Set1 = Set2 = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns a new ordered set formed from <CODE>Set1</CODE> with
<CODE>Element</CODE> inserted.
</UL>
<P><A NAME="del_element%2"><STRONG><CODE>del_element(Element, Set1) -&#62; Set2</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Element = term()</CODE></STRONG><BR>
<STRONG><CODE>Set1 = Set2 = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns <CODE>Set1</CODE>, but with <CODE>Element</CODE> removed.
</UL>
<P><A NAME="union%2"><STRONG><CODE>union(Set1, Set2) -&#62; Set3</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set1 = Set2 = Set3 = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns the merged (union) set of <CODE>Set1</CODE> and
<CODE>Set2</CODE>.
</UL>
<P><A NAME="union%1"><STRONG><CODE>union(SetList) -&#62; Set</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>SetList = [set()]</CODE></STRONG><BR>
<STRONG><CODE>Set = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns the merged (union) set of the list of sets.
</UL>
<P><A NAME="intersection%2"><STRONG><CODE>intersection(Set1, Set2) -&#62; Set3</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set1 = Set2 = Set3 = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns the intersection of <CODE>Set1</CODE> and
<CODE>Set2</CODE>.
</UL>
<P><A NAME="intersection%1"><STRONG><CODE>intersection(SetList) -&#62; Set</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>SetList = [set()]</CODE></STRONG><BR>
<STRONG><CODE>Set = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns the intersection of the non-empty list of sets.
</UL>
<P><A NAME="subtract%2"><STRONG><CODE>subtract(Set1, Set2) -&#62; Set3</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set1 = Set2 = Set3 = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns only the elements of <CODE>Set1</CODE> which are not
also elements of <CODE>Set2</CODE>.
</UL>
<P><A NAME="is_subset%2"><STRONG><CODE>is_subset(Set1, Set2) -&#62; bool()</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Set1 = Set2 = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Returns <CODE>true</CODE> when every element of <CODE>Set</CODE>1 is
also a member of <CODE>Set2</CODE>, otherwise <CODE>false</CODE>.
</UL>
<P><A NAME="fold%3"><STRONG><CODE>fold(Function, Acc0, Set) -&#62; Acc1</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Function = fun (E, AccIn) -&#62; AccOut</CODE></STRONG><BR>
<STRONG><CODE>Acc0 = Acc1 = AccIn = AccOut = term()</CODE></STRONG><BR>
<STRONG><CODE>Set = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Fold <CODE>Function</CODE> over every element in <CODE>Set</CODE>
returning the final value of the accumulator.
</UL>
<P><A NAME="filter%2"><STRONG><CODE>filter(Pred, Set1) -&#62; Set2</CODE></STRONG></A><BR>
<P><UL>Types:
<UL>
<STRONG><CODE>Pred = fun (E) -&#62; bool()</CODE></STRONG><BR>
<STRONG><CODE>Set1 = Set2 = set()</CODE></STRONG><BR>
</UL>
</UL>
<UL>
<P>Filter elements in <CODE>Set1</CODE> with boolean function
<CODE>Fun</CODE>.
</UL>
<H3>AUTHORS</H3>
<UL>
Robert Virding - support@erlang.ericsson.se<BR>
</UL>
<CENTER>
<HR>
<FONT SIZE=-1>stdlib 1.10<BR>
Copyright &copy; 1991-2001
<A HREF="http://www.erlang.se">Ericsson Utvecklings AB</A><BR>
<!--#include virtual="/ssi/otp_footer.html"-->
</FONT>
</CENTER>
</BODY>
</HTML>