summaryrefslogtreecommitdiffstats
path: root/src/java/com/jogamp/common/util/FloatStack.java
blob: e5790a93a6b03935d92426edc74d896cc455d281 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/**
 * Copyright 2012 JogAmp Community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of JogAmp Community.
 */
package com.jogamp.common.util;

import java.nio.BufferOverflowException;
import java.nio.BufferUnderflowException;
import java.nio./*value2*/FloatBuffer/*value2*/;

/**
 * Simple primitive-type stack.
 * <p>
 * Implemented operations:
 * <ul>
 *  <li>FILO - First In, Last Out</li>
 * </ul>
 * </p>
 */
public class /*name*/FloatStack/*name*/ implements PrimitiveStack {
    private int position;
    private /*value*/float/*value*/[] buffer;
    private int growSize;
    
    /**
     * @param initialSize initial size, must be &gt; zero
     * @param growSize grow size if {@link #position()} is reached, maybe <code>0</code>
     *        in which case an {@link IndexOutOfBoundsException} is thrown. 
     */
    public /*name*/FloatStack/*name*/(int initialSize, int growSize) {
        this.position = 0;
        this.growSize = growSize;
        this.buffer = new /*value*/float/*value*/[initialSize];
    }
    
    @Override
    public final int capacity() { return buffer.length; }
    
    @Override
    public final int position() { return position; }
    
    @Override
    public final int remaining() { return buffer.length - position; }
    
    @Override
    public final int getGrowSize() { return growSize; }
    
    @Override
    public final void setGrowSize(int newGrowSize) { growSize = newGrowSize; }
    
    public final String toString() {
        return "FloatStack[0..(top "+position+").."+buffer.length+", remaining "+remaining()+"]";
    }
    
    public final /*value*/float/*value*/[] buffer() { return buffer; }
    
    private final void growIfNecessary(int length) throws IndexOutOfBoundsException {
        if( position + length > buffer.length ) {
            if( 0 >= growSize ) {
                throw new IndexOutOfBoundsException("Out of fixed stack size: "+this);
            }
            /*value*/float/*value*/[] newBuffer = 
                    new /*value*/float/*value*/[buffer.length + growSize];
            System.arraycopy(buffer, 0, newBuffer, 0, position);
            buffer = newBuffer;
        }        
    }

    /**
     * FILO put operation
     * 
     * @param src source buffer
     * @param srcOffset offset of src 
     * @param length number of float elements to put from <code>src</code> on-top this stack 
     * @return the src float[]
     * @throws IndexOutOfBoundsException if stack cannot grow due to zero grow-size or offset+length exceeds src.
     */
    public final /*value*/float/*value*/[] 
                    putOnTop(/*value*/float/*value*/[] src, int srcOffset, int length) throws IndexOutOfBoundsException {
        growIfNecessary(length);
        System.arraycopy(src, srcOffset, buffer, position, length);
        position += length;
        return src;
    }

    /**
     * FILO put operation
     * 
     * @param src source buffer, it's position is incremented by <code>length</code>
     * @param length number of float elements to put from <code>src</code> on-top this stack 
     * @return the src FloatBuffer
     * @throws IndexOutOfBoundsException if stack cannot grow due to zero grow-size
     * @throws BufferUnderflowException if <code>src</code> FloatBuffer has less remaining elements than <code>length</code>.
     */
    public final /*value2*/FloatBuffer/*value2*/ 
                        putOnTop(/*value2*/FloatBuffer/*value2*/ src, int length) throws IndexOutOfBoundsException, BufferUnderflowException  {
        growIfNecessary(length);        
        src.get(buffer, position, length);
        position += length;
        return src;
    }
    
    /**
     * FILO get operation
     * 
     * @param dest destination buffer
     * @param destOffset offset of dest 
     * @param length number of float elements to get from-top this stack to <code>dest</code>. 
     * @return the dest float[]
     * @throws IndexOutOfBoundsException if stack or <code>dest</code> has less elements than <code>length</code>.
     */
    public final /*value*/float/*value*/[] 
                        getFromTop(/*value*/float/*value*/[] dest, int destOffset, int length) throws IndexOutOfBoundsException {
        System.arraycopy(buffer, position-length, dest, destOffset, length);
        position -= length;
        return dest;
    }
    
    /**
     * FILO get operation
     * 
     * @param dest destination buffer, it's position is incremented by <code>length</code>.
     * @param length number of float elements to get from-top this stack to <code>dest</code>.
     * @return the dest FloatBuffer
     * @throws IndexOutOfBoundsException if stack has less elements than length
     * @throws BufferOverflowException if <code>src</code> FloatBuffer has less remaining elements than <code>length</code>.
     */
    public final /*value2*/FloatBuffer/*value2*/ 
                        getFromTop(/*value2*/FloatBuffer/*value2*/ dest, int length) throws IndexOutOfBoundsException, BufferOverflowException  {
        dest.put(buffer, position-length, length);
        position -= length;
        return dest;
    }
}