clarion.system
Interface InterfaceTracksMatchStatistics

All Known Implementing Classes:
AbstractFixedRule, AbstractIRLRule, AbstractRule, AbstractRuntimeTrainableBPNet, AbstractRuntimeTrainableImplicitModule, ImplicitModuleCollection, QBPNet, RefineableRule, RuleCollection, SimplifiedQBPNet, TableLookup

public interface InterfaceTracksMatchStatistics

This interface is implemented by classes that track match statistics within CLARION.

Usage:

Any class that implements this interface will be able to update its match statistics at each time step based on feedback it received (if provided).

Known classes implementing this interface:

Version:
6.0.4
Author:
Nick Wilson

Method Summary
 double getNM()
          Gets the negative match (NM) statistic.
 double getPM()
          Gets the positive match (PM) statistic.
 void incrementNM()
          Increments the negative match (NM) statistic.
 void incrementPM()
          Increments the positive match (PM) statistic.
 void resetMatchStatistics()
          Resets the match statistics.
 void setNM(double nm)
          Sets the negative match (NM) statistic.
 void setPM(double pm)
          Sets the positive match (PM) statistic.
 void updateMatchStatistics(AbstractMatchCalculator MatchCalculator)
          Updates the match statistics using the specified match calculator.
 

Method Detail

updateMatchStatistics

void updateMatchStatistics(AbstractMatchCalculator MatchCalculator)
Updates the match statistics using the specified match calculator.

Parameters:
MatchCalculator - The match calculator to use for updating the match statistics.

getPM

double getPM()
Gets the positive match (PM) statistic.

Returns:
the PM statistic.

getNM

double getNM()
Gets the negative match (NM) statistic.

Returns:
the NM statistic.

setPM

void setPM(double pm)
Sets the positive match (PM) statistic.

Parameters:
pm - The value to set for the PM statistic.

setNM

void setNM(double nm)
Sets the negative match (NM) statistic.

Parameters:
nm - The value to set for the NM statistic.

incrementPM

void incrementPM()
Increments the positive match (PM) statistic.


incrementNM

void incrementNM()
Increments the negative match (NM) statistic.


resetMatchStatistics

void resetMatchStatistics()
Resets the match statistics.