Debian Codegraph @

texmf-dist/source/latex/nchairx/chairxmathGeneralDoc.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2018 - 2021 by ChairX
4 %
5 % This file may be distributed and/or modified under the
6 % conditions of the LaTeX Project Public License, either
7 % version 1.3 of this license or (at your option) any later
8 % version. The latest version of this license is in:
9 %
10 % http://www.latex-project.org/lppl.txt
11 %
12 % and version 1.3 or later is part of all distributions of
13 % LaTeX version 2005/12/01 or later.
14 %
15 % This file contains the documentation of all general mathematics macros .
16 %
17 % Macros have to be described by (delete the first %)
18 % \DescribeMacro{\macro}
19 % Description and usage of the macro.
20 %
21 % The description will appear in the usage
22 % part of the documentation. Use \subsubsection{} etc. for structuring.
23 %
24 % The implementation of the macros defined here has to be written in
25 % chairxmathGeneral.dtx
26 %\fi
27 %
28 % \subsubsection{General Math Commands} \label{sec:Doc_GeneralMathCommands}
29 %
30 % \DescribeMacro{\I}
31 % Imaginary unit |\I|: $\I$
32 %
33 %\DescribeMacro{\E}
34 % Euler number |\E|: $\E$
35 %
36 %\DescribeMacro{\D}
37 % Differential |\D x|: $\D x$
38 %
39 %\DescribeMacro{\cc}
40 % Complex conjugation |z \mapsto \cc{z}|: $z \mapsto \cc{z}$
41 %
42 %\DescribeMacro{\sign}
43 % Signum |\sign \sigma|: $\sign \sigma$ \\
44 % Uses |operatorfont|.
45 %
46 %\DescribeMacro{\RE}
47 % Real part (the standard symbols are sooo ugly) |\RE(z)|: $\RE(z)$ \\
48 % Uses |operatorfont|.
49 %
50 %\DescribeMacro{\IM}
51 % Imaginary part |\IM(z)|: $\IM(z)$ \\
52 % Uses |operatorfont|.
53 %
54 %\DescribeMacro{\Unit}
55 % Unit element |\Unit|: $\Unit$
56 %
57 %\DescribeMacro{\const}
58 % Generic constant |\const|: $\const$ \\
59 % Uses |mathit| as font.
60 %
61 %\DescribeMacro{\canonical}
62 % Subscript for canonical |\omega_\canonical|: $\omega_\canonical$ \\
63 % Uses |scriptfont|.
64 %
65 %\DescribeMacro{\pt}
66 % A single point |\{\pt\}|: $\{\pt\}$ \\
67 % Uses |operatorfont|
68 %
69 %\subsubsection{Restrictions} \label{sec:Doc_Restrictions}
70 %
71 %\DescribeMacro{\at}
72 % Restriction of a map to a subset |f\at{U}|: $f\at{U}$
73 % or with optional size |f\at[\Big]{U}|: $f\at[\Big]{U}$. \\
74 % Default size is |\big|.
75 %
76 % \subsubsection{Maps and Related Stuff} \label{sec:Doc_MapsandRelatedStuff}
77 %
78 %\DescribeMacro{\Map}
79 % Space of maps |\Map(X, Y)|: $\Map(X, Y)$\\
80 % Uses |operatorfont|.
81 %
82 %\DescribeMacro{\Bij}
83 % Space of bijections |\Bij(X, Y)|: $\Bij(X, Y)$\\
84 % Uses |operatorfont|.
85 %
86 %\DescribeMacro{\argument}
87 % Generic argument of a map |f(\argument)|: $f(\argument)$
88 %
89 %\DescribeMacro{\domain}
90 % Domain of a map |\domain(\phi)|: $\domain(\phi)$\\
91 % Uses |operatorfont|.
92 %
93 %\DescribeMacro{\range}
94 % Range of a map |\range(\phi)|: $\range(\phi)$\\
95 % Uses |operatorfont|.
96 %
97 %\DescribeMacro{\id}
98 % Identity map |\id|: $\id$\\
99 % Uses |operatorfont|.
100 %
101 %\DescribeMacro{\pr}
102 % Generic projection |\pr \colon E \to M|: $\pr \colon E \to M$\\
103 % Uses |operatorfont|.
104 %
105 %\DescribeMacro{\inv}
106 % Inversion map |\inv \colon g \mapsto g^{-1}|: $\inv \colon g \mapsto g^{-1}$ \\
107 % Uses |operatorfont|.
108 %
109 %\DescribeMacro{\ev}
110 % Evaluation map |\ev \colon V \tensor V^* \to \mathbb{k}|: $\ev \colon V \tensor V^* \to \mathbb{k}$\\
111 % Uses |operatorfont|.
112 %
113 %\DescribeMacro{\image}
114 % Image of a map |\image(f)|: $\image(f)$\\
115 % Uses |operatorfont|.
116 %
117 %\DescribeMacro{\graph}
118 % Graph of a map |\graph(f)|: $\graph(f)$\\
119 % Uses |operatorfont|.
120 %
121 %\DescribeMacro{\coimage}
122 % Coimage of a map |\coimage(f)|: $\coimage(f)$\\
123 % Uses |operatorfont|.
124 %
125 %\DescribeMacro{\coker}
126 % Cokernel of a map |\coker(f)|: $\coker(f)$\\
127 % Uses |operatorfont|.
128 %
129 %\DescribeMacro{\operator}
130 % This macro allows to construct own mathematical operators
131 % whose fonts are consistent with the predefined operators of |nchairx|
132 % |\operator{asso}|: $\operator{asso}$\\
133 % Uses |operatorfont|.
134 %
135 % \subsubsection{Relations} \label{sec:Doc_Relations}
136 %
137 %\DescribeMacro{\later}
138 % Later in a directed set |i \later j|: $i \later j$
139
140 %\DescribeMacro{\earlier}
141 % Earlier in a directed set |i \earlier j|: $i \earlier j$
142 %
143 %\subsubsection{Big Sums and Products}
144 %
145 %\DescribeMacro{\bigplus}
146 % A big plus sign that can be decorated with limits. Similar to the usual sum it can be used inline
147 %|\bigplus_{k=1}^n V_k|: $\bigplus_{k=1}^n V_k$
148 % and in displaystyle:
149 % \begin{equation*}
150 % \bigplus_{k=1}^n V_k
151 % \end{equation*}
152 %
153 %\DescribeMacro{\bigtimes}
154 % A big times sign that can be decorated with limits. Similar to the usual sum it can be used inline
155 %|\bigtimes_{k=1}^n V_k|: $\bigtimes_{k=1}^n V_k$
156 % and in displaystyle:
157 % \begin{equation*}
158 % \bigtimes_{k=1}^n V_k
159 % \end{equation*}
160 %
161 %\DescribeMacro{\biprod}
162 % A biproduct sign that can be decorated with limits. Similar to the usual sum it can be used inline
163 %|\biprod_{k=1}^n V_k|: $\biprod_{k=1}^n V_k$
164 % and in displaystyle:
165 % \begin{equation*}
166 % \biprod_{k=1}^n V_k
167 % \end{equation*}
168 %
169 % \subsubsection{Labels} \label{sec:Doc_Labels}
170 %
171 % In proofs we sometimes want to label an equation by a symbol and
172 % not by an equation number. Typical choices are of course ($*$) or
173 % ($**$). But as proofs become longer, some additional labels are nice
174 % to have:
175 %
176 % \DescribeMacro{\smiley}
177 % A smiley |\smiley| $\smiley$
178 %
179 % \DescribeMacro{\frownie}
180 % A frownie |\frownie| $\frownie$
181 %
182 % \DescribeMacro{\heart}
183 % A heart |\heart| $\heart$
184 %