Skip to content

Commit 8a52f82

Browse files
jishnubjishnub
committed
BinaryTree iterator
1 parent d6a4eed commit 8a52f82

File tree

3 files changed

+121
-44
lines changed

3 files changed

+121
-44
lines changed

‎Project.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "ParallelUtilities"
22
uuid = "fad6cfc8-4f83-11e9-06cc-151124046ad0"
33
authors = ["Jishnu Bhattacharya <[email protected]>"]
4-
version = "0.3.2"
4+
version = "0.3.3"
55

66
[deps]
77
Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"

‎src/ParallelUtilities.jl‎

Lines changed: 59 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,58 @@ end
602602

603603
@inline nchildren(::BinaryTreeNode{N}) where {N} = N
604604

605+
struct BinaryTree{T}
606+
N :: Int # total number of nodes
607+
h :: Int # Number of levels
608+
twochildendind :: Int
609+
onechildendind :: Int
610+
procs :: T
611+
612+
function BinaryTree(procs::T) where {T<:AbstractVector{Int}}
613+
614+
N = length(procs)
615+
(N >=1) || throw(DomainError(N,"need at least 1 node to create a binary tree"))
616+
617+
h = floor(Int,log2(N)) # Number of levels of the tree
618+
Ninternalnodes = 2^h - 1
619+
Nleaf = N - Ninternalnodes
620+
Nonechildinternalnodes = (Ninternalnodes > 0) ? rem(Nleaf,2) : 0
621+
twochildendind = div(N-1,2)
622+
onechildstartind = twochildendind + 1
623+
onechildendind = onechildstartind + Nonechildinternalnodes - 1
624+
625+
new{T}(N,h,twochildendind,onechildendind,procs)
626+
end
627+
end
628+
629+
Base.length(b::BinaryTree) = b.N
630+
# This method is not used as empty binary trees are not allowed
631+
# It will be removed in the next minor release
632+
Base.isempty(b::BinaryTree) = length(b) == 0
633+
634+
function Base.getindex(tree::BinaryTree,i::Int)
635+
procs = tree.procs
636+
637+
p = procs[i]
638+
p_parent = procs[parentnoderank(i)]
639+
640+
if i <= tree.twochildendind
641+
# These nodes have two children each
642+
p_children = (procs[2i],procs[2i+1])
643+
644+
elseif i <= tree.onechildendind
645+
# These nodes have one child each
646+
p_children = (procs[2i],)
647+
648+
else
649+
# These nodes have no children
650+
p_children = ()
651+
end
652+
653+
BinaryTreeNode(p,p_parent,p_children)
654+
end
655+
656+
# This function is not used and will be removed in the next minor release
605657
function constructBinaryTree(procs::AbstractVector{Int})
606658
N = length(procs)
607659
h = floor(Int,log2(N)) # Number of levels of the tree
@@ -621,7 +673,7 @@ function constructBinaryTree(procs::AbstractVector{Int})
621673
# These nodes have two children each
622674
p_children = (procs[2i],procs[2i+1])
623675
elseif onechildstartind <= i <= onechildendind
624-
# These nodes have one children each
676+
# These nodes have one child each
625677
p_children = (procs[2i],)
626678
else
627679
# These nodes have no children
@@ -682,10 +734,9 @@ function Base.finalize(bc::BranchChannel)
682734
finalize_except_wherewhence(bc.parentchannels)
683735
end
684736

685-
function createbranchchannels(::Type{T},tree::Vector{BinaryTreeNode}) where {T}
737+
function createbranchchannels(::Type{T},tree::Union{Vector{BinaryTreeNode},BinaryTree}) where {T}
686738
branches = Vector{BranchChannel}(undef,length(tree))
687739
isempty(tree) && return branches
688-
689740
# the first node has to be created separately as its children will be linked to it
690741
firstnode = tree[1]
691742
N = nchildren(firstnode)
@@ -704,8 +755,7 @@ function createbranchchannels(::Type{T},tree::Vector{BinaryTreeNode}) where {T}
704755
end
705756

706757
function createbranchchannels(::Type{T},iterators::Tuple) where {T}
707-
procs_used = workersactive(iterators)
708-
tree = constructBinaryTree(procs_used)
758+
tree = BinaryTree(workersactive(iterators))
709759
createbranchchannels(T,tree)
710760
end
711761
@inline createbranchchannels(iterators::Tuple) = createbranchchannels(Any,iterators)
@@ -829,6 +879,8 @@ function return_unless_error(r::RemoteChannelContainer)
829879
end
830880
end
831881

882+
@inline return_unless_error(b::BranchChannel) = return_unless_error(b.parentchannels)
883+
832884
# This function does not sort the values, so it might be faster
833885
function pmapreduce_commutative(fmap::Function,freduce::Function,iterators::Tuple,args...;kwargs...)
834886

