RangeBitmap (RoaringBitmap 0.9.27-bitlap API)

java.lang.Object
- org.bitlap.roaringbitmap.RangeBitmap

```
public final class RangeBitmap
extends java.lang.Object
```
A 2D bitmap which associates values with a row index and can perform range queries.

嵌套类概要

嵌套类
限定符和类型类和说明

static class RangeBitmap.Appender
Builder for constructing immutable RangeBitmaps

嵌套类
限定符和类型	类和说明
`static class`	`RangeBitmap.Appender` Builder for constructing immutable RangeBitmaps

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static RangeBitmap.Appender`	`appender(long maxValue)` Append values to the RangeBitmap before sealing it, defaults to on heap ByteBuffers.
`static RangeBitmap.Appender`	`appender(long maxValue, java.util.function.IntFunction<java.nio.ByteBuffer> bufferSupplier, java.util.function.Consumer<java.nio.ByteBuffer> cleaner)` Append values to the RangeBitmap before sealing it.
`RoaringBitmap`	`between(long min, long max)` Returns a RoaringBitmap of rows which have a value in between the thresholds.
`long`	`betweenCardinality(long min, long max)` Returns the number of rows which have a value in between the thresholds.
`long`	`betweenCardinality(long min, long max, RoaringBitmap context)` Returns the number of rows which have a value in between the thresholds.
`RoaringBitmap`	`gt(long threshold)` Returns a RoaringBitmap of rows which have a value greater than the threshold.
`RoaringBitmap`	`gt(long threshold, RoaringBitmap context)` Returns a RoaringBitmap of rows which have a value greater than the threshold, and intersect with the context bitmap, which will not be modified.
`long`	`gtCardinality(long threshold)` Returns the number of rows which have a value greater than the threshold.
`long`	`gtCardinality(long threshold, RoaringBitmap context)` Returns the number of rows which have a value greater than the threshold, and intersect with the context bitmap, which will not be modified.
`RoaringBitmap`	`gte(long threshold)` Returns a RoaringBitmap of rows which have a value greater than or equal to the threshold.
`RoaringBitmap`	`gte(long threshold, RoaringBitmap context)` Returns a RoaringBitmap of rows which have a value greater than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
`long`	`gteCardinality(long threshold)` Returns the number of rows which have a value greater than or equal to the threshold.
`long`	`gteCardinality(long threshold, RoaringBitmap context)` Returns the number of rows which have a value greater than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
`RoaringBitmap`	`lt(long threshold)` Returns a RoaringBitmap of rows which have a value less than the threshold.
`RoaringBitmap`	`lt(long threshold, RoaringBitmap context)` Returns a RoaringBitmap of rows which have a value less than the threshold, and intersect with the context bitmap, which will not be modified.
`long`	`ltCardinality(long threshold)` Returns the number of rows which have a value less than the threshold.
`long`	`ltCardinality(long threshold, RoaringBitmap context)` Returns the number of rows which have a value less than the threshold, and intersect with the context bitmap, which will not be modified.
`RoaringBitmap`	`lte(long threshold)` Returns a RoaringBitmap of rows which have a value less than or equal to the threshold.
`RoaringBitmap`	`lte(long threshold, RoaringBitmap context)` Returns a RoaringBitmap of rows which have a value less than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
`long`	`lteCardinality(long threshold)` Returns the number of rows which have a value less than or equal to the threshold.
`long`	`lteCardinality(long threshold, RoaringBitmap context)` Returns the number of rows which have a value less than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
`static RangeBitmap`	`map(java.nio.ByteBuffer buffer)` Maps the RangeBitmap from the buffer with minimal allocation.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - appender
```
public static RangeBitmap.Appender appender(long maxValue,
                                            java.util.function.IntFunction<java.nio.ByteBuffer> bufferSupplier,
                                            java.util.function.Consumer<java.nio.ByteBuffer> cleaner)
```
    Append values to the RangeBitmap before sealing it.
    
    参数:
    
    maxValue - the maximum value to be appended, values larger than this value will be rejected.
    
    bufferSupplier - provides ByteBuffers.
    
    返回:
    
    an appender.
  - appender
```
public static RangeBitmap.Appender appender(long maxValue)
```
    Append values to the RangeBitmap before sealing it, defaults to on heap ByteBuffers.
    
    参数:
    
    maxValue - the maximum value to be appended, values larger than this value will be rejected.
    
    返回:
    
    an appender.
  - map
```
public static RangeBitmap map(java.nio.ByteBuffer buffer)
```
    Maps the RangeBitmap from the buffer with minimal allocation. The buffer must not be reused while the mapped RangeBitmap is live.
    
    参数:
    
    buffer - a buffer containing a serialized RangeBitmap.
    
    返回:
    
    a RangeBitmap backed by the buffer.
  - between
```
public RoaringBitmap between(long min,
                             long max)
```
    Returns a RoaringBitmap of rows which have a value in between the thresholds.
    
    参数:
    
    min - the inclusive minimum value.
    
    max - the inclusive maximum value.
    
    返回:
    
    a bitmap of matching rows.
  - betweenCardinality
```
public long betweenCardinality(long min,
                               long max)
