com.graphhopper.routing.ev

Class UnsignedDecimalEncodedValue

java.lang.Object

com.graphhopper.routing.ev.UnsignedIntEncodedValue

com.graphhopper.routing.ev.UnsignedDecimalEncodedValue

All Implemented Interfaces:

DecimalEncodedValue, EncodedValue, IntEncodedValue

public final class UnsignedDecimalEncodedValue
extends UnsignedIntEncodedValue
implements DecimalEncodedValue

This class holds a decimal value and stores it as an unsigned integer value via a conversion factor and a maximum number of bits.

Nested Class Summary

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

EncodedValue.InitializerConfig

Field Summary

Fields

Modifier and Type	Field and Description
protected double	factor

Fields inherited from class com.graphhopper.routing.ev.UnsignedIntEncodedValue

bwdDataIndex, fwdDataIndex

Constructor Summary

Constructors

Constructor and Description
UnsignedDecimalEncodedValue(String name, int bits, double factor, boolean storeTwoDirections)
UnsignedDecimalEncodedValue(String name, int bits, double factor, double defaultValue, boolean storeTwoDirections)
UnsignedDecimalEncodedValue(String name, int bits, double factor, double defaultValue, 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 double value this EncodedValue accepts for setDecimal without throwing an exception.
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 ints, 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.UnsignedIntEncodedValue

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.DecimalEncodedValue

isStoreTwoDirections

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

getName, init

Field Detail

factor

protected final double factor

Constructor Detail

UnsignedDecimalEncodedValue

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

UnsignedDecimalEncodedValue

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

Parameters:

name - the key to identify this EncodedValue

bits - the bits that should be reserved for the storage

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

defaultValue - the value that should be returned if the stored value is 0.

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

UnsignedDecimalEncodedValue

public UnsignedDecimalEncodedValue(String name,
                                   int bits,
                                   double factor,
                                   double defaultValue,
                                   boolean storeTwoDirections,
                                   boolean useMaximumAsInfinity)

Method Detail

setDecimal

public final void setDecimal(boolean reverse,
                             IntsRef ints,
                             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 final double getDecimal(boolean reverse,
                               IntsRef ref)

Specified by:

getDecimal in interface DecimalEncodedValue

getMaxDecimal

public double getMaxDecimal()

Description copied from interface: DecimalEncodedValue

The 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 UnsignedIntEncodedValue

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 UnsignedIntEncodedValue