All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class sim.funApp.Recurrent

java.lang.Object
   |
   +----sim.funApp.FunApp
           |
           +----sim.funApp.Recurrent

public class Recurrent
extends FunApp
IMPORTANT NOTE: This code assumes that the output signal is equal to or less than the length of the input signal.

This code is (c) 1998 Mance Harmon mharmon@acm.org, http://www-anw.cs.umass.edu/~=mharmon
The source and object code may be redistributed freely. If the code is modified, please state so in the comments.

Version:
0.5, 26 January 98
Author:
Mance Harmon, Leemon Baird

Constructor Index

 o Recurrent()

Method Index

 o BNF(int)
 o clone()
Make an exact duplicate of this class.
 o cloneVars(FunApp)
After making a copy of self during a clone(), call cloneVars() to copy variables into the copy, then return super.cloneVars(copy).
 o evaluate()
calculate the output for the given input
 o findGradients()
Calculate the output and gradient for a given input.
 o findHessian()
Calculate the output, gradient, and Hessian for a given input.
 o nWeights(int, int)
Return # elements (weights) in the network.
 o parse(Parser, int)
Parse the input file to get the parameters for this object.
 o setIO(Matrix, Matrix, Matrix, Matrix, Matrix, Matrix, Matrix, Matrix, Matrix)
Define the Matrix objects that will be used by evaluate() and findGradients().
 o unparse(Unparser, int)
Output a description of this object that can be parsed with parse().

Constructors

 o Recurrent
 public Recurrent()

Methods

 o parse
 public Object parse(Parser p,
                     int lang) throws ParserException
Parse the input file to get the parameters for this object.

Throws: ParserException
parser didn't find the required token
Overrides:
parse in class FunApp
 o setIO
 public void setIO(Matrix inVect,
                   Matrix outVect,
                   Matrix weights,
                   Matrix dEdIn,
                   Matrix dEdOut,
                   Matrix dEdWeights,
                   Matrix dEdIndIn,
                   Matrix dEdOutdOut,
                   Matrix dEdWeightsdWeights) throws MatrixException
Define the Matrix objects that will be used by evaluate() and findGradients(). All 6 should be column vectors (n by 1 matrices). All the Matrix objects are copied, but the pointers still point to the same data arrays.

Throws: MatrixException
if vector shapes don't match
Overrides:
setIO in class FunApp
 o evaluate
 public void evaluate()
calculate the output for the given input

Overrides:
evaluate in class FunApp
 o findGradients
 public void findGradients()
Calculate the output and gradient for a given input. This does everything evaluate() does, plus it calculates the gradient of the error with respect to the inputs and weights, dEdx and dEdw, User must set dEdOut before calling.

Overrides:
findGradients in class FunApp
 o findHessian
 public void findHessian()
Calculate the output, gradient, and Hessian for a given input. This does everything evaluate() and findGradients() do, plus it calculates the Hessian of the error with resepect to the the weights and inputs, dEdxdx, dEdwdx, and dEdwdw.

Overrides:
findHessian in class FunApp
 o nWeights
 public int nWeights(int nIn,
                     int nOut)
Return # elements (weights) in the network. This assumes the output vector is small than or equal to the input vector in length

Overrides:
nWeights in class FunApp
 o clone
 public Object clone()
Make an exact duplicate of this class. For objects it contains, it only duplicates the pointers, not the objects they point to. For a new FunApp called MyFunApp, the code in this method should be the single line: return cloneVars(new MyFunApp());

Overrides:
clone in class FunApp
 o cloneVars
 public Object cloneVars(FunApp copy)
After making a copy of self during a clone(), call cloneVars() to copy variables into the copy, then return super.cloneVars(copy). The variables copied are just those set in parse() and setWatchManager(). The caller will be required to call setIO to set up the rest of the variables.

Overrides:
cloneVars in class FunApp
 o BNF
 public String BNF(int lang)
Overrides:
BNF in class FunApp
 o unparse
 public void unparse(Unparser u,
                     int lang)
Output a description of this object that can be parsed with parse().

Overrides:
unparse in class FunApp
See Also:
Parsable

All Packages  Class Hierarchy  This Package  Previous  Next  Index