Tree

class Tree(val glibTreePointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

The GTree struct is an opaque data structure representing a glib-Balanced-Binary-Trees. It should be accessed only by using the following functions.

Skipped during bindings generation

parameter orig_key: orig_key: Out parameter is not supported
method traverse: C function g_tree_traverse is ignored
parameter key_compare_func: CompareFunc
parameter key_destroy_func: DestroyNotify

Constructors

Tree

constructor(keyCompareFunc: CompareDataFunc)

Creates a new #GTree with a comparison function that accepts user data. See g_tree_new() for more details.

constructor(glibTreePointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

glibTreePointer

val glibTreePointer: <Error class: unknown class><<Error class: unknown class>>

handle

open override val handle: <Error class: unknown class>

Functions

addCleaner

open override fun addCleaner(cleaner: <Error class: unknown class>): Boolean

Registers a cleaner to be executed when this proxy object is garbage collected.

destroy

fun destroy()

Removes all keys and values from the #GTree and decreases its reference count by one. If keys and/or values are dynamically allocated, you should either free them first or create the #GTree using g_tree_new_full(). In the latter case the destroy functions you supplied will be called on all keys and values before destroying the #GTree.

equals

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

foreach

fun foreach(func: TraverseFunc)

Calls the given function for each of the key/value pairs in the #GTree. The function is passed the key and value of each pair, and the given

foreachNode

fun foreachNode(func: TraverseNodeFunc)

Calls the given function for each of the nodes in the #GTree. The function is passed the pointer to the particular node, and the given

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

hashCode

open override fun hashCode(): Int

height

fun height(): <Error class: unknown class>

Gets the height of a #GTree.

insert

fun insert(key: <Error class: unknown class>? = null, value: <Error class: unknown class>? = null)

Inserts a key/value pair into a #GTree.

insertNode

fun insertNode(key: <Error class: unknown class>? = null, value: <Error class: unknown class>? = null): TreeNode?

Inserts a key/value pair into a #GTree.

lookup

fun lookup(key: <Error class: unknown class>? = null): <Error class: unknown class>?

Gets the value corresponding to the given key. Since a #GTree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree).

lookupNode

fun lookupNode(key: <Error class: unknown class>? = null): TreeNode?

Gets the tree node corresponding to the given key. Since a #GTree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree).

lowerBound

fun lowerBound(key: <Error class: unknown class>? = null): TreeNode?

Gets the lower bound node corresponding to the given key, or null if the tree is empty or all the nodes in the tree have keys that are strictly lower than the searched key.

nnodes

fun nnodes(): <Error class: unknown class>

Gets the number of nodes in a #GTree.

nodeFirst

fun nodeFirst(): TreeNode?

Returns the first in-order node of the tree, or null for an empty tree.

nodeLast

fun nodeLast(): TreeNode?

Returns the last in-order node of the tree, or null for an empty tree.

ref

fun ref(): Tree

Increments the reference count of @tree by one.

remove

fun remove(key: <Error class: unknown class>? = null): Boolean

Removes a key/value pair from a #GTree.

removeAll

fun removeAll()

Removes all nodes from a #GTree and destroys their keys and values, then resets the #GTree’s root to null.

removeCleaner

open override fun removeCleaner(cleaner: <Error class: unknown class>): Boolean

Removes a previously registered cleaner from this proxy object.

replace

fun replace(key: <Error class: unknown class>? = null, value: <Error class: unknown class>? = null)

Inserts a new key and value into a #GTree as g_tree_replace_node() does, only this function does not return the inserted or set node.

replaceNode

fun replaceNode(key: <Error class: unknown class>? = null, value: <Error class: unknown class>? = null): TreeNode?

Inserts a new key and value into a #GTree similar to g_tree_insert_node(). The difference is that if the key already exists in the #GTree, it gets replaced by the new key. If you supplied a @value_destroy_func when creating the #GTree, the old value is freed using that function. If you supplied a @key_destroy_func when creating the #GTree, the old key is freed using that function.

fun search(searchFunc: CompareFunc): <Error class: unknown class>?

Searches a #GTree using @search_func.

searchNode

fun searchNode(searchFunc: CompareFunc): TreeNode?

Searches a #GTree using @search_func.

steal

fun steal(key: <Error class: unknown class>? = null): Boolean

Removes a key and its associated value from a #GTree without calling the key and value destroy functions.

unref

fun unref()

Decrements the reference count of @tree by one. If the reference count drops to 0, all keys and values will be destroyed (if destroy functions were specified) and all memory allocated by @tree will be released.

upperBound

fun upperBound(key: <Error class: unknown class>? = null): TreeNode?

Gets the upper bound node corresponding to the given key, or null if the tree is empty or all the nodes in the tree have keys that are lower than or equal to the searched key.