Tree configuration #138

hanish520 · 2024-12-22T07:50:09Z

create trees from position slice

We don't need an interface (yet), since there is only one implementation. A client (user) of the package can easily add its own interface as necessary.

This makes the test data specify the label: number to make it more readable; it is hard to map the four numbers to the field name of original createTreeTest type.

We only need to store the IDs once; the index into the ID slice represents that ID's position in the tree. I think it will be faster for small trees to do this approach; we may consider to add a benchmark to find the breaking point where it is faster to use a map for this. If a map is needed for larger trees for speed, we could consider to revert this change, or allocate the map only if the tree is actually large.

trees/treeconfig.go

This moves the code to compute the height together rather than splitting it with code for argument checks. This makes it easier to see that computing the height could be moved to a external function if it was ever necessary to do separately.

In Go we try to avoid using the Get prefix.

We don't need to check that t.id's position isn't -1 since we do that check in CreateTree, so we would never get -1 here.

NodeChildren returns this tree's replica's children, while the ChildrenOf(node) returns the node's children. This also removes an unnecessary allocation; we can return nil instead of an empty slice of IDs.

NodeHeight returns the height of this tree's replica's height.

We can return a subsclice of the original to avoid allocating.

The math.Pow calls in a loop can be slow; this should be faster.

hanish520 and others added 5 commits December 21, 2024 23:48

added tree configuration and testcases

9840f5f

chore(trees): gofmt and fixed lint issues

0131823

chore(trees): removed TreeConfiguration interface

5fe6e96

We don't need an interface (yet), since there is only one implementation. A client (user) of the package can easily add its own interface as necessary.

test(trees): make the TestCreateTree table use labeled entries

2bd3535

This makes the test data specify the label: number to make it more readable; it is hard to map the four numbers to the field name of original createTreeTest type.

meling requested review from meling and leandernikolaus December 22, 2024 15:54

meling requested changes Dec 22, 2024

View reviewed changes

meling reviewed Dec 22, 2024

View reviewed changes

trees/treeconfig.go Outdated Show resolved Hide resolved

hanish520 and others added 16 commits December 23, 2024 00:21

Addressed review comments and added benchmarks for ChildrenOf api

7266f1f

refactor(tree): rename GetTreeHeight to TreeHeight

1871d1d

In Go we try to avoid using the Get prefix.

fix(tree): removed unnecessary check for -1

64b3d23

We don't need to check that t.id's position isn't -1 since we do that check in CreateTree, so we would never get -1 here.

refactor(tree): rename to ChildrenOf(node) and NodeChildren()

c29ed18

NodeChildren returns this tree's replica's children, while the ChildrenOf(node) returns the node's children. This also removes an unnecessary allocation; we can return nil instead of an empty slice of IDs.

refactor(tree): rename GetHeight to NodeHeight

5f92d28

NodeHeight returns the height of this tree's replica's height.

refactor(tree): avoid allocation of empty slice of IDs

ad4f140

refactor(tree): simplified SubTree implementation

8001f10

doc(tree): added a comment about computing height of the tree

8f780f9

refactor(tree): rename Node/node methods/vars to Replica/replica

6e02d5f

chore(tree): moved private helper funcs to bottom of file

8945718

refactor(tree): allocate less in SubTree() method

e470824

refactor(tree): avoid allocation in ChildrenOf()

6f94b07

We can return a subsclice of the original to avoid allocating.

refactor(tree): avoid math.Pow in heightOf()

7dddede

The math.Pow calls in a loop can be slow; this should be faster.

bench(tree): use modern table-driven benchmarks

8fa760c

fix(tree): removed unused isWithInIndex()

c3f8a5a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tree configuration #138

Tree configuration #138

hanish520 commented Dec 22, 2024

Tree configuration #138

Are you sure you want to change the base?

Tree configuration #138

Conversation

hanish520 commented Dec 22, 2024