Package org.biojava.bio.dist
Class IgnoreCountsTrainer
java.lang.Object
org.biojava.bio.dist.IgnoreCountsTrainer
- All Implemented Interfaces:
DistributionTrainer
A distribution trainer that just ignores all counts.
- Since:
- 1.0
- Author:
- Matthew Pocock
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor intended for sub-classes. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCount(DistributionTrainerContext dtc, AtomicSymbol sym, double times) Registers that sym was counted in this state.voidClears all of the counts to zero.doublegetCount(DistributionTrainerContext dtc, AtomicSymbol sym) Get the current count for this state.static IgnoreCountsTrainerReturns the global singleton instance of the IgnoreCountsTrainer.voidtrain(DistributionTrainerContext dtc, double weight) Trains the Distribution, given a null model.
-
Constructor Details
-
IgnoreCountsTrainer
protected IgnoreCountsTrainer()Constructor intended for sub-classes.
-
-
Method Details
-
addCount
public void addCount(DistributionTrainerContext dtc, AtomicSymbol sym, double times) throws IllegalSymbolException Description copied from interface:DistributionTrainerRegisters that sym was counted in this state.
This method may be called multiple times with the same symbol. In this case, the times should be summed.
- Specified by:
addCountin interfaceDistributionTrainer- Parameters:
dtc- the DistributionTrainerContext within which the count was addedsym- the Symbol seentimes- the number of times to add- Throws:
IllegalSymbolException- if sym is not recognised
-
getCount
public double getCount(DistributionTrainerContext dtc, AtomicSymbol sym) throws IllegalSymbolException Description copied from interface:DistributionTrainerGet the current count for this state.
This method may be called multiple times with the same symbol. Each time it should return the agregate of the counts added with addCount since the last invocation of clearCounts.
- Specified by:
getCountin interfaceDistributionTrainer- Parameters:
dtc- the DistributionTrainerContext within which the count was addedsym- the Symbol seen- Returns:
- the agregate of the counts
- Throws:
IllegalSymbolException- if sym is not recognised
-
train
Description copied from interface:DistributionTrainerTrains the Distribution, given a null model.
This will use the information collected with multiple addCount calls, and the null model to generate the new weights.
This method should not modify the underlying counts.
- Specified by:
trainin interfaceDistributionTrainer- Parameters:
dtc- the context to useweight- how many lots of the null model to add
-
clearCounts
Description copied from interface:DistributionTrainerClears all of the counts to zero.- Specified by:
clearCountsin interfaceDistributionTrainer
-
getInstance
Returns the global singleton instance of the IgnoreCountsTrainer.- Returns:
- the singleton instance of this trainer
-