Overview | Package | Class | Use | Tree | Serialized | Deprecated | Index | Help
| ABLE 2.3.0 07/13/2005 14:21:00
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.ibm.able.beans
Class AbleTemporalDifferenceLearning

    java.lang.Object
      com.ibm.able.AbleObject
          com.ibm.able.beans.AbleNetwork
              com.ibm.able.beans.AbleTemporalDifferenceLearning

All Implemented Interfaces:
  AbleBean, AbleDataBufferManager, AbleEventListener, AbleEventListenerManager, AbleEventQueueManager, AbleEventQueueProcessor, AblePropertyChangeManager, AbleSerializable, java.io.Serializable

public class AbleTemporalDifferenceLearning
extends AbleNetwork
implements java.io.Serializable

Temporal Difference Learning Model Programmer: Joe Bigus Created: 8/28/2000 Change Log:

See Also:
  Serialized Form

Field Summary
`static java.lang.String` | `defaultName` Value assigned to name by default.

Fields inherited from class com.ibm.able.beans.AbleNetwork
`activations, breakPointFlag, breakPoints, inNum, lastBreakPoint, MODE_NAMES, netArchitecture, netEpoch, netMode, netModelType, netRecInx, netStepsPerEpoch, NNRUN, NNTEST, NNTRAIN, outNum`

Fields inherited from class com.ibm.able.AbleObject
`changed, chgSupport, comment, dataFlowEnabled, destBufferConnections, eventQueue, fileName, inputBuffer, listeners, logger, name, outputBuffer, parent, properties, propertyConnectionMgr, sourceBufferConnections, state, stateChgSupport, trace`

Constructor Summary
`AbleTemporalDifferenceLearning()` default constructor
`AbleTemporalDifferenceLearning(java.lang.String aName)` default constrcutor with a name
`AbleTemporalDifferenceLearning(java.lang.String aName, java.lang.String args)` construct a back prop network with specified name and architecture

Method Summary
`void` | `changeNetArchitecture(java.lang.String parms)` Change the network architecture.
`void` | `createNetwork(int NumIn, int NumHid1, int NumHid2, int NumHid3, int NumOut, int FeedbackType)` create a Back Propagation network with the specified architecture
`void` | `endEpoch()` Perform the end of epoch processing.
`double[]` | `getActivations()`
`double` | `getAveRMSError()` return the average RMS error
`double` | `getAvgRMSError()`
`double` | `getBadPatRatio()`
`double` | `getDecayFactor()`
`double[]` | `getError()`
`int` | `getFeedbackType()`
`double` | `getGamma()`
`double` | `getLambda()`
`double` | `getLastRMSError()`
`double` | `getLearnRate()` return the learn rate parameter
`double` | `getMaxRMSError()`
`double` | `getMomentum()` return the momentum parameter
`java.lang.String` | `getNetArchitecture()` get the network architecture as specified by the user
`java.util.Vector` | `getNetworkGraphicData()` return data on the network architecture, activations, and weights for display by the AbleNetworkGraphicView custom inspector
`int` | `getNumHidden1()`
`int` | `getNumHidden2()`
`int` | `getNumHidden3()`
`int` | `getNumInputs()`
`int` | `getNumOutputs()`
`int` | `getNumUnits()`
`int` | `getNumWeights1()`
`int` | `getNumWeights2()`
`int` | `getNumWeights3()`
`int` | `getNumWeights4()`
`double` | `getPatternType()`
`double` | `getPercentCorrect()`
`double` | `getPercentIncorrect()`
`double` | `getPercentUnknown()`
`double` | `getReinforcement()`
`double[]` | `getTeach()`
`double[]` | `getThreshold()`
`double` | `getTolerance()` return the error tolerance parameter
`double[]` | `getWeights1()`
`double[]` | `getWeights2()`
`double[]` | `getWeights3()`
`double[]` | `getWeights4()`
`double[]` | `getWgtDeriv1()`
`double[]` | `getWgtDeriv2()`
`double[]` | `getWgtDeriv3()`
`double[]` | `getWgtDeriv4()`
`boolean` | `isAdaptLearnRate()`
`boolean` | `isEpochUpdate()`
`boolean` | `isExplicitErrorMode()`
`boolean` | `isSymmetricActFunction()`
`void` | `process()` Performs the main, synchronous, standard processing function performed by this bean.
`void` | `readInputs()` move data from the train/test set into the network input units and the teach array
`void` | `reset()` Reset this bean to its "initialized" state.
`void` | `setAdaptLearnRate(boolean state)`
`void` | `setDecayFactor(double factor)`
`void` | `setEpochUpdate(boolean state)`
`void` | `setExplicitErrorMode(boolean state)`
`void` | `setGamma(double gamma)`
`void` | `setLambda(double lambda)`
`void` | `setLearnRate(double newVal)` set the learn rate parameter
`void` | `setMomentum(double newVal)` set the momentum parameter
`void` | `setNetArchitecture(java.lang.String arch)` Set the back propagation network architecture The architecture string is a sequence of space-delimited integers as follows: numInput numHid1 numHid2 numHid3 numOutput feedbackType Note if feedbackType is not specified, it will be set to 0
`void` | `setPatternType(double type)`
`void` | `setReinforcement(double reinforce)`
`void` | `setSymmetricActFunction(boolean state)`
`void` | `setTolerance(double newVal)` set the error tolerance parameter

