clarion.tools
Class Range

java.lang.Object
  extended by clarion.system.Value
      extended by clarion.tools.Range
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable<Value>

public class Range
extends Value

This class implements a range for use within the TrainableImplicitModulePreTrainer class. It extends the Value class.

Usage:

This class is used for training a trainable implicit module to report the correct output activations based on a range of input activations from a lower bound to an upper bound at a precision determined by the increment constant.

Since this class is a subclass of Value, it can be used within the dimensions of a dimension-value collection as a replacement for a Value. However, it should be noted that a Range is meant for "offline" training purposes ONLY. You should NOT use this class to define the input space of your task (although the system will not be affected if you do).

This class contains both global (static) and local constants. The default is to use the local constants. If you want to change any of the global constants, you need to do so before any instances of this class are initialized.

Version:
6.0.4.5
Author:
Nick Wilson

Field Summary
static double GLOBAL_INCREMENT
          The increment at which to traverse through the range
 double INCREMENT
          The increment at which to traverse through the range
private  double lowerbound
          The lower bound of the range.
private  double upperbound
          The upper bound of the range.
 
Fields inherited from class clarion.system.Value
Activation, ACTIVATION_MATCH_EPSILON, FULL_ACTIVATION_THRESHOLD, GLOBAL_ACTIVATION_EPSILON, GLOBAL_FULL_ACTIVATION_THRESHOLD, GLOBAL_MINIMUM_ACTIVATION_THRESHOLD, hash, ID, MINIMUM_ACTIVATION_THRESHOLD
 
Constructor Summary
Range(java.lang.Object id, double lower, double upper)
          Initializes a range with the specified ID, lower and upper bounds.
 
Method Summary
 Range clone()
          Clones the range.
 double getLowerBound()
          Gets the lower bound of the range.
 double getUpperBound()
          Gets the upper bound of the range.
 void setLowerBound(double lower)
          Sets the lower bound for the range.
 void setUpperBound(double upper)
          Sets the upper bound for the range.
 java.lang.String toString()
           
 
Methods inherited from class clarion.system.Value
compareTo, equals, equalsID, getActivation, getID, hashCode, isActivated, isFullyActivated, resetActivation, setActivation
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

lowerbound

private double lowerbound
The lower bound of the range.


upperbound

private double upperbound
The upper bound of the range.


GLOBAL_INCREMENT

public static double GLOBAL_INCREMENT
The increment at which to traverse through the range


INCREMENT

public double INCREMENT
The increment at which to traverse through the range

Constructor Detail

Range

public Range(java.lang.Object id,
             double lower,
             double upper)
      throws java.lang.IllegalArgumentException
Initializes a range with the specified ID, lower and upper bounds.

Parameters:
id - The ID to set for the range.
lower - The lower bound.
upper - The upper bound.
Throws:
java.lang.IllegalArgumentException - If the upper bound is less than the lower bound.
Method Detail

getLowerBound

public double getLowerBound()
Gets the lower bound of the range.

Returns:
The lower bound.

setLowerBound

public void setLowerBound(double lower)
                   throws java.lang.IllegalArgumentException
Sets the lower bound for the range.

Parameters:
lower - The lower bound.
Throws:
java.lang.IllegalArgumentException - If the lower bound specified is greater than the upper bound.

getUpperBound

public double getUpperBound()
Gets the upper bound of the range.

Returns:
The upper bound.

setUpperBound

public void setUpperBound(double upper)
                   throws java.lang.IllegalArgumentException
Sets the upper bound for the range.

Parameters:
upper - The upper bound.
Throws:
java.lang.IllegalArgumentException - If the upper bound specified is less than the lower bound.

clone

public Range clone()
Clones the range.

Overrides:
clone in class Value
Returns:
A copy of the range.

toString

public java.lang.String toString()
Overrides:
toString in class Value