```
    Returns the number of rows which have a value in between the thresholds.
    
    参数:
    
    min - the inclusive minimum value.
    
    max - the inclusive maximum value.
    
    返回:
    
    the number of matching rows.
  - betweenCardinality
```
public long betweenCardinality(long min,
                               long max,
                               RoaringBitmap context)
```
    Returns the number of rows which have a value in between the thresholds.
    
    参数:
    
    min - the inclusive minimum value.
    
    max - the inclusive maximum value.
    
    context - to be intersected with.
    
    返回:
    
    the number of matching rows.
  - lte
```
public RoaringBitmap lte(long threshold)
```
    Returns a RoaringBitmap of rows which have a value less than or equal to the threshold.
    
    参数:
    
    threshold - the inclusive maximum value.
    
    返回:
    
    a bitmap of matching rows.
  - lte
```
public RoaringBitmap lte(long threshold,
                         RoaringBitmap context)
```
    Returns a RoaringBitmap of rows which have a value less than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the inclusive maximum value.
    
    context - to be intersected with.
    
    返回:
    
    a bitmap of matching rows.
  - lteCardinality
```
public long lteCardinality(long threshold)
```
    Returns the number of rows which have a value less than or equal to the threshold.
    
    参数:
    
    threshold - the inclusive maximum value.
    
    返回:
    
    the number of matching rows.
  - lteCardinality
```
public long lteCardinality(long threshold,
                           RoaringBitmap context)
```
    Returns the number of rows which have a value less than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the inclusive maximum value.
    
    context - to be intersected with.
    
    返回:
    
    the number of matching rows.
  - lt
```
public RoaringBitmap lt(long threshold)
```
    Returns a RoaringBitmap of rows which have a value less than the threshold.
    
    参数:
    
    threshold - the exclusive maximum value.
    
    返回:
    
    a bitmap of matching rows.
  - lt
```
public RoaringBitmap lt(long threshold,
                        RoaringBitmap context)
```
    Returns a RoaringBitmap of rows which have a value less than the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the exclusive maximum value.
    
    context - to be intersected with.
    
    返回:
    
    a bitmap of matching rows which intersect .
  - ltCardinality
```
public long ltCardinality(long threshold)
```
    Returns the number of rows which have a value less than the threshold.
    
    参数:
    
    threshold - the exclusive maximum value.
    
    返回:
    
    the number of matching rows.
  - ltCardinality
```
public long ltCardinality(long threshold,
                          RoaringBitmap context)
```
    Returns the number of rows which have a value less than the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the exclusive maximum value.
    
    context - to be intersected with.
    
    返回:
    
    the number of matching rows which intersect .
  - gt
```
public RoaringBitmap gt(long threshold)
```
    Returns a RoaringBitmap of rows which have a value greater than the threshold.
    
    参数:
    
    threshold - the exclusive minimum value.
    
    返回:
    
    a bitmap of matching rows.
  - gt
```
public RoaringBitmap gt(long threshold,
                        RoaringBitmap context)
```
    Returns a RoaringBitmap of rows which have a value greater than the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the exclusive minimum value.
    
    context - to be intersected with.
    
    返回:
    
    a bitmap of matching rows.
  - gtCardinality
```
public long gtCardinality(long threshold)
```
    Returns the number of rows which have a value greater than the threshold.
    
    参数:
    
    threshold - the exclusive minimum value.
    
    返回:
    
    the number of matching rows.
  - gtCardinality
```
public long gtCardinality(long threshold,
                          RoaringBitmap context)
```
    Returns the number of rows which have a value greater than the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the exclusive minimum value.
    
    context - to be intersected with.
    
    返回:
    
    the number of matching rows.
  - gte
```
public RoaringBitmap gte(long threshold)
```
    Returns a RoaringBitmap of rows which have a value greater than or equal to the threshold.
    
    参数:
    
    threshold - the inclusive minimum value.
    
    返回:
    
    a bitmap of matching rows.
  - gte
```
public RoaringBitmap gte(long threshold,
                         RoaringBitmap context)
```
    Returns a RoaringBitmap of rows which have a value greater than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the inclusive minimum value.
    
    context - to be intersected with.
    
    返回:
    
    a bitmap of matching rows.
  - gteCardinality
```
public long gteCardinality(long threshold)
```
    Returns the number of rows which have a value greater than or equal to the threshold.
    
    参数:
    
    threshold - the inclusive minimum value.
    
    返回:
    
    the number of matching rows.
  - gteCardinality
```
public long gteCardinality(long threshold,
                           RoaringBitmap context)
```
    Returns the number of rows which have a value greater than or equal to the threshold, and intersect with the context bitmap, which will not be modified.
    
    参数:
    
    threshold - the inclusive minimum value.
    
    context - to be intersected with.
    
    返回:
    
    the number of matching rows.

类 RangeBitmap

嵌套类概要

方法概要

从类继承的方法 java.lang.Object

方法详细资料

appender

appender

map

between

betweenCardinality

betweenCardinality

lte

lte

lteCardinality

lteCardinality

lt

lt

ltCardinality

ltCardinality

gt

gt

gtCardinality

gtCardinality

gte

gte

gteCardinality

gteCardinality