summaryrefslogtreecommitdiff
path: root/decoder/ff.h
diff options
context:
space:
mode:
authorWu, Ke <wuke@cs.umd.edu>2014-12-17 10:42:18 -0500
committerWu, Ke <wuke@cs.umd.edu>2014-12-17 10:42:18 -0500
commitd2c51ae79bca9b7c87f87ff458f77a6f07fff9a6 (patch)
tree9a118946600999ac50973a95066319a77baaaac6 /decoder/ff.h
parent2b30e44c7845c0e9fccbf2fc0ea535a0c5322d60 (diff)
Warn about possible misuse of IgnoredStateSize() related functions
Diffstat (limited to 'decoder/ff.h')
-rw-r--r--decoder/ff.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/decoder/ff.h b/decoder/ff.h
index afa3dbca..647b4834 100644
--- a/decoder/ff.h
+++ b/decoder/ff.h
@@ -27,6 +27,12 @@ class FeatureFunction {
// search. When non-zero, the last N bytes in the state should be ignored when
// splitting a hypernode by the state. This allows the feature function to
// store some side data and later retrieve it via the state bytes.
+ //
+ // In general, this should not be necessary and it should always be possible
+ // to replace this with a more appropriate design of state (if you find
+ // yourself having to ignore some part of the state, you are most likely
+ // storing redundant information in the state). Be sure that you
+ // understand how this affects ApplyModelSet() before using it.
int IgnoredStateSize() const { return ignored_state_size_; }
// override this. not virtual because we want to expose this to factory template for help before creating a FF
@@ -82,6 +88,7 @@ class FeatureFunction {
state_size_ = state_size;
}
+ // See document of IgnoredStateSize() above.
void SetIgnoredStateSize(size_t ignored_state_size) {
ignored_state_size_ = ignored_state_size;
}