@@ -846,7 +898,7 @@ function pmapreduce_commutative(fmap::Function,freduce::Function,iterators::Tupl
846898
end
847899
end
848900

849-
return_unless_error(first(branches).parentchannels)
901+
return_unless_error(first(branches))
850902
end
851903

852904
function pmapreduce_commutative(fmap::Function,freduce::Function,
@@ -888,7 +940,7 @@ function pmapreduce(fmap::Function,freduce::Function,iterators::Tuple,args...;kw
888940
end
889941
end
890942

891-
return_unless_error(first(branches).parentchannels)
943+
return_unless_error(first(branches))
892944
end
893945

894946
function pmapreduce(fmap::Function,freduce::Function,

‎test/runtests.jl‎

Lines changed: 61 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ addprocs(2)
88
Pkg.activate(".")
99
using ParallelUtilities
1010
import ParallelUtilities: BinaryTreeNode, RemoteChannelContainer, BranchChannel,
11-
Sorted, Unsorted, Ordering, pval, value, reducedvalue, collectvalues, reduceTreeNode
11+
Sorted, Unsorted, Ordering, pval, value, reducedvalue, collectvalues, reduceTreeNode,
12+
BinaryTree, constructBinaryTree, parentnoderank
1213
end
1314

1415
@testset "ProductSplit" begin
@@ -440,39 +441,63 @@ end
440441

441442
@test_throws ParallelUtilities.BinaryTreeError BinaryTreeNode(p,p,(2,3,4))
442443
end
443-
444-
@testset "constructBinaryTree" begin
445-
for imax = 1:10
446-
procs = collect(1:imax)
447-
tree = ParallelUtilities.constructBinaryTree(procs)
448-
@test length(tree) == length(procs)
449-
@test tree[1].parent == 1
450-
for (rank,node) in enumerate(tree)
451-
@test node.p == procs[rank]
452-
@test node.parent == procs[ParallelUtilities.parentnoderank(rank)]
453-
end
454-
end
455-
456-
procs = [1]
457-
tree = ParallelUtilities.constructBinaryTree(procs)
458-
@test tree[1].children == ()
459-
460-
procs = collect(1:2)
461-
tree = ParallelUtilities.constructBinaryTree(procs)
462-
@test tree[1].children == (2,)
463-
@test tree[2].children == ()
464-
465-
procs = collect(1:8)
466-
tree = ParallelUtilities.constructBinaryTree(procs)
467-
@test tree[1].children == (2,3)
468-
@test tree[2].children == (4,5)
469-
@test tree[3].children == (6,7)
470-
@test tree[4].children == (8,)
471-
@test tree[5].children == ()
472-
@test tree[6].children == ()
473-
@test tree[7].children == ()
474-
@test tree[8].children == ()
475-
end
444+
end
445+
446+
@testset "BinaryTree" begin
447+
448+
@testset "constructBinaryTree" begin
449+
for imax = 1:10
450+
procs = collect(1:imax)
451+
tree = constructBinaryTree(procs)
452+
@test length(tree) == length(procs)
453+
@test tree[1].parent == 1
454+
for (rank,node) in enumerate(tree)
455+
@test node.p == procs[rank]
456+
@test node.parent == procs[parentnoderank(rank)]
457+
end
458+
end
459+
460+
procs = [1]
461+
tree = constructBinaryTree(procs)
462+
@test tree[1].children == ()
463+
464+
procs = collect(1:2)
465+
tree = constructBinaryTree(procs)
466+
@test tree[1].children == (2,)
467+
@test tree[2].children == ()
468+
469+
procs = collect(1:8)
470+
tree = constructBinaryTree(procs)
471+
@test tree[1].children == (2,3)
472+
@test tree[2].children == (4,5)
473+
@test tree[3].children == (6,7)
474+
@test tree[4].children == (8,)
475+
@test tree[5].children == ()
476+
@test tree[6].children == ()
477+
@test tree[7].children == ()
478+
@test tree[8].children == ()
479+
end
480+
481+
@testset "Constructor" begin
482+
function test_constructor(procs)
483+
bt = BinaryTree(procs)
484+
btvector = constructBinaryTree(procs)
485+
486+
@test length(bt) == length(btvector)
487+
@test !isempty(bt)
488+
489+
for (i,btnode) in enumerate(btvector)
490+
@test bt[i] == btnode
491+
end
492+
end
493+
494+
@test_throws DomainError BinaryTree(1:0)
495+
@test_throws DomainError BinaryTree(Int[])
496+
497+
test_constructor(1:10)
498+
test_constructor(collect(1:10))
499+
test_constructor(workers())
500+
end
476501
end
477502

478503
@testset "RemoteChannelContainer" begin
@@ -678,7 +703,7 @@ end
678703
branches = ParallelUtilities.createbranchchannels(T,tree)
679704
@test length(branches) == length(tree)
680705
for (rank,branch) in enumerate(branches)
681-
parentrank = ParallelUtilities.parentnoderank(rank)
706+
parentrank = parentnoderank(rank)
682707
p = branch.p
683708
p_parent = branches[parentrank].p
684709
@test branch.selfchannels.out.where == p
@@ -697,7 +722,7 @@ end
697722
end
698723
end
699724

700-
tree = ParallelUtilities.constructBinaryTree(workers())
725+
tree = constructBinaryTree(workers())
701726
for T in [Int,Any,Bool,Vector{Float64},Array{ComplexF64,2}]
702727
testbranches(T,tree)
703728
end

0 commit comments

Comments
 (0)