com.github.davidmoten.geo

Class Coverage

java.lang.Object

com.github.davidmoten.geo.Coverage

public class Coverage
extends Object

A set of hashes and a measure of how well those hashes cover a region. Immutable.

Author:

dave

Constructor Summary

Constructors

Constructor and Description
Coverage(Set<String> hashes, double ratio) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getHashes() Returns the hashes which are expected to be all of the same length.
int	getHashLength() Returns the length in characters of the first hash returned by an iterator on the hash set.
double	getRatio() Returns the measure of how well the hashes cover a region.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Coverage

public Coverage(Set<String> hashes,
        double ratio)

Constructor.

Parameters:

hashes - set of hashes comprising the coverage

ratio - ratio of area of hashes to the area of target region

Method Detail

getHashes

public Set<String> getHashes()

Returns the hashes which are expected to be all of the same length.

Returns:

set of hashes

getRatio

public double getRatio()

Returns the measure of how well the hashes cover a region. The ratio is the total area of hashes divided by the area of the bounding box in degrees squared. The closer the ratio is to 1 the better the more closely the hashes approximate the bounding box.

Returns:

ratio of area of hashes to area of target region.

getHashLength

public int getHashLength()

Returns the length in characters of the first hash returned by an iterator on the hash set. All hashes should be of the same length in this coverage.

Returns:

length of the hash

toString

public String toString()

Overrides:

toString in class Object