BitSet (Java Platform SE 7)

java.lang.Object
- java.util.BitSet

すべての実装されたインタフェース:

Serializable、Cloneable
```
public class BitSet
extends Object
implements Cloneable, Serializable
```
このクラスは、必要に応じて大きくなるビットベクトルを実装します。ビットセットの各コンポーネントは、boolean 値を持ちます。BitSet のビットには、負でない整数のインデックスが付けられます。インデックスが付けられた個別のビットは、試験したり、設定したり、クリアしたりできます。また、論理積、包含的論理和、および排他的論理和の演算を行うと、ある BitSet を使って別の BitSet の内容を変更できます。
デフォルトでは、セットのすべてのビットは初期値として false を持ちます。
ビットセットの、現在のサイズは、そのビットセットによって現在使用されているスペースのビット数です。このサイズはビットセットの実装と関連するので、サイズは実装によって変わる場合があります。ビットセットの長さはビットセットの論理的な長さと関連し、実装とは関係なく定義されます。
特に明記されていないかぎり、null パラメータを BitSet のメソッドに渡すと、NullPointerException がスローされます。
BitSet が、外部の同期化を行わずにマルチスレッドを使用するのは安全ではありません。

導入されたバージョン:

JDK1.0

関連項目:
直列化された形式

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`BitSet()` 新規ビットセットを作成します。
`BitSet(int nbits)` `0` - `nbits-1` の範囲のインデックスを持つビットを明示的に表すために十分な初期サイズを持つビットセットを作成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`void`	`and(BitSet set)` ターゲットビットセットと引数ビットセットの論理積を取ります。
`void`	`andNot(BitSet set)` 対応するビットが、指定された `BitSet` 内に設定されているこの `BitSet` 内のすべてのビットをクリアします。
`int`	`cardinality()` この `BitSet` で、`true` に設定されたビットの数を返します。
`void`	`clear()` この BitSet 内のビットをすべて `false` に設定します。
`void`	`clear(int bitIndex)` インデックスで指定されたビットを `false` に設定します。
`void`	`clear(int fromIndex, int toIndex)` 指定された `fromIndex` (これを含む) から指定された `toIndex` (これを含まない) までのビットを `false` に設定します。
`Object`	`clone()` この `BitSet` をクローニングして、それと同等の新しい `BitSet` を作成します。
`boolean`	`equals(Object obj)` このオブジェクトと指定されたオブジェクトを比較します。
`void`	`flip(int bitIndex)` 現在値の補数に指定されたインデックスのビットを設定します。
`void`	`flip(int fromIndex, int toIndex)` 指定された `fromIndex` (これを含む) から指定された `toIndex` (これを含まない) までの各ビットをその現在値の補数に設定します。
`boolean`	`get(int bitIndex)` 指定されたインデックスを持つビットの値を返します。
`BitSet`	`get(int fromIndex, int toIndex)` この `BitSet` からのビットで構成される新規 `BitSet` を `fromIndex` (これを含む) から `toIndex` (これを含まない) まで返します。
`int`	`hashCode()` このビットセットのハッシュコード値を返します。
`boolean`	`intersects(BitSet set)` この `BitSet` でも `true` に設定された、`true` 設定のビットが、指定された `BitSet` にある場合、true を返します。
`boolean`	`isEmpty()` この `BitSet` に `true` に設定されたビットが含まれていない場合は、true を返します。
`int`	`length()` この `BitSet` の「論理サイズ」、つまり `BitSet` の最上位セットビットのインデックスに 1 を加えた値を返します。
`int`	`nextClearBit(int fromIndex)` 指定された開始インデックス時、またはそのインデックス後に生じる、`false` に設定された最初のビットのインデックスを返します。
`int`	`nextSetBit(int fromIndex)` 指定された開始インデックス時、またはそのインデックス後に生じる、`true` に設定された最初のビットのインデックスを返します。
`void`	`or(BitSet set)` ビットセットとビットセット引数の論理和を取ります。
`int`	`previousClearBit(int fromIndex)` 指定された開始インデックス時、またはそのインデックス前に生じる、`false` に設定されたもっとも近いビットのインデックスを返します。
`int`	`previousSetBit(int fromIndex)` 指定された開始インデックス時、またはそのインデックス前に生じる、`true` に設定されたもっとも近いビットのインデックスを返します。
`void`	`set(int bitIndex)` 指定されたインデックスのビットを `true` に設定します。
`void`	`set(int bitIndex, boolean value)` 指定されたインデックスのビットを指定された値に設定します。
`void`	`set(int fromIndex, int toIndex)` 指定された `fromIndex` (これを含む) から指定された `toIndex` (これを含まない) までのビットを `true` に設定します。
`void`	`set(int fromIndex, int toIndex, boolean value)` 指定された `fromIndex` (これを含む) から指定された `toIndex` (これを含まない) までのビットを指定された値に設定します。
`int`	`size()` この `BitSet` でビット値を表すために実際に使用しているビットの数を返します。
`byte[]`	`toByteArray()` このビットセット内のすべてのビットを含む新しいバイト配列を返します。
`long[]`	`toLongArray()` このビットセット内のすべてのビットを含む新しい long 配列を返します。
`String`	`toString()` ビットセットの文字列表現を返します。
`static BitSet`	`valueOf(byte[] bytes)` 指定されたバイト配列内のすべてのビットを含む新しいビットセットを返します。
`static BitSet`	`valueOf(ByteBuffer bb)` 指定された byte バッファー内の、その位置から上限までのすべてのビットを含む新しいビットセットを返します。
`static BitSet`	`valueOf(long[] longs)` 指定された long 配列内のすべてのビットを含む新しいビットセットを返します。
`static BitSet`	`valueOf(LongBuffer lb)` 指定された long バッファー内の、その位置から上限までのすべてのビットを含む新しいビットセットを返します。
`void`	`xor(BitSet set)` ビットセットとビットセット引数の排他的論理和を取ります。

