small revisions to section 5.2 (notes on the implementation)

to improve the latex formatting and make the comments on spurious
compiler warnings a bit clearer


git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/LocalInterp/trunk@67 df1f8a13-aa1d-4dd4-9681-27ded5b42416

1 files changed, 14 insertions, 10 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 7e863e6..f741a6b 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -950,7 +950,9 @@ implemented, but the framework is all there for more general cases.
 
 This interpolator's basic design is to use separate specialized code
 for each combination of
-$(\verb|N_dims|, \verb|molecule_family|, \verb|order|, \verb|smoothing|)$,
+\begin{verbatim}
+   (N_dims, molecule_family, order, smoothing|)
+\end{verbatim}
 \ie{} in practice for each distinct choice of interpolation molecule.
 Maple is used to generate all the interpolation coefficients.
 The C preprocessor is then used to generate all the specialized code
@@ -966,19 +968,21 @@ size/shape.  Generating new coefficients can be rather time-consuming,
 though, \eg{} the current coefficients for 3-D for orders~1-4
 take about 8~cpu minutes to generate using Maple~7 on a 1.7~GHz~P4.
 
+Note that when compiling the code in the directory
+\verb|LocalInterp/src/UniformCartesian/|, you may get compiler
+warnings about casts discarding \verb|const| qualifiers from pointers
+in (the \verb|#include|-ed file) \verb|template.c|.  Don't worry --
+the code is actually ok, the problem is that C's \verb|const|-qualifier
+rules are overly strict in some cases.  See question 11.10 in the
+(excellent!) \verb|comp.lang.c| online FAQ list
+(\verb|http://www.eskimo.com/~scs/C-faq/top.html|) for details.
+(I think \Cplusplus{} has at least partially fixed the
+\verb|const|-qualifier rules.)
+
 See the \verb|README| file in the source code directory
 \verb|LocalInterp/src/UniformCartesian/| for further details on the
 implementation.
 
-Note that when compiling the code in this directory, you may get
-compiler warnings about casts discarding \verb|const| qualifiers from
-pointers in \verb|template.c|.  Don't worry -- the code is actually ok,
-the problem is that C's \verb|const|-qualifier rules are overly strict
-in some cases.  See question 11.10 in the (excellent!) \verb|comp.lang.c|
-FAQ list (\verb|http://www.eskimo.com/~scs/C-faq/top.html|) for details.
-(I think \Cplusplus{} has at least partially fixed the
-\verb|const|-qualifier rules.)
-
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \subsection{A Simple Example of {\tt CCTK\_InterpLocalUniform} Usage}