org.robokind.api.common.position
Class DoubleRange

java.lang.Object
  extended by org.robokind.api.common.position.DoubleRange
All Implemented Interfaces:
NormalizableRange<Double>

public class DoubleRange
extends Object
implements NormalizableRange<Double>

Specifies a simple NormalizableRange of Numbers defined by a min and max. The min is specifies the number corresponding to 0.0 when normalized. The min is not always less than the max (using compareTo()). If the min is larger than the max, it results is reversing the direction of the range.

Author:
Matthew Stevenson

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.robokind.api.common.position.NormalizableRange
NormalizableRange.DefaultRange
 
Field Summary
 
Fields inherited from interface org.robokind.api.common.position.NormalizableRange
NORMALIZED_RANGE
 
Constructor Summary
DoubleRange(double min, double max)
           
 
Method Summary
 Double denormalizeValue(NormalizedDouble v)
          Denormalizes a NormalizedDouble to a value within this NormalizableRange.
 Double getMax()
          Returns the minimum value of the NormalizableRange.
 Double getMin()
           
 boolean isValid(Double val)
          Returns true if t is within the NormalizableRange.
 NormalizedDouble normalizeValue(Double val)
          Normalizes a value within the NormalizableRange.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DoubleRange

public DoubleRange(double min,
                   double max)
Method Detail

isValid

public boolean isValid(Double val)
Description copied from interface: NormalizableRange
Returns true if t is within the NormalizableRange.

Specified by:
isValid in interface NormalizableRange<Double>
Parameters:
val - value to check
Returns:
true if t is within the NormalizableRange

normalizeValue

public NormalizedDouble normalizeValue(Double val)
Description copied from interface: NormalizableRange
Normalizes a value within the NormalizableRange.

Specified by:
normalizeValue in interface NormalizableRange<Double>
Parameters:
val - value to normalize
Returns:
value within the NormalizableRange, null if t is out of range

denormalizeValue

public Double denormalizeValue(NormalizedDouble v)
Description copied from interface: NormalizableRange
Denormalizes a NormalizedDouble to a value within this NormalizableRange.

Specified by:
denormalizeValue in interface NormalizableRange<Double>
Parameters:
v - value to denormalize
Returns:
non-normalized value within the NormalizableRange

getMin

public Double getMin()
Specified by:
getMin in interface NormalizableRange<Double>

getMax

public Double getMax()
Description copied from interface: NormalizableRange
Returns the minimum value of the NormalizableRange.

Specified by:
getMax in interface NormalizableRange<Double>
Returns:
minimum value of the NormalizableRange


Copyright © 2011-2013. All Rights Reserved.