hierarchy/com.juul.krayon.hierarchy

Package-level declarations

Types

Node

class Node<T, L>

Properties

depth

val <T, L> Node<T, L>.depth: Int

Number of parents before hitting the root Node. If this is the root, then this is 0.

height

val <T, L> Node<T, L>.height: Int

Maximum number of children before hitting a leaf Node. If this is a leaf, then this is 0.

isLeaf

val <T, L> Node<T, L>.isLeaf: Boolean

Returns true if this node has no children.

Functions

ancestors

fun <T, L> Node<T, L>.ancestors(): Sequence<Node<T, L>>

Returns ancestor nodes, starting with this and then following the Node.parent chain.

count

fun <T, L> Node<T, L>.count(): Node<T, L>

each

inline fun <T, L> Node<T, L>.each(crossinline action: (Node<T, L>) -> Unit): Node<T, L>

eachAfter

inline fun <T, L> Node<T, L>.eachAfter(crossinline action: (Node<T, L>) -> Unit): Node<T, L>

eachAfterIndexed

inline fun <T, L> Node<T, L>.eachAfterIndexed(crossinline action: (Int, Node<T, L>) -> Unit): Node<T, L>

eachBefore

inline fun <T, L> Node<T, L>.eachBefore(crossinline action: (Node<T, L>) -> Unit): Node<T, L>

eachBeforeIndexed

inline fun <T, L> Node<T, L>.eachBeforeIndexed(crossinline action: (Int, Node<T, L>) -> Unit): Node<T, L>

eachIndexed

inline fun <T, L> Node<T, L>.eachIndexed(crossinline action: (Int, Node<T, L>) -> Unit): Node<T, L>

flatHierarchy

fun <T> flatHierarchy(values: Iterable<T>): Node<T?, Nothing?>

hierarchy

fun <T> hierarchy(root: T, getChildren: (T) -> List<T>): Node<T, Nothing?>

removeHierarchy

fun <T, L> Node<T?, L>.removeHierarchy(): Sequence<Pair<T, L>>

Returns a breadth-first traversal of nodes, removing those with null data, and pairing the data to the layout.

sort

fun <T, L> Node<T, L>.sort(comparator: Comparator<T>): Node<T, L>

sum

inline fun <T, L> Node<T, L>.sum(crossinline value: (T) -> Float): Node<T, L>

traverseBreadthFirst

fun <T, L> Node<T, L>.traverseBreadthFirst(): Sequence<Node<T, L>>

Returns descendant nodes, starting with this and then following the Node.children chain in a breadth-first traversal.

traversePostOrder

fun <T, L> Node<T, L>.traversePostOrder(): Sequence<Node<T, L>>

Returns descendant nodes, starting with the Node.children chain in a depth-first traversal, and ending with this.

traversePreOrder

fun <T, L> Node<T, L>.traversePreOrder(): Sequence<Node<T, L>>

Returns descendant nodes, starting with this and then following the Node.children chain in a depth-first traversal.