com.highqsoft.p2d

Class P2DRange1D

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.p2d.P2DRange1D

All Implemented Interfaces:

FwkInterface, P2DRange1DInterface, java.io.Serializable

public class P2DRange1D
extends Fwk
implements P2DRange1DInterface

The Range1D object represents a one dimensional range value.

Since:

$Date: 2017/04/06 13:30:09 $

Version:

$Revision: 1.17 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double	lower The lower limit of the range.
double	minPositiveValue The minimum of the positive values.
double	upper The upper limit of the range.
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
P2DRange1D() The default constructor.
P2DRange1D(double lower, double upper) The constructor receives the predifined limits.
P2DRange1D(double lower, double upper, double minPositiveValue) The constructor receives the predifined limits.
P2DRange1D(P2DRange1DInterface range) The constructor receiving another range.
P2DRange1D(P2DRange1DInterface range, double minPositiveValue) The constructor receiving another range.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(double value) This method checks whether the range contains the given point.
boolean	equals(P2DRange1DInterface r) Compare this range with the given.
double	getDistance() Returns the distance of the range.
double	getLower() Retrieves the lower limit of the range.
double	getMinPositiveValue() Get the lowest value that is greater than 0.
double[]	getNiceNumbers(double base, boolean isLog, int ticks_requested) Get the nicenumber vector of Double's from axis.
double[]	getNiceNumbers(double min, double max, double base, boolean isLog, int ticks_requested) Get the nicenumber vector of Double's from axis.
static double[]	getNiceNumbersImpl(double min, double max, double base, boolean isLog, double minPositive, int ticks_requested) The implementation of the nicenumber algorithmn.
java.lang.String	getParams() Get the parameter string.
double	getUpper() Retrieves the upper limit of the range.
java.lang.String	getVersion() Return the version string of the FWK component.
static void	main(java.lang.String[] args)
void	move(double distance) Move the range.
void	setDefaults() Set all the internal properties to the default.
void	setDistance(double distance) Sets the length of the range.
void	setLower(double lower) Sets the lower limit of the range.
void	setMinPositiveValue(double minPositiveValue) Set the lowest value that is greater than 0.
void	setRange(double lower, double upper) Set the range.
void	setUpper(double upper) Sets the upper limit of the range.
java.lang.String	toString() Get the string representation of the object.

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

lower

public double lower

The lower limit of the range.

minPositiveValue

public double minPositiveValue

The minimum of the positive values.

upper

public double upper

The upper limit of the range.

Constructor Detail

P2DRange1D

public P2DRange1D()

The default constructor.

P2DRange1D

public P2DRange1D(P2DRange1DInterface range)

The constructor receiving another range.

Parameters:

range - The source range.

P2DRange1D

public P2DRange1D(P2DRange1DInterface range,
          double minPositiveValue)

The constructor receiving another range.

Parameters:

range - The source range.

minPositiveValue - the minimum positive value.

P2DRange1D

public P2DRange1D(double lower,
          double upper)

The constructor receives the predifined limits.

Parameters:

lower - the lower value.

upper - the upper value.

P2DRange1D

public P2DRange1D(double lower,
          double upper,
          double minPositiveValue)

The constructor receives the predifined limits.

Parameters:

lower - the lower value.

upper - the upper value.

minPositiveValue - the minimum positive value.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class Fwk

contains

public boolean contains(double value)

This method checks whether the range contains the given point.

Specified by:

contains in interface P2DRange1DInterface

Parameters:

value - The value to be checked.

Returns:

true if the given point is included by this range.

getLower

public double getLower()

Retrieves the lower limit of the range.

Specified by:

getLower in interface P2DRange1DInterface

Returns:

The lower limit of the range.

See Also:

getUpper(), getDistance()

setLower

public void setLower(double lower)

Sets the lower limit of the range. If the new lower limit is greater than the current upper limit the two values will be swapped.

Specified by:

setLower in interface P2DRange1DInterface

Parameters:

lower - The new lower limit of the range.

See Also:

setUpper(double), setDistance(double)

getMinPositiveValue

public double getMinPositiveValue()

