clarion.system
Class DefaultMatchCalculator

java.lang.Object
  extended by clarion.system.AbstractMatchCalculator
      extended by clarion.system.DefaultMatchCalculator

public class DefaultMatchCalculator
extends AbstractMatchCalculator

This class implements a default match calculator within CLARION. It extends the AbstractMatchCalculator class.

Usage:

This class acts as the default match calculator that can be used within the subsystems of CLARION (mainly the ACS). It is used for calculating match statistics for any components within the CLARION Library that implement InterfaceTracksMatchStatistics. Usually the subsystem itself will contain a match calculator which is used communally by all of the components within that subsystem. However, if a component implements InterfaceHasMatchCalculator, then that component will use its own match calculator.

The method used by the default match calculator for determining positivity is:

Feedback >= Positive Match Threshold

Version:
6.0.4
Author:
Nick Wilson

Constructor Summary
DefaultMatchCalculator()
           
 
Method Summary
 boolean isPositive(double feedback, double threshold)
          Checks to see if an outcome was positive based on the feedback received and a specified pre-defined threshold parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultMatchCalculator

public DefaultMatchCalculator()
Method Detail

isPositive

public boolean isPositive(double feedback,
                          double threshold)
Checks to see if an outcome was positive based on the feedback received and a specified pre-defined threshold parameter.

The method used by the default match calculator for determining positivity is:

Feedback >= Positive Match Threshold

Specified by:
isPositive in class AbstractMatchCalculator
Parameters:
feedback - The feedback received.
threshold - The threshold that must be passed in order for the outcome to be considered positive.
Returns:
True if the outcome was positive, otherwise false.