01: /*
02: * Primitive Collections for Java.
03: * Copyright (C) 2003 Søren Bak
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library; if not, write to the Free Software
17: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18: */
19: package bak.pcj.list;
20:
21: import java.util.Stack; // Workaround for bug in Javadoc 1.3.
22:
23: /**
24: * This interface represents stacks of float values.
25: *
26: * @see java.util.Stack
27: * @see FloatDeque
28: *
29: * @author Søren Bak
30: * @version 1.1 2003/15/2
31: * @since 1.0
32: */
33: public interface FloatStack extends FloatList {
34:
35: /**
36: * Pushes a specified element onto this stack.
37: *
38: * @param v
39: * the element to push onto this stack.
40: */
41: void push(float v);
42:
43: /**
44: * Pops an element off this stack.
45: *
46: * @return the element that was popped off this stack.
47: *
48: * @throws IndexOutOfBoundsException
49: * if the stack is empty.
50: *
51: * @see #peek()
52: */
53: float pop();
54:
55: /**
56: * Returns the top element of this stack.
57: *
58: * @return the top element of this stack.
59: *
60: * @throws IndexOutOfBoundsException
61: * if the stack is empty.
62: *
63: * @see #pop()
64: */
65: float peek();
66:
67: }
|