core/org.gnit.lucenekmp.jdkport/BitSet

BitSet

This class implements a vector of bits that grows as needed. Each component of the bit set has a boolean value. The bits of a BitSet are indexed by nonnegative integers. Individual indexed bits can be examined, set, or cleared. One BitSet may be used to modify the contents of another BitSet through logical AND, logical inclusive OR, and logical exclusive OR operations.

By default, all bits in the set initially have the value false.

Every bit set has a current size, which is the number of bits of space currently in use by the bit set. Note that the size is related to the implementation of a bit set, so it may change with implementation. The length of a bit set relates to logical length of a bit set and is defined independently of implementation.

Unless otherwise noted, passing a null parameter to any of the methods in a BitSet will result in a NullPointerException.

A BitSet is not safe for multithreaded use without external synchronization.

Author

Arthur van Hoff

Michael McCloskey

Martin Buchholz

Since

1.0

Constructors

BitSet

constructor()

Creates a new bit set. All bits are initially false.

constructor(nbits: Int)

Creates a bit set whose initial size is large enough to explicitly represent bits with indices in the range 0 through nbits-1. All bits are initially false.

Types

Companion

object Companion

Properties

isEmpty

val isEmpty: Boolean

Functions

and

fun and(set: BitSet)

Performs a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the bit set argument also had the value true.

andNot

fun andNot(set: BitSet)

Clears all of the bits in this BitSet whose corresponding bit is set in the specified BitSet.

cardinality

fun cardinality(): Int

Returns the number of bits set to true in this BitSet.

clear

fun clear()

Sets all of the bits in this BitSet to false.

fun clear(bitIndex: Int)

Sets the bit specified by the index to false.

fun clear(fromIndex: Int, toIndex: Int)

Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to false.

clone

open override fun clone(): BitSet

Returns a new BitSet that is a clone of this BitSet. The clone is a new BitSet with the same internal state.

equals

open operator override fun equals(obj: Any?): Boolean

Compares this bit set against the specified object. The result is true if and only if the argument is not null and is a BitSet object that has exactly the same set of bits set to true as this bit set. That is, for every nonnegative int index k,

flip

fun flip(bitIndex: Int)

Sets the bit at the specified index to the complement of its current value.

fun flip(fromIndex: Int, toIndex: Int)

Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.

get

operator fun get(bitIndex: Int): Boolean

Returns the value of the bit with the specified index. The value is true if the bit with the index bitIndex is currently set in this BitSet; otherwise, the result is false.

fun get(fromIndex: Int, toIndex: Int): BitSet

Returns a new BitSet composed of bits from this BitSet from fromIndex (inclusive) to toIndex (exclusive).

hashCode

open override fun hashCode(): Int

{@return the hash code value for this bit set}

intersects

fun intersects(set: BitSet): Boolean

Returns true if the specified BitSet has any bits set to true that are also set to true in this BitSet.

length

fun length(): Int

Returns the "logical size" of this BitSet: the index of the highest set bit in the BitSet plus one. Returns zero if the BitSet contains no set bits.

nextClearBit

fun nextClearBit(fromIndex: Int): Int

Returns the index of the first bit that is set to false that occurs on or after the specified starting index.

nextSetBit

fun nextSetBit(fromIndex: Int): Int

Returns the index of the first bit that is set to true that occurs on or after the specified starting index. If no such bit exists then -1 is returned.

fun or(set: BitSet)

Performs a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if it either already had the value true or the corresponding bit in the bit set argument has the value true.

previousClearBit

fun previousClearBit(fromIndex: Int): Int

Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index. If no such bit exists, or if -1 is given as the starting index, then -1 is returned.

previousSetBit

fun previousSetBit(fromIndex: Int): Int

Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index. If no such bit exists, or if -1 is given as the starting index, then -1 is returned.

set

fun set(bitIndex: Int)

Sets the bit at the specified index to true.

operator fun set(bitIndex: Int, value: Boolean)

Sets the bit at the specified index to the specified value.

fun set(fromIndex: Int, toIndex: Int)

Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to true.

fun set(fromIndex: Int, toIndex: Int, value: Boolean)

Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the specified value.

size

fun size(): Int

Returns the number of bits of space actually in use by this BitSet to represent bit values. The maximum element in the set is the size - 1st element.

toByteArray

fun toByteArray(): ByteArray

Returns a new byte array containing all the bits in this bit set.

toLongArray

fun toLongArray(): LongArray

Returns a new long array containing all the bits in this bit set.

toString

open override fun toString(): String

Returns a string representation of this bit set. For every index for which this BitSet contains a bit in the set state, the decimal representation of that index is included in the result. Such indices are listed in order from lowest to highest, separated by ", " (a comma and a space) and surrounded by braces, resulting in the usual mathematical notation for a set of integers.

trimToSize

fun trimToSize()

Attempts to reduce internal storage used for the bits in this bit set. Calling this method may, but is not required to, affect the value returned by a subsequent call to the .size method.

xor

fun xor(set: BitSet)

Performs a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if one of the following statements holds: