org.retro.neural
Class LinAlgFactory

java.lang.Object
  extended byorg.retro.neural.LinAlgFactory
Direct Known Subclasses:
DoubleFactory

public abstract class LinAlgFactory
extends java.lang.Object


Constructor Summary
LinAlgFactory()
           
 
Method Summary
 Matrix identity(int size)
          Returns the identity Matrix.
 Vector ones(int length)
          Returns a Vector of all ones.
 Matrix ones(int numberOfRows, int numberOfCols)
           
abstract  FieldElement randomValue(java.util.Random random)
          This method should return a random value.
 Vector uniformNoise(int length)
          Returns a Vector of uniformly distributed random values.
 Matrix uniformNoise(int numberOfRows, int numberOfCols)
          Returns a Matrix of uniformly distributed random values.
 Matrix uniformNoise(int numberOfRows, int numberOfCols, long seed)
          Returns a Matrix of uniformly distributed random values.
 Matrix uniformNoise(int numberOfRows, int numberOfCols, java.util.Random random)
          Returns a Matrix of uniformly distributed random values.
 Vector uniformNoise(int length, long seed)
          Returns a Vector of uniformly distributed random values.
 Vector uniformNoise(int length, java.util.Random random)
          Returns a Vector of uniformly distributed random values.
abstract  FieldElement unityValue()
          This method should return a FieldElement corresponding to unity (1), the neutral element of multiplication.
 Vector zeros(int length)
          Returns a Vector of all zeros.
 Matrix zeros(int numberOfRows, int numberOfCols)
          Returns a Matrix of all zeros.
abstract  FieldElement zeroValue()
          This method should return a FieldElement corresponding to zero (0), the neutral element of addition.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LinAlgFactory

public LinAlgFactory()
Method Detail

ones

public Matrix ones(int numberOfRows,
                   int numberOfCols)

zeros

public Matrix zeros(int numberOfRows,
                    int numberOfCols)
Returns a Matrix of all zeros.

Parameters:
numberOfRows -
numberOfCols -
Returns:
matrix of zeros

uniformNoise

public Matrix uniformNoise(int numberOfRows,
                           int numberOfCols,
                           java.util.Random random)
Returns a Matrix of uniformly distributed random values.

Parameters:
numberOfRows -
numberOfCols -
random - random-number generator
Returns:
matrix of uniformly distributed random values

uniformNoise

public Matrix uniformNoise(int numberOfRows,
                           int numberOfCols,
                           long seed)
Returns a Matrix of uniformly distributed random values.

Parameters:
numberOfRows -
numberOfCols -
seed - seed for random-number generator
Returns:
matrix of uniformly distributed random values

uniformNoise

public Matrix uniformNoise(int numberOfRows,
                           int numberOfCols)
Returns a Matrix of uniformly distributed random values.

Parameters:
numberOfRows -
numberOfCols -
Returns:
matrix of uniformly distributed random values

ones

public Vector ones(int length)
Returns a Vector of all ones.

Parameters:
length - vector length
Returns:
vector of ones

zeros

public Vector zeros(int length)
Returns a Vector of all zeros.

Parameters:
length - vector length
Returns:
vector of zeros

uniformNoise

public Vector uniformNoise(int length,
                           java.util.Random random)
Returns a Vector of uniformly distributed random values.

Parameters:
length - vector length
random - random-number generator
Returns:
vector of uniformly distributed random values

uniformNoise

public Vector uniformNoise(int length,
                           long seed)
Returns a Vector of uniformly distributed random values.

Parameters:
length - vector length
seed - seed for random-number generator
Returns:
vector of uniformly distributed random values

uniformNoise

public Vector uniformNoise(int length)
Returns a Vector of uniformly distributed random values.

Parameters:
length - vector length
Returns:
vector of uniformly distributed random values

identity

public Matrix identity(int size)
Returns the identity Matrix. This is a square matrix with ones on its diagonal and zeros elsewhere.

Parameters:
size - number of rows (= number of columns)
Returns:
identity matrix

unityValue

public abstract FieldElement unityValue()
This method should return a FieldElement corresponding to unity (1), the neutral element of multiplication.

Returns:
one

zeroValue

public abstract FieldElement zeroValue()
This method should return a FieldElement corresponding to zero (0), the neutral element of addition.

Returns:
zero

randomValue

public abstract FieldElement randomValue(java.util.Random random)
This method should return a random value.

Returns:
random value