com.graphhopper.routing.ev

Class DecimalEncodedValueImpl

java.lang.Object

com.graphhopper.routing.ev.IntEncodedValueImpl

com.graphhopper.routing.ev.DecimalEncodedValueImpl

All Implemented Interfaces:

DecimalEncodedValue, EncodedValue, IntEncodedValue

public final class DecimalEncodedValueImpl
extends IntEncodedValueImpl
implements DecimalEncodedValue

This class holds a signed decimal value and stores it as an integer value via a conversion factor and a certain number of bits that determine the maximum value.

Nested Class Summary

Nested classes/interfaces inherited from interface com.graphhopper.routing.ev.EncodedValue

EncodedValue.InitializerConfig

Constructor Summary

Constructors

Constructor and Description
DecimalEncodedValueImpl(String name, int bits, double factor, boolean storeTwoDirections)
DecimalEncodedValueImpl(String name, int bits, double factor, boolean defaultIsInfinity, boolean storeTwoDirections)
DecimalEncodedValueImpl(String name, int bits, double minValue, double factor, boolean defaultIsInfinity, boolean negateReverseDirection, boolean storeTwoDirections, boolean useMaximumAsInfinity)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
double	getDecimal(boolean reverse, IntsRef ref)
double	getMaxDecimal() The maximum double value this EncodedValue accepts for setDecimal without throwing an exception.
double	getNextStorableValue(double value)
int	getVersion() The return value represents the state of this EncodedValue and it can be assumed that two JVMs return the same version when the EncodedValue has the same state unlike the hashCode method.
void	setDecimal(boolean reverse, IntsRef ref, double value) This method stores the specified double value (rounding with a previously defined factor) into the IntsRef.

Methods inherited from class com.graphhopper.routing.ev.IntEncodedValueImpl

getInt, getMaxInt, getName, hashCode, init, isStoreTwoDirections, setInt, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.graphhopper.routing.ev.EncodedValue

getName, init, isStoreTwoDirections

Constructor Detail

DecimalEncodedValueImpl

public DecimalEncodedValueImpl(String name,
                               int bits,
                               double factor,
                               boolean storeTwoDirections)

See Also:

DecimalEncodedValueImpl(String, int, double, double, boolean, boolean, boolean, boolean)

DecimalEncodedValueImpl

public DecimalEncodedValueImpl(String name,
                               int bits,
                               double factor,
                               boolean defaultIsInfinity,
                               boolean storeTwoDirections)

See Also:

DecimalEncodedValueImpl(String, int, double, double, boolean, boolean, boolean, boolean)

DecimalEncodedValueImpl

public DecimalEncodedValueImpl(String name,
                               int bits,
                               double minValue,
                               double factor,
                               boolean defaultIsInfinity,
                               boolean negateReverseDirection,
                               boolean storeTwoDirections,
                               boolean useMaximumAsInfinity)

Parameters:

name - the key to identify this EncodedValue

bits - the bits that should be reserved for storing the integer value. This determines the maximum value.

minValue - the minimum value. Use e.g. 0 if no negative values are needed.

factor - the precision factor, i.e. store = (int) Math.round(value / factor)

defaultIsInfinity - true if default should be Double.Infinity. False if 0 should be default.

negateReverseDirection - true if the reverse direction should be always negative of the forward direction. This is used to reduce space and store the value only once.

storeTwoDirections - true if forward and backward direction of the edge should get two independent values.

useMaximumAsInfinity - true if the maximum value should be treated as Double.Infinity

Method Detail

setDecimal

public void setDecimal(boolean reverse,
                       IntsRef ref,
                       double value)

Description copied from interface: DecimalEncodedValue

This method stores the specified double value (rounding with a previously defined factor) into the IntsRef.

Specified by:

setDecimal in interface DecimalEncodedValue

See Also:

DecimalEncodedValue.getMaxDecimal()

getDecimal

public double getDecimal(boolean reverse,
                         IntsRef ref)

Specified by:

getDecimal in interface DecimalEncodedValue

getNextStorableValue

public double getNextStorableValue(double value)

Specified by:

getNextStorableValue in interface DecimalEncodedValue

Returns:

the smallest decimal value that is larger or equal to the given value and that can be stored exactly, i.e. for which DecimalEncodedValue.getDecimal(boolean, com.graphhopper.storage.IntsRef) returns the same value that we put in using DecimalEncodedValue.setDecimal(boolean, com.graphhopper.storage.IntsRef, double). For example if the internal scaling factor is 3 calling getDecimal after setDecimal(reverse, ref, 5) will return 6 not 5! The value returned by this method is guaranteed to be storable without such a modification.

getMaxDecimal

public double getMaxDecimal()

Description copied from interface: DecimalEncodedValue

The maximum double value this EncodedValue accepts for setDecimal without throwing an exception.

Specified by:

getMaxDecimal in interface DecimalEncodedValue

equals

public boolean equals(Object o)

Overrides:

equals in class IntEncodedValueImpl

getVersion

public int getVersion()

Description copied from interface: EncodedValue

The return value represents the state of this EncodedValue and it can be assumed that two JVMs return the same version when the EncodedValue has the same state unlike the hashCode method. Same version ensures compatibility when reading values.

Specified by:

getVersion in interface EncodedValue

Overrides:

getVersion in class IntEncodedValueImpl