mirror of
https://github.com/Mercury-Language/mercury.git
synced 2026-05-01 17:24:34 +00:00
92121e1ea4
Branches: main Add the modules svstack and svpqueue to the standard library. library/svpqueue.m: library/svstack.m: Add state variable friendly interfaces to stacks and pqueues. library/pqueue.m: Add a det version of remove/4. Group function definitions with the clauses for the corresponding predicates. library/library.m: Include the new modules. NEWS: Announce the above changes.
73 lines
2.6 KiB
Mathematica
73 lines
2.6 KiB
Mathematica
%---------------------------------------------------------------------------%
|
|
% vim: ft=mercury ts=4 sw=4 et wm=0 tw=0
|
|
%---------------------------------------------------------------------------%
|
|
% Copyright (C) 2011 The University of Melbourne.
|
|
% This file may only be copied under the terms of the GNU Library General
|
|
% Public License - see the file COPYING.LIB in the Mercury distribution.
|
|
%---------------------------------------------------------------------------%
|
|
%
|
|
% File: stack.m.
|
|
% Main author: fjh.
|
|
% Stability: high.
|
|
%
|
|
% This file provides an interface to the 'stack' ADT that is conducive to the
|
|
% use of state variable notation. The predicates here do the same thing as
|
|
% their counterparts in the stack module; the only difference is the order of
|
|
% the arguments.
|
|
%
|
|
%--------------------------------------------------------------------------%
|
|
|
|
:- module svstack.
|
|
:- interface.
|
|
|
|
:- import_module list.
|
|
:- import_module stack.
|
|
|
|
%--------------------------------------------------------------------------%
|
|
|
|
% `svstack.push(Elem, Stack0, Stack)' is true iff `Stack' is
|
|
% the stack which results from pushing `Elem' onto the top
|
|
% of `Stack0'.
|
|
%
|
|
:- pred svstack.push(T::in, stack(T)::in, stack(T)::out) is det.
|
|
|
|
% `svstack.push_list(Elems, Stack0, Stack)' is true iff `Stack'
|
|
% is the stack which results from pushing the elements of the
|
|
% list `Elems' onto the top of `Stack0'.
|
|
%
|
|
:- pred svstack.push_list(list(T)::in, stack(T)::in, stack(T)::out) is det.
|
|
|
|
% `svstack.pop(Elem, Stack0, Stack)' is true iff `Stack0' is
|
|
% a non-empty stack whose top element is `Elem', and `Stack'
|
|
% the stack which results from popping `Elem' off `Stack0'.
|
|
%
|
|
:- pred svstack.pop(T::out, stack(T)::in, stack(T)::out) is semidet.
|
|
|
|
% `svstack.det_pop' is like `svstack.pop' except that it will
|
|
% call error/1 rather than failing if given an empty stack.
|
|
%
|
|
:- pred svstack.det_pop(T::out, stack(T)::in, stack(T)::out) is det.
|
|
|
|
%--------------------------------------------------------------------------%
|
|
%--------------------------------------------------------------------------%
|
|
|
|
:- implementation.
|
|
|
|
%--------------------------------------------------------------------------%
|
|
|
|
svstack.push(E, !S) :-
|
|
stack.push(!.S, E, !:S).
|
|
|
|
svstack.push_list(Es, !S) :-
|
|
stack.push_list(!.S, Es, !:S).
|
|
|
|
svstack.pop(E, !S) :-
|
|
stack.pop(!.S, E, !:S).
|
|
|
|
svstack.det_pop(E, !S) :-
|
|
stack.det_pop(!.S, E, !:S).
|
|
|
|
%--------------------------------------------------------------------------%
|
|
:- end_module svstack.
|
|
%--------------------------------------------------------------------------%
|