クラス java.lang.Object から継承されたメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - BitSet
```
public BitSet()
```
    新規ビットセットを作成します。ビットの初期値はすべて false です。
  - BitSet
```
public BitSet(int nbits)
```
    0 - nbits-1 の範囲のインデックスを持つビットを明示的に表すために十分な初期サイズを持つビットセットを作成します。ビットの初期値はすべて false です。
    
    パラメータ:
    nbits - ビットセットの初期サイズ
    
    例外:
    
    NegativeArraySizeException - 指定された初期サイズが負の場合
- メソッドの詳細
  - valueOf
```
public static BitSet valueOf(long[] longs)
```
    指定された long 配列内のすべてのビットを含む新しいビットセットを返します。
    より正確には、
    すべての n < 64 * longs.length に対して
    BitSet.valueOf(longs).get(n) == ((longs[n/64] & (1L<<(n%64))) != 0) となります。
    このメソッドは、BitSet.valueOf(LongBuffer.wrap(longs)) と同等です。
    
    パラメータ:
    longs - 新規ビットセットの初期ビットとして使用されるビットシーケンスのリトルエンディアン表現を含む long 配列
    導入されたバージョン:
    
    1.7
  - valueOf
```
public static BitSet valueOf(LongBuffer lb)
```
    指定された long バッファー内の、その位置から上限までのすべてのビットを含む新しいビットセットを返します。
    より正確には、
    すべての n < 64 * lb.remaining() に対して
    BitSet.valueOf(lb).get(n) == ((lb.get(lb.position()+n/64) & (1L<<(n%64))) != 0) となります。
    long バッファーはこのメソッドによって変更されず、このバッファーへの参照はビットセットによって保存されません。
    
    パラメータ:
    lb - 新規ビットセットの初期ビットとして使用される、その位置から上限までのビットシーケンスのリトルエンディアン表現を含む long バッファー
    導入されたバージョン:
    
    1.7
  - valueOf
```
public static BitSet valueOf(byte[] bytes)
```
    指定されたバイト配列内のすべてのビットを含む新しいビットセットを返します。
    より正確には、
    すべての n < 8 * bytes.length に対して
    BitSet.valueOf(bytes).get(n) == ((bytes[n/8] & (1<<(n%8))) != 0) となります。
    このメソッドは、BitSet.valueOf(ByteBuffer.wrap(bytes)) と同等です。
    
    パラメータ:
    bytes - 新規ビットセットの初期ビットとして使用されるビットシーケンスのリトルエンディアン表現を含むバイト配列
    導入されたバージョン:
    
    1.7
  - valueOf
```
public static BitSet valueOf(ByteBuffer bb)
```
    指定された byte バッファー内の、その位置から上限までのすべてのビットを含む新しいビットセットを返します。
    より正確には、
    すべての n < 8 * bb.remaining() に対して
    BitSet.valueOf(bb).get(n) == ((bb.get(bb.position()+n/8) & (1<<(n%8))) != 0) となります。
    byte バッファーはこのメソッドによって変更されず、このバッファーへの参照はビットセットによって保存されません。
    
    パラメータ:
    bb - 新規ビットセットの初期ビットとして使用される、その位置から上限までのビットシーケンスのリトルエンディアン表現を含む byte バッファー
    導入されたバージョン:
    
    1.7
  - toByteArray
