summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJosh Blum2012-11-18 17:33:40 -0800
committerJosh Blum2012-11-18 17:33:40 -0800
commit4f9768f88eeed0c0b7e6ce7335752475d6a20df1 (patch)
tree833f69f1dd86332c7f2ee5e5b3ccd6795da3cba2 /include
parent2918d7145bfc1bed64f1ec4939a9856a8175aba8 (diff)
downloadsandhi-4f9768f88eeed0c0b7e6ce7335752475d6a20df1.tar.gz
sandhi-4f9768f88eeed0c0b7e6ce7335752475d6a20df1.tar.bz2
sandhi-4f9768f88eeed0c0b7e6ce7335752475d6a20df1.zip
propagate_tags director for python
Diffstat (limited to 'include')
-rw-r--r--include/gras/block.hpp12
1 files changed, 8 insertions, 4 deletions
diff --git a/include/gras/block.hpp b/include/gras/block.hpp
index bddc0f4..70c570c 100644
--- a/include/gras/block.hpp
+++ b/include/gras/block.hpp
@@ -163,14 +163,18 @@ struct GRAS_API Block : Element
void erase_input_tags(const size_t which_input);
/*!
- * Overload me to implement tag propagation logic:
+ * Overload me to implement custom tag propagation logic:
*
* Propagate tags will be given an iterator for all input tags
* whose offset counts is less than the number of items consumed.
- * It is the job of the propagate_tags overload to
+ * It is the job of the propagate_tags overloaded function to
* propagate tags to the downstream and interpolate the offset.
- * By default, the propagate_tags implementation is a NOP.
- * Also, the user may simple propagate tags from within work.
+ *
+ * By default, the propagate_tags implementation is to:
+ * broadcast each consumed input tags to all output ports
+ * using the local input offset as the local output offset.
+ *
+ * Also, the user may simply propagate tags from within work.
*/
virtual void propagate_tags(const size_t which_input, const TagIter &iter);