1
0
Fork 0
cl-sites/HyperSpec-7-0/HyperSpec/Body/f_mask_f.htm
2024-04-01 10:24:07 +02:00

72 lines
4.3 KiB
HTML

<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
<HTML>
<HEAD>
<TITLE>CLHS: Accessor MASK-FIELD</TITLE>
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
<LINK REL=TOP HREF="../Front/index.htm">
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
<LINK REL=PREV HREF="f_ldb_te.htm">
<LINK REL=UP HREF="c_number.htm">
<LINK REL=NEXT HREF="v_most_p.htm">
</HEAD>
<BODY>
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="f_ldb_te.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_number.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="v_most_p.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="mask-field"><I>Accessor</I> <B>MASK-FIELD</B></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>mask-field</B> <I>bytespec integer</I> =&gt; <I>masked-integer</I><P>
<TT>(setf (</TT><B>mask-field</B> <I>bytespec place</I><TT>) </TT><I>new-masked-integer</I><TT>)</TT><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>bytespec</I>---a <A REL=DEFINITION HREF="26_glo_b.htm#byte_specifier"><I>byte specifier</I></A>. <P>
<I>integer</I>---an <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integer</I></A>. <P>
<I>masked-integer</I>, <I>new-masked-integer</I>---a non-negative <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integer</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="#mask-field"><B>mask-field</B></A> performs a ``mask'' operation on <I>integer</I>. It returns an <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integer</I></A> that has the same bits as <I>integer</I> in the <A REL=DEFINITION HREF="26_glo_b.htm#byte"><I>byte</I></A> specified by <I>bytespec</I>, but that has zero-bits everywhere else. <P>
<A REL=DEFINITION HREF="m_setf_.htm#setf"><B>setf</B></A> may be used with <A REL=DEFINITION HREF="#mask-field"><B>mask-field</B></A> to modify a byte within the <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integer</I></A> that is stored in a given <I>place</I>. The effect is to perform a <A REL=DEFINITION HREF="f_deposi.htm#deposit-field"><B>deposit-field</B></A> operation and then store the result back into the <I>place</I>. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(mask-field (byte 1 5) -1) =&gt; 32
(setq a 15) =&gt; 15
(mask-field (byte 2 0) a) =&gt; 3
a =&gt; 15
(setf (mask-field (byte 2 0) a) 1) =&gt; 1
a =&gt; 13
</PRE>
</TT> <P>
<P><B>Side Effects:</B> None.
<P>
<P><B>Affected By:</B> None.
<P>
<P><B>Exceptional Situations:</B> None.
<P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="f_by_by.htm#byte"><B>byte</B></A>, <A REL=DEFINITION HREF="f_ldb.htm#ldb"><B>ldb</B></A> <P>
<P><B>Notes:</B><P>
<P>
<PRE>
(ldb bs (mask-field bs n)) == (ldb bs n)
(logbitp j (mask-field (byte s p) n))
== (and (&gt;= j p) (&lt; j s) (logbitp j n))
(mask-field bs n) == (logand n (dpb -1 bs 0))
</PRE>
</TT> <P>
<HR>
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
</BODY>
</HTML>