.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Tree::R 3pm"
.TH Tree::R 3pm "2022-10-13" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Tree::R \- Perl extension for the R\-tree data structure and algorithms
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Tree::R;
\&
\&  my $rtree = Tree::R\->new
\&
\&  for my $object (@objects) {
\&      my @bbox = $object\->bbox(); # (minx,miny,maxx,maxy)
\&      $rtree\->insert($object,@bbox);
\&  }
\&
\&  my @point = (123, 456); # (x,y)
\&  my @results;
\&  $rtree\->query_point(@point,\e@results);
\&  for my $object (@results) {
\&      # point is in object\*(Aqs bounding box
\&  }
\&
\&  my @rect = (123, 456, 789, 1234); # (minx,miny,maxx,maxy)
\&  @results = ();
\&  $rtree\->query_completely_within_rect(@rect,\e@results);
\&  for my $object (@results) {
\&      # object is within rectangle
\&  }
\&
\&  @results = ();
\&  $rtree\->query_partly_within_rect(@rect,\e@results);
\&  for my $object (@results) {
\&      # object\*(Aqs bounding box and rectangle overlap
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
R\-tree is a data structure for storing and indexing and efficiently
looking up non-zero-size spatial objects.
.SS "\s-1EXPORT\s0"
.IX Subsection "EXPORT"
None by default.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
A. Guttman: R\-trees: a dynamic index structure for spatial
indexing. \s-1ACM SIGMOD\s0'84, Proc. of Annual Meeting (1984), 47\-\-57.
.PP
N. Beckmann, H.\-P. Kriegel, R. Schneider & B. Seeger: The R*\-tree: an
efficient and robust access method for points and rectangles. Proc. of
the 1990 \s-1ACM SIGMOD\s0 Internat. Conf. on Management of Data (1990),
322\-\-331.
.PP
The homepage of this module is on github:
https://github.com/ajolma/Tree\-R
.SH "AUTHOR"
.IX Header "AUTHOR"
Ari Jolma
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005\- by Ari Jolma
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of The Artistic License 2.0.
.SH "REPOSITORY"
.IX Header "REPOSITORY"
<https://github.com/ajolma/Tree\-R>