kotlin-stdlib/com.javiersc.kotlin.stdlib.tree/TreeNode

TreeNode

open class TreeNode<T>(val value: T) : Iterable<TreeNode<T>> , ChildDeclarationInterface<T>

Original library: https://github.com/AdrianKuta/Tree-Data-Structure

Constructors

TreeNode

constructor(value: T)

Properties

children

val children: List<TreeNode<T>>

A group of nodes with the same parent.

defaultIterator

var defaultIterator: TreeNodeIterators

Choose one of available iterators from TreeNodeIterators

depth

val depth: Int

Distance is the number of edges along the shortest path between two nodes.

height

val height: Int

isRoot

val isRoot: Boolean

Checks whether the current tree node is the root of the tree

nodeCount

val nodeCount: Int

This function go through tree and counts children. Root element is not counted.

parent

val parent: TreeNode<T>?

The converse notion of a child, an immediate ancestor.

root

val root: TreeNode<T>

The root of the tree.

value

val value: T

Functions

addChild

fun addChild(child: TreeNode<T>)

Add new child to current node or root.

child

open override fun child(value: T, childDeclaration: ChildDeclaration<T>?): TreeNode<T>

This method is used to easily create child in node.

clear

fun clear()

Remove all children from root and every node in tree.

eighth

inline fun <T> Iterable<T>.eighth(): T

Returns eighth element.

eighthOrNull

inline fun <T> Iterable<T>.eighthOrNull(): T?

fifth

inline fun <T> Iterable<T>.fifth(): T

Returns fifth element.

fifthOrNull

inline fun <T> Iterable<T>.fifthOrNull(): T?

forth

inline fun <T> Iterable<T>.forth(): T

Returns forth element.

forthOrNull

inline fun <T> Iterable<T>.forthOrNull(): T?

iterator

open operator override fun iterator(): Iterator<TreeNode<T>>

You can change default iterator by changing defaultIterator property.

ninth

inline fun <T> Iterable<T>.ninth(): T

Returns ninth element.

ninthOrNull

inline fun <T> Iterable<T>.ninthOrNull(): T?

path

fun path(descendant: TreeNode<T>): List<TreeNode<T>>

Returns the collection of nodes, which connect the current node with its descendants

penultimate

inline fun <T> Iterable<T>.penultimate(): T

Returns penultimate element.

penultimateOrNull

inline fun <T> Iterable<T>.penultimateOrNull(): T?

prettyString

fun prettyString(): String

removeChild

fun removeChild(child: TreeNode<T>): Boolean

Removes a single instance of the specified node from this tree, if it is present.

second

inline fun <T> Iterable<T>.second(): T

Returns second element.

secondOrNull

inline fun <T> Iterable<T>.secondOrNull(): T?

seventh

inline fun <T> Iterable<T>.seventh(): T

Returns seventh element.

seventhOrNull

inline fun <T> Iterable<T>.seventhOrNull(): T?

sixth

inline fun <T> Iterable<T>.sixth(): T

Returns sixth element.

sixthOrNull

inline fun <T> Iterable<T>.sixthOrNull(): T?

tenth

inline fun <T> Iterable<T>.tenth(): T

Returns tenth element.

tenthOrNull

inline fun <T> Iterable<T>.tenthOrNull(): T?

third

inline fun <T> Iterable<T>.third(): T

Returns third element.

thirdOrNull

inline fun <T> Iterable<T>.thirdOrNull(): T?

toString

open override fun toString(): String