package org.apache.lucene.codecs.lucene40;
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.IOException;
import java.util.Arrays;
import org.apache.lucene.codecs.CodecUtil;
import org.apache.lucene.store.CompoundFileDirectory;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.IOContext;
import org.apache.lucene.store.IndexInput;
import org.apache.lucene.store.IndexOutput;
import org.apache.lucene.util.BitUtil;
import org.apache.lucene.util.IOUtils;
import org.apache.lucene.util.MutableBits;
/** Optimized implementation of a vector of bits. This is more-or-less like
* java.util.BitSet, but also includes the following:
* <ul>
* <li>a count() method, which efficiently computes the number of one bits;</li>
* <li>optimized read from and write to disk;</li>
* <li>inlinable get() method;</li>
* <li>store and load, as bit set or d-gaps, depending on sparseness;</li>
* </ul>
*
* @lucene.internal
*/
// pkg-private: if this thing is generally useful then it can go back in .util,
// but the serialization must be here underneath the codec.
final class BitVector implements Cloneable, MutableBits {
private byte[] bits;
private int size;
private int count;
private int version;
/** Constructs a vector capable of holding <code>n</code> bits. */
public BitVector(int n) {
size = n;
bits = new byte[getNumBytes(size)];
count = 0;
}
BitVector(byte[] bits, int size) {
this.bits = bits;
this.size = size;
count = -1;
}
private int getNumBytes(int size) {
int bytesLength = size >>> 3;
if ((size & 7) != 0) {
bytesLength++;
}
return bytesLength;
}
@Override
public BitVector clone() {
byte[] copyBits = new byte[bits.length];
System.arraycopy(bits, 0, copyBits, 0, bits.length);
BitVector clone = new BitVector(copyBits, size);
clone.count = count;
return clone;
}
/** Sets the value of <code>bit</code> to one. */
public final void set(int bit) {
if (bit >= size) {
throw new ArrayIndexOutOfBoundsException("bit=" + bit + " size=" + size);
}
bits[bit >> 3] |= 1 << (bit & 7);
count = -1;
}
/** Sets the value of <code>bit</code> to true, and
* returns true if bit was already set */
public final boolean getAndSet(int bit) {
if (bit >= size) {
throw new ArrayIndexOutOfBoundsException("bit=" + bit + " size=" + size);
}
final int pos = bit >> 3;
final int v = bits[pos];
final int flag = 1 << (bit & 7);
if ((flag & v) != 0)
return true;
else {
bits[pos] = (byte) (v | flag);
if (count != -1) {
count++;
assert count <= size;
}
return false;
}
}
/** Sets the value of <code>bit</code> to zero. */
@Override
public final void clear(int bit) {
if (bit >= size) {
throw new ArrayIndexOutOfBoundsException(bit);
}
bits[bit >> 3] &= ~(1 << (bit & 7));
count = -1;
}
public final boolean getAndClear(int bit) {
if (bit >= size) {
throw new ArrayIndexOutOfBoundsException(bit);
}
final int pos = bit >> 3;
final int v = bits[pos];
final int flag = 1 << (bit & 7);
if ((flag & v) == 0) {
return false;
} else {
bits[pos] &= ~flag;
if (count != -1) {
count--;
assert count >= 0;
}
return true;
}
}
/** Returns <code>true</code> if <code>bit</code> is one and
<code>false</code> if it is zero. */
@Override
public final boolean get(int bit) {
assert bit >= 0 && bit < size: "bit " + bit + " is out of bounds 0.." + (size-1);
return (bits[bit >> 3] & (1 << (bit & 7))) != 0;
}
/** Returns the number of bits in this vector. This is also one greater than
the number of the largest valid bit number. */
public final int size() {
return size;
}
@Override
public int length() {
return size;
}
/** Returns the total number of one bits in this vector. This is efficiently
computed and cached, so that, if the vector is not changed, no
recomputation is done for repeated calls. */
public final int count() {
// if the vector has been modified
if (count == -1) {
int c = 0;
int end = bits.length;
for (int i = 0; i < end; i++) {
c += BitUtil.bitCount(bits[i]); // sum bits per byte
}
count = c;
}
assert count <= size: "count=" + count + " size=" + size;
return count;
}
/** For testing */
public final int getRecomputedCount() {
int c = 0;
int end = bits.length;
for (int i = 0; i < end; i++) {
c += BitUtil.bitCount(bits[i]); // sum bits per byte
}
return c;
}
private static String CODEC = "BitVector";
// Version before version tracking was added:
public final static int VERSION_PRE = -1;
// First version:
public final static int VERSION_START = 0;
// Changed DGaps to encode gaps between cleared bits, not
// set:
public final static int VERSION_DGAPS_CLEARED = 1;
// Increment version to change it:
public final static int VERSION_CURRENT = VERSION_DGAPS_CLEARED;
public int getVersion() {
return version;
}
/** Writes this vector to the file <code>name</code> in Directory
<code>d</code>, in a format that can be read by the constructor {@link
#BitVector(Directory, String, IOContext)}. */
public final void write(Directory d, String name, IOContext context) throws IOException {
assert !(d instanceof CompoundFileDirectory);
IndexOutput output = d.createOutput(name, context);
try {
output.writeInt(-2);
CodecUtil.writeHeader(output, CODEC, VERSION_CURRENT);
if (isSparse()) {
// sparse bit-set more efficiently saved as d-gaps.
writeClearedDgaps(output);
} else {
writeBits(output);
}
assert verifyCount();
} finally {
IOUtils.close(output);
}
}
/** Invert all bits */
public void invertAll() {
if (count != -1) {
count = size - count;
}
if (bits.length > 0) {
for(int idx=0;idx<bits.length;idx++) {
bits[idx] = (byte) (~bits[idx]);
}
clearUnusedBits();
}
}
private void clearUnusedBits() {
// Take care not to invert the "unused" bits in the
// last byte:
if (bits.length > 0) {
final int lastNBits = size & 7;
if (lastNBits != 0) {
final int mask = (1 << lastNBits)-1;
bits[bits.length-1] &= mask;
}
}
}
/** Set all bits */
public void setAll() {
Arrays.fill(bits, (byte) 0xff);
clearUnusedBits();
count = size;
}
/** Write as a bit set */
private void writeBits(IndexOutput output) throws IOException {
output.writeInt(size()); // write size
output.writeInt(count()); // write count
output.writeBytes(bits, bits.length);
}
/** Write as a d-gaps list */
private void writeClearedDgaps(IndexOutput output) throws IOException {
output.writeInt(-1); // mark using d-gaps
output.writeInt(size()); // write size
output.writeInt(count()); // write count
int last=0;
int numCleared = size()-count();
for (int i=0; i<bits.length && numCleared>0; i++) {
if (bits[i] != (byte) 0xff) {
output.writeVInt(i-last);
output.writeByte(bits[i]);
last = i;
numCleared -= (8-BitUtil.bitCount(bits[i]));
assert numCleared >= 0 || (i == (bits.length-1) && numCleared == -(8-(size&7)));
}
}
}
/** Indicates if the bit vector is sparse and should be saved as a d-gaps list, or dense, and should be saved as a bit set. */
private boolean isSparse() {
final int clearedCount = size() - count();
if (clearedCount == 0) {
return true;
}
final int avgGapLength = bits.length / clearedCount;
// expected number of bytes for vInt encoding of each gap
final int expectedDGapBytes;
if (avgGapLength <= (1<< 7)) {
expectedDGapBytes = 1;
} else if (avgGapLength <= (1<<14)) {
expectedDGapBytes = 2;
} else if (avgGapLength <= (1<<21)) {
expectedDGapBytes = 3;
} else if (avgGapLength <= (1<<28)) {
expectedDGapBytes = 4;
} else {
expectedDGapBytes = 5;
}
// +1 because we write the byte itself that contains the
// set bit
final int bytesPerSetBit = expectedDGapBytes + 1;
// note: adding 32 because we start with ((int) -1) to indicate d-gaps format.
final long expectedBits = 32 + 8 * bytesPerSetBit * clearedCount;
// note: factor is for read/write of byte-arrays being faster than vints.
final long factor = 10;
return factor * expectedBits < size();
}
/** Constructs a bit vector from the file <code>name</code> in Directory
<code>d</code>, as written by the {@link #write} method.
*/
public BitVector(Directory d, String name, IOContext context) throws IOException {
IndexInput input = d.openInput(name, context);
try {
final int firstInt = input.readInt();
if (firstInt == -2) {
// New format, with full header & version:
version = CodecUtil.checkHeader(input, CODEC, VERSION_START, VERSION_CURRENT);
size = input.readInt();
} else {
version = VERSION_PRE;
size = firstInt;
}
if (size == -1) {
if (version >= VERSION_DGAPS_CLEARED) {
readClearedDgaps(input);
} else {
readSetDgaps(input);
}
} else {
readBits(input);
}
if (version < VERSION_DGAPS_CLEARED) {
invertAll();
}
assert verifyCount();
} finally {
input.close();
}
}
// asserts only
private boolean verifyCount() {
assert count != -1;
final int countSav = count;
count = -1;
assert countSav == count(): "saved count was " + countSav + " but recomputed count is " + count;
return true;
}
/** Read as a bit set */
private void readBits(IndexInput input) throws IOException {
count = input.readInt(); // read count
bits = new byte[getNumBytes(size)]; // allocate bits
input.readBytes(bits, 0, bits.length);
}
/** read as a d-gaps list */
private void readSetDgaps(IndexInput input) throws IOException {
size = input.readInt(); // (re)read size
count = input.readInt(); // read count
bits = new byte[getNumBytes(size)]; // allocate bits
int last=0;
int n = count();
while (n>0) {
last += input.readVInt();
bits[last] = input.readByte();
n -= BitUtil.bitCount(bits[last]);
assert n >= 0;
}
}
/** read as a d-gaps cleared bits list */
private void readClearedDgaps(IndexInput input) throws IOException {
size = input.readInt(); // (re)read size
count = input.readInt(); // read count
bits = new byte[getNumBytes(size)]; // allocate bits
Arrays.fill(bits, (byte) 0xff);
clearUnusedBits();
int last=0;
int numCleared = size()-count();
while (numCleared>0) {
last += input.readVInt();
bits[last] = input.readByte();
numCleared -= 8-BitUtil.bitCount(bits[last]);
assert numCleared >= 0 || (last == (bits.length-1) && numCleared == -(8-(size&7)));
}
}
}