Extendable arrays with logarithmic access time

Author(s): Lena Flood.

Version: 1.11#222 (2004/5/24, 13:8:7 CEST)

Version of last change: 1.11#112 (2003/12/22, 18:18:22 CET)

This module implements extendable arrays with logarithmic access time. It has been adapted from shared code written by David Warren and Fernando Pereira.

• Usage and interface (arrays)
• Documentation on exports (arrays)

Usage and interface (arrays)

Documentation on exports (arrays)

PREDICATE: new_array/1:

Usage: new_array(Array)

• Description: returns an empty new array Array.
• The following properties should hold at call time: Array is a free variable. (term_typing:var/1)

PREDICATE: is_array/1:

Usage: is_array(Array)

• Description: Array actually is an array.
• The following properties should hold at call time: Array is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: aref/3:

Usage: aref(Index, Array, Element)

• Description: unifies Element to Array[Index], or fails if Array[Index] has not been set.
• The following properties should hold at call time: Index is currently a term which is not a free variable. (term_typing:nonvar/1) Array is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: arefa/3:

Usage: arefa(Index, Array, Element)

• Description: is as aref/3, except that it unifies Element with a new array if Array[Index] is undefined. This is useful for multidimensional arrays implemented as arrays of arrays.
• The following properties should hold at call time: Index is currently a term which is not a free variable. (term_typing:nonvar/1) Array is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: arefl/3:

Usage: arefl(Index, Array, Element)

• Description: is as aref/3, except that Element appears as [] for undefined cells. Thus, arefl(_,_,[]) always succeeds no matter what you give in the first or second args.
• The following properties should hold at call time: Index is currently a term which is not a free variable. (term_typing:nonvar/1) Array is currently a term which is not a free variable. (term_typing:nonvar/1)

PREDICATE: aset/4:

Usage: aset(Index, Array, Element, NewArray)

• Description: unifies NewArray with the result of setting Array[Index] to Element.
• The following properties should hold at call time: Index is currently a term which is not a free variable. (term_typing:nonvar/1) Array is currently a term which is not a free variable. (term_typing:nonvar/1) NewArray is a free variable. (term_typing:var/1)

PREDICATE: array_to_list/2:

Usage: array_to_list(Array, List)

• Description: returns a List of pairs Index-Element of all the elements of Array that have been set.
• The following properties should hold at call time: Array is currently a term which is not a free variable. (term_typing:nonvar/1) List is a free variable. (term_typing:var/1)

Go to the first, previous, next, last section, table of contents.