aboutsummaryrefslogtreecommitdiffstats
path: root/src/junit/com/jogamp/common/util/RingBuffer01Base.java
blob: ced94dcf89823402b432c8e266dad9b40b8f40fe (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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/**
 * Copyright 2013 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 org.junit.Assert;
import org.junit.Test;

import com.jogamp.common.util.Ringbuffer;

public abstract class RingBuffer01Base {
    private static boolean DEBUG = false;

    public abstract Ringbuffer<Integer> createEmpty(int initialCapacity);
    public abstract Ringbuffer<Integer> createFull(Integer[] source);

    public Integer[] createIntArray(final int capacity, final int startValue) {
        final Integer[] array = new Integer[capacity];
        for(int i=0; i<capacity; i++) {
            array[i] = Integer.valueOf(startValue+i);
        }
        return array;
    }

    private void readTestImpl(final Ringbuffer<Integer> rb, final boolean clearRef, final int capacity, final int len, final int startValue) {
        final int preSize = rb.size();
        Assert.assertEquals("Wrong capacity "+rb, capacity, rb.capacity());
        Assert.assertTrue("Too low capacity to read "+len+" elems: "+rb, capacity-len >= 0);
        Assert.assertTrue("Too low size to read "+len+" elems: "+rb, preSize >= len);
        Assert.assertTrue("Is empty "+rb, !rb.isEmpty());

        for(int i=0; i<len; i++) {
            final Integer vI = rb.get();
            Assert.assertNotNull("Empty at read #"+(i+1)+": "+rb, vI);
            Assert.assertEquals("Wrong value at read #"+(i+1)+": "+rb, startValue+i, vI.intValue());
        }

        Assert.assertEquals("Invalid size "+rb, preSize-len, rb.size());
        Assert.assertTrue("Invalid free slots after reading "+len+": "+rb, rb.getFreeSlots()>= len);
        Assert.assertTrue("Is full "+rb, !rb.isFull());
    }

    private void writeTestImpl(final Ringbuffer<Integer> rb, final int capacity, final int len, final int startValue) {
        final int preSize = rb.size();

        Assert.assertEquals("Wrong capacity "+rb, capacity, rb.capacity());
        Assert.assertTrue("Too low capacity to write "+len+" elems: "+rb, capacity-len >= 0);
        Assert.assertTrue("Too low size to write "+len+" elems: "+rb, preSize+len <= capacity);
        Assert.assertTrue("Is full "+rb, !rb.isFull());

        for(int i=0; i<len; i++) {
            Assert.assertTrue("Buffer is full at put #"+i+": "+rb, rb.put( Integer.valueOf(startValue+i) ));
        }

        Assert.assertEquals("Invalid size "+rb, preSize+len, rb.size());
        Assert.assertTrue("Is empty "+rb, !rb.isEmpty());
    }

    private void moveGetPutImpl(final Ringbuffer<Integer> rb, final int pos) {
        Assert.assertTrue("RB is empty "+rb, !rb.isEmpty());
        for(int i=0; i<pos; i++) {
            Assert.assertEquals("MoveFull.get failed "+rb, i, rb.get().intValue());
            Assert.assertTrue("MoveFull.put failed "+rb, rb.put(i));
        }
    }

    private void movePutGetImpl(final Ringbuffer<Integer> rb, final int pos) {
        Assert.assertTrue("RB is full "+rb, !rb.isFull());
        for(int i=0; i<pos; i++) {
            Assert.assertTrue("MoveEmpty.put failed "+rb, rb.put(600+i));
            Assert.assertEquals("MoveEmpty.get failed "+rb, 600+i, rb.get().intValue());
        }
    }

    @Test
    public void test01_FullRead() {
        final int capacity = 11;
        final Integer[] source = createIntArray(capacity, 0);
        final Ringbuffer<Integer> rb = createFull(source);
        Assert.assertEquals("Not full size "+rb, capacity, rb.size());
        Assert.assertTrue("Not full "+rb, rb.isFull());

        readTestImpl(rb, true, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
    }

    @Test
    public void test02_EmptyWrite() {
        final int capacity = 11;
        final Ringbuffer<Integer> rb = createEmpty(capacity);
        Assert.assertEquals("Not zero size "+rb, 0, rb.size());
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());

        writeTestImpl(rb, capacity, capacity, 0);
        Assert.assertEquals("Not full size "+rb, capacity, rb.size());
        Assert.assertTrue("Not full "+rb, rb.isFull());

        readTestImpl(rb, true, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
    }

    @Test
    public void test03_FullReadReset() {
        final int capacity = 11;
        final Integer[] source = createIntArray(capacity, 0);
        final Ringbuffer<Integer> rb = createFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        rb.resetFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        readTestImpl(rb, false, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());

        rb.resetFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        readTestImpl(rb, false, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
    }

    @Test
    public void test04_EmptyWriteClear() {
        final int capacity = 11;
        final Ringbuffer<Integer> rb = createEmpty(capacity);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());

        rb.clear();
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());

        writeTestImpl(rb, capacity, capacity, 0);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        readTestImpl(rb, false, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());

        rb.clear();
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());

        writeTestImpl(rb, capacity, capacity, 0);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        readTestImpl(rb, false, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
    }

    @Test
    public void test05_ReadResetMid01() {
        final int capacity = 11;
        final Integer[] source = createIntArray(capacity, 0);
        final Ringbuffer<Integer> rb = createFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        rb.resetFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        readTestImpl(rb, false, capacity, 5, 0);
        Assert.assertTrue("Is empty "+rb, !rb.isEmpty());
        Assert.assertTrue("Is Full "+rb, !rb.isFull());

        if( DEBUG ) {
            rb.dump(System.err, "ReadReset01["+5+"].pre0");
        }
        rb.resetFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());
        if( DEBUG ) {
            rb.dump(System.err, "ReadReset01["+5+"].post");
        }

        readTestImpl(rb, false, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
    }

    @Test
    public void test06_ReadResetMid02() {
        final int capacity = 11;
        final Integer[] source = createIntArray(capacity, 0);
        final Ringbuffer<Integer> rb = createFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        rb.resetFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());

        moveGetPutImpl(rb, 5);
        // readTestImpl(rb, false, capacity, 5, 0);
        // Assert.assertTrue("Is empty "+rb, !rb.isEmpty());
        // Assert.assertTrue("Is Full "+rb, !rb.isFull());

        if( DEBUG ) {
            rb.dump(System.err, "ReadReset02["+5+"].pre0");
        }
        rb.resetFull(source);
        Assert.assertTrue("Not full "+rb, rb.isFull());
        if( DEBUG ) {
            rb.dump(System.err, "ReadReset02["+5+"].post");
        }

        readTestImpl(rb, false, capacity, capacity, 0);
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
    }

    private void test_GrowEmptyImpl(final int initCapacity, final int pos) {
        final int growAmount = 5;
        final int grownCapacity = initCapacity+growAmount;
        final Integer[] growArray = new Integer[growAmount];
        for(int i=0; i<growAmount; i++) {
            growArray[i] = Integer.valueOf(100+i);
        }
        final Ringbuffer<Integer> rb = createEmpty(initCapacity);

        if( DEBUG ) {
            rb.dump(System.err, "GrowEmpty["+pos+"].pre0");
        }
        movePutGetImpl(rb, pos);
        if( DEBUG ) {
            rb.dump(System.err, "GrowEmpty["+pos+"].pre1");
        }
        rb.growEmptyBuffer(growArray);
        if( DEBUG ) {
            rb.dump(System.err, "GrowEmpty["+pos+"].post");
        }

        Assert.assertEquals("Wrong capacity "+rb, grownCapacity, rb.capacity());
        Assert.assertEquals("Not growAmount size "+rb, growAmount, rb.size());
        Assert.assertTrue("Is full "+rb, !rb.isFull());
        Assert.assertTrue("Is empty "+rb, !rb.isEmpty());

        for(int i=0; i<growAmount; i++) {
            final Integer vI = rb.get();
            Assert.assertNotNull("Empty at read #"+(i+1)+": "+rb, vI);
            Assert.assertEquals("Wrong value at read #"+(i+1)+": "+rb, 100+i, vI.intValue());
        }

        Assert.assertEquals("Not zero size "+rb, 0, rb.size());
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
        Assert.assertTrue("Is full "+rb, !rb.isFull());
    }
    @Test
    public void test10_GrowEmpty01_Begin() {
        test_GrowEmptyImpl(11, 0);
    }
    @Test
    public void test11_GrowEmpty02_Begin2() {
        test_GrowEmptyImpl(11, 0+2);
    }
    @Test
    public void test12_GrowEmpty03_End() {
        test_GrowEmptyImpl(11, 11-1);
    }
    @Test
    public void test13_GrowEmpty04_End2() {
        test_GrowEmptyImpl(11, 11-1-2);
    }

    private void test_GrowFullImpl(final int initCapacity, final int pos, final boolean debug) {
        final int growAmount = 5;
        final int grownCapacity = initCapacity+growAmount;
        final Integer[] source = createIntArray(initCapacity, 0);
        final Ringbuffer<Integer> rb = createFull(source);

        if( DEBUG || debug ) {
            rb.dump(System.err, "GrowFull["+pos+"].pre0");
        }
        moveGetPutImpl(rb, pos);
        if( DEBUG || debug ) {
            rb.dump(System.err, "GrowFull["+pos+"].pre1");
        }
        rb.growFullBuffer(growAmount);
        if( DEBUG || debug ) {
            rb.dump(System.err, "GrowFull["+pos+"].post");
        }

        Assert.assertEquals("Wrong capacity "+rb, grownCapacity, rb.capacity());
        Assert.assertEquals("Not orig size "+rb, initCapacity, rb.size());
        Assert.assertTrue("Is full "+rb, !rb.isFull());
        Assert.assertTrue("Is empty "+rb, !rb.isEmpty());

        for(int i=0; i<growAmount; i++) {
            Assert.assertTrue("Buffer is full at put #"+i+": "+rb, rb.put( Integer.valueOf(100+i) ));
        }
        Assert.assertEquals("Not new size "+rb, grownCapacity, rb.size());
        Assert.assertTrue("Not full "+rb, rb.isFull());

        for(int i=0; i<initCapacity; i++) {
            final Integer vI = rb.get();
            Assert.assertNotNull("Empty at read #"+(i+1)+": "+rb, vI);
            Assert.assertEquals("Wrong value at read #"+(i+1)+": "+rb, (pos+i)%initCapacity, vI.intValue());
        }
        for(int i=0; i<growAmount; i++) {
            final Integer vI = rb.get();
            Assert.assertNotNull("Empty at read #"+(i+1)+": "+rb, vI);
            Assert.assertEquals("Wrong value at read #"+(i+1)+": "+rb, 100+i, vI.intValue());
        }

        Assert.assertEquals("Not zero size "+rb, 0, rb.size());
        Assert.assertTrue("Not empty "+rb, rb.isEmpty());
        Assert.assertTrue("Is full "+rb, !rb.isFull());
    }
    @Test
    public void test20_GrowFull01_Begin() {
        test_GrowFullImpl(11, 0, false);
    }
    @Test
    public void test21_GrowFull02_Begin1() {
        test_GrowFullImpl(11, 0+1, false);
    }
    @Test
    public void test22_GrowFull03_Begin2() {
        test_GrowFullImpl(11, 0+2, false);
    }
    @Test
    public void test23_GrowFull04_Begin3() {
        test_GrowFullImpl(11, 0+3, false);
    }
    @Test
    public void test24_GrowFull05_End() {
        test_GrowFullImpl(11, 11-1, false);
    }
    @Test
    public void test25_GrowFull11_End1() {
        test_GrowFullImpl(11, 11-1-1, false);
    }
    @Test
    public void test26_GrowFull12_End2() {
        test_GrowFullImpl(11, 11-1-2, false);
    }
    @Test
    public void test27_GrowFull13_End3() {
        test_GrowFullImpl(11, 11-1-3, false);
    }
}