CombinedStringDistanceLearner (SecondString 0.1 API)

java.lang.Object
- com.wcohen.ss.CombinedStringDistanceLearner

All Implemented Interfaces:

StringDistanceLearner

Direct Known Subclasses:

AveragedStringDistanceLearner
```
public abstract class CombinedStringDistanceLearner
extends Object
implements StringDistanceLearner
```
Abstract StringDistanceLearner class which combines results of a number of inner distance metrics, learned by a number of inner distance learners.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`CombinedStringDistanceLearner.CombinedStringDistance` Abstract class for combining innerDistances's
`protected class`	`CombinedStringDistanceLearner.JthDistanceInstanceIterator` Iterate over the j-th field of MultiStringWrapper's in a DistanceInstance of MultiStringWrapper's
`protected class`	`CombinedStringDistanceLearner.JthStringWrapperValueIterator` Iterate over the j-th field of MultiStringWrapper
`protected class`	`CombinedStringDistanceLearner.MyDistanceInstance`
`protected class`	`CombinedStringDistanceLearner.MyMultiDistanceInstance`

Field Summary

Fields
Modifier and Type Field and Description

protected String delim

protected StringDistanceLearner[] innerLearners

Fields
Modifier and Type	Field and Description
`protected String`	`delim`
`protected StringDistanceLearner[]`	`innerLearners`

Constructor Summary

Constructors
Constructor and Description

CombinedStringDistanceLearner()

CombinedStringDistanceLearner(StringDistanceLearner[] innerLearners, String delim)

Constructors
Constructor and Description
`CombinedStringDistanceLearner()`
`CombinedStringDistanceLearner(StringDistanceLearner[] innerLearners, String delim)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExample(DistanceInstance answeredQuery)` Pass new labels to the sublearners.
`protected CombinedStringDistanceLearner.MyMultiDistanceInstance`	`asMultiDistanceInstance(DistanceInstance di)`
`protected List`	`asMultiDistanceInstanceList(DistanceInstanceIterator i)`
`protected MultiStringWrapper`	`asMultiStringWrapper(StringWrapper w)`
`protected List`	`asMultiStringWrapperList(StringWrapperIterator i)`
`protected abstract void`	`comboAddExample(DistanceInstance di)` Pass a labeled example to the score-combination learner.
`protected abstract boolean`	`comboHasNextQuery()` Poll the routine that learns to combine inner distance scores to see if it wants to make more queries.
`protected abstract DistanceInstance`	`comboNextQuery()` Get the next query from the score-combination learner.
`protected abstract void`	`comboSetDistanceInstancePool(Iterator i)` Set up a pool of (possibly unlabeled) instance distances, for the learner to make queries from.
`protected abstract void`	`comboSetStringWrapperPool(Iterator i)` Pass an iterator over unlabeled string wrappers to the score-combination learner, just in case that's useful.
`abstract StringDistance`	`getDistance()` Get the final string distance, which will be based on the distances learned by the inner learners, as well as the combination scheme learned by comboSetAnswer, comboTrain, and etc.
`protected StringDistance[]`	`getInnerDistances()` Get an array of trained inner distances.
`boolean`	`hasNextQuery()` See if someone has a query
`DistanceInstance`	`nextQuery()` Get a next query from one of the sublearners
`DistanceInstanceIterator`	`prepare(DistanceInstanceIterator it)` Prepare data for the learners.
`StringWrapperIterator`	`prepare(StringWrapperIterator it)` Prepare data for the sublearners.
`void`	`setDistanceInstancePool(DistanceInstanceIterator it)` Pass the training data along to the inner learners.
`void`	`setStringWrapperPool(StringWrapperIterator it)` Pass the training data along to the inner learners.

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

- Field Detail
  - innerLearners
```
protected StringDistanceLearner[] innerLearners
```
  - delim
```
protected String delim
```
- Constructor Detail
  - CombinedStringDistanceLearner
