Try to be a better Github citizen
[clqr.git] / clqr-characters.tex
blob48193a94c99383c402c8d72b7d01301a247d07da
1 % Copyright (C) 2008, 2010 Bert Burgemeister
3 % Permission is granted to copy, distribute and/or modify this
4 % document under the terms of the GNU Free Documentation License,
5 % Version 1.2 or any later version published by the Free Software
6 % Foundation; with no Invariant Sections, no Front-Cover Texts and
7 % no Back-Cover Texts. For details see file COPYING.
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11 \section{Characters}
12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14 The \kwd*{standard-char} type comprises \LIT{a}-\LIT{z},
15 \LIT{A}-\LIT{Z}, \LIT{0}-\LIT{9}, \LIT{Newline}, \LIT{Space}, and
16 \LIT{!?\$"'`.:,;*+-/|{\tt\char`\\}\TLD\_\^{}<=>\#\%@\&()[]\{\}}.
17 \index{NEWLINE}\index{SPACE}
19 \begin{LIST}{1cm}
21 \IT{\arrGOO{(\FU*{CHARACTERP} \VAR{ foo})\\
22 (\FU*{STANDARD-CHAR-P} \VAR{ char})}{.}}
24 \retval{\T} if argument is of indicated type.
27 \IT{\arrGOO{(\FU*{GRAPHIC-CHAR-P} \VAR{ character})\\
28 (\FU*{ALPHA-CHAR-P} \VAR{ character})\\
29 (\FU*{ALPHANUMERICP} \VAR{ character})}{.}}
31 \retval{\T} if \VAR{character} is visible, alphabetic, or
32 alphanumeric, respectively.
35 \IT{\arrGOO{(\FU*{UPPER-CASE-P} \VAR{ character})\\
36 (\FU*{LOWER-CASE-P} \VAR{ character})\\
37 (\FU*{BOTH-CASE-P} \VAR{ character})}{.}}
39 Return \retval{\T} if \VAR{character} is uppercase, lowercase, or
40 able to be in another case, respectively.
43 \IT{(\FU*{DIGIT-CHAR-P} \VAR{character}
44 \Op{\VAR{radix}\DF{\LIT{10}}})}
46 Return \retval{its weight} if \VAR{character} is a digit, or
47 \retval{\NIL} otherwise.
50 \IT{\arrGOO{(\FU*{CHAR=}\RP{\VAR{
51 character}})\\(\FU*{CHAR/=}\RP{\VAR{
52 character}})}{.}}
54 Return \retval{\T} if all \VAR{character}s, or
55 none, respectively, are equal.
58 \IT{\arrGOO{(\FU*{CHAR-EQUAL}\RP{\VAR{
59 character}})\\(\FU*{CHAR-NOT-EQUAL}\RP{\VAR{
60 character}})}{.}}
62 Return \retval{\T} if all \VAR{character}s, or
63 none, respectively, are equal ignoring case.
66 \IT{\arrGOO{(\FU{CHAR\boldmath$>$}\RP{\VAR{
67 character}})\\(\FU{CHAR\boldmath$>$=}\RP{\VAR{
68 character}})\\(\FU{CHAR\boldmath$<$}\RP{\VAR{
69 character}})\\(\FU{CHAR\boldmath$<$=}\RP{\VAR{
70 character}})}{.}}
72 \index{CHAR>@CHAR$>$}%
73 \index{CHAR>=@CHAR$>$=}%
74 \index{CHAR<@CHAR$<$}%
75 \index{CHAR<=@CHAR$<$=}%
76 Return \retval{\T} if \VAR{character}s are
77 monotonically decreasing, monotonically non-increasing, monotonically
78 increasing, or monotonically non-decreasing, respectively.
81 \IT{\arrGOO{
82 (\FU*{CHAR-GREATERP}\RP{\VAR{ character}})\\
83 (\FU*{CHAR-NOT-LESSP}\RP{\VAR{ character}})\\
84 (\FU*{CHAR-LESSP}\RP{\VAR{ character}})\\
85 (\FU*{CHAR-NOT-GREATERP}\RP{\VAR{ character}})}{.}}
87 Return \retval{\T} if \VAR{character}s are monotonically
88 decreasing, monotonically non-increasing, monotonically
89 increasing, or monotonically non-decreasing, respectively,
90 ignoring case.
93 \IT{\arrGOO{(\FU*{CHAR-UPCASE} \VAR{ character})\\
94 (\FU*{CHAR-DOWNCASE} \VAR{ character})}{.}}
96 Return corresponding uppercase/lowercase \retval{character},
97 respectively.
100 \IT{(\FU*{DIGIT-CHAR} \VAR{i} \Op{\VAR{radix}\DF{\LIT{10}}})}
102 \retval{Character} representing digit \VAR{i}.
105 \IT{(\FU*{CHAR-NAME} \VAR{character})}
107 \VAR{character}'s \retval{name} if any, or
108 \retval{\NIL}.
111 \IT{(\FU*{NAME-CHAR} \VAR{foo})}
113 \retval{Character} named \VAR{foo} if any, or
114 \retval{\NIL}.
117 \IT{\arrGOO{(\FU*{CHAR-INT} \VAR{ character})\\
118 (\FU*{CHAR-CODE} \VAR{ character})}{.}}
120 \retval{Code} of \VAR{character}.
123 \IT{(\FU*{CODE-CHAR} \VAR{code})}
125 \retval{Character} with \VAR{code}.
128 \IT{\CNS*{CHAR-CODE-LIMIT}}
130 Upper bound of (\FU{CHAR-CODE} \VAR{char}); $\geq 96$.
133 \IT{(\FU*{CHARACTER} \VAR{c})}
135 Return \retval{\kwd{\#$\backslash$}\VAR{c}}.
138 \end{LIST}
140 %%% Local Variables:
141 %%% mode: latex
142 %%% TeX-master: "clqr"
143 %%% End: