/usr/share/mozart/doc/base/bitarray.html

1
2

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD><TITLE>9.5 Bit Arrays</TITLE><LINK href="ozdoc.css" rel="stylesheet" type="text/css"></HEAD><BODY><TABLE align="center" border="0" cellpadding="6" cellspacing="6" class="nav"><TR bgcolor="#DDDDDD"><TD><A href="weakdictionary.html#section.chunks.weakdictionaries">&lt;&lt; Prev</A></TD><TD><A href="node11.html">- Up -</A></TD><TD><A href="port.html#section.chunks.ports">Next &gt;&gt;</A></TD></TR></TABLE><DIV id="section.chunks.bitarrays"><H2><A name="section.chunks.bitarrays">9.5 Bit Arrays</A></H2><P> The module <A name="label599"></A><SPAN class="index"><CODE>BitArray</CODE></SPAN> contains procedures operating on arrays of bits (i.&nbsp;e., units of information each being either <EM>set</EM> or <EM>reset</EM>). </P><DL><DT><A name="label600"></A><SPAN class="index"><CODE>IsBitArray</CODE></SPAN> <A name="label602"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>is&nbsp;</CODE><CODE>+<I>X</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>B</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>tests whether <CODE><I>X</I></CODE> is a bit array.</P></DD><DT><CODE>new</CODE> <A name="label604"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>new&nbsp;</CODE><CODE>+<I>LowI</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>HighI</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>BitArray</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>creates an new <CODE><I>BitArray</I></CODE> with lower bound <CODE><I>LowI</I></CODE> and upper bound <CODE><I>HighI</I></CODE>, and all bits initially cleared. This interface is identical to that of general Oz arrays.</P></DD><DT><CODE>set</CODE> <A name="label606"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>set&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>I</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>sets bit&nbsp;<CODE><I>I</I></CODE> of <CODE><I>BitArray</I></CODE>.</P></DD><DT><CODE>clear</CODE> <A name="label608"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>clear&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>I</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>clears bit&nbsp;<CODE><I>I</I></CODE> of <CODE><I>BitArray</I></CODE>.</P></DD><DT><CODE>test</CODE> <A name="label610"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>test&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>I</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>B</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>tests whether bit&nbsp;<CODE><I>I</I></CODE> of <CODE><I>BitArray</I></CODE> is set.</P></DD><DT><CODE>low</CODE> <A name="label612"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>low&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>LowI</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>returns the lower bound <CODE><I>LowI</I></CODE> of <CODE><I>BitArray</I></CODE>.</P></DD><DT><CODE>high</CODE> <A name="label614"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>high&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>HighI</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>returns the upper bound <CODE><I>HighI</I></CODE> of <CODE><I>BitArray</I></CODE>.</P></DD><DT><CODE>clone</CODE> <A name="label616"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>clone&nbsp;</CODE><CODE>+<I>BitArray1</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>BitArray2</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>returns a new bit array that is a copy of its first argument.</P></DD><DT><CODE>disj</CODE> <A name="label618"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>disj&nbsp;</CODE><CODE>+<I>BitArray1</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>BitArray2</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>side-effects its first argument with the bitwise ``or'' of the two arguments.</P></DD><DT><CODE>conj</CODE> <A name="label620"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>conj&nbsp;</CODE><CODE>+<I>BitArray1</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>BitArray2</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>side-effects its first argument with the bitwise ``and'' of the two arguments.</P></DD><DT><CODE>nimpl</CODE> <A name="label622"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>nimpl&nbsp;</CODE><CODE>+<I>BitArray1</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>BitArray2</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>side-effects its first argument with the bitwise ``and'' of the the first argument and the negation of the second argument (i.&nbsp;e., negated implication).</P></DD><DT><CODE>disjoint</CODE> <A name="label624"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>disjoint&nbsp;</CODE><CODE>+<I>BitArray1</I></CODE><CODE>&nbsp;</CODE><CODE>+<I>BitArray2</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>B</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>tests whether the bit arrays have no set bits in common.</P></DD><DT><CODE>card</CODE> <A name="label626"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>card&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>I</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>returns the number of set bits.</P></DD><DT><CODE>toList</CODE> <A name="label628"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>toList&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>L</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>returns the list of indices for all set bits in <CODE><I>BitArray</I></CODE>.</P></DD><DT><CODE>complementToList</CODE> <A name="label630"></A></DT><DD><BLOCKQUOTE class="synopsis"><P><CODE>{BitArray<SPAN class="keyword">.</SPAN>complementToList&nbsp;</CODE><CODE>+<I>BitArray</I></CODE><CODE>&nbsp;</CODE><CODE>?<I>L</I></CODE><CODE>}</CODE></P></BLOCKQUOTE></DD><DD><P>returns the list of indices for all cleared bits in <CODE><I>BitArray</I></CODE>.</P></DD></DL><P></P></DIV><TABLE align="center" border="0" cellpadding="6" cellspacing="6" class="nav"><TR bgcolor="#DDDDDD"><TD><A href="weakdictionary.html#section.chunks.weakdictionaries">&lt;&lt; Prev</A></TD><TD><A href="node11.html">- Up -</A></TD><TD><A href="port.html#section.chunks.ports">Next &gt;&gt;</A></TD></TR></TABLE><HR><ADDRESS><A href="http://www.ps.uni-sb.de/~duchier/">Denys&nbsp;Duchier</A>, <A href="http://www.ps.uni-sb.de/~kornstae/">Leif&nbsp;Kornstaedt</A> and&nbsp;<A href="http://www.ps.uni-sb.de/~schulte/">Christian&nbsp;Schulte</A><BR><SPAN class="version">Version 1.4.0 (20110908185330)</SPAN></ADDRESS></BODY></HTML>

mozart-doc 1.4.0-8ubuntu1 / usr / share / mozart / doc / base / bitarray.html