NAME

Geo::Hex1 - Convert between latitude/longitude and GeoHex code version 1

SYNOPSIS

    use Geo::Hex1;

    # From latitude/longitude to hex code

    my $code = latlng2geohex( $lat, $lng, $level );

    # From hex code to center latitude/longitude

    my ( $center_lat, $center_lng, $level ) = geohex2latlng( $code );

    # From hex code to hex polygon

    my $poly = geohex2polygon( $code );

    my ( $wlat,  $wlng  ) = @{$poly->[0]}; # West point
    my ( $nwlat, $nwlng ) = @{$poly->[1]}; # North west point
    my ( $nelat, $nelng ) = @{$poly->[2]}; # North east point
    my ( $elat,  $elng  ) = @{$poly->[3]}; # East point
    my ( $selat, $selng ) = @{$poly->[4]}; # South east point
    my ( $swlat, $swlng ) = @{$poly->[5]}; # South west point
    my ( $wlat,  $wlng  ) = @{$poly->[6]}; # West point again ( Same with 0 )

    # Get hex distance between two hex codes

    my $dist = geohex2distance('wknR','wkmO'); # 3

    # Get all hex codes list include in given hex distance

    my $list = distance2geohexes('8sijg',2); 
    foreach my $code (@{$list}) { print $code . "\n" }
    # 8sijh
    # 8siig
    # 8siif
    # 8sijf
    # 8sikg
    # 8sikh
    # 8sili
    # 8siki
    # 8siji
    # 8siih
    # 8sihg
    # 8sihf
    # 8sihe
    # 8siie
    # 8sije
    # 8sikf
    # 8silg
    # 8silh

EXPORT

latlng2geohex( $lat, $lng ): Convert latitude/longitude to GeoHex version 1 code.
geohex2latlng( $hex ): Convert GeoHex version 1 code to center latitude/longitude, and level value.
geohex2polygon( $hex ): Convert GeoHex version 1 code to polygon points.
geohex2distance( $hex1, $hex2 ): Get hex distance between two GeoHex version 1 codes.
distance2geohexes( $hex, $distance ): Get GeoHex version 1 codes list within given hex distance.

DEPENDENCIES

Exporter POSIX Math::Round Math::Trig

AUTHOR

OHTSUKA Ko-hei <nene@kokogiko.net>

LICENCE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.