1/* Part of SWI-Prolog 2 3 Author: Jan Wielemaker 4 E-mail: J.Wielemaker@vu.nl 5 WWW: http://www.swi-prolog.org 6 Copyright (c) 2010-2011, University of Amsterdam 7 All rights reserved. 8 9 Redistribution and use in source and binary forms, with or without 10 modification, are permitted provided that the following conditions 11 are met: 12 13 1. Redistributions of source code must retain the above copyright 14 notice, this list of conditions and the following disclaimer. 15 16 2. Redistributions in binary form must reproduce the above copyright 17 notice, this list of conditions and the following disclaimer in 18 the documentation and/or other materials provided with the 19 distribution. 20 21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 24 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 25 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 26 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 27 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 28 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 29 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 31 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 POSSIBILITY OF SUCH DAMAGE. 33*/ 34 35:- module(arrays, 36 [ new_array/1, % -Array 37 is_array/1, % +Term 38 aref/3, % +Index, +Array, -Element 39 arefa/3, % +Index, +Array, -ArrayElement 40 arefl/3, % +Index, +Array, -ListElement 41 array_to_list/2, % +Array, -List 42 aset/4 % +Index, +Array, +Element, -NewArray 43 ]). 44:- use_module(library(rbtrees)). 45 46/** <module> SICStus 3-compatible library(arrays). 47 48@deprecated library(arrays) has been removed in SICStus 4. 49@compat This library builds on library(rbtrees) and therefore the 50 internal representation differs from the SICStus implementation. 51@see https://sicstus.sics.se/sicstus/docs/3.12.11/html/sicstus/Arrays.html 52*/ 53 54 55%% new_array(-Array) is det. 56% 57% @compat SICStus-3 58 59new_array(array(Array)) :- 60 rb_empty(Array). 61 62%% is_array(@Term) is semidet. 63% 64% True if Term is an array 65% 66% @compat SICStus-3 67 68is_array(Var) :- 69 var(Var), !, fail. 70is_array(array(Tree)) :- 71 is_rbtree(Tree). 72 73%% aref(+Index, +Array, -Element) is semidet. 74% 75% True if Element is the current element in Array at Index. 76% 77% @compat SICStus-3 78 79aref(Index, array(Tree), Element) :- 80 rb_lookup(Index, array(Tree), Element). 81 82%% arefa(+Index, +Array, -ArrayElement) is det. 83% 84% As aref/3, but succeeds with an empty array of the element is 85% not set. 86% 87% @compat SICStus-3 88 89arefa(Index, array(Tree), ArrayElement) :- 90 rb_lookup(Index, array(Tree), ArrayElement), !. 91arefa(_, _, Array) :- 92 new_array(Array). 93 94%% arefl(+Index, +Array, -ListElement) is det. 95% 96% As aref/3, but succeeds with an empty list of the element is not 97% set. 98% 99% @compat SICStus-3 100 101arefl(Index, array(Tree), ListElement) :- 102 rb_lookup(Index, array(Tree), ListElement), !. 103arefl(_, _, []). 104 105%% array_to_list(+Array, -Pairs) is det. 106% 107% @compat SICStus-3 108 109array_to_list(array(Tree), Pairs) :- 110 rb_visit(Tree, Pairs). 111 112%% aset(+Index, +Array, +Element, -NewArray) is det. 113% 114% NewArray is Array with Element added/updated at Index. 115% 116% @compat SICStus-3 117 118aset(Index, array(Tree), Element, array(NewTree)) :- 119 rb_update(Tree, Index, Element, NewTree), !. 120aset(Index, array(Tree), Element, array(NewTree)) :- 121 rb_insert_new(Tree, Index, Element, NewTree)