Docs: Update to reflect additions to CkArrayOptions
[charm.git] / doc / charm++ / arrays.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}