メインコンテンツへスキップ
メインコンテンツへスキップ

ビットマップ関数

ビットマップは 2 通りの方法で構築できます。1 つ目は集約関数 groupBitmap に -State を付けて構築する方法で、もう 1 つは Array オブジェクトからビットマップを構築する方法です。

bitmapAnd​

導入バージョン：v20.1.0

2つのビットマップの論理積 (AND) を計算します。

構文

bitmapAnd(bitmap1, bitmap2)

引数

返り値

両方の入力ビットマップに共通するビットを持つビットマップを返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(bitmapAnd(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;

┌─res─┐
│ [3] │
└─────┘

bitmapAndCardinality​

導入バージョン: v20.1.0

2つのビットマップの論理積 (AND) の基数を返します。

構文

bitmapAndCardinality(bitmap1, bitmap2)

引数

戻り値

2 つのビットマップの積集合に含まれるセットされたビットの数を返します。UInt64

例

使用例

SELECT bitmapAndCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;

┌─res─┐
│   1 │
└─────┘

bitmapAndnot​

導入バージョン: v20.1.0

2 つのビットマップの集合差 A AND-NOT B を計算します。

構文

bitmapAndnot(bitmap1, bitmap2)

引数

返り値

1 つ目のビットマップには存在し、2 つ目のビットマップには存在しないセットされたビットを含むビットマップを返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(bitmapAndnot(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;

┌─res────┐
│ [1, 2] │
└────────┘

bitmapAndnotCardinality​

導入バージョン: v20.1.0

2 つのビットマップに対する AND-NOT 演算結果のカーディナリティを返します。

構文

bitmapAndnotCardinality(bitmap1, bitmap2)

引数

返り値

bitmap1 AND-NOT bitmap2 の結果中のセットされているビット数を返します。UInt64

例

使用例

SELECT bitmapAndnotCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;

┌─res─┐
│   2 │
└─────┘

bitmapBuild​

導入バージョン: v20.1.0

符号なし整数配列からビットマップを生成します。関数 bitmapToArray と逆の処理を行います。

構文

bitmapBuild(array)

引数

戻り値

与えられた配列からビットマップを返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapBuild([1, 2, 3, 4, 5]) AS res, toTypeName(res);

┌─res─┬─toTypeName(bitmapBuild([1, 2, 3, 4, 5]))─────┐
│     │ AggregateFunction(groupBitmap, UInt8)        │
└─────┴──────────────────────────────────────────────┘

bitmapCardinality​

導入バージョン: v20.1.0

bitmap 内で 1 にセットされているビットの数 (基数) を返します。

構文

bitmapCardinality(bitmap)

引数

戻り値

ビットマップ内で 1 に設定されているビットの数を返します。型は UInt64 です。

例

使用例

SELECT bitmapCardinality(bitmapBuild([1, 3, 3, 5, 7, 7])) AS res

┌─res─┐
│   4 │
└─────┘

bitmapContains​

導入バージョン: v20.1.0

ビットマップに特定の要素が含まれているかどうかを判定します。

構文

bitmapContains(bitmap, value)

引数

返り値

ビットマップに指定した値が含まれていれば 1、含まれていなければ 0 を返します。型は UInt8

例

使用例

SELECT bitmapContains(bitmapBuild([1, 2, 3]), 2) AS res;

┌─res─┐
│  1  │
└─────┘

bitmapHasAll​

導入バージョン: v20.1.0

1 つ目のビットマップが、2 つ目のビットマップに立っているすべてのビットを含んでいるかどうかを判定します。

構文

bitmapHasAll(bitmap1, bitmap2)

引数

戻り値

2番目のビットマップのすべての set ビットが1番目のビットマップに含まれている場合は 1 を返し、そうでない場合は 0 を返します。UInt8

例

使用例

SELECT bitmapHasAll(bitmapBuild([1, 2, 3]), bitmapBuild([2, 3])) AS res;

┌─res─┐
│  1  │
└─────┘

bitmapHasAny​

導入バージョン: v20.1.0

最初のビットマップが、2番目のビットマップでセットされているビットを1つでも含んでいるかどうかをチェックします。

構文

bitmapHasAny(bitmap1, bitmap2)

引数

返り値

2 番目のビットマップのいずれかのビットが 1 つ目のビットマップにも存在する場合は 1 を返し、そうでない場合は 0 を返します。戻り値の型は UInt8 です。

例

使用例

SELECT bitmapHasAny(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5])) AS res;

┌─res─┐
│  1  │
└─────┘

bitmapMax​

導入バージョン: v20.1.0

bitmap 内でセットされているビットのうち、最も大きいビット位置を返します。bitmap が空の場合は 0 を返します。

構文

bitmapMax(bitmap)

引数

戻り値

bitmap 内で最も大きいビットが立っている位置を返し、どのビットも立っていない場合は 0 を返します。UInt64

例

使用例

SELECT bitmapMax(bitmapBuild([1, 2, 3, 4, 5])) AS res;

┌─res─┐
│   5 │
└─────┘

bitmapMin​

導入バージョン: v20.1.0

ビットマップ内でセットされている最小のビットの位置を返します。すべてのビットが未セットの場合は UINT32_MAX を返します (ビットマップに 2^64 を超えるビットが含まれる場合は UINT64_MAX を返します) 。

構文

bitmapMin(bitmap)

引数

戻り値

bitmap 内でセットされている最小のビット位置、または UINT32_MAX/UINT64_MAX UInt64 を返します。

例

利用例

SELECT bitmapMin(bitmapBuild([3, 5, 2, 6])) AS res;

┌─res─┐
│   2 │
└─────┘

bitmapOr​

導入バージョン: v20.1.0

2つのビットマップに対して論理和 (OR) を計算します。

構文

bitmapOr(bitmap1, bitmap2)

引数

戻り値

どちらか一方の入力ビットマップで 1 になっているビットを含むビットマップを返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(bitmapOr(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;

┌─res─────────────┐
│ [1, 2, 3, 4, 5] │
└─────────────────┘

bitmapOrCardinality​

導入バージョン: v20.1.0

2 つのビットマップの論理和 (OR) のカーディナリティを返します。

構文

bitmapOrCardinality(bitmap1, bitmap2)

引数

戻り値

2つのビットマップの和集合に含まれる、1 に設定されているビットの数を返します。戻り値の型は UInt64 です。

例

使用例

SELECT bitmapOrCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;

┌─res─┐
│   5 │
└─────┘

bitmapSubsetInRange​

導入バージョン: v20.1.0

指定された範囲 [start, end) 内のセットされたビットのみを含むビットマップの部分集合を返します。インデックスは 1 から始まります。

構文

bitmapSubsetInRange(bitmap, start, end)

引数

返される値

指定された範囲内のビットのうち、セットされているビットだけを含むビットマップを返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(bitmapSubsetInRange(bitmapBuild([1, 2, 3, 4, 5]), 2, 5)) AS res;

┌─res───────┐
│ [2, 3, 4] │
└───────────┘

bitmapSubsetLimit​

導入バージョン: v20.1.0

ビットマップの range_start 番目の位置から、最大で cardinality_limit 個の 1 に設定されたビットを含む部分集合を返します。インデックスは 1 始まりです。

構文

bitmapSubsetLimit(bitmap, range_start, cardinality_limit)

引数

返される値

range_start から開始して、最大で cardinality_limit 個のビットがセットされた bitmap を返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(bitmapSubsetLimit(bitmapBuild([1, 5, 3, 2, 8]), 3, 2)) AS res;

┌─res────┐
│ [5, 3] │
└────────┘

bitmapToArray​

導入バージョン: v20.1.0

ビットマップを符号なし整数の配列に変換します。関数 bitmapBuild の逆の処理を行います。

構文

bitmapToArray(bitmap)

引数

戻り値

ビットマップに含まれる符号なし整数からなる配列 Array(UInt*) を返します。

例

使用例

SELECT bitmapToArray(bitmapBuild([1, 2, 3, 4, 5])) AS res;

┌─res─────────────┐
│ [1, 2, 3, 4, 5] │
└─────────────────┘

bitmapTransform​

導入バージョン: v20.1.0

from_array 内の特定のビット値を to_array 内の対応する値と入れ替えることで、ビットマップ内の最大 N ビットを変更します。

構文

bitmapTransform(bitmap, from_array, to_array)

引数

  • bitmap — ビットマップオブジェクト。AggregateFunction(groupBitmap, T). - from_array — 置換対象となる元のセットビットの配列。Array(T). - to_array — 置換後の新しいセットビットの配列。Array(T).

返される値

指定されたマッピングに従って要素が変換された bitmap を返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(bitmapTransform(bitmapBuild([1, 2, 3, 4, 5]), [2, 4], [20, 40])) AS res;

┌─res───────────────┐
│ [1, 3, 5, 20, 40] │
└───────────────────┘

bitmapXor​

v20.1.0 で導入

2 つのビットマップの対称差 (XOR) を計算します。

構文

bitmapXor(bitmap1, bitmap2)

引数

返り値

2つの入力ビットマップのうち、一方にのみ存在し、両方には同時に存在しないビットが立っているビットマップを返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(bitmapXor(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;

┌─res──────────┐
│ [1, 2, 4, 5] │
└──────────────┘

bitmapXorCardinality​

導入バージョン: v20.1.0

2つのビットマップの XOR (対称差) の基数 (cardinality) を返します。

構文

bitmapXorCardinality(bitmap1, bitmap2)

引数

返される値

2つのビットマップの対称差における、セットされているビットの数を返します。型は UInt64 です。

例

使用例

SELECT bitmapXorCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;

┌─res─┐
│   4 │
└─────┘

subBitmap​

導入バージョン: v21.9.0

offset の位置から始まる部分ビットマップを返します。返されるビットマップのカーディナリティの上限は cardinality_limit です。

構文

subBitmap(bitmap, offset, cardinality_limit)

引数

  • bitmap — Bitmap オブジェクト。AggregateFunction(groupBitmap, T). - offset — 先頭からスキップするセットされたビット数 (0 起算) 。UInt32 - cardinality_limit — 部分集合に含めるセットされたビット数の最大値。UInt32

戻り値

offset 個のセットされたビットを昇順でスキップした後、その位置から最大 limit 個のセットされたビットを含むビットマップを返します。AggregateFunction(groupBitmap, T)

例

使用例

SELECT bitmapToArray(subBitmap(bitmapBuild([1, 2, 3, 4, 5]), 2, 2)) AS res;

┌─res────┐
│ [3, 4] │
└────────┘