Documentation Source Text

Check-in [fe9ab1ba5b]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Fix a typo in the rtree documentation.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256:fe9ab1ba5bb4bd6c1d955aca7355386a9f0c1f67bf409ee04bd32acee4d76c0c
User & Date: drh 2018-05-25 22:50:12
Context
2018-05-26
01:59
Show the apSqlParam field that was added to the sqlite3_rtree_query_info object in version 3.8.11. check-in: b5582fa868 user: drh tags: trunk
2018-05-25
22:50
Fix a typo in the rtree documentation. check-in: fe9ab1ba5b user: drh tags: trunk
18:17
Improved wording on the OsQuery description. check-in: 1a2d15781d user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to pages/rtree.in.

533
534
535
536
537
538
539
540
541
542
543
544
545
546
547

<p>The first five fields of the sqlite3_rtree_query_info structure are identical
to the sqlite3_rtree_geometry structure, and have exactly the same meaning.
The sqlite3_rtree_query_info structure also contains nCoord and aCoord fields 
which have the same meaning as the parameter of the same name in the xGeom callback.

<p>The xQueryFunc must set the eWithin field of sqlite3_rtree_query_info to
on of the values NOT_WITHIN, PARTLY_WITHIN, or FULLY_WITHIN depending on whether
or not the bounding box defined by aCoord[] is completely outside the region,
overlaps the region, or is completely inside the region, respectively.  In
addition, the xQueryFunc must set the rScore field to a non-negative value that
indicates the order in which subtrees and entries of the query should be analyzed
and returned.  ^Smaller scores are processed first.

<p>As its name implies, an R*Tree is organized as a tree.  Each node of the







|







533
534
535
536
537
538
539
540
541
542
543
544
545
546
547

<p>The first five fields of the sqlite3_rtree_query_info structure are identical
to the sqlite3_rtree_geometry structure, and have exactly the same meaning.
The sqlite3_rtree_query_info structure also contains nCoord and aCoord fields 
which have the same meaning as the parameter of the same name in the xGeom callback.

<p>The xQueryFunc must set the eWithin field of sqlite3_rtree_query_info to
one of the values NOT_WITHIN, PARTLY_WITHIN, or FULLY_WITHIN depending on whether
or not the bounding box defined by aCoord[] is completely outside the region,
overlaps the region, or is completely inside the region, respectively.  In
addition, the xQueryFunc must set the rScore field to a non-negative value that
indicates the order in which subtrees and entries of the query should be analyzed
and returned.  ^Smaller scores are processed first.

<p>As its name implies, an R*Tree is organized as a tree.  Each node of the