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

80 lines
5.5 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 BUTLAST, NBUTLAST</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_revapp.htm">
<LINK REL=UP HREF="c_conses.htm">
<LINK REL=NEXT HREF="f_last.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_revapp.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_conses.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_last.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="butlast"><A NAME="nbutlast"><I>Function</I> <B>BUTLAST, NBUTLAST</B></A></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>butlast</B> <I>list <TT>&amp;optional</TT> n</I> =&gt; <I>result-list</I><P>
<B>nbutlast</B> <I>list <TT>&amp;optional</TT> n</I> =&gt; <I>result-list</I><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>list</I>---a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A>, which might be a <A REL=DEFINITION HREF="26_glo_d.htm#dotted_list"><I>dotted list</I></A> but must not be a <A REL=DEFINITION HREF="26_glo_c.htm#circular_list"><I>circular list</I></A>. <P>
<I>n</I>---a non-negative <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integer</I></A>. <P>
<I>result-list</I>---a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="#butlast"><B>butlast</B></A> returns a copy of <I>list</I> from which the last <I>n</I> conses have been omitted. If <I>n</I> is not supplied, its value is 1. If there are fewer than <I>n</I> conses in <I>list</I>, <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A> is returned and, in the case of <A REL=DEFINITION HREF="#nbutlast"><B>nbutlast</B></A>, <I>list</I> is not modified. <P>
<A REL=DEFINITION HREF="#nbutlast"><B>nbutlast</B></A> is like <A REL=DEFINITION HREF="#butlast"><B>butlast</B></A>, but <A REL=DEFINITION HREF="#nbutlast"><B>nbutlast</B></A> may modify <I>list</I>. It changes the <A REL=DEFINITION HREF="26_glo_c.htm#cdr"><I>cdr</I></A> of the <A REL=DEFINITION HREF="26_glo_c.htm#cons"><I>cons</I></A> <I>n</I>+1 from the end of the <I>list</I> to <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
<P><B>Examples:</B><P>
<PRE>
(setq lst '(1 2 3 4 5 6 7 8 9)) =&gt; (1 2 3 4 5 6 7 8 9)
(butlast lst) =&gt; (1 2 3 4 5 6 7 8)
(butlast lst 5) =&gt; (1 2 3 4)
(butlast lst (+ 5 5)) =&gt; NIL
lst =&gt; (1 2 3 4 5 6 7 8 9)
(nbutlast lst 3) =&gt; (1 2 3 4 5 6)
lst =&gt; (1 2 3 4 5 6)
(nbutlast lst 99) =&gt; NIL
lst =&gt; (1 2 3 4 5 6)
(butlast '(a b c d)) =&gt; (A B C)
(butlast '((a b) (c d))) =&gt; ((A B))
(butlast '(a)) =&gt; NIL
(butlast nil) =&gt; NIL
(setq foo (list 'a 'b 'c 'd)) =&gt; (A B C D)
(nbutlast foo) =&gt; (A B C)
foo =&gt; (A B C)
(nbutlast (list 'a)) =&gt; NIL
(nbutlast '()) =&gt; NIL
</PRE>
</TT> <P>
<P><B>Affected By:</B> None.
<P>
<P><B>Exceptional Situations:</B><P>
<P>
Should signal an error of <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> <A REL=DEFINITION HREF="e_tp_err.htm#type-error"><B>type-error</B></A> if <I>list</I> is not a <A REL=DEFINITION HREF="26_glo_p.htm#proper_list"><I>proper list</I></A> or a <A REL=DEFINITION HREF="26_glo_d.htm#dotted_list"><I>dotted list</I></A>. Should signal an error of <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> <A REL=DEFINITION HREF="e_tp_err.htm#type-error"><B>type-error</B></A> if <I>n</I> is not a non-negative <A REL=DEFINITION HREF="26_glo_i.htm#integer"><I>integer</I></A>. <P>
<P><B>See Also:</B> None.
<P>
<P><B>Notes:</B><P>
<P>
<PRE>
(butlast list n) == (ldiff list (last list n))
</PRE>
</TT> <P>
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issues</A>, <I>not part of the specification</I>, apply to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss022.htm">BUTLAST-NEGATIVE:SHOULD-SIGNAL</A><LI> <A REL=CHILD HREF="../Issues/iss138.htm">DOTTED-LIST-ARGUMENTS:CLARIFY</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>