```
public byte[] toByteArray()
```
    このビットセット内のすべてのビットを含む新しいバイト配列を返します。
    より正確には、
    byte[] bytes = s.toByteArray(); の場合
    すべての n < 8 * bytes.length に対して
    bytes.length == (s.length()+7)/8 および
    s.get(n) == ((bytes[n/8] & (1<<(n%8))) != 0) となります。
    
    戻り値:
    このビットセットのすべてのビットのリトルエンディアン表現を含むバイト配列
    導入されたバージョン:
    
    1.7
  - toLongArray
```
public long[] toLongArray()
```
    このビットセット内のすべてのビットを含む新しい long 配列を返します。
    より正確には、
    long[] longs = s.toLongArray(); の場合
    すべての n < 64 * longs.length に対して
    longs.length == (s.length()+63)/64 および
    s.get(n) == ((longs[n/64] & (1L<<(n%64))) != 0) となります。
    
    戻り値:
    このビットセットのすべてのビットのリトルエンディアン表現を含む long 配列
    導入されたバージョン:
    
    1.7
  - flip
```
public void flip(int bitIndex)
```
    現在値の補数に指定されたインデックスのビットを設定します。
    
    パラメータ:
    bitIndex - 反転するビットのインデックス
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが負の値の場合
    導入されたバージョン:
    
    1.4
  - flip
```
public void flip(int fromIndex,
        int toIndex)
```
    指定された fromIndex (これを含む) から指定された toIndex (これを含まない) までの各ビットをその現在値の補数に設定します。
    
    パラメータ:
    fromIndex - 反転する最初のビットのインデックス
    toIndex - 反転する最後のビットの後ろのインデックス
    
    例外:
    
    IndexOutOfBoundsException - fromIndex が負の値の場合、toIndex が負の値の場合、あるいは fromIndex が toIndex よりも大きい場合
    導入されたバージョン:
    
    1.4
  - set
```
public void set(int bitIndex)
```
    指定されたインデックスのビットを true に設定します。
    
    パラメータ:
    bitIndex - ビットインデックス
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが負の値の場合
    導入されたバージョン:
    
    JDK1.0
  - set
```
public void set(int bitIndex,
       boolean value)
```
    指定されたインデックスのビットを指定された値に設定します。
    
    パラメータ:
    bitIndex - ビットインデックス
    value - 設定される boolean 値
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが負の値の場合
    導入されたバージョン:
    
    1.4
  - set
```
public void set(int fromIndex,
       int toIndex)
```
    指定された fromIndex (これを含む) から指定された toIndex (これを含まない) までのビットを true に設定します。
    
    パラメータ:
    fromIndex - 設定する最初のビットのインデックス
    toIndex - 設定される最後のビットの後ろのインデックス
    
    例外:
    
    IndexOutOfBoundsException - fromIndex が負の値の場合、toIndex が負の値の場合、あるいは fromIndex が toIndex よりも大きい場合
    導入されたバージョン:
    
    1.4
  - set
```
public void set(int fromIndex,
       int toIndex,
       boolean value)
```
    指定された fromIndex (これを含む) から指定された toIndex (これを含まない) までのビットを指定された値に設定します。
    
    パラメータ:
    fromIndex - 設定する最初のビットのインデックス
    toIndex - 設定される最後のビットの後ろのインデックス
    value - 選択されたビットを設定する値
    
    例外:
    
    IndexOutOfBoundsException - fromIndex が負の値の場合、toIndex が負の値の場合、あるいは fromIndex が toIndex よりも大きい場合
    導入されたバージョン:
    
    1.4
  - clear
```
public void clear(int bitIndex)
```
    インデックスで指定されたビットを false に設定します。
    
    パラメータ:
    bitIndex - クリアするビットのインデックス
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが負の値の場合
    導入されたバージョン:
    
    JDK1.0
  - clear
```
public void clear(int fromIndex,
         int toIndex)
```
    指定された fromIndex (これを含む) から指定された toIndex (これを含まない) までのビットを false に設定します。
    
    パラメータ:
    fromIndex - クリアする最初のビットのインデックス
    toIndex - クリアされる最後のビットの後ろのインデックス
    
    例外:
    
    IndexOutOfBoundsException - fromIndex が負の値の場合、toIndex が負の値の場合、あるいは fromIndex が toIndex よりも大きい場合
    導入されたバージョン:
    
    1.4
  - clear
```
public void clear()
```
    この BitSet 内のビットをすべて false に設定します。
    
    導入されたバージョン:
    
    1.4
  - get