Methods inherited from class com.ibm.able.beans.AbleNetwork
`breakPointReached, clearAllBreakPoints, clearBreakPoint, clearBreakPoint, clearLastBreakPoint, getLastBreakPoint, getNetEpoch, getNetMode, getNetRecInx, getNetStepsPerEpoch, setBreakPoint, setDefaults, setNetMode, setNetStepsPerEpoch, testBreakPoints`

Methods inherited from class com.ibm.able.AbleObject
`addAbleEventListener, addDestBufferConnection, addPropertyChangeListener, addPropertyConnection, addSourceBufferConnection, addStateChangeListener, dataChanged, firePropertyChange, flushAbleEventQueue, getAbleEventListeners, getAbleEventProcessingEnabled, getAbleEventQueueSize, getComment, getDestBufferConnections, getFileName, getInputBuffer, getInputBuffer, getInputBufferAsString, getInputBufferAsStringArray, getInputBufferContents, getLogger, getName, getOutputBuffer, getOutputBuffer, getOutputBufferAsString, getOutputBufferAsStringArray, getOutputBufferContents, getParent, getProperties, getProperty, getPropertyChangeListeners, getPropertyConnectionManager, getSleepTime, getSourceBufferConnections, getState, getTraceLogger, handleAbleEvent, hasInputBuffer, hasOutputBuffer, init, init, isAbleEventPostingEnabled, isAbleEventProcessingEnabled, isChanged, isConnectable, isDataFlowEnabled, isTimerEventProcessingEnabled, notifyAbleEventListeners, process, processAbleEvent, processBufferConnections, processNoEventProcessingEnabledSituation, processTimerEvent, quitAll, quitEnabledEventProcessing, removeAbleEventListener, removeAllAbleEventListeners, removeAllBufferConnections, removeAllConnections, removeAllPropertyConnections, removeDestBufferConnection, removeProperty, removePropertyChangeListener, removePropertyConnection, removeSourceBufferConnection, removeStateChangeListener, restartEnabledEventProcessing, restoreFromFile, restoreFromFile, restoreFromSerializedFile, restoreFromStream, resumeAll, resumeEnabledEventProcessing, saveToFile, saveToFile, setAbleEventProcessingEnabled, setChanged, setComment, setDataFlowEnabled, setFileName, setInputBuffer, setInputBuffer, setLogger, setName, setOutputBuffer, setOutputBuffer, setParent, setProperties, setProperty, setSleepTime, setState, setTimerEventProcessingEnabled, setTraceLogger, sourceConnectionsOK, startEnabledEventProcessing, suspendAll, suspendEnabledEventProcessing`

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

Field Detail

### defaultName

    public static final java.lang.String defaultName

  Value assigned to name by default.

Constructor Detail

### AbleTemporalDifferenceLearning

    public AbleTemporalDifferenceLearning()
                                   throws AbleException

  default constructor

### AbleTemporalDifferenceLearning

    public AbleTemporalDifferenceLearning(java.lang.String aName)
                                   throws AbleException

  default constrcutor with a name

### AbleTemporalDifferenceLearning

    public AbleTemporalDifferenceLearning(java.lang.String aName,
                                          java.lang.String args)
                                   throws AbleException

  construct a back prop network with specified name and architecture

Method Detail

### getNumInputs

    public int getNumInputs()

### getNumHidden1

    public int getNumHidden1()

### getNumHidden2

    public int getNumHidden2()

### getNumHidden3

    public int getNumHidden3()

### getNumOutputs

    public int getNumOutputs()

### getNumUnits

    public int getNumUnits()

### getNumWeights1

    public int getNumWeights1()

### getNumWeights2

    public int getNumWeights2()

### getNumWeights3

    public int getNumWeights3()

### getNumWeights4

    public int getNumWeights4()

### isExplicitErrorMode

    public boolean isExplicitErrorMode()

### setExplicitErrorMode

    public void setExplicitErrorMode(boolean state)

### isAdaptLearnRate

    public boolean isAdaptLearnRate()

### setAdaptLearnRate

    public void setAdaptLearnRate(boolean state)

### isEpochUpdate

    public boolean isEpochUpdate()

### setEpochUpdate

    public void setEpochUpdate(boolean state)

### isSymmetricActFunction

    public boolean isSymmetricActFunction()

### setSymmetricActFunction

    public void setSymmetricActFunction(boolean state)

### getFeedbackType

    public int getFeedbackType()

### getDecayFactor

    public double getDecayFactor()

### setDecayFactor

    public void setDecayFactor(double factor)

