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

72 lines
6.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 TREE-EQUAL</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_substc.htm">
<LINK REL=UP HREF="c_conses.htm">
<LINK REL=NEXT HREF="f_cp_lis.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_substc.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_cp_lis.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="tree-equal"><I>Function</I> <B>TREE-EQUAL</B></A> <P>
<P>
<P><B>Syntax:</B><P>
<P>
<B>tree-equal</B> <I>tree-1 tree-2 <TT>&amp;key</TT> test test-not</I> =&gt; <I>generalized-boolean</I><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>tree-1</I>---a <A REL=DEFINITION HREF="26_glo_t.htm#tree"><I>tree</I></A>. <P>
<I>tree-2</I>---a <A REL=DEFINITION HREF="26_glo_t.htm#tree"><I>tree</I></A>. <P>
<I>test</I>---a <A REL=DEFINITION HREF="26_glo_d.htm#designator"><I>designator</I></A> for a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> of two <A REL=DEFINITION HREF="26_glo_a.htm#argument"><I>arguments</I></A> that returns a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>. <P>
<I>test-not</I>---a <A REL=DEFINITION HREF="26_glo_d.htm#designator"><I>designator</I></A> for a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> of two <A REL=DEFINITION HREF="26_glo_a.htm#argument"><I>arguments</I></A> that returns a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>. <P>
<I>generalized-boolean</I>---a <A REL=DEFINITION HREF="26_glo_g.htm#generalized_boolean"><I>generalized boolean</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="#tree-equal"><B>tree-equal</B></A> tests whether two trees are of the same shape and have the same leaves. <A REL=DEFINITION HREF="#tree-equal"><B>tree-equal</B></A> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if <I>tree-1</I> and <I>tree-2</I> are both <A REL=DEFINITION HREF="26_glo_a.htm#atom"><I>atoms</I></A> and <A REL=DEFINITION HREF="26_glo_s.htm#satisfy_the_test"><I>satisfy the test</I></A>, or if they are both <A REL=DEFINITION HREF="26_glo_c.htm#cons"><I>conses</I></A> and the <A REL=DEFINITION HREF="26_glo_c.htm#car"><I>car</I></A> of <I>tree-1</I> is <A REL=DEFINITION HREF="#tree-equal"><B>tree-equal</B></A> to the <A REL=DEFINITION HREF="26_glo_c.htm#car"><I>car</I></A> of <I>tree-2</I> and the <A REL=DEFINITION HREF="26_glo_c.htm#cdr"><I>cdr</I></A> of <I>tree-1</I> is <A REL=DEFINITION HREF="#tree-equal"><B>tree-equal</B></A> to the <A REL=DEFINITION HREF="26_glo_c.htm#cdr"><I>cdr</I></A> of <I>tree-2</I>. Otherwise, <A REL=DEFINITION HREF="#tree-equal"><B>tree-equal</B></A> returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. <P>
<A REL=DEFINITION HREF="#tree-equal"><B>tree-equal</B></A> recursively compares <A REL=DEFINITION HREF="26_glo_c.htm#cons"><I>conses</I></A> but not any other <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>objects</I></A> that have components. <P>
The first argument to the <TT>:test</TT> or <TT>:test-not</TT> function is <I>tree-1</I> or a <A REL=DEFINITION HREF="26_glo_c.htm#car"><I>car</I></A> or <A REL=DEFINITION HREF="26_glo_c.htm#cdr"><I>cdr</I></A> of <I>tree-1</I>; the second argument is <I>tree-2</I> or a <A REL=DEFINITION HREF="26_glo_c.htm#car"><I>car</I></A> or <A REL=DEFINITION HREF="26_glo_c.htm#cdr"><I>cdr</I></A> of <I>tree-2</I>. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(setq tree1 '(1 (1 2))
tree2 '(1 (1 2))) =&gt; (1 (1 2))
(tree-equal tree1 tree2) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(eql tree1 tree2) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(setq tree1 '('a ('b 'c))
tree2 '('a ('b 'c))) =&gt; ('a ('b 'c))
=&gt; ((QUOTE A) ((QUOTE B) (QUOTE C)))
(tree-equal tree1 tree2 :test 'eq) =&gt; <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><P>
<P>
The consequences are undefined if both <I>tree-1</I> and <I>tree-2</I> are circular. <P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="f_equal.htm#equal"><B>equal</B></A>, <A REL=CHILD HREF="03_f.htm">Section 3.6 (Traversal Rules and Side Effects)</A> <P>
<P><B>Notes:</B><P>
<P>
The <TT>:test-not</TT> parameter is deprecated. <P>
<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/iss345.htm">TEST-NOT-IF-NOT:FLUSH-ALL</A><LI> <A REL=CHILD HREF="../Issues/iss240.htm">MAPPING-DESTRUCTIVE-INTERACTION:EXPLICITLY-VAGUE</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>