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

129 lines
16 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 CHAR=, CHAR/=, CHAR&lt;, CHAR&gt;...</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="t_extend.htm">
<LINK REL=UP HREF="c_charac.htm">
<LINK REL=NEXT HREF="f_ch.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="t_extend.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_charac.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_ch.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="charEQ"><A NAME="charSLEQ"><A NAME="charLT"><A NAME="charGT"><A NAME="charLTEQ"><A NAME="charGTEQ"><A NAME="char-equal"><A NAME="char-not-equal"><A NAME="char-lessp"><A NAME="char-greaterp"><A NAME="char-not-greaterp"><A NAME="char-not-lessp"><I>Function</I> <B>CHAR=, CHAR/=, CHAR&lt;, CHAR&gt;, CHAR&lt;=, CHAR&gt;=, CHAR-EQUAL, CHAR-NOT-EQUAL, CHAR-LESSP, CHAR-GREATERP, CHAR-NOT-GREATERP, CHAR-NOT-LESSP</B></A></A></A></A></A></A></A></A></A></A></A></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>char=</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char/=</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char&lt;</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char&gt;</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char&lt;=</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char&gt;=</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char-equal</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char-not-equal</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char-lessp</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char-greaterp</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char-not-greaterp</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<B>char-not-lessp</B> <I></I><TT>&amp;rest</TT><I> characters</I>+<I></I> =&gt; <I>generalized-boolean</I><P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>character</I>---a <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>character</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>
These predicates compare <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A>. <P>
<A REL=DEFINITION HREF="#charEQ"><B>char=</B></A> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if all <I>characters</I> are the <A REL=DEFINITION HREF="26_glo_s.htm#same"><I>same</I></A>; otherwise, it returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. If two <I>characters</I> differ in any <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attributes</I></A>, then they are not <A REL=DEFINITION HREF="#charEQ"><B>char=</B></A>. <P>
<A REL=DEFINITION HREF="#charSLEQ"><B>char/=</B></A> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if all <I>characters</I> are different; otherwise, it returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. <P>
<A REL=DEFINITION HREF="#charLT"><B>char&lt;</B></A> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if the <I>characters</I> are monotonically increasing; otherwise, it returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. If two <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> have <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attributes</I></A>, then their ordering by <A REL=DEFINITION HREF="#charLT"><B>char&lt;</B></A> is consistent with the numerical ordering by the predicate <TT>&lt;</TT> on their <A REL=DEFINITION HREF="26_glo_c.htm#code"><I>codes</I></A>. <P>
<A REL=DEFINITION HREF="#charGT"><B>char&gt;</B></A> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if the <I>characters</I> are monotonically decreasing; otherwise, it returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. If two <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> have <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attributes</I></A>, then their ordering by <A REL=DEFINITION HREF="#charGT"><B>char&gt;</B></A> is consistent with the numerical ordering by the predicate <TT>&gt;</TT> on their <A REL=DEFINITION HREF="26_glo_c.htm#code"><I>codes</I></A>. <P>
<A REL=DEFINITION HREF="#charLTEQ"><B>char&lt;=</B></A> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if the <I>characters</I> are monotonically nondecreasing; otherwise, it returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. If two <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> have <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attributes</I></A>, then their ordering by <A REL=DEFINITION HREF="#charLTEQ"><B>char&lt;=</B></A> is consistent with the numerical ordering by the predicate <TT>&lt;=</TT> on their <A REL=DEFINITION HREF="26_glo_c.htm#code"><I>codes</I></A>. <P>
<A REL=DEFINITION HREF="#charGTEQ"><B>char&gt;=</B></A> returns <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A> if the <I>characters</I> are monotonically nonincreasing; otherwise, it returns <A REL=DEFINITION HREF="26_glo_f.htm#false"><I>false</I></A>. If two <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> have <A REL=DEFINITION HREF="26_glo_i.htm#identical"><I>identical</I></A> <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attributes</I></A>, then their ordering by <A REL=DEFINITION HREF="#charGTEQ"><B>char&gt;=</B></A> is consistent with the numerical ordering by the predicate <TT>&gt;=</TT> on their <A REL=DEFINITION HREF="26_glo_c.htm#code"><I>codes</I></A>. <P>
<A REL=DEFINITION HREF="#char-equal"><B>char-equal</B></A>, <A REL=DEFINITION HREF="#char-not-equal"><B>char-not-equal</B></A>, <A REL=DEFINITION HREF="#char-lessp"><B>char-lessp</B></A>, <A REL=DEFINITION HREF="#char-greaterp"><B>char-greaterp</B></A>, <A REL=DEFINITION HREF="#char-not-greaterp"><B>char-not-greaterp</B></A>, and <A REL=DEFINITION HREF="#char-not-lessp"><B>char-not-lessp</B></A> are similar to <A REL=DEFINITION HREF="#charEQ"><B>char=</B></A>, <A REL=DEFINITION HREF="#charSLEQ"><B>char/=</B></A>, <A REL=DEFINITION HREF="#charLT"><B>char&lt;</B></A>, <A REL=DEFINITION HREF="#charGT"><B>char&gt;</B></A>, <A REL=DEFINITION HREF="#charLTEQ"><B>char&lt;=</B></A>, <A REL=DEFINITION HREF="#charGTEQ"><B>char&gt;=</B></A>, respectively, except that they ignore differences in <A REL=DEFINITION HREF="26_glo_c.htm#case"><I>case</I></A> and might have an <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> behavior for <A REL=DEFINITION HREF="26_glo_n.htm#non-simple"><I>non-simple</I></A> <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A>. For example, an <A REL=DEFINITION HREF="26_glo_i.htm#implementation"><I>implementation</I></A> might define that <A REL=DEFINITION HREF="#char-equal"><B>char-equal</B></A>, <I>etc.</I> ignore certain <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attributes</I></A>. The effect, if any, of each <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attribute</I></A> upon these functions must be specified as part of the definition of that <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attribute</I></A>. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(char= #\d #\d) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char= #\A #\a) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char= #\d #\x) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char= #\d #\D) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char/= #\d #\d) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char/= #\d #\x) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char/= #\d #\D) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char= #\d #\d #\d #\d) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char/= #\d #\d #\d #\d) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char= #\d #\d #\x #\d) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char/= #\d #\d #\x #\d) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char= #\d #\y #\x #\c) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char/= #\d #\y #\x #\c) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char= #\d #\c #\d) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char/= #\d #\c #\d) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char&lt; #\d #\x) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&lt;= #\d #\x) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&lt; #\d #\d) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char&lt;= #\d #\d) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&lt; #\a #\e #\y #\z) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&lt;= #\a #\e #\y #\z) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&lt; #\a #\e #\e #\y) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char&lt;= #\a #\e #\e #\y) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&gt; #\e #\d) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&gt;= #\e #\d) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&gt; #\d #\c #\b #\a) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&gt;= #\d #\c #\b #\a) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&gt; #\d #\d #\c #\a) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char&gt;= #\d #\d #\c #\a) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(char&gt; #\e #\d #\b #\c #\a) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char&gt;= #\e #\d #\b #\c #\a) =&gt; <A REL=DEFINITION HREF="26_glo_f.htm#false">false</A>
(char&gt; #\z #\A) =&gt; <A REL=DEFINITION HREF="26_glo_i.htm#implementation-dependent">implementation-dependent</A>
(char&gt; #\Z #\a) =&gt; <A REL=DEFINITION HREF="26_glo_i.htm#implementation-dependent">implementation-dependent</A>
(char-equal #\A #\a) =&gt; <A REL=DEFINITION HREF="26_glo_t.htm#true">true</A>
(stable-sort (list #\b #\A #\B #\a #\c #\C) #'char-lessp)
=&gt; (#\A #\a #\b #\B #\c #\C)
(stable-sort (list #\b #\A #\B #\a #\c #\C) #'char&lt;)
=&gt; (#\A #\B #\C #\a #\b #\c) ;Implementation A
=&gt; (#\a #\b #\c #\A #\B #\C) ;Implementation B
=&gt; (#\a #\A #\b #\B #\c #\C) ;Implementation C
=&gt; (#\A #\a #\B #\b #\C #\c) ;Implementation D
=&gt; (#\A #\B #\a #\b #\C #\c) ;Implementation E
</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_progra.htm#program-error"><B>program-error</B></A> if at least one <I>character</I> is not supplied. <P>
<P><B>See Also:</B><P>
<P>
<A REL=CHILD HREF="02_a.htm">Section 2.1 (Character Syntax)</A>, <A REL=CHILD HREF="13_aj.htm">Section 13.1.10 (Documentation of Implementation-Defined Scripts)</A> <P>
<P><B>Notes:</B><P>
<P>
If characters differ in their <A REL=DEFINITION HREF="26_glo_c.htm#code"><I>code</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attribute</I></A> or any <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> <A REL=DEFINITION HREF="26_glo_a.htm#attribute"><I>attribute</I></A>, they are considered to be different by <A REL=DEFINITION HREF="#charEQ"><B>char=</B></A>. <P>
There is no requirement that <TT>(eq c1 c2)</TT> be true merely because <TT>(char= c1 c2)</TT> is <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A>. While <A REL=DEFINITION HREF="f_eq.htm#eq"><B>eq</B></A> can distinguish two <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> that <A REL=DEFINITION HREF="#charEQ"><B>char=</B></A> does not, it is distinguishing them not as <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A>, but in some sense on the basis of a lower level implementation characteristic. If <TT>(eq c1 c2)</TT> is <A REL=DEFINITION HREF="26_glo_t.htm#true"><I>true</I></A>, then <TT>(char= c1 c2)</TT> is also true. <A REL=DEFINITION HREF="f_eql.htm#eql"><B>eql</B></A> and <A REL=DEFINITION HREF="f_equal.htm#equal"><B>equal</B></A> compare <A REL=DEFINITION HREF="26_glo_c.htm#character"><I>characters</I></A> in the same way that <A REL=DEFINITION HREF="#charEQ"><B>char=</B></A> does. <P>
The manner in which <A REL=DEFINITION HREF="26_glo_c.htm#case"><I>case</I></A> is used by <A REL=DEFINITION HREF="#char-equal"><B>char-equal</B></A>, <A REL=DEFINITION HREF="#char-not-equal"><B>char-not-equal</B></A>, <A REL=DEFINITION HREF="#char-lessp"><B>char-lessp</B></A>, <A REL=DEFINITION HREF="#char-greaterp"><B>char-greaterp</B></A>, <A REL=DEFINITION HREF="#char-not-greaterp"><B>char-not-greaterp</B></A>, and <A REL=DEFINITION HREF="#char-not-lessp"><B>char-not-lessp</B></A> implies an ordering for <A REL=DEFINITION HREF="26_glo_s.htm#standard_character"><I>standard characters</I></A> such that <TT>A=a</TT>, <TT>B=b</TT>, and so on, up to <TT>Z=z</TT>, and furthermore either <TT>9&lt;A</TT> or <TT>Z&lt;0</TT>. <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/iss027.htm">CHARACTER-PROPOSAL:2-1-1</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>