```
public CombinedStringDistanceLearner()
```
  - CombinedStringDistanceLearner
```
public CombinedStringDistanceLearner(StringDistanceLearner[] innerLearners,
                                     String delim)
```
- Method Detail
  - comboSetStringWrapperPool
```
protected abstract void comboSetStringWrapperPool(Iterator i)
```
    Pass an iterator over unlabeled string wrappers to the score-combination learner, just in case that's useful.
  - comboSetDistanceInstancePool
```
protected abstract void comboSetDistanceInstancePool(Iterator i)
```
    Set up a pool of (possibly unlabeled) instance distances, for the learner to make queries from.
  - comboHasNextQuery
```
protected abstract boolean comboHasNextQuery()
```
    Poll the routine that learns to combine inner distance scores to see if it wants to make more queries.
  - comboNextQuery
```
protected abstract DistanceInstance comboNextQuery()
```
    Get the next query from the score-combination learner.
  - comboAddExample
```
protected abstract void comboAddExample(DistanceInstance di)
```
    Pass a labeled example to the score-combination learner.
  - getDistance
```
public abstract StringDistance getDistance()
```
    Get the final string distance, which will be based on the distances learned by the inner learners, as well as the combination scheme learned by comboSetAnswer, comboTrain, and etc.
    
    Specified by:
    
    getDistance in interface StringDistanceLearner
  - setStringWrapperPool
```
public void setStringWrapperPool(StringWrapperIterator it)
```
    Pass the training data along to the inner learners.
    
    Specified by:
    
    setStringWrapperPool in interface StringDistanceLearner
  - setDistanceInstancePool
```
public void setDistanceInstancePool(DistanceInstanceIterator it)
```
    Pass the training data along to the inner learners.
    
    Specified by:
    
    setDistanceInstancePool in interface StringDistanceLearner
  - hasNextQuery
```
public boolean hasNextQuery()
```
    See if someone has a query
    
    Specified by:
    
    hasNextQuery in interface StringDistanceLearner
  - nextQuery
```
public DistanceInstance nextQuery()
```
    Get a next query from one of the sublearners
    
    Specified by:
    
    nextQuery in interface StringDistanceLearner
  - addExample
```
public void addExample(DistanceInstance answeredQuery)
```
    Pass new labels to the sublearners.
    
    Specified by:
    
    addExample in interface StringDistanceLearner
  - prepare
```
public StringWrapperIterator prepare(StringWrapperIterator it)
```
    Prepare data for the sublearners.
    
    Specified by:
    
    prepare in interface StringDistanceLearner
  - prepare
```
public DistanceInstanceIterator prepare(DistanceInstanceIterator it)
```
    Prepare data for the learners.
    
    Specified by:
    
    prepare in interface StringDistanceLearner
  - asMultiStringWrapperList
```
protected List asMultiStringWrapperList(StringWrapperIterator i)
```
  - asMultiStringWrapper
```
protected MultiStringWrapper asMultiStringWrapper(StringWrapper w)
```
  - asMultiDistanceInstanceList
```
protected List asMultiDistanceInstanceList(DistanceInstanceIterator i)
```
  - asMultiDistanceInstance
```
protected CombinedStringDistanceLearner.MyMultiDistanceInstance asMultiDistanceInstance(DistanceInstance di)
```
  - getInnerDistances
```
protected StringDistance[] getInnerDistances()
```
    Get an array of trained inner distances.

Class CombinedStringDistanceLearner

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

innerLearners

delim

Constructor Detail

CombinedStringDistanceLearner

CombinedStringDistanceLearner

Method Detail

comboSetStringWrapperPool

comboSetDistanceInstancePool

comboHasNextQuery

comboNextQuery

comboAddExample

getDistance

setStringWrapperPool

setDistanceInstancePool

hasNextQuery

nextQuery

addExample

prepare

prepare

asMultiStringWrapperList

asMultiStringWrapper

asMultiDistanceInstanceList

asMultiDistanceInstance

getInnerDistances