xref: /titanic_41/usr/src/man/man3avl/avl_destroy.3avl (revision d9fc8ba670791dc3b8398347e67e1c5825d5e341)
1*d9fc8ba6SRobert Mustacchi.\"
2*d9fc8ba6SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*d9fc8ba6SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*d9fc8ba6SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*d9fc8ba6SRobert Mustacchi.\" 1.0 of the CDDL.
6*d9fc8ba6SRobert Mustacchi.\"
7*d9fc8ba6SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*d9fc8ba6SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*d9fc8ba6SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*d9fc8ba6SRobert Mustacchi.\"
11*d9fc8ba6SRobert Mustacchi.\"
12*d9fc8ba6SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
13*d9fc8ba6SRobert Mustacchi.\"
14*d9fc8ba6SRobert Mustacchi.Dd May 07, 2015
15*d9fc8ba6SRobert Mustacchi.Dt AVL_DESTROY 3AVL
16*d9fc8ba6SRobert Mustacchi.Os
17*d9fc8ba6SRobert Mustacchi.Sh NAME
18*d9fc8ba6SRobert Mustacchi.Nm avl_destroy
19*d9fc8ba6SRobert Mustacchi.Nd destroy an AVL tree
20*d9fc8ba6SRobert Mustacchi.Sh SYNOPSIS
21*d9fc8ba6SRobert Mustacchi.Lb libavl
22*d9fc8ba6SRobert Mustacchi.In sys/avl.h
23*d9fc8ba6SRobert Mustacchi.Ft void
24*d9fc8ba6SRobert Mustacchi.Fo avl_destroy
25*d9fc8ba6SRobert Mustacchi.Fa "avl_tree_t *tree"
26*d9fc8ba6SRobert Mustacchi.Fc
27*d9fc8ba6SRobert Mustacchi.Sh DESCRIPTION
28*d9fc8ba6SRobert MustacchiThe
29*d9fc8ba6SRobert Mustacchi.Fn avl_destroy
30*d9fc8ba6SRobert Mustacchifunction is used to destroy the AVL tree that is rooted at
31*d9fc8ba6SRobert Mustacchi.Fa tree .
32*d9fc8ba6SRobert MustacchiAt the time that
33*d9fc8ba6SRobert Mustacchi.Fn avl_destroy
34*d9fc8ba6SRobert Mustacchiis called,
35*d9fc8ba6SRobert Mustacchi.Fa tree
36*d9fc8ba6SRobert Mustacchimust be empty. It is a programmer error to call
37*d9fc8ba6SRobert Mustacchi.Fn avl_destroy
38*d9fc8ba6SRobert Mustacchiotherwise. To efficiently remove all entries in the tree, see
39*d9fc8ba6SRobert Mustacchi.Xr avl_destroy_nodes 3AVL .
40*d9fc8ba6SRobert Mustacchi.Pp
41*d9fc8ba6SRobert MustacchiAfter a call to
42*d9fc8ba6SRobert Mustacchi.Fn avl_destroy ,
43*d9fc8ba6SRobert Mustacchi.Fa tree
44*d9fc8ba6SRobert Mustacchishould not be used with any other library functions until a subsequent
45*d9fc8ba6SRobert Mustacchicall to
46*d9fc8ba6SRobert Mustacchi.Xr avl_create 3AVL .
47*d9fc8ba6SRobert Mustacchi.Sh EXAMPLES
48*d9fc8ba6SRobert MustacchiSee the
49*d9fc8ba6SRobert Mustacchi.Sy EXAMPLES
50*d9fc8ba6SRobert Mustacchisection in
51*d9fc8ba6SRobert Mustacchi.Xr libavl 3LIB .
52*d9fc8ba6SRobert Mustacchi.Sh INTERFACE STABILITY
53*d9fc8ba6SRobert Mustacchi.Sy Committed
54*d9fc8ba6SRobert Mustacchi.Sh MT-Level
55*d9fc8ba6SRobert MustacchiSee
56*d9fc8ba6SRobert Mustacchi.Sx Locking
57*d9fc8ba6SRobert Mustacchiin
58*d9fc8ba6SRobert Mustacchi.Xr libavl 3LIB .
59*d9fc8ba6SRobert Mustacchi.Sh SEE ALSO
60*d9fc8ba6SRobert Mustacchi.Xr libavl 3LIB ,
61*d9fc8ba6SRobert Mustacchi.Xr avl_create 3AVL ,
62*d9fc8ba6SRobert Mustacchi.Xr avl_destroy_nodes 3AVL
63