Skip to content

Commit 1f5fba2

Browse files
committed
node_extent in readme
1 parent 41e8184 commit 1f5fba2

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/utils/SpatialTreeInterface/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,14 @@ This is also a zero cost interface if implemented correctly! Verified implement
2323
- `getchild(node)` - get the children of a node. This may be materialized if necessary or available, but can also be lazy (like a generator).
2424
- `getchild(node, i)` - get the `i`-th child of a node.
2525
- `nchild(node)::Int` - the number of children of a node.
26-
- `child_indices_extents(node)` - an iterator over the indices and extents of the children of a node.
26+
- `child_indices_extents(node)` - an iterator over the indices and extents of the children of a **leaf** node.
2727

28-
These are the only methods that are required to be implemented. They enable the generic query functions described below:
28+
These are the only methods that are required to be implemented.
29+
30+
Optionally, one may define:
31+
- `node_extent(node)` - get the extent of a node. This falls back to `GI.extent` but can potentially be overridden if you want to return a different but extent-like object.
32+
33+
They enable the generic query functions described below:
2934

3035
## Query functions
3136

0 commit comments

Comments
 (0)