export subtrees (#85)

* export subtrees, SubtreeIterator

* set version to 2.12.0

Author: ranocha

Project.toml

@@ -1,7 +1,7 @@
 name = "RootedTrees"
 uuid = "47965b36-3f3e-11e9-0dcf-4570dfd42a8c"
 authors = ["Hendrik Ranocha <mail@ranocha.de> and contributors"]
-version = "2.11.1"
+version = "2.12.0"
 
 [deps]
 Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"

src/RootedTrees.jl

@@ -19,6 +19,8 @@ export residual_order_condition, elementary_weight, derivative_weight
 
 export count_trees
 
+export subtrees, SubtreeIterator
+
 export partition_forest, PartitionForestIterator,
        partition_skeleton,
        all_partitions, PartitionIterator
@@ -547,6 +549,15 @@ function count_trees(order)
 end
 
 # subtrees
+"""
+    SubtreeIterator(t::AbstractRootedTree)
+
+Lazy iterator representation of the [`subtrees`](@ref) of the rooted
+tree `t`.
+Similar to [`RootedTreeIterator`](@ref), you should `copy` the iterates
+if you want to store or modify them during the iteration since they may be
+views to internal caches.
+"""
 struct SubtreeIterator{Tree <: AbstractRootedTree}
     t::Tree
 end
@@ -581,6 +592,8 @@ end
     subtrees(t::RootedTree)
 
 Returns a vector of all subtrees of `t`.
+
+See also [`SubtreeIterator`](@ref).
 """
 function subtrees(t::RootedTree)
     subtr = typeof(t)[]