org.encog.normalize.output
Class OutputFieldRangeMapped

java.lang.Object
  org.encog.normalize.output.BasicOutputField
      org.encog.normalize.output.OutputFieldRangeMapped

All Implemented Interfaces:

OutputField

public class OutputFieldRangeMapped
extends BasicOutputField

A ranged mapped output field. This will scale the input so that it is between the high and low value.

Constructor Summary

OutputFieldRangeMapped()
Default constructor, used mainly for reflection.

OutputFieldRangeMapped(InputField field, double low, double high)
Construct a range mapped output field.

Method Summary

double	calculate(int subfield) Calculate this output field.
InputField	getField()
double	getHigh()
double	getLow()
int	getSubfieldCount()
void	rowInit() Not needed for this sort of output field.

Methods inherited from class org.encog.normalize.output.BasicOutputField

isIdeal, setIdeal

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputFieldRangeMapped

public OutputFieldRangeMapped()

Default constructor, used mainly for reflection.

OutputFieldRangeMapped

public OutputFieldRangeMapped(InputField field,
                              double low,
                              double high)

Construct a range mapped output field.

Parameters:

field - The input field to base this on.

low - The low value.

high - The high value.

Method Detail

calculate

public double calculate(int subfield)

Calculate this output field.

Parameters:

subfield - Not used.

Returns:

The calculated value.

getField

public InputField getField()

Returns:

The field that this output is based on.

getHigh

public double getHigh()

Returns:

The high value of the range to map into.

getLow

public double getLow()

Returns:

The low value of the range to map into.

getSubfieldCount

public int getSubfieldCount()

Returns:

This field only produces one value, so this will return 1.

rowInit

public void rowInit()

Not needed for this sort of output field.