001/*******************************************************************************
002 * This software is provided as a supplement to the authors' textbooks on digital
003 * image processing published by Springer-Verlag in various languages and editions.
004 * Permission to use and distribute this software is granted under the BSD 2-Clause
005 * "Simplified" License (see http://opensource.org/licenses/BSD-2-Clause).
006 * Copyright (c) 2006-2023 Wilhelm Burger, Mark J. Burge. All rights reserved.
007 * Visit https://imagingbook.com for additional details.
008 ******************************************************************************/
009package imagingbook.common.util.bits;
010
011import java.util.Arrays;
012
013/**
014 * This class implements {@link BitVector} with internal 32-bit {@code int} data.
015 * @author WB
016 */
017public class BitVector32 implements BitVector {
018        
019        private static final int WL = 32;
020        
021        private final int[] data;
022        private final int length;
023        
024        public BitVector32(int length) {
025                if (length <= 0) {
026                        throw new IllegalArgumentException("bit vector length must be at least 1");
027                }
028                this.length = length;
029                int n = (length % WL == 0) ? length / WL : length / WL + 1;     // word count
030                this.data = new int[n];
031        }
032        
033        public BitVector32(byte[] bytes) {
034                this(bytes.length);
035                for (int i = 0; i < bytes.length; i++) {
036                        if (bytes[i] != 0) {
037                                this.set(i);
038                        }
039                }
040        }
041        
042        public BitVector32(boolean[] bools) {
043                this(bools.length);
044                for (int i = 0; i < bools.length; i++) {
045                        this.set(i, bools[i]);
046                }
047        }
048        
049        // ---------------------------------------------------------------------
050
051        @Override
052        public int getLength() {
053                return this.length;
054        }
055        
056        @Override
057        public boolean get(int i) {
058                if (i < 0 || i >= length) {
059                        throw new IndexOutOfBoundsException("illegal index " + i);
060                }
061                final int mask = 1 << (i % WL);
062                return (data[i / WL] & mask) != 0;
063        }
064        
065        @Override
066        public void set(int i) {
067                if (i < 0 || i >= length) {
068                        throw new IndexOutOfBoundsException("illegal index " + i);
069                }
070                final int j = i / WL;   // word index
071                final int mask = 1 << (i % WL);
072                data[j] =  data[j] | mask;
073        }
074        
075        @Override
076        public void unset(int i) {
077                if (i < 0 || i >= length) {
078                        throw new IndexOutOfBoundsException("illegal index " + i);
079                }
080                final int j = i / WL;   // word index
081                final int mask = 0x01 << (i % WL);
082                data[j] =  data[j] & ~mask;
083        }
084        
085        @Override
086        public void setAll() {
087                Arrays.fill(data, ~0);
088        }
089
090        @Override
091        public void unsetAll() {
092                Arrays.fill(data, 0);
093        }
094        
095        @Override
096        public String toString() {
097                StringBuilder buf = new StringBuilder();
098                buf.append(BitVector32.class.getSimpleName() + "[");
099                for (int i = 0; i < length; i++) {
100                        buf.append(this.get(i) ? "1" : "0");
101                }
102                buf.append("]");
103                return buf.toString();
104        }
105
106}