diff options
| author | tradke <tradke@d60812e6-3970-4df4-986e-c251b06effeb> | 2003-04-15 15:31:12 +0000 |
|---|---|---|
| committer | tradke <tradke@d60812e6-3970-4df4-986e-c251b06effeb> | 2003-04-15 15:31:12 +0000 |
| commit | 16266c2af7fe606b142e3c8498b8bf690ce48cc3 (patch) | |
| tree | 501dee7b97bb6d3fd1b70f070c2e3aaf2137eca7 | |
| parent | 2a7f167722503f0ef2a08268d7a8ed24555be1de (diff) | |
Update for new reduction operators and synonym names.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGH/PUGHReduce/trunk@41 d60812e6-3970-4df4-986e-c251b06effeb
| -rw-r--r-- | doc/documentation.tex | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index c83f3f0..3e6e8de 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -33,19 +33,23 @@ The reduction operations this thorn registers are\\ \hline Reduction Operator & Calculates & By \\ \hline -{\tt average$^*$} & the average of a grid variable & $ \sum{ GV }/n $ \\ -{\tt minimum$^*$} & the minimum of a grid variable & $ \min{ GV } $ \\ +{\tt average$^*$, mean$^*$} & the average/mean of a grid variable & $ \sum{ GV }/N $ \\ +{\tt count} & the number of grid points in a grid variable & $ N $ \\ {\tt maximum$^*$} & the maximum of a grid variable & $ \max{ GV } $ \\ +{\tt minimum$^*$} & the minimum of a grid variable & $ \min{ GV } $ \\ +{\tt norm1, L1Norm} & the L1 norm of a grid variable & $ \left(\Sigma |GV| \right)/N $ \\ +{\tt norm2, L2Norm} & the L2 norm of a grid variable & $ \sqrt[2]{(\Sigma |GV|^2)/N} $ \\ +{\tt norm3, L3Norm} & the L3 norm of a grid variable & $ \sqrt[3]{(\Sigma |GV|^3)/N} $ \\ +{\tt norm4, L4Norm} & the L4 norm of a grid variable & $ \sqrt[4]{(\Sigma |GV|^4)/N} $ \\ +{\tt norm\_inf, LinfNorm} & the Infinitity norm of a grid variable & $ \max{| GV |} $ \\ {\tt sum$^*$} & the sum of the elements of a grid variable & $ \sum{ GV } $ \\ -{\tt norm1} & the L1 norm of a grid variable & $ \left(\Sigma | GV | \right)/n $ \\ -{\tt norm2} & the L2 norm of a grid variable & $ \sqrt{(\Sigma GV^2)/n} $ \\ -{\tt norm\_inf} & the Inf norm of a grid variable & $ \max{| GV |} $ \\ \hline \end{tabular}\\ -In the formulas $GV$ is the grid variable to be reduced, and $n$ denotes the -number of its elements. Reduction operators marked with $^*$ cannot be applied -to grid variables of complex datatype. +Reduction operators with multiple names are just synonyms for the same kind of +reduction operation. In the formulas $GV$ is the grid variable to be reduced, +and $N$ denotes the number of its elements. Reduction operators marked with +$^*$ cannot be applied to grid variables of complex datatype. % % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |