com.ibm.able.beans
Class AbleRadialBasisFunctionNet

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

All Implemented Interfaces:

AbleBean, AbleDataBufferManager, AbleEventListener, AbleEventListenerManager, AbleEventQueueManager, AbleEventQueueProcessor, AblePropertyChangeManager, AbleSerializable, AbleTranslateTemplateProvider, java.io.Serializable

public class AbleRadialBasisFunctionNet

extends AbleNetwork

implements AbleTranslateTemplateProvider, java.io.Serializable

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

AbleRadialBasisFunctionNet()
default constructor

AbleRadialBasisFunctionNet(java.lang.String aName)
default constrcutor with a name

AbleRadialBasisFunctionNet(java.lang.String aName, java.lang.String args)
construct an rbf network with specified name and architecture

Method Summary

void	changeNetArchitecture(java.lang.String parms) Change the network architecture.
void	createNetwork(int NumIn, int NumHid, int NumOut) create a Radial Basis Function network with the specified architecture
void	endEpoch() Perform the end of epoch processing.
java.lang.Object[]	generateFilters(AbleDataSource theDataSource) Return a filter for converting data to a bean's input specifications, and a filter for converting a bean's output specifications back to the original coordinates.
void	generateTranslateTemplates(AbleFilter filt, AbleFilter outFilt, java.util.Vector fields) Populate a filter for converting data to a bean's input specifications, and a filter for converting a bean's output specifications back to the original coordinates.
double[]	getActivations()
double	getAllWidths()
boolean	getAutoCenter()
double	getAveRMSError() return the average RMS error
double	getAvgRMSError()
double	getBadPatRatio()
int	getBasisFunction()
double[]	getCenters()
int	getCenterWeightPasses()
double	getDecayFactor()
double[]	getError()
int	getFeedbackType()
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	getNumCenters()
int	getNumHidden()
int	getNumInputs()
int	getNumOutputs()
int	getNumUnits()
int	getNumWeights()
double	getPercentCorrect()
double	getPercentIncorrect()
double	getPercentUnknown()
double[]	getTeach()
double[]	getThreshold()
double	getTolerance() return the error tolerance parameter
boolean	getTrainingKMapNet()
double[]	getWeights()
double[]	getWgtDeriv()
int	getWinner()
double	getWinnerAct()
boolean	isAdaptLearnRate()
boolean	isEpochUpdate()
boolean	isExplicitErrorMode()
boolean	isNormalized()
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	setAllWidths(double wid)
void	setAutoCenter(boolean state)
void	setBasisFunction(int fun)
void	setCenterWeightPasses(int passes)
void	setDecayFactor(double factor)
void	setEpochUpdate(boolean state)
void	setExplicitErrorMode(boolean state)
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	setNormalized(boolean state)
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

AbleRadialBasisFunctionNet

public AbleRadialBasisFunctionNet()
                           throws AbleException

default constructor

AbleRadialBasisFunctionNet

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

default constrcutor with a name

AbleRadialBasisFunctionNet

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

construct an rbf network with specified name and architecture

Method Detail

getNumInputs

public int getNumInputs()

getNumHidden

public int getNumHidden()

getNumOutputs

public int getNumOutputs()

getNumUnits

public int getNumUnits()

getNumWeights

public int getNumWeights()

getNumCenters

public int getNumCenters()

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()

getCenterWeightPasses

public int getCenterWeightPasses()

setCenterWeightPasses

public void setCenterWeightPasses(int passes)

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()

getWeights

public double[] getWeights()

getCenters

public double[] getCenters()

getWgtDeriv

public double[] getWgtDeriv()

getThreshold

public double[] getThreshold()

getTeach

public double[] getTeach()

getError

public double[] getError()

setBasisFunction

public void setBasisFunction(int fun)

getBasisFunction

public int getBasisFunction()

getAllWidths

public double getAllWidths()

setAllWidths

public void setAllWidths(double wid)

setNormalized

public void setNormalized(boolean state)

isNormalized

public boolean isNormalized()

setAutoCenter

public void setAutoCenter(boolean state)

getAutoCenter

public boolean getAutoCenter()

getWinner

public int getWinner()

getWinnerAct

public double getWinnerAct()

getTrainingKMapNet

public boolean getTrainingKMapNet()

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()

generateTranslateTemplates

public void generateTranslateTemplates(AbleFilter filt,
                                       AbleFilter outFilt,
                                       java.util.Vector fields)
                                throws AbleException

Description copied from interface: AbleTranslateTemplateProvider

Populate a filter for converting data to a bean's input specifications, and a filter for converting a bean's output specifications back to the original coordinates. Translate templates are added to each filter for each field as appropriate for its field usage and datatype. A bean who wishes to provide only default templates can use the static link provided in AbleFilter.generateTranslateTemplates(com.ibm.able.beans.filter.AbleFilter, com.ibm.able.beans.filter.AbleFilter, java.util.Vector)

Specified by:

generateTranslateTemplates in interface AbleTranslateTemplateProvider

Parameters:

filt - The AbleFilter used to convert incoming data.

outFilt - The AbleFilter used to convert outgoing data.

fields - A vector of AbleFields from which to derive the translation template.

Returns:

An array containing two AbleFilter objectshe translation template.

Throws:

AbleException

generateFilters

public java.lang.Object[] generateFilters(AbleDataSource theDataSource)
                                   throws AbleException

Return a filter for converting data to a bean's input specifications, and a filter for converting a bean's output specifications back to the original coordinates.

Parameters:

theDataSource - The data source from which to get the fields to derive the translation template.

Returns:

An array containing two AbleFilter objectshe translation template.

Throws:

AbleException

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 NumHid,
                          int NumOut)
                   throws AbleException

create a Radial Basis Function 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.