```
public boolean get(int bitIndex)
```
    指定されたインデックスを持つビットの値を返します。この BitSet に bitIndex のインデックスを持つビットが設定されている場合、値は true です。そうでない場合は false です。
    
    パラメータ:
    bitIndex - ビットインデックス
    
    戻り値:
    指定されたインデックスを持つビットの値
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが負の値の場合
  - get
```
public BitSet get(int fromIndex,
         int toIndex)
```
    この BitSet からのビットで構成される新規 BitSet を fromIndex (これを含む) から toIndex (これを含まない) まで返します。
    
    パラメータ:
    fromIndex - 組み込む最初のビットのインデックス
    toIndex - 組み込む最後のビットの後ろのインデックス
    
    戻り値:
    この BitSet の範囲からの新規 BitSet
    
    例外:
    
    IndexOutOfBoundsException - fromIndex が負の値の場合、toIndex が負の値の場合、あるいは fromIndex が toIndex よりも大きい場合
    導入されたバージョン:
    
    1.4
  - nextSetBit
```
public int nextSetBit(int fromIndex)
```
    指定された開始インデックス時、またはそのインデックス後に生じる、true に設定された最初のビットのインデックスを返します。該当するビットが存在しない場合は、-1 が返されます。
    BitSet 内の true ビットに対して反復処理を実行する場合は、次のループを使用します。
```
 for (int i = bs.nextSetBit(0); i >= 0; i = bs.nextSetBit(i+1)) {
     // operate on index i here
 }
```
    パラメータ:
    fromIndex - チェックを開始する位置のインデックス (これを含む)
    
    戻り値:
    次のセットビットのインデックス。そのようなビットが存在しない場合は -1
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが負の値の場合
    導入されたバージョン:
    
    1.4
  - nextClearBit
```
public int nextClearBit(int fromIndex)
```
    指定された開始インデックス時、またはそのインデックス後に生じる、false に設定された最初のビットのインデックスを返します。
    
    パラメータ:
    fromIndex - チェックを開始する位置のインデックス (これを含む)
    
    戻り値:
    次のクリアビットのインデックス
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが負の値の場合
    導入されたバージョン:
    
    1.4
  - previousSetBit
```
public int previousSetBit(int fromIndex)
```
    指定された開始インデックス時、またはそのインデックス前に生じる、true に設定されたもっとも近いビットのインデックスを返します。そのようなビットが存在しない場合、または開始インデックスとして -1 が指定された場合は、-1 が返されます。
    BitSet 内の true ビットに対して反復処理を実行する場合は、次のループを使用します。
```
 for (int i = bs.length(); (i = bs.previousSetBit(i-1)) >= 0; ) {
     // operate on index i here
 }
```
    パラメータ:
    fromIndex - チェックを開始する位置のインデックス (これを含む)
    
    戻り値:
    前のセットビットのインデックス。そのようなビットが存在しない場合は -1
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが次より小さい場合-1
    導入されたバージョン:
    
    1.7
  - previousClearBit
```
public int previousClearBit(int fromIndex)
```
    指定された開始インデックス時、またはそのインデックス前に生じる、false に設定されたもっとも近いビットのインデックスを返します。そのようなビットが存在しない場合、または開始インデックスとして -1 が指定された場合は、-1 が返されます。
    
    パラメータ:
    fromIndex - チェックを開始する位置のインデックス (これを含む)
    
    戻り値:
    前のクリアビットのインデックス。そのようなビットが存在しない場合は -1
    
    例外:
    
    IndexOutOfBoundsException - 指定されたインデックスが次より小さい場合-1
    導入されたバージョン:
    
    1.7
  - length
```
public int length()
```
    この BitSet の「論理サイズ」、つまり BitSet の最上位セットビットのインデックスに 1 を加えた値を返します。BitSet にセットビットがない場合はゼロを返します。
    
    戻り値:
    BitSet の論理サイズ
    導入されたバージョン:
    
    1.2
  - isEmpty
```
public boolean isEmpty()
```
    この BitSet に true に設定されたビットが含まれていない場合は、true を返します。
    
    戻り値:
    この BitSet が空かどうかを示す boolean 型
    導入されたバージョン:
    
    1.4
  - intersects
```
public boolean intersects(BitSet set)
```
    この BitSet でも true に設定された、true 設定のビットが、指定された BitSet にある場合、true を返します。
    
    パラメータ:
    set - 交差する BitSet
    
    戻り値:
    この BitSet が指定された BitSet と交差するかどうかを示す boolean 型
    導入されたバージョン:
    
    1.4
  - cardinality
```
public int cardinality()
```
    この BitSet で、true に設定されたビットの数を返します。
    
    戻り値:
    この BitSet で、true に設定されたビットの数
    導入されたバージョン:
    
    1.4
  - and
