org.vizzini.math
Interface IScaler

All Known Implementing Classes:
AbstractScaler, LinearScaler

public interface IScaler

Defines methods required by classes which scale numbers between two ranges.

Since:
v0.1
Version:
v0.3
Author:
Jeffrey M. Thompson

Method Summary
 double getMaxInput()
          Set the maximum expected input value.
 double getMaxOutput()
          Set the maximum expected output value.
 double getMinInput()
          Set the minimum expected input value.
 double getMinOutput()
          Set the minimum expected output value.
 double scale(double input)
          Scale the given input.
 double[] scale(double[] inputs)
          Scale the given inputs.
 double[] scale(double[] inputs, double[] outputs)
          Scale the given inputs.
 void setMaxInput(double max)
          Set the maximum expected input value.
 void setMaxOutput(double max)
          Set the maximum expected output value.
 void setMinInput(double min)
          Set the minimum expected input value.
 void setMinOutput(double min)
          Set the minimum expected output value.
 String toString()
          Return a string representation of this object.
 double unscale(double output)
          Unscale the given output.
 double[] unscale(double[] outputs)
          Unscale the given outputs.
 

Method Detail

getMaxInput

double getMaxInput()
Set the maximum expected input value.

Since:
v0.1

getMaxOutput

double getMaxOutput()
Set the maximum expected output value.

Since:
v0.1

getMinInput

double getMinInput()
Set the minimum expected input value.

Since:
v0.1

getMinOutput

double getMinOutput()
Set the minimum expected output value.

Since:
v0.1

scale

double scale(double input)
Scale the given input.

Since:
v0.1

scale

double[] scale(double[] inputs)
Scale the given inputs.

Since:
v0.1

scale

double[] scale(double[] inputs,
               double[] outputs)
Scale the given inputs.

Since:
v0.1

setMaxInput

void setMaxInput(double max)
Set the maximum expected input value.

Since:
v0.1

setMaxOutput

void setMaxOutput(double max)
Set the maximum expected output value.

Since:
v0.1

setMinInput

void setMinInput(double min)
Set the minimum expected input value.

Since:
v0.1

setMinOutput

void setMinOutput(double min)
Set the minimum expected output value.

Since:
v0.1

toString

String toString()
Return a string representation of this object.

Overrides:
toString in class Object
Since:
v0.1

unscale

double unscale(double output)
Unscale the given output.

Since:
v0.1

unscale

double[] unscale(double[] outputs)
Unscale the given outputs.

Since:
v0.1


Copyright 2007 Vizzini.org. All Rights Reserved. 2007.12.25.03.00.02