76 lines
5.4 KiB
HTML
76 lines
5.4 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: Function COMPLEMENT</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_identi.htm">
|
|
<LINK REL=UP HREF="c_data_a.htm">
|
|
<LINK REL=NEXT HREF="f_cons_1.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_identi.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_data_a.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_cons_1.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
|
|
|
<HR>
|
|
|
|
<A NAME="complement"><I>Function</I> <B>COMPLEMENT</B></A> <P>
|
|
<P>
|
|
<P><B>Syntax:</B><P>
|
|
<P>
|
|
|
|
<B>complement</B> <I>function</I> => <I>complement-function</I><P>
|
|
<P>
|
|
<P><B>Arguments and Values:</B><P>
|
|
<P>
|
|
<I>function</I>---a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A>. <P>
|
|
<I>complement-function</I>---a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A>. <P>
|
|
<P><B>Description:</B><P>
|
|
<P>
|
|
Returns a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> that takes the same <A REL=DEFINITION HREF="26_glo_a.htm#argument"><I>arguments</I></A> as <I>function</I>, and has the same side-effect behavior as <I>function</I>, but returns only a single value: a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A> with the opposite truth value of that which would be returned as the <A REL=DEFINITION HREF="26_glo_p.htm#primary_value"><I>primary value</I></A> of <I>function</I>. That is, when the <I>function</I> would have returned <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> as its <A REL=DEFINITION HREF="26_glo_p.htm#primary_value"><I>primary value</I></A> the <I>complement-function</I> returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>, and when the <I>function</I> would have returned <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A> as its <A REL=DEFINITION HREF="26_glo_p.htm#primary_value"><I>primary value</I></A> the <I>complement-function</I> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A>. <P>
|
|
<P><B>Examples:</B><P>
|
|
<P>
|
|
<PRE>
|
|
(funcall (complement #'zerop) 1) => <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
|
|
(funcall (complement #'characterp) #\A) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(funcall (complement #'member) 'a '(a b c)) => <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
|
|
(funcall (complement #'member) 'd '(a b c)) => <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
|
|
</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_not.htm#not"><B>not</B></A> <P>
|
|
<P><B>Notes:</B><P>
|
|
<P>
|
|
<PRE>
|
|
(complement x) == #'(lambda (&rest arguments) (not (apply x arguments)))
|
|
</PRE>
|
|
</TT> <P>
|
|
In Common Lisp, functions with names like ``<TT></TT><I>xxx</I><TT>-if-not</TT>'' are related to functions with names like ``<TT></TT><I>xxx</I><TT>-if</TT>'' in that <P>
|
|
<PRE>
|
|
(xxx-if-not f . arguments) == (xxx-if (complement f) . arguments)
|
|
</PRE>
|
|
</TT> <P>
|
|
For example, <P>
|
|
<PRE>
|
|
(find-if-not #'zerop '(0 0 3)) ==
|
|
(find-if (complement #'zerop) '(0 0 3)) => 3
|
|
</PRE>
|
|
</TT> <P>
|
|
Note that since the ``<TT></TT><I>xxx</I><TT>-if-not</TT>'' <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>functions</I></A> and the <TT>:test-not</TT> arguments have been deprecated, uses of ``<TT></TT><I>xxx</I><TT>-if</TT>'' <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>functions</I></A> or <TT>:test</TT> arguments with <A REL=DEFINITION HREF="#complement"><B>complement</B></A> are preferred. <P>
|
|
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issue</A>, <I>not part of the specification</I>, applies to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss172.htm">FUNCTION-COMPOSITION:JAN89-X3J13</A><P></UL><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>
|