```
public void and(BitSet set)
```
    ターゲットビットセットと引数ビットセットの論理積を取ります。このビットセットの各ビットの初期値が true で、ビットセット引数の対応するビットの初期値も true の場合にかぎり、このビットセットが変更され、その各ビットの値が true になります。
    
    パラメータ:
    set - ビットセット
  - or
```
public void or(BitSet set)
```
    ビットセットとビットセット引数の論理和を取ります。このビットセットのビットの値が true であったか、ビットセット引数の対応するビットの値が true である場合にかぎり、このビットセットが変更され、そのビットの値が true になります。
    
    パラメータ:
    set - ビットセット
  - xor
```
public void xor(BitSet set)
```
    ビットセットとビットセット引数の排他的論理和を取ります。次のいずれかの条件が成り立つ場合にかぎり、このビットセットが変更され、そのビットの値が true になります。
    - このビットの初期値が true で、引数の対応するビットの値が false である。
    - このビットの初期値が false で、引数の対応するビットの値が true である。
    パラメータ:
    set - ビットセット
  - andNot
```
public void andNot(BitSet set)
```
    対応するビットが、指定された BitSet 内に設定されているこの BitSet 内のすべてのビットをクリアします。
    
    パラメータ:
    set - この BitSet をマスクするための BitSet
    導入されたバージョン:
    
    1.2
  - hashCode
```
public int hashCode()
```
    このビットセットのハッシュコード値を返します。ハッシュコードは、この BitSet 内に設定されているビットによってのみ決まります。
    ハッシュコードは、次の計算の結果として定義されます。
```
 public int hashCode() {
     long h = 1234;
     long[] words = toLongArray();
     for (int i = words.length; --i >= 0; )
         h ^= words[i] * (i + 1);
     return (int)((h >> 32) ^ h);
 }
```
    ビットの設定が変わると、ハッシュコードは変更されます。
    オーバーライド:
    
    hashCode、クラス: Object
    
    戻り値:
    このビットセットのハッシュコード値
    関連項目:
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - size
```
public int size()
```
    この BitSet でビット値を表すために実際に使用しているビットの数を返します。このセットで最大の要素は「サイズ」で、これが第一要素です。
    
    戻り値:
    ビットセットに現在あるビットの数
  - equals
```
public boolean equals(Object obj)
```
    このオブジェクトと指定されたオブジェクトを比較します。引数が null ではなく、このビットセットとまったく同じ true のビットのセットを持つ Bitset オブジェクトである場合にかぎり、結果は true です。つまり、負でない int 型のインデックス k に対して、
```
((BitSet)obj).get(k) == this.get(k)
```
    が成り立たなければいけません。2 つのビットセットの現在のサイズは比較されません。
    オーバーライド:
    
    equals、クラス: Object
    
    パラメータ:
    obj - 比較対象のオブジェクト
    
    戻り値:
    オブジェクトが同じである場合は true、それ以外の場合は false
    関連項目:
    size()
  - clone
```
public Object clone()
```
    この BitSet をクローニングして、それと同等の新しい BitSet を作成します。このビットセットの複製は、このビットセットとまったく同じ true のビットを持ちます。
    
    オーバーライド:
    
    clone、クラス: Object
    
    戻り値:
    このビットセットの複製
    関連項目:
    size()
  - toString
```
public String toString()
```
    ビットセットの文字列表現を返します。この BitSet でビットが設定状態で保持されているインデックスごとに、そのインデックスの 10 進表現が結果に含まれます。こうしたインデックスは、最下位から最上位の順序で並べられ、「, 」(コンマとスペース) で区切って中括弧で囲まれます。このため、整数セットの通常の数値表記になります。
    例:
```
 BitSet drPepper = new BitSet();
```
    これで、drPepper.toString() は「{}」を返します。
```
 drPepper.set(2);
```
    これで、drPepper.toString() は「{2}」を返します。
```
 drPepper.set(4);
 drPepper.set(10);
```
    これで、drPepper.toString() は「{2, 4, 10}」を返します。
    オーバーライド:
    
    toString、クラス: Object
    
    戻り値:
    このビットセットの文字列表現

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス BitSet

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

コンストラクタの詳細

BitSet

BitSet

メソッドの詳細

valueOf

valueOf

valueOf

valueOf

toByteArray

toLongArray

flip

flip

set

set

set

set

clear

clear

clear

get

get

nextSetBit

nextClearBit

previousSetBit

previousClearBit

length

isEmpty

intersects

cardinality

and

or

xor

andNot

hashCode

size

equals

clone

toString