summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac>2005-07-12 12:14:24 +0000
committerjthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac>2005-07-12 12:14:24 +0000
commit88b939f83794b1de2e68478724cdf28f23691bdb (patch)
treebd9187771e0c4675731a18f31cd95e76b66691bb
parente01fde77513187c71b8229eff7fad32b38bde7c6 (diff)
Chapter on Key/Value Tables:
clarify wording of footnote warning about the inefficency of storing large arrays in tables git-svn-id: http://svn.cactuscode.org/flesh/trunk@4089 17b73243-c579-4c4c-a9d2-2d5706c11dac
-rw-r--r--doc/UsersGuide/UtilityRoutines.tex12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/UsersGuide/UtilityRoutines.tex b/doc/UsersGuide/UtilityRoutines.tex
index 77335b79..cdb05254 100644
--- a/doc/UsersGuide/UtilityRoutines.tex
+++ b/doc/UsersGuide/UtilityRoutines.tex
@@ -196,12 +196,12 @@ if (Util_TableGetReal(handle, &pi_value, "pi") < 0)
As well as a single numbers (or characters or pointers), tables can
also store 1-dimensional arrays of numbers (or characters or pointers).%%%
\footnote{%%%
- The table makes (stores) a \emph{copy} of the array
- you pass in, so you probably shouldn't use tables to
- store really big arrays like grid functions. But it's
- fine to store things like parameters and coefficients.
- If you do have a really big array, consider storing
- a pointer to it.%%%
+ Note that the table makes (stores) a \emph{copy} of the array
+ you pass in, so it's somewhat inefficient to store a large array
+ (e.g.~a grid function) this way. If this is a problem, consider
+ storing a \texttt{CCTK\_POINTER} (pointing to the array) in the table
+ instead. (Of course, this requires that you ensure that the pointed-to
+ data is still valid whenever that \texttt{CCTK\_POINTER} is used.)
}%%%
For example (continuing the previous example):