summaryrefslogtreecommitdiff
path: root/example_extff/ff_example.cc
blob: 51ebf3645f415cad9fd276f4cccc0a844385ad64 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#include "ff.h"
#include <iostream>
#include <sstream>

using namespace std;

// example of a "stateful" feature made available as an external library
// This feature looks nodes and their daughters and fires an indicator based
// on the arities of the rules involved.
// (X (X a) b (X c)) - this is a 2 arity parent with children of 0 and 0 arity
//                     so you get MAF_2_0_0=1
class ParentChildrenArityFeatures : public FeatureFunction {
 public:
  ParentChildrenArityFeatures(const string& param) : fids(16, vector<int>(256, -1)) {
    SetStateSize(1); // number of bytes extra state required by this Feature
  }
  virtual void FinalTraversalFeatures(const void* context,
                                      SparseVector<double>* features) const {
    // Goal always is arity 1, so there's no discriminative value of
    // computing a feature
  }
 protected:
  virtual void TraversalFeaturesImpl(const SentenceMetadata& smeta,
                                     const Hypergraph::Edge& edge,
                                     const std::vector<const void*>& ant_contexts,
                                     FeatureVector* features,
                                     FeatureVector* estimated_features,
                                     void* context) const {
    unsigned child_arity_code = 0;
    for (unsigned j = 0; j < ant_contexts.size(); ++j) {
      child_arity_code <<= 4;
      child_arity_code |= *reinterpret_cast<const unsigned char*>(ant_contexts[j]);
    }
    int& fid = fids[edge.Arity()][child_arity_code]; // reference!
    if (fid < 0) {
      ostringstream feature_string;
      feature_string << "MAF_" << edge.Arity();
      for (unsigned j = 0; j < ant_contexts.size(); ++j)
        feature_string << '_' << 
          static_cast<int>(*reinterpret_cast<const unsigned char*>(ant_contexts[j]));
      fid = FD::Convert(feature_string.str());
    }
    features->set_value(fid, 1.0);
    *reinterpret_cast<unsigned char*>(context) = edge.Arity(); // save state
  }
 private:
  mutable vector<vector<int> > fids;
};

// IMPORTANT: this function must be implemented by any external FF library
// if your library has multiple features, you can use str to configure things
extern "C" FeatureFunction* create_ff(const string& str) {
  return new ParentChildrenArityFeatures(str);
}