### getAvgRMSError

    public double getAvgRMSError()

### getLastRMSError

    public double getLastRMSError()

### getMaxRMSError

    public double getMaxRMSError()

### getBadPatRatio

    public double getBadPatRatio()

### setLambda

    public void setLambda(double lambda)

### getLambda

    public double getLambda()

### setGamma

    public void setGamma(double gamma)

### getGamma

    public double getGamma()

### setReinforcement

    public void setReinforcement(double reinforce)

### getReinforcement

    public double getReinforcement()

### setPatternType

    public void setPatternType(double type)

### getPatternType

    public double getPatternType()

### setLearnRate

    public void setLearnRate(double newVal)

  set the learn rate parameter

### getLearnRate

    public double getLearnRate()

  return the learn rate parameter

### setMomentum

    public void setMomentum(double newVal)

  set the momentum parameter

### getPercentCorrect

    public double getPercentCorrect()

### getPercentIncorrect

    public double getPercentIncorrect()

### getPercentUnknown

    public double getPercentUnknown()

### getMomentum

    public double getMomentum()

  return the momentum parameter

### setTolerance

    public void setTolerance(double newVal)

  set the error tolerance parameter

### getTolerance

    public double getTolerance()

  return the error tolerance parameter

### getAveRMSError

    public double getAveRMSError()

  return the average RMS error

### getActivations

    public double[] getActivations()

### getWeights1

    public double[] getWeights1()

### getWeights2

    public double[] getWeights2()

### getWeights3

    public double[] getWeights3()

### getWeights4

    public double[] getWeights4()

### getWgtDeriv1

    public double[] getWgtDeriv1()

### getWgtDeriv2

    public double[] getWgtDeriv2()

### getWgtDeriv3

    public double[] getWgtDeriv3()

### getWgtDeriv4

    public double[] getWgtDeriv4()

### getThreshold

    public double[] getThreshold()

### getTeach

    public double[] getTeach()

### getError

    public double[] getError()

### getNetArchitecture

    public java.lang.String getNetArchitecture()

  get the network architecture as specified by the user

### reset

    public void reset()
               throws AbleException

  Description copied from class: `AbleObject`
  Reset this bean to its "initialized" state.

  This base method has no default implementation. It only provides tracing.

  Specified by:
    `reset` in interface `AbleBean`
  Overrides:
    `reset` in class `AbleObject`
  Throws:
    `AbleException` - If an error occurs.
  See Also:
    `AbleBean.reset()`

### readInputs

    public void readInputs()
                    throws AbleException

  move data from the train/test set into the network input units and the teach array

  Throws:
    `AbleException`

### process

    public void process()
                 throws AbleException

  Description copied from class: `AbleObject`
  Performs the main, synchronous, standard processing function performed by this bean.

  This base method implementation provides tracing only.

  Specified by:
    `process` in interface `AbleBean`
  Overrides:
    `process` in class `AbleObject`
  Throws:
    `AbleException`
  See Also:
    `AbleObject.inputBuffer`, `AbleObject.outputBuffer`, `AbleBean.process()`

### endEpoch

    public void endEpoch()

  Description copied from class: `AbleNetwork`
  Perform the end of epoch processing.

  Overrides:
    `endEpoch` in class `AbleNetwork`

### changeNetArchitecture

    public void changeNetArchitecture(java.lang.String parms)
                               throws AbleException

  Description copied from class: `AbleNetwork`
  Change the network architecture.

  Overrides:
    `changeNetArchitecture` in class `AbleNetwork`
  Parameters:
    `parms` - The new network architecture specification
  Throws:
    `AbleException`

### createNetwork

    public void createNetwork(int NumIn,
                              int NumHid1,
                              int NumHid2,
                              int NumHid3,
                              int NumOut,
                              int FeedbackType)
                       throws AbleException

  create a Back Propagation network with the specified architecture

  Throws:
    `AbleException`

### setNetArchitecture

    public void setNetArchitecture(java.lang.String arch)
                            throws AbleException

  Set the back propagation network architecture The architecture string is a sequence of space-delimited integers as follows: numInput numHid1 numHid2 numHid3 numOutput feedbackType Note if feedbackType is not specified, it will be set to 0

  Overrides:
    `setNetArchitecture` in class `AbleNetwork`
  Parameters:
    `arch` - A string that defines the network architecture
  Throws:
    `AbleException`

### getNetworkGraphicData

    public java.util.Vector getNetworkGraphicData()

  return data on the network architecture, activations, and weights for display by the AbleNetworkGraphicView custom inspector

  Overrides:
    `getNetworkGraphicData` in class `AbleNetwork`
  Returns:
    a Vector containing 3 elements, a) an int[] containing num units per layer b) a double[] array containing network activations, c) a Vector containing N weights arrays.

Overview | Package | Class | Use | Tree | Serialized | Deprecated | Index | Help
| ABLE 2.3.0 07/13/2005 14:21:00
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

(C) Copyright IBM Corporation 1999, 2005