Docs: Update to reflect additions to CkArrayOptions
authorPhil Miller <mille121@illinois.edu>
Thu, 28 Oct 2010 23:50:29 +0000 (18:50 -0500)
committerPhil Miller <mille121@illinois.edu>
Thu, 4 Nov 2010 21:38:45 +0000 (16:38 -0500)
doc/charm++/arrays.tex
doc/charm++/reductions.tex

index 36947c5e892ba97445c2fe0fae21d977e2338d01..a20d094244259716437bede6ac4b8caefd68a7c4 100644 (file)
@@ -276,6 +276,17 @@ will be significantly more efficient in the number of messages
 required than inserting each element individually which will require
 one message send per element.
 
+\kw{CkArrayOptions} contains a few flags that the runtime can use to
+optimize handling of a given array. If the array elements will only
+migrate at controlled points (such as periodic load balancing with
+{\tt AtASync()}), this is signalled to the runtime by calling {\tt
+  opts.setAnytimeMigration(false)}\footnote{At present, this optimizes
+broadcasts to not save old messages for immigrating chares.}. If all
+array elements will be inserted by bulk creation or by {\tt
+  fooArray[x].insert()} calls, signal this by calling {\tt
+  opts.setStaticInsertion(true)} \footnote{This can enable a slightly
+  faster default mapping scheme.}.
+
 \subsubsection{Advanced Array Creation: Map Object}
 
 \index{array map}
index 45b3b5bc5df95bc8469220e540a82182caf85bee..44f3844500f2557cf4e77bc4d43c2fbd025fc878 100644 (file)
@@ -89,8 +89,10 @@ callback parameter will be the only input parameter:
 \end{alltt}
 
 If no member passes a callback to \kw{contribute}, the reduction will use
-the default callback. You set the default callback for an array or group
-using the \kw{ckSetReductionClient} proxy call on processor zero.
+the default callback. Programmers can set the default callback for an array or group
+using the \kw{ckSetReductionClient} proxy call on processor zero, or
+by passing the callback to {\tt CkArrayOptions::setReductionClient()}
+before creating the array, as described in section~\ref{CkArrayOptions}.
 Again, a \kw{CkReductionMsg} message will be passed to this callback,
 which must delete the message when done.