summaryrefslogtreecommitdiffstats
path: root/src/java/jogamp/common/util/Int32ArrayBitfield.java
blob: dd18b3d9c0afd89f514fc29ddd6fca36e99c4959 (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
/**
 * Copyright 2015 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 jogamp.common.util;

import com.jogamp.common.util.Bitfield;

/**
 * Simple bitfield interface for efficient storage access in O(1).
 * <p>
 * Implementation uses a 32bit integer array for storage.
 * </p>
 */
public class Int32ArrayBitfield implements Bitfield {
    private static final int UNIT_SHIFT = 5;
    private final int[] storage;
    private final int bitSize;

    /**
     * @param storageBitSize
     */
    public Int32ArrayBitfield(final int storageBitSize) {
        final int units = Math.max(1, ( storageBitSize + 7 ) >>> UNIT_SHIFT);
        this.storage = new int[units];
        this.bitSize = units << UNIT_SHIFT;
    }

    @Override
    public int getStorageBitSize() {
        return bitSize;
    }

    private static final void check(final int size, final int bitnum) throws IndexOutOfBoundsException {
        if( 0 > bitnum || bitnum >= size ) {
            throw new IndexOutOfBoundsException("Bitnum should be within [0.."+(size-1)+"], but is "+bitnum);
        }
    }

    @Override
    public final int get32(final int lowBitnum, final int length) throws IndexOutOfBoundsException {
        if( 0 > length || length > 32 ) {
            throw new IndexOutOfBoundsException("length should be within [0..32], but is "+length);
        }
        check(bitSize-length+1, lowBitnum);
        final int u = lowBitnum >>> UNIT_SHIFT;
        final int left = 32 - ( lowBitnum - ( u << UNIT_SHIFT ) ); // remaining bits of first chunk storage
        if( 32 == left ) {
            // fast path
            final int m = ( 1 << length ) - 1;
            return m & storage[u];
        } else {
            // slow path
            final int l = Math.min(length, left);    // length of first chunk
            final int m = ( 1 << l ) - 1;            // mask of first chunk
            final int d = m & ( storage[u] >>> lowBitnum );
            final int l2 = length - l;               // length of last chunk
            if( l2 > 0 ) {
                final int m2 = ( 1 << l2 ) - 1;      // mask of last chunk
                return d | ( ( m2 & storage[u+1] ) << l );
            } else {
                return d;
            }
        }
    }
    @Override
    public final void put32(final int lowBitnum, final int length, final int data) throws IndexOutOfBoundsException {
        if( 0 > length || length > 32 ) {
            throw new IndexOutOfBoundsException("length should be within [0..32], but is "+length);
        }
        check(bitSize-length+1, lowBitnum);
        final int u = lowBitnum >>> UNIT_SHIFT;
        final int left = 32 - ( lowBitnum - ( u << UNIT_SHIFT ) ); // remaining bits of first chunk storage
        if( 32 == left ) {
            // fast path
            final int m = ( 1 << length ) - 1;       // mask of chunk
            storage[u] = ( ( ~m ) & storage[u] )     // keep non-written storage bits
                         | ( m & data );             // overwrite storage w/ used data bits
        } else {
            // slow path
            final int l = Math.min(length, left);    // length of first chunk
            final int m = ( 1 << l ) - 1;            // mask of first chunk
            storage[u] = ( ( ~( m << lowBitnum ) ) & storage[u] ) // keep non-written storage bits
                         | ( ( m & data ) << lowBitnum );         // overwrite storage w/ used data bits
            final int l2 = length - l;               // length of last chunk
            if( l2 > 0 ) {
                final int m2 = ( 1 << l2 ) - 1;      // mask of last chunk
                storage[u] = ( ( ~m2 ) & storage[u+1] ) // keep non-written storage bits
                             | ( m2 & ( data >>> l ) ); // overwrite storage w/ used data bits
            }
        }
    }
    @Override
    public final int copy32(final int srcBitnum, final int dstBitnum, final int length) throws IndexOutOfBoundsException {
        final int data = get32(srcBitnum, length);
        put32(dstBitnum, length, data);
        return data;
    }

    @Override
    public final boolean get(final int bitnum) throws IndexOutOfBoundsException {
        check(bitSize, bitnum);
        final int u = bitnum >>> UNIT_SHIFT;
        final int b = bitnum - ( u << UNIT_SHIFT );
        return 0 != ( storage[u] & ( 1 << b ) ) ;
    }

    @Override
    public final void put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException {
        check(bitSize, bitnum);
        final int u = bitnum >>> UNIT_SHIFT;
        final int b = bitnum - ( u << UNIT_SHIFT );
        final int m = 1 << b;
        if( bit ) {
            storage[u] |=  m;
        } else {
            storage[u] &= ~m;
        }
    }
    @Override
    public final void set(final int bitnum) throws IndexOutOfBoundsException {
        check(bitSize, bitnum);
        final int u = bitnum >>> UNIT_SHIFT;
        final int b = bitnum - ( u << UNIT_SHIFT );
        final int m = 1 << b;
        storage[u] |=  m;
    }
    @Override
    public final void clear(final int bitnum) throws IndexOutOfBoundsException {
        check(bitSize, bitnum);
        final int u = bitnum >>> UNIT_SHIFT;
        final int b = bitnum - ( u << UNIT_SHIFT );
        final int m = 1 << b;
        storage[u] &= ~m;
    }
    @Override
    public final boolean copy(final int srcBitnum, final int dstBitnum) throws IndexOutOfBoundsException {
        check(bitSize, srcBitnum);
        check(bitSize, dstBitnum);
        final boolean bit;
        // get
        {
            final int u = srcBitnum >>> UNIT_SHIFT;
            final int b = srcBitnum - ( u << UNIT_SHIFT );
            bit = 0 != ( storage[u] & ( 1 << b ) ) ;
        }
        // put
        final int u = dstBitnum >>> UNIT_SHIFT;
        final int b = dstBitnum - ( u << UNIT_SHIFT );
        final int m = 1 << b;
        if( bit ) {
            storage[u] |=  m;
        } else {
            storage[u] &= ~m;
        }
        return bit;
    }

    @Override
    public int getBitCount() {
        int c = 0;
        for(int i = storage.length-1; i>=0; i--) {
            c += Bitfield.Util.getBitCount(storage[i]);
        }
        return c;
    }
}