...
 
......@@ -56,7 +56,4 @@
\pagestyle{scrheadings}
\KOMAoptions{headsepline=true}
\KOMAoptions{footsepline=true}
\KOMAoptions{plainfootsepline=true}
% HACK to fix \SS until we have a decision what to use here
\renewcommand{\SS}{\mathcal{S}}
\KOMAoptions{plainfootsepline=true}
\ No newline at end of file
%
% This file collects old definitions that were replaced by newer ones and might be deleted, soon
%
\ProvidesPackage{numapde-deprecated}
\newcommand{\BB}{\PackageWarning{numapde-latex}{The command \noexpand\BB is obsolete, please use \noexpand\cB instead}\mathcal{B}}
\newcommand{\CC}{\PackageWarning{numapde-latex}{The command \noexpand\CC is obsolete, please use \noexpand\cC instead}\mathcal{C}}
\newcommand{\DD}{\PackageWarning{numapde-latex}{The command \noexpand\DD is obsolete, please use \noexpand\cD instead}\mathcal{D}}
\newcommand{\EE}{\PackageWarning{numapde-latex}{The command \noexpand\EE is obsolete, please use \noexpand\cE instead}\mathcal{E}}
\newcommand{\FF}{\PackageWarning{numapde-latex}{The command \noexpand\FF is obsolete, please use \noexpand\cF instead}\mathcal{F}}
\newcommand{\GG}{\PackageWarning{numapde-latex}{The command \noexpand\GG is obsolete, please use \noexpand\cG instead}\mathcal{G}}
\newcommand{\HH}{\PackageWarning{numapde-latex}{The command \noexpand\HH is obsolete, please use \noexpand\cH instead}\mathcal{H}}
\newcommand{\II}{\PackageWarning{numapde-latex}{The command \noexpand\II is obsolete, please use \noexpand\cI instead}\mathcal{I}}
\newcommand{\JJ}{\PackageWarning{numapde-latex}{The command \noexpand\JJ is obsolete, please use \noexpand\cJ instead}\mathcal{J}}
\newcommand{\KK}{\PackageWarning{numapde-latex}{The command \noexpand\KK is obsolete, please use \noexpand\cK instead}\mathcal{K}}
\newcommand{\LL}{\PackageWarning{numapde-latex}{The command \noexpand\LL is obsolete, please use \noexpand\cL instead}\mathcal{L}}
\newcommand{\MM}{\PackageWarning{numapde-latex}{The command \noexpand\MM is obsolete, please use \noexpand\cM instead}\mathcal{M}}
\newcommand{\NN}{\PackageWarning{numapde-latex}{The command \noexpand\NN is obsolete, please use \noexpand\cN instead}\mathcal{N}}
\newcommand{\OO}{\PackageWarning{numapde-latex}{The command \noexpand\OO is obsolete, please use \noexpand\cO instead}\mathcal{O}}
\newcommand{\PP}{\PackageWarning{numapde-latex}{The command \noexpand\PP is obsolete, please use \noexpand\cP instead}\mathcal{P}}
\newcommand{\QQ}{\PackageWarning{numapde-latex}{The command \noexpand\QQ is obsolete, please use \noexpand\cQ instead}\mathcal{Q}}
\newcommand{\RR}{\PackageWarning{numapde-latex}{The command \noexpand\RR is obsolete, please use \noexpand\cR instead}\mathcal{R}}
\newcommand{\TT}{\PackageWarning{numapde-latex}{The command \noexpand\TT is obsolete, please use \noexpand\cT instead}\mathcal{T}}
\newcommand{\UU}{\PackageWarning{numapde-latex}{The command \noexpand\UU is obsolete, please use \noexpand\cU instead}\mathcal{U}}
\newcommand{\VV}{\PackageWarning{numapde-latex}{The command \noexpand\VV is obsolete, please use \noexpand\cV instead}\mathcal{V}}
\newcommand{\WW}{\PackageWarning{numapde-latex}{The command \noexpand\WW is obsolete, please use \noexpand\cW instead}\mathcal{W}}
\newcommand{\XX}{\PackageWarning{numapde-latex}{The command \noexpand\XX is obsolete, please use \noexpand\cX instead}\mathcal{X}}
\newcommand{\YY}{\PackageWarning{numapde-latex}{The command \noexpand\YY is obsolete, please use \noexpand\cY instead}\mathcal{Y}}
\newcommand{\ZZ}{\PackageWarning{numapde-latex}{The command \noexpand\ZZ is obsolete, please use \noexpand\cZ instead}\mathcal{Z}}
\ No newline at end of file
......@@ -40,8 +40,13 @@ This document provides a comprehensive overview of all packages and commands def
Packages are meant to used hierarchically, i.e, \file{numapde-manifolds.sty} builds upon and hence loads \file{numapde-semantic.sty}, which in turn builds upon and loads \file{numapde-packages.sty} and \file{numapde-syntax.sty}.
Additional commands and document specific settings should generally be defined locally initially in \file{numapde-local.sty} (\cref{sec:local-definitions}) and can make their way into the general collection later.
\textbf{Note.} Any changes to files in this repository need to be reflected in this file, \file{documentation.tex}, as well.
\textbf{Note 1.} Any changes to files in this repository need to be reflected in this file, \file{documentation.tex}, as well.
\textbf{Note 2.} If there are breaking changes, this package tries to provide old commands with warnings, if you load \file{numapde-deprecated.sty}.
While most old commands are loaded that way, commands that break with other packages,
symbols that break with other packages,
like \codeExample{\AA} or \codeExample{\SS} (which were used for calligraphic letters),
are not loaded in this legacy mode, neither.
\section{Packages: \texorpdfstring{\file{numapde-packages.sty}}{numapde-packages.sty}}\label{sec:packages}
......@@ -92,7 +97,10 @@ They usually are rather simple commands without too many parameters.
\item[ba\ldots bZ] bold-face letters \mathCodeExample{\bR, \bf}
\item[bnull] bold-face zero \mathCodeExample{\bnull}
\item[bone] bold-face one \mathCodeExample{\bone}
\item[AA\ldots ZZ] calligraphic uppercase letters \mathCodeExample{\MM, \NN}
\item[cA\ldots cZ] calligraphic uppercase letters \mathCodeExample{\cM, \cN}\\
\numapdeWarning these symbols were initially called \codeCommand{\AA} and so on,
if your are migrating from a previous version you can use \codeCommand{\usepackage{numapde-deprecated}}
to re-enable the old commands with a warning.
\item[C, K, N, Q, R, S, Z] mathematical sets \par\mathCodeExample{\C,\K,\N,\Q,\R,\S,\Z}
\end{commandlist}
......@@ -105,7 +113,8 @@ Its default definition is \codeCommand{\textsc{#1}\xspace}.\footnote{which adds
\begin{commandlist}
\item[aa] almost all \codeExample{\aa}
\item[adimat] \justCodeExample{\adimat}
\item[ae] almost everwhere \codeExample{\ae}
\item[ale] almost everwhere \codeExample{\ale}\\
\numapdeWarning this was called \codeCommand{\ae} (which is reserved for \justCodeExample{\ae}) previously.
\item[ampl] \justCodeExample{\ampl}
\item[BibTeX] \justCodeExample{\BibTeX}
\item[BibLaTeX] \justCodeExample{\BibLaTeX}
......@@ -223,6 +232,7 @@ Its default definition is \codeCommand{\textsc{#1}\xspace}.\footnote{which adds
The third and fifth argument are the content to be enclosed.
\par\mathCodeExample{\encloseSet[big]{\{}{x\in\R}{|}{x>5}{\}}} % chktex 9
\par\mathCodeExample{\encloseSet[auto]{\{}{x\in\R}{|}{x>\dfrac{1}{2}}{\}}} % chktex 9
\\
\textbf{Note.} This command should normally be used only in the definition of other commands.
For instance, \codeCommand{\setDef} is using it internally.
\item[paren] is an alternative to \codeCommand{\enclose}, with a different ordering of arguments.
......@@ -316,8 +326,8 @@ a notion for an inner product.
The second argument denotes the set.
The third argument denotes the point; it can be omitted.
The command \codeCommand{\distOp} is used to typeset the operator.
\par\mathCodeExample{\dist[Big]{\CC}{\dfrac{x}{2}}}
\par\mathCodeExample{\dist{\CC}}
\par\mathCodeExample{\dist[Big]{\cC}{\dfrac{x}{2}}}
\par\mathCodeExample{\dist{\cC}}
\par\mathCodeExample{\dist}
\item[div] divergence \mathCodeExample{\div}
\item[Div] (row-wise) divergence \mathCodeExample{\Div}
......@@ -385,10 +395,10 @@ a notion for an inner product.
The command \codeCommand{\projOp} is used to typeset the operator.
\par\mathCodeExample{\proj}
\par\mathCodeExample{\proj(x)}
\par\mathCodeExample{\proj{\CC}}
\par\mathCodeExample{\proj{\CC}(x)}
\par\mathCodeExample{\proj{\cC}}
\par\mathCodeExample{\proj{\cC}(x)}
\par\mathCodeExample{\proj[Big](\dfrac{x}{2})}
\par\mathCodeExample{\proj[Big]{\CC}(\dfrac{x}{2})}
\par\mathCodeExample{\proj[Big]{\cC}(\dfrac{x}{2})}
\item[proxOp] the mathematical operator denoting the proximal map
\par\mathCodeExample{\proxOp}
\item[prox] the proximal operator of a function.
......@@ -462,22 +472,22 @@ The semantic file \file{numapde-manifolds.sty} collects definitions and notation
\item[bitangent] the bitangent space.
Its syntax is \codeCommand{\bitangent{#1}[#2]}.
The first argument denotes the base point.
The second (optional) argument denotes the manifold, which defaults to $\MM$.
The second (optional) argument denotes the manifold, which defaults to $\cM$.
\par\mathCodeExample{\bitangent{p}}
\par\mathCodeExample{\bitangent{q}[\NN]}
\par\mathCodeExample{\bitangent{q}[\cN]}
\item[bitangentSpaceSymbol] the symbol used within \codeCommand{\bitangent}.
\par\mathCodeExample{\bitangentSpaceSymbol}
\item[cotangent] the cotangent space.
Its syntax is \codeCommand{\cotangent{#1}[#2]}.
The first argument denotes the base point.
The second (optional) argument denotes the manifold, which defaults to $\MM$.
The second (optional) argument denotes the manifold, which defaults to $\cM$.
\par\mathCodeExample{\cotangent{p}}
\par\mathCodeExample{\cotangent{q}[\NN]}
\par\mathCodeExample{\cotangent{q}[\cN]}
\item[cotangentBundle] the cotangent bundle.
Its syntax is \codeCommand{\cotangentBundle[#1]}.
The (optional) argument denotes the manifold, which defaults to $\MM$.
The (optional) argument denotes the manifold, which defaults to $\cM$.
\par\mathCodeExample{\cotangentBundle}
\par\mathCodeExample{\cotangentBundle[\NN]}
\par\mathCodeExample{\cotangentBundle[\cN]}
\item[cotangentSpaceSymbol] the symbol used within \codeCommand{\cotangent}.
\par\mathCodeExample{\cotangentSpaceSymbol}
\item[exponential] the exponential map.
......@@ -590,14 +600,14 @@ The semantic file \file{numapde-manifolds.sty} collects definitions and notation
\item[tangent] the tangent space.
Its syntax is \codeCommand{\tangent{#1}[#2]}.
The first argument denotes the base point.
The second (optional) argument denotes the manifold, which defaults to $\MM$.
The second (optional) argument denotes the manifold, which defaults to $\cM$.
\par\mathCodeExample{\tangent{p}}
\par\mathCodeExample{\tangent{q}[\NN]}
\par\mathCodeExample{\tangent{q}[\cN]}
\item[tangentBundle] the tangent bundle.
Its syntax is \codeCommand{\tangentBundle[#1]}.
The (optional) argument denotes the manifold, which defaults to $\MM$.
The (optional) argument denotes the manifold, which defaults to $\cM$.
\par\mathCodeExample{\tangentBundle}
\par\mathCodeExample{\tangentBundle[\NN]}
\par\mathCodeExample{\tangentBundle[\cN]}
\item[tangentSpaceSymbol] the symbol used within \codeCommand{\tangent}.
\par\mathCodeExample{\tangentSpaceSymbol}
\item[vectorTransport] a vector transport.\\
......
......@@ -37,6 +37,8 @@
\scantokens{$\displaystyle #1\noexpand$}%
}
\newcommand{\numapdeWarning}{{ \color{TolVibrantOrange}\faIcon{exclamation-triangle}\ }}
% Define a command which displays colors
\NewDocumentCommand\colorExample{v}{%
\faIcon{tint}%
......
......@@ -6,8 +6,8 @@
\RequirePackage{numapde-semantic}
% Define some symbols
\newcommand{\bitangentSpaceSymbol}{\TT^{**}}
\newcommand{\cotangentSpaceSymbol}{\TT^*}
\newcommand{\bitangentSpaceSymbol}{\cT^{**}}
\newcommand{\cotangentSpaceSymbol}{\cT^*}
\newcommand{\covariantDerivativeSymbol}{\textup{D}}
\newcommand{\secondCovariantDerivativeSymbol}{\covariantDerivativeSymbol^2}
\newcommand{\geodesicSymbol}{\gamma}
......@@ -20,23 +20,23 @@
}
\newcommand{\parallelTransportSymbol}{\textup{P}}
\newcommand{\retractionSymbol}{\textup{retr}}
\newcommand{\tangentSpaceSymbol}{\TT}
\newcommand{\tensorSpaceSymbol}{\TT}
\newcommand{\tangentSpaceSymbol}{\cT}
\newcommand{\tensorSpaceSymbol}{\cT}
\newcommand{\vectorTransportSymbol}{\textup{T}}
% Define a command for the bitangent space
% Argument {#1} is the base point
% The optional argument [#2] (default \MM) is the manifold
\NewDocumentCommand{\bitangent}{ m O{\MM} }{\bitangentSpaceSymbol_{#1}#2}
% The optional argument [#2] (default \cM) is the manifold
\NewDocumentCommand{\bitangent}{ m O{\cM} }{\bitangentSpaceSymbol_{#1}#2}
% Define a command for the cotangent space
% Argument {#1} is the base point
% The optional argument [#2] (default \MM) is the manifold
\NewDocumentCommand{\cotangent}{ m O{\MM} }{\cotangentSpaceSymbol_{#1}#2}
% The optional argument [#2] (default \cM) is the manifold
\NewDocumentCommand{\cotangent}{ m O{\cM} }{\cotangentSpaceSymbol_{#1}#2}
% Define a command for the cotangent bundle
% The optional argument [#1] (default \MM) is the manifold
\NewDocumentCommand{\cotangentBundle}{ O{\MM} }{\cotangentSpaceSymbol{}#1}
% The optional argument [#1] (default \cM) is the manifold
\NewDocumentCommand{\cotangentBundle}{ O{\cM} }{\cotangentSpaceSymbol{}#1}
% Define a command for the covariant derivative (connection)
% Argument {#1} is the vector (field) which determines the direction of differentiation
......@@ -146,18 +146,18 @@
% Define a command for the tangent space
% Argument {#1} is the base point
% The optional argument [#2] (default \MM) is the manifold
\NewDocumentCommand{\tangent}{ m O{\MM} }{\tangentSpaceSymbol_{#1}#2}
% The optional argument [#2] (default \cM) is the manifold
\NewDocumentCommand{\tangent}{ m O{\cM} }{\tangentSpaceSymbol_{#1}#2}
% Define a command for the tangent bundle
% The optional argument [#1] (default \MM) is the manifold
\NewDocumentCommand{\tangentBundle}{ O{\MM} }{\tangentSpaceSymbol{}#1}
% The optional argument [#1] (default \cM) is the manifold
\NewDocumentCommand{\tangentBundle}{ O{\cM} }{\tangentSpaceSymbol{}#1}
% Define a command for the (r,s)-tensor bundle
% Argument {#1} is the number r of elements of the dual space V^* the tensors accept.
% Argument {#2} is the number s of elements of the space V the tensors accept.
% The optimal argument [#3] (default \MM) is the manifold
\NewDocumentCommand{\tensorBundle}{ m m O{\MM} }{\tensorSpaceSymbol^{(#1,#2)}#3}
% The optimal argument [#3] (default \cM) is the manifold
\NewDocumentCommand{\tensorBundle}{ m m O{\cM} }{\tensorSpaceSymbol^{(#1,#2)}#3}
% Define a command for the space of (r,s)-tensors over a vector space V
% Argument {#1} is the number r of elements of the dual space V^* the tensors accept.
......
......@@ -6,10 +6,10 @@
\RequirePackage{numapde-semantic}
% Define some symbols
\newcommand{\normalCone}{\NN}
\newcommand{\radialCone}{\KK}
\newcommand{\tangentCone}{\TT}
\newcommand{\linearizingCone}{\TT^\textup{lin}}
\newcommand{\normalCone}{\cN}
\newcommand{\radialCone}{\cK}
\newcommand{\tangentCone}{\cT}
\newcommand{\linearizingCone}{\cT^\textup{lin}}
% Define a command for the radial cone
% The optional argument [#1] scales the delimiters
......@@ -38,4 +38,3 @@
% Define a command for the polar cone
% Argument {#1} is the set
\NewDocumentCommand{\polarcone}{ m }{#1^\circ}
......@@ -128,33 +128,32 @@
\newcommand{\bOmega}{{\boldsymbol{\Omega}}}
% Define commands for calligraphic upper-case letters in math mode
\let\AA\undefined \newcommand{\AA}{\mathcal{A}}
\newcommand{\BB}{\mathcal{B}}
\newcommand{\CC}{\mathcal{C}}
\newcommand{\DD}{\mathcal{D}}
\newcommand{\EE}{\mathcal{E}}
\newcommand{\FF}{\mathcal{F}}
\newcommand{\GG}{\mathcal{G}}
\newcommand{\HH}{\mathcal{H}}
\newcommand{\II}{\mathcal{I}}
\newcommand{\JJ}{\mathcal{J}}
\newcommand{\KK}{\mathcal{K}}
\newcommand{\LL}{\mathcal{L}}
\newcommand{\MM}{\mathcal{M}}
\newcommand{\NN}{\mathcal{N}}
\newcommand{\OO}{\mathcal{O}}
\newcommand{\PP}{\mathcal{P}}
\newcommand{\QQ}{\mathcal{Q}}
\newcommand{\RR}{\mathcal{R}}
\let\SS\undefined
\newcommand{\SS}{\mathcal{S}}
\newcommand{\TT}{\mathcal{T}}
\newcommand{\UU}{\mathcal{U}}
\newcommand{\VV}{\mathcal{V}}
\newcommand{\WW}{\mathcal{W}}
\newcommand{\XX}{\mathcal{X}}
\newcommand{\YY}{\mathcal{Y}}
\newcommand{\ZZ}{\mathcal{Z}}
\newcommand{\cA}{\mathcal{A}}
\newcommand{\cB}{\mathcal{B}}
\newcommand{\cC}{\mathcal{C}}
\newcommand{\cD}{\mathcal{D}}
\newcommand{\cE}{\mathcal{E}}
\newcommand{\cF}{\mathcal{F}}
\newcommand{\cG}{\mathcal{G}}
\newcommand{\cH}{\mathcal{H}}
\newcommand{\cI}{\mathcal{I}}
\newcommand{\cJ}{\mathcal{J}}
\newcommand{\cK}{\mathcal{K}}
\newcommand{\cL}{\mathcal{L}}
\newcommand{\cM}{\mathcal{M}}
\newcommand{\cN}{\mathcal{N}}
\newcommand{\cO}{\mathcal{O}}
\newcommand{\cP}{\mathcal{P}}
\newcommand{\cQ}{\mathcal{Q}}
\newcommand{\cR}{\mathcal{R}}
\newcommand{\cS}{\mathcal{S}}
\newcommand{\cT}{\mathcal{T}}
\newcommand{\cU}{\mathcal{U}}
\newcommand{\cV}{\mathcal{V}}
\newcommand{\cW}{\mathcal{W}}
\newcommand{\cX}{\mathcal{X}}
\newcommand{\cY}{\mathcal{Y}}
\newcommand{\cZ}{\mathcal{Z}}
% Define commands for lower-case letters with vector accents in math mode
\newcommand{\va}{\vec{a}}
......