Get the lowest value that is greater than 0. This method is needed for logarithmn use.

Specified by:

getMinPositiveValue in interface P2DRange1DInterface

Returns:

the lowest value that is greater than 0. If no value is greater than 0 the method returns Double.NaN.

setMinPositiveValue

public void setMinPositiveValue(double minPositiveValue)

Set the lowest value that is greater than 0. This method is needed for logarithmn use.

Specified by:

setMinPositiveValue in interface P2DRange1DInterface

Parameters:

minPositiveValue - the lowest value that is greater than 0. If no value is greater than 0 the method returns Double.NaN.

getUpper

public double getUpper()

Retrieves the upper limit of the range.

Specified by:

getUpper in interface P2DRange1DInterface

Returns:

The upper limit of the range.

See Also:

getLower(), getDistance()

setUpper

public void setUpper(double upper)

Sets the upper limit of the range. If the new upper limit is lower than the current lower limit the two values will be swapped.

Specified by:

setUpper in interface P2DRange1DInterface

Parameters:

lower - The new lower limit of the range.

See Also:

setUpper(double), setDistance(double)

setRange

public void setRange(double lower,
            double upper)

Set the range.

Specified by:

setRange in interface P2DRange1DInterface

Parameters:

lower - The new lower limit of the range.

upper - The new upper limit of the range.

getDistance

public double getDistance()

Returns the distance of the range. The retrieved value is always greater the null.

Specified by:

getDistance in interface P2DRange1DInterface

Returns:

The upper limit of the range.

See Also:

getLower(), getUpper()

setDistance

public void setDistance(double distance)

Sets the length of the range. This routine sets the upper limit to the sum of the incoming parameter and the lower limit. A negative distance is allowed, it will swap the the lmits.

Specified by:

setDistance in interface P2DRange1DInterface

Parameters:

lower - The new lower limit of the range.

See Also:

setLower(double), setUpper(double)

move

public void move(double distance)

Move the range.

Specified by:

move in interface P2DRange1DInterface

Parameters:

distance - The value of the distance.

equals

public boolean equals(P2DRange1DInterface r)

Compare this range with the given.

Specified by:

equals in interface P2DRange1DInterface

Parameters:

r - The range that should be compared to this.

Returns:

true if the given range is equal to this one.

getParams

public java.lang.String getParams()

Get the parameter string.

Specified by:

getParams in interface P2DRange1DInterface

toString

public java.lang.String toString()

Get the string representation of the object.

Overrides:

toString in class java.lang.Object

setDefaults

public void setDefaults()

Set all the internal properties to the default.

Specified by:

setDefaults in interface P2DRange1DInterface

getNiceNumbers

public double[] getNiceNumbers(double base,
                      boolean isLog,
                      int ticks_requested)

Get the nicenumber vector of Double's from axis.

Specified by:

getNiceNumbers in interface P2DRange1DInterface

Parameters:

base - The log base. If <= 1 then 10.

isLog - A boolean indicates that the scale should be logarithmic.

ticks_requested - The total number of requested tick values. If this parameter is 0 the routine will optimized the value.

getNiceNumbers

public double[] getNiceNumbers(double min,
                      double max,
                      double base,
                      boolean isLog,
                      int ticks_requested)

Get the nicenumber vector of Double's from axis.

Parameters:

min - The minimum value of the range.

max - The maximum of the range.

base - The log base. If <= 1 then 10.

isLog - A boolean indicates that the scale should be logarithmic.

ticks_requested - The total number of requested tick values. If this parameter is 0 the routine will optimized the value.

getNiceNumbersImpl

public static double[] getNiceNumbersImpl(double min,
                          double max,
                          double base,
                          boolean isLog,
                          double minPositive,
                          int ticks_requested)

The implementation of the nicenumber algorithmn.

Parameters:

min - The minimum value of the range.

max - The maximum of the range.

base - The log base. If <= 1 then 10.

isLog - A boolean indicates that the scale should be logarithmic.

minPositive - the minimum positive value.

ticks_requested - The total number of requested tick values. If this parameter is 0 the routine will optimized the value.

main

public static void main(java.lang.String[] args)