remove

Calc Software Package for Number Calc

NAME
    remove - remove the last member of a list

SYNOPSIS
    remove(lst)

TYPES
    lst		lvalue whose current value is a list

    return	any

DESCRIPTION
    If lst has no members, remove(lst) returns the null value and does
    not change lst.

    If lst has n members where n > 0, remove(lst) returns the value of
    lst[[n-1]] and deletes this value from the end of the lst, so that
    lst now has n - 1 members and for 0 <= i < n - 1, lst[[i]] returns
    what it would have returned before the remove operation.

EXAMPLE
    ; lst = list(2,"three")

    list (2 elements, 2 nonzero):
      [[0]] = 2
      [[1]] = "three"

    ; remove(lst)
	    "three"
    ; print lst

    list (1 elements, 1 nonzero):
      [[0]] = 2

    ; remove(lst)
	    2
    ; print lst
    list (0 elements, 0 nonzero)
    ; remove(lst)
    ; print lst
    list (0 elements, 0 nonzero)

LIMITS
    none

LINK LIBRARY
    none

SEE ALSO
     append, delete, insert, islist, pop, push, rsearch, search,
     select, size

## Copyright (C) 1999-2006  Landon Curt Noll
##
## Calc is open software; you can redistribute it and/or modify it under
## the terms of the version 2.1 of the GNU Lesser General Public License
## as published by the Free Software Foundation.
##
## Calc 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 Lesser General
## Public License for more details.
##
## A copy of version 2.1 of the GNU Lesser General Public License is
## distributed with calc under the filename COPYING-LGPL.  You should have
## received a copy with calc; if not, write to Free Software Foundation, Inc.
## 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
##
## @(#) $Revision: 29.4 $
## @(#) $Id: remove,v 29.4 2006/06/25 22:16:55 chongo Exp $
## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/remove,v $
##
## Under source code control:	1996/03/12 23:10:01
## File existed as early as:	1996
##
## chongo <was here> /\oo/\	http://www.isthe.com/chongo/
## Share and enjoy!  :-)	http://www.isthe.com/chongo/tech/comp/calc/