struct::stack(n)                                                Tcl Data Structures                                               struct::stack(n)

__________________________________________________________________________________________________________________________________________________

NAME

       struct::stack - Create and manipulate stack objects

SYNOPSIS

       package require Tcl  8.2

       package require struct::stack  ?1.3.3?

       stackName option ?arg arg ...?

       stackName clear

       stackName destroy

       stackName peek ?count?

       stackName pop ?count?

       stackName push item ?item...?

       stackName size

_________________________________________________________________

DESCRIPTION

       The ::struct namespace contains a commands for processing finite stacks.

       It exports a single command, ::struct::stack. All functionality provided here can be reached through a subcommand of this command.

       Note:  As  of  version  1.3.3 of this package a critcl based C implementation is available. This implementation however requires Tcl 8.4 to
       run.

       The ::struct::stack command creates a new stack object with an associated global Tcl command whose name is stackName.  This command may  be
       used to invoke various operations on the stack.  It has the following general form:

       stackName option ?arg arg ...?
              Option and the args determine the exact behavior of the command.  The following commands are possible for stack objects:

       stackName clear
              Remove all items from the stack.

       stackName destroy
              Destroy the stack, including its storage space and associated command.

       stackName peek ?count?
              Return  the  top  count  items of the stack, without removing them from the stack.  If count is not specified, it defaults to 1.  If
              count is 1, the result is a simple string; otherwise, it is a list.  If specified, count must be greater than or  equal  to  1.   If
              there are not enoughs items on the stack to fulfull the request, this command will throw an error.

       stackName pop ?count?
              Return  the top count items of the stack, and remove them from the stack.  If count is not specified, it defaults to 1.  If count is
              1, the result is a simple string; otherwise, it is a list.  If specified, count must be greater than or equal to 1.   If  there  are
              not enoughs items on the stack to fulfull the request, this command will throw an error.

       stackName push item ?item...?
              Push the item or items specified onto the stack.  If more than one item is given, they will be pushed in the order they are listed.

       stackName size
              Return the number of items on the stack.

BUGS, IDEAS, FEEDBACK
       This  document,  and the package it describes, will undoubtedly contain bugs and other problems.  Please report such in the category struct
       :: stack of the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883].  Please also report any ideas for enhancements you may
       have for either package and/or documentation.

KEYWORDS

       graph, matrix, queue, tree

struct                                                                 1.3.3                                                      struct::stack(n)