JuliaCollections / JuliaCollections/AbstractTrees.jl

The Index tree interface

Open
#107 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
243
Forks
67
PR merge metrics
No merged PRs in 30d

Description

I am having difficulty getting my head around the indexed tree interface. I have a small package RangeTrees.jl that creates interval trees in what I think is the indexed tree form. A RangeTree{T} consists of a Vector{RangeNode{T}} and the index of the root node in that vector. Each RangeNode contains the indexes of its left and right child nodes with the convention that a zero index indicates there is no node on that side.

If someone (@ExpandingMan @ararslan ?) can describe for me what AbstractTrees methods I should implement for RangeTree in my package, I will create a documentation PR for the index tree interface.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the indexed tree interface in AbstractTrees.jl and the RangeTrees.jl description of RangeTree and RangeNode. Identify the AbstractTrees methods required for a vector-backed tree with a root index and zero-valued missing-child indexes, then document those methods so the author can create a documentation PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.