org.openimaj.ml.linear.learner.perceptron

Class SimplePerceptron

java.lang.Object

org.openimaj.ml.linear.learner.perceptron.SimplePerceptron

All Implemented Interfaces:

Cloneable, EstimatableModel<double[],Integer>, Model<double[],Integer>, OnlineLearner<double[],Integer>

public class SimplePerceptron
extends Object
implements OnlineLearner<double[],Integer>, EstimatableModel<double[],Integer>

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
SimplePerceptron()

Method Summary

Modifier and Type	Method and Description
protected double	calculateError(List<? extends IndependentPair<double[],Integer>> pts)
SimplePerceptron	clone() Clone the model
double[]	computeHyperplanePoint(double[] x) Compute NaN-coordinate of a point on the hyperplane given non-NaN-coordinates.
boolean	estimate(List<? extends IndependentPair<double[],Integer>> data) Estimates the model from the observations in the list of data.
double[]	getWeights()
int	numItemsToEstimate()
Integer	predict(double[] x) Uses the model to predict dependent data from an independent value.
void	process(double[] pt, Integer clazz)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimplePerceptron

public SimplePerceptron()

Method Detail

process

public void process(double[] pt,
                    Integer clazz)

Specified by:

process in interface OnlineLearner<double[],Integer>

predict

public Integer predict(double[] x)

Description copied from interface: Model

Uses the model to predict dependent data from an independent value.

Specified by:

predict in interface Model<double[],Integer>

Specified by:

predict in interface OnlineLearner<double[],Integer>

Parameters:

x - the data (independent variable)

Returns:

Dependent variable(s) predicted from the independent ones.

estimate

public boolean estimate(List<? extends IndependentPair<double[],Integer>> data)

Description copied from interface: EstimatableModel

Estimates the model from the observations in the list of data. The data must contain at least EstimatableModel.numItemsToEstimate() pairs of dependent and independent data. It may contain more, in which case the estimate method may choose to make use of this data for validation, or obtaining a better model by a least squares method for example.

Specified by:

estimate in interface EstimatableModel<double[],Integer>

Parameters:

data - Data with which to estimate the model

Returns:

true if a successful estimate was made, false otherwise

See Also:

EstimatableModel.numItemsToEstimate()

numItemsToEstimate

public int numItemsToEstimate()

Specified by:

numItemsToEstimate in interface EstimatableModel<double[],Integer>

Returns:

The minimum number of observations required to estimate the model.

calculateError

protected double calculateError(List<? extends IndependentPair<double[],Integer>> pts)

computeHyperplanePoint

public double[] computeHyperplanePoint(double[] x)

Compute NaN-coordinate of a point on the hyperplane given non-NaN-coordinates. Only one x coordinate may be nan. If more NaN are seen after the first they are assumed to be 0

Parameters:

x - the coordinates, only one may be NaN, all others must be provided

Returns:

the y-ordinate

clone

public SimplePerceptron clone()

Description copied from interface: EstimatableModel

Clone the model

Specified by:

clone in interface EstimatableModel<double[],Integer>

Overrides:

clone in class Object

Returns:

a cloned copy

getWeights

public double[] getWeights()