container/Stack.fz

# This file is part of the Fuzion language implementation.
#
# The Fuzion language implementation is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public License as published
# by the Free Software Foundation, version 3 of the License.
#
# The Fuzion language implementation is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
# License for more details.
#
# You should have received a copy of the GNU General Public License along with The
# Fuzion language implementation.  If not, see <https://www.gnu.org/licenses/>.


# -----------------------------------------------------------------------
#
#  Tokiwa Software GmbH, Germany
#
#  Source code of Fuzion standard library feature Stack
#
# -----------------------------------------------------------------------


# interface definition for stacks
#
public Stack(T type) ref is

  # push an element onto the top of the stack.
  #
  public push(e T) unit => abstract

  # remove and return the top element of the stack.
  #
  public pop option T => abstract

  # return the top element of the stack without removing it.
  #
  public peek option T => abstract

  # convert this Stack to a Sequence (top element first)
  #
  public as_sequence Sequence T => abstract