Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## calhoun.analysis.crf.features.generic
Class IndicatorEdges

    java.lang.Object
      calhoun.analysis.crf.AbstractFeatureManager
          calhoun.analysis.crf.features.generic.IndicatorEdges

All Implemented Interfaces:
  FeatureManager, FeatureManagerEdge, java.io.Serializable

    public class IndicatorEdges

extends AbstractFeatureManager
implements FeatureManagerEdge

a set of indicator features for the valid transitions in the model.

Notes:

- Each indicator returns 1 when evaluated on it's transition, otherwise 0.
- Exactly one feature will return a non-zero value for every valid edge transition.

See Also:
  Serialized Form

Constructor Summary
`IndicatorEdges()`

Method Summary
`void` | `evaluateEdge(InputSequence seq, int pos, int prevState, int state, FeatureList result)` Evaluates the set of features managed by this object for the given arguments.
`java.lang.String` | `getFeatureName(int featureIndex)` Returns a human identifiable name for the feature referenced by a given index.
`int` | `getNumFeatures()` Returns the number of features maintained by this `FeatureManager`.
`void` | `train(int startingIndex, ModelManager modelInfo, java.util.List data)` Edge features don't train based on the data.

Methods inherited from class calhoun.analysis.crf.AbstractFeatureManager
`getCacheStrategy, getInputComponent, setInputComponent`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface calhoun.analysis.crf.FeatureManager
`getCacheStrategy, getInputComponent, setInputComponent`

Constructor Detail

### IndicatorEdges

    public IndicatorEdges()

Method Detail

### getFeatureName

    public java.lang.String getFeatureName(int featureIndex)

  Description copied from interface: `FeatureManager`
  Returns a human identifiable name for the feature referenced by a given index. Used for display purposes only.

  Specified by:
    `getFeatureName` in interface `FeatureManager`
  Parameters:
    `featureIndex` - the index of this feature
  Returns:
    the human readable name of this feature

### getNumFeatures

    public int getNumFeatures()

  Description copied from interface: `FeatureManager`
  Returns the number of features maintained by this `FeatureManager`. This number must be fixed after the call to trainFeatures is complete.

  Specified by:
    `getNumFeatures` in interface `FeatureManager`
  Returns:
    number of features managed by this `FeatureManager`

### evaluateEdge

    public void evaluateEdge(InputSequence seq,
                             int pos,
                             int prevState,
                             int state,
                             FeatureList result)

  Description copied from interface: `FeatureManagerEdge`
  Evaluates the set of features managed by this object for the given arguments.

  Specified by:
    `evaluateEdge` in interface `FeatureManagerEdge`

### train

    public void train(int startingIndex,
                      ModelManager modelInfo,
                      java.util.List data)

  Edge features don't train based on the data. Just set up based on the model.

  Specified by:
    `train` in interface `FeatureManager`
  Parameters:
    `startingIndex` - the feature index of the first feature owned by this FeatureManager. Each FeatureManager must use up consecutive indexes, so the last index used will be startingIndex + numFeatures - 1.
    `modelInfo` - the model that contains this feature
    `data` - the full list of training sequences to use to train the feature

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD