From b66e75c285cba469c5225f3394da149456d17d16 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Mon, 3 Feb 2014 10:27:39 +0100 Subject: Deprecate pre-defined built-in types The types array(), dict(), digraph(), gb_set(), gb_tree(), queue(), set(), and tid() have been deprecated. They will be removed in OTP 18.0. Instead the types array:array(), dict:dict(), digraph:graph(), gb_set:set(), gb_tree:tree(), queue:queue(), sets:set(), and ets:tid() can be used. (Note: it has always been necessary to use ets:tid().) It is allowed in OTP 17.0 to locally re-define the types array(), dict(), and so on. New types array:array/1, dict:dict/2, gb_sets:set/1, gb_trees:tree/2, queue:queue/1, and sets:set/1 have been added. --- lib/stdlib/doc/src/gb_trees.xml | 46 ++++++++++++++++++++++++++--------------- 1 file changed, 29 insertions(+), 17 deletions(-) (limited to 'lib/stdlib/doc/src/gb_trees.xml') diff --git a/lib/stdlib/doc/src/gb_trees.xml b/lib/stdlib/doc/src/gb_trees.xml index 57e60eacb7..b2f237e1d7 100644 --- a/lib/stdlib/doc/src/gb_trees.xml +++ b/lib/stdlib/doc/src/gb_trees.xml @@ -4,7 +4,7 @@
- 20012013 + 20012014 Ericsson AB. All Rights Reserved. @@ -59,13 +59,25 @@ - gb_tree() +

A GB tree.

 - + + +

tree() is equivalent to tree(term(), term()).

+ + + +

A GB tree iterator.

 + + + +

iter() is equivalent to iter(term(), term()).

+ + @@ -108,9 +120,9 @@ Insert or update key with value in a tree -

Inserts Key with value Val into Tree1 if +

Inserts Key with value Value into Tree1 if the key is not present in the tree, otherwise updates - Key to value Val in Tree1. Returns the + Key to value Value in Tree1. Returns the new tree.

 @@ -135,7 +147,7 @@ Insert a new key and value in a tree -

Inserts Key with value Val into Tree1; +

Inserts Key with value Value into Tree1; returns the new tree. Assumes that the key is not present in the tree, crashes otherwise.

 @@ -181,8 +193,8 @@ Return largest key and value -

Returns {Key, Val}, where Key is the largest - key in Tree, and Val is the value associated +

Returns {Key, Value}, where Key is the largest + key in Tree, and Value is the value associated with this key. Assumes that the tree is nonempty.

 @@ -191,7 +203,7 @@ Look up a key in a tree

Looks up Key in Tree; returns - {value, Val}, or none if Key is not + {value, Value}, or none if Key is not present.

 @@ -207,7 +219,7 @@ Traverse a tree with an iterator -

Returns {Key, Val, Iter2} where Key is the +

Returns {Key, Value, Iter2} where Key is the smallest key referred to by the iterator Iter1, and Iter2 is the new iterator to be used for traversing the remaining nodes, or the atom none if no @@ -225,8 +237,8 @@ Return smallest key and value -

Returns {Key, Val}, where Key is the smallest - key in Tree, and Val is the value associated +

Returns {Key, Value}, where Key is the smallest + key in Tree, and Value is the value associated with this key. Assumes that the tree is nonempty.

 @@ -234,8 +246,8 @@ Extract largest key and value -

Returns {Key, Val, Tree2}, where Key is the - largest key in Tree1, Val is the value +

Returns {Key, Value, Tree2}, where Key is the + largest key in Tree1, Value is the value associated with this key, and Tree2 is this tree with the corresponding node deleted. Assumes that the tree is nonempty.

@@ -245,8 +257,8 @@ Extract smallest key and value -

Returns {Key, Val, Tree2}, where Key is the - smallest key in Tree1, Val is the value +

Returns {Key, Value, Tree2}, where Key is the + smallest key in Tree1, Value is the value associated with this key, and Tree2 is this tree with the corresponding node deleted. Assumes that the tree is nonempty.

@@ -263,7 +275,7 @@ Update a key to new value in a tree -

Updates Key to value Val in Tree1; +

Updates Key to value Value in Tree1; returns the new tree. Assumes that the key is present in the tree.

 -- cgit v1.2.3