From 047e9adaf2a5f51f7acfa194a744c99b6bfadaea Mon Sep 17 00:00:00 2001
From: Sven Gothel
+ * Implementation handles n == 32.
+ *
* http://www.inwap.com/pdp10/hbaker/hakmem/hakmem.html
* http://home.pipeline.com/~hbaker1/hakmem/hacks.html#item169
* http://tekpool.wordpress.com/category/bit-count/
+ * http://www.hackersdelight.org/
*
*/
- public static final int getBitCount(final int n) {
+ public static final int bitCount(int n) {
// Note: Original used 'unsigned int',
// hence we use the unsigned right-shift '>>>'
- int c = n;
- c -= (n >>> 1) & 033333333333;
- c -= (n >>> 2) & 011111111111;
- return ( (c + ( c >>> 3 ) ) & 030707070707 ) % 63;
+ /**
+ * Original does not work due to lack of 'unsigned' right-shift and modulo,
+ * we need 2-complementary solution, i.e. 'signed'.
+ int c = n;
+ c -= (n >>> 1) & 033333333333;
+ c -= (n >>> 2) & 011111111111;
+ return ( (c + ( c >>> 3 ) ) & 030707070707 ) & 0x3f; // % 63
+ */
+ // Hackers Delight, Figure 5-2, pop1 of pop.c.txt
+ n = n - ((n >>> 1) & 0x55555555);
+ n = (n & 0x33333333) + ((n >>> 2) & 0x33333333);
+ n = (n + (n >>> 4)) & 0x0f0f0f0f;
+ n = n + (n >>> 8);
+ n = n + (n >>> 16);
+ return n & 0x3f;
}
}
/**
@@ -84,12 +116,18 @@ public interface Bitfield {
/**
* Returns the storage size in bit units, e.g. 32 bit for implementations using one {@code int} field.
*/
- int getStorageBitSize();
+ int size();
+
+
+ /**
+ * Set all bits of this bitfield to the given value {@code bit}.
+ */
+ void clearField(final boolean bit);
/**
* Returns {@code length} bits from this storage,
* starting with the lowest bit from the storage position {@code lowBitnum}.
- * @param lowBitnum storage bit position of the lowest bit, restricted to [0..{@link #getStorageBitSize()}-{@code length}].
+ * @param lowBitnum storage bit position of the lowest bit, restricted to [0..{@link #size()}-{@code length}].
* @param length number of bits to read, constrained to [0..32].
* @throws IndexOutOfBoundsException if {@code rightBitnum} is out of bounds
* @see #put32(int, int, int)
@@ -99,8 +137,8 @@ public interface Bitfield {
/**
* Puts {@code length} bits of given {@code data} into this storage,
* starting w/ the lowest bit to the storage position {@code lowBitnum}.
- * @param lowBitnum storage bit position of the lowest bit, restricted to [0..{@link #getStorageBitSize()}-{@code length}].
- * @param length number of bits to read, constrained to [0..32].
+ * @param lowBitnum storage bit position of the lowest bit, restricted to [0..{@link #size()}-{@code length}].
+ * @param length number of bits to write, constrained to [0..32].
* @param data the actual bits to be put into this storage
* @throws IndexOutOfBoundsException if {@code rightBitnum} is out of bounds
* @see #get32(int, int)
@@ -114,8 +152,8 @@ public interface Bitfield {
* Implementation shall operate as if invoking {@link #get32(int, int)}
* and then {@link #put32(int, int, int)} sequentially.
*
true
if the bit at position bitnum
is set, otherwise false
.
- * @param bitnum bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+ * @param bitnum bit number, restricted to [0..{@link #size()}-1].
* @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
*/
boolean get(final int bitnum) throws IndexOutOfBoundsException;
@@ -132,21 +170,21 @@ public interface Bitfield {
/**
* Set or clear the bit at position bitnum
according to bit
* and return the previous value.
- * @param bitnum bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+ * @param bitnum bit number, restricted to [0..{@link #size()}-1].
* @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
*/
void put(final int bitnum, final boolean bit) throws IndexOutOfBoundsException;
/**
* Set the bit at position bitnum
according to bit
.
- * @param bitnum bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+ * @param bitnum bit number, restricted to [0..{@link #size()}-1].
* @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
*/
void set(final int bitnum) throws IndexOutOfBoundsException;
/**
* Clear the bit at position bitnum
according to bit
.
- * @param bitnum bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+ * @param bitnum bit number, restricted to [0..{@link #size()}-1].
* @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
*/
void clear(final int bitnum) throws IndexOutOfBoundsException;
@@ -154,17 +192,17 @@ public interface Bitfield {
/**
* Copies the bit at position {@code srcBitnum} to position {@code dstBitnum}
* and returning true
if the bit is set, otherwise false
.
- * @param srcBitnum source bit number, restricted to [0..{@link #getStorageBitSize()}-1].
- * @param dstBitnum destination bit number, restricted to [0..{@link #getStorageBitSize()}-1].
+ * @param srcBitnum source bit number, restricted to [0..{@link #size()}-1].
+ * @param dstBitnum destination bit number, restricted to [0..{@link #size()}-1].
* @throws IndexOutOfBoundsException if {@code bitnum} is out of bounds
*/
boolean copy(final int srcBitnum, final int dstBitnum) throws IndexOutOfBoundsException;
/**
- * Returns the number of set bits within this bitfield.
+ * Returns the number of one bits within this bitfield.
* - * Utilizes {#link {@link Bitfield.Util#getBitCount(int)}}. + * Utilizes {#link {@link Bitfield.Util#bitCount(int)}}. *
*/ - int getBitCount(); + int bitCount(); } diff --git a/src/java/com/jogamp/common/util/IntBitfield.java b/src/java/com/jogamp/common/util/IntBitfield.java index 3ef5bb7..e7a9d70 100644 --- a/src/java/com/jogamp/common/util/IntBitfield.java +++ b/src/java/com/jogamp/common/util/IntBitfield.java @@ -140,10 +140,10 @@ public class IntBitfield { return prev; } /** - * @deprecated Use {@link Bitfield.Util#getBitCount(int)}. + * @deprecated Use {@link Bitfield.Util#bitCount(int)}. */ public static final int getBitCount(final int n) { - return Bitfield.Util.getBitCount(n); + return Bitfield.Util.bitCount(n); } /** @@ -155,7 +155,7 @@ public class IntBitfield { public long getBitCount() { long c = 0; for(int i = storage.length-1; i>=0; i--) { - c += Bitfield.Util.getBitCount(storage[i]); + c += Bitfield.Util.bitCount(storage[i]); } return c; } diff --git a/src/java/jogamp/common/util/Int32ArrayBitfield.java b/src/java/jogamp/common/util/Int32ArrayBitfield.java index dd18b3d..3dcb9ae 100644 --- a/src/java/jogamp/common/util/Int32ArrayBitfield.java +++ b/src/java/jogamp/common/util/Int32ArrayBitfield.java @@ -44,16 +44,29 @@ public class Int32ArrayBitfield implements Bitfield { * @param storageBitSize */ public Int32ArrayBitfield(final int storageBitSize) { - final int units = Math.max(1, ( storageBitSize + 7 ) >>> UNIT_SHIFT); - this.storage = new int[units]; + final int units = Math.max(1, ( storageBitSize + 31 ) >>> UNIT_SHIFT); + this.storage = new int[units]; // initialized w/ default '0' this.bitSize = units << UNIT_SHIFT; } @Override - public int getStorageBitSize() { + public int size() { return bitSize; } + @Override + public final void clearField(final boolean bit) { + final int v; + if( bit ) { + v = Bitfield.UNSIGNED_INT_MAX_VALUE; + } else { + v = 0; + } + for(int i=storage.length-1; i>=0; i--) { + storage[i] = v; + } + } + 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); @@ -70,14 +83,14 @@ public class Int32ArrayBitfield implements Bitfield { 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; + final int m = Util.getBitMask(length); // mask of chunk return m & storage[u]; } else { // slow path - final int l = Math.min(length, left); // length of first chunk + final int l = Math.min(length, left); // length of first chunk < 32 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 + final int l2 = length - l; // length of last chunk < 32 if( l2 > 0 ) { final int m2 = ( 1 << l2 ) - 1; // mask of last chunk return d | ( ( m2 & storage[u+1] ) << l ); @@ -96,20 +109,20 @@ public class Int32ArrayBitfield implements Bitfield { 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 + final int m = Util.getBitMask(length); // 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 l = Math.min(length, left); // length of first chunk < 32 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 + final int l2 = length - l; // length of last chunk < 32 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 + storage[u+1] = ( ( ~m2 ) & storage[u+1] ) // keep non-written storage bits + | ( m2 & ( data >>> l ) ); // overwrite storage w/ used data bits } } } @@ -180,10 +193,10 @@ public class Int32ArrayBitfield implements Bitfield { } @Override - public int getBitCount() { + public int bitCount() { int c = 0; for(int i = storage.length-1; i>=0; i--) { - c += Bitfield.Util.getBitCount(storage[i]); + c += Bitfield.Util.bitCount(storage[i]); } return c; } diff --git a/src/java/jogamp/common/util/Int32Bitfield.java b/src/java/jogamp/common/util/Int32Bitfield.java index 6119a00..9bf2117 100644 --- a/src/java/jogamp/common/util/Int32Bitfield.java +++ b/src/java/jogamp/common/util/Int32Bitfield.java @@ -45,10 +45,19 @@ public class Int32Bitfield implements Bitfield { } @Override - public int getStorageBitSize() { + public int size() { return UNIT_SIZE; } + @Override + public final void clearField(final boolean bit) { + if( bit ) { + storage = Bitfield.UNSIGNED_INT_MAX_VALUE; + } else { + storage = 0; + } + } + 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); @@ -64,11 +73,11 @@ public class Int32Bitfield implements Bitfield { final int left = 32 - lowBitnum; // remaining bits of first chunk if( 32 == left ) { // fast path - final int m = ( 1 << length ) - 1; + final int m = Util.getBitMask(length); // mask of chunk return m & storage; } else { // slow path - final int l = Math.min(length, left); // length of first chunk + final int l = Math.min(length, left); // length of first chunk < 32 final int m = ( 1 << l ) - 1; // mask of first chunk return m & ( storage >>> lowBitnum ); } @@ -82,12 +91,12 @@ public class Int32Bitfield implements Bitfield { final int left = 32 - lowBitnum; // remaining bits of first chunk storage if( 32 == left ) { // fast path - final int m = ( 1 << length ) - 1; // mask of chunk + final int m = Util.getBitMask(length); // mask of chunk storage = ( ( ~m ) & storage ) // 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 l = Math.min(length, left); // length of first chunk < 32 final int m = ( 1 << l ) - 1; // mask of first chunk storage = ( ( ~( m << lowBitnum ) ) & storage ) // keep non-written storage bits | ( ( m & data ) << lowBitnum ); // overwrite storage w/ used data bits @@ -144,7 +153,7 @@ public class Int32Bitfield implements Bitfield { } @Override - public int getBitCount() { - return Bitfield.Util.getBitCount(storage); + public int bitCount() { + return Bitfield.Util.bitCount(storage); } } diff --git a/src/java/jogamp/common/util/SyncedBitfield.java b/src/java/jogamp/common/util/SyncedBitfield.java index 783fb91..488be12 100644 --- a/src/java/jogamp/common/util/SyncedBitfield.java +++ b/src/java/jogamp/common/util/SyncedBitfield.java @@ -40,8 +40,13 @@ public class SyncedBitfield implements Bitfield { } @Override - public final synchronized int getStorageBitSize() { - return impl.getStorageBitSize(); + public final synchronized int size() { + return impl.size(); + } + + @Override + public final void clearField(final boolean bit) { + impl.clearField(bit); } @Override @@ -85,7 +90,7 @@ public class SyncedBitfield implements Bitfield { } @Override - public final synchronized int getBitCount() { - return impl.getBitCount(); + public final synchronized int bitCount() { + return impl.bitCount(); } } \ No newline at end of file diff --git a/src/junit/com/jogamp/common/util/TestBitfield00.java b/src/junit/com/jogamp/common/util/TestBitfield00.java new file mode 100644 index 0000000..7f2835a --- /dev/null +++ b/src/junit/com/jogamp/common/util/TestBitfield00.java @@ -0,0 +1,379 @@ +/** + * 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 com.jogamp.common.util; + +import java.io.IOException; + +import org.junit.Test; +import org.junit.Assert; + +import com.jogamp.junit.util.SingletonJunitCase; + +import org.junit.FixMethodOrder; +import org.junit.runners.MethodSorters; + +/** + * Test basic bitfield operations for {@link Bitfield} + */ +@FixMethodOrder(MethodSorters.NAME_ASCENDING) +public class TestBitfield00 extends SingletonJunitCase { + + @Test + public void test01_BitCount32_One() { + final String[] pyramid32bit_one = BitDemoData.pyramid32bit_one; + for(int i=0; i