RoaringBitmapWriter.Wizard (RoaringBitmap 0.9.27-bitlap API)

java.lang.Object
- org.bitlap.roaringbitmap.RoaringBitmapWriter.Wizard<C,T>

所有已实现的接口:: java.util.function.Supplier<RoaringBitmapWriter<T>>

直接已知子类:: RoaringBitmapWriter.BufferWizard, RoaringBitmapWriter.RoaringWizard

封闭接口:: RoaringBitmapWriter<T extends BitmapDataProvider>

public abstract static class RoaringBitmapWriter.Wizard<C extends WordStorage<C>,T extends BitmapDataProvider & AppendableStorage<C>>
extends java.lang.Object
implements java.util.function.Supplier<RoaringBitmapWriter<T>>

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`constantMemory`
`protected java.util.function.Supplier<C>`	`containerSupplier`
`protected int`	`expectedContainerSize`
`protected int`	`initialCapacity`
`protected boolean`	`partiallySortValues`
`protected boolean`	`runCompress`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected abstract java.util.function.Supplier<C>`	`arraySupplier()`
`RoaringBitmapWriter.Wizard<C,T>`	`constantMemory()` All writes are buffered into the same buffer of 8kB, before converting to the best container representation and appending to the bitmap.
`protected abstract T`	`createUnderlying(int initialCapacity)`
`RoaringBitmapWriter.Wizard<C,T>`	`doPartialRadixSort()` Will partially sort values, which can allocate O(n) temporary memory but can significantly speed up adding unsorted values to a bitmap.
`RoaringBitmapWriter.Wizard<C,T>`	`expectedDensity(double density)` Influence default container choice by how dense the bitmap is expected to be.
`RoaringBitmapWriter.Wizard<C,T>`	`expectedRange(long min, long max)` Guesses the number of prefices required based on an estimate of the range the bitmap will contain, assumes that all prefices in the range will be required.
`RoaringBitmapWriter.Wizard<C,T>`	`expectedValuesPerContainer(int count)`
`RoaringBitmapWriter.Wizard<Container,FastRankRoaringBitmap>`	`fastRank()`
`RoaringBitmapWriter<T>`	`get()` Builds a bitmap writer based on the supplied options.
`RoaringBitmapWriter.Wizard<C,T>`	`initialCapacity(int count)` Takes control of the size of the prefix array, in case it can be precalculated or estimated.
`RoaringBitmapWriter.Wizard<C,T>`	`optimiseForArrays()` Choose this option if it is known that most containers will be sparse.
`RoaringBitmapWriter.Wizard<C,T>`	`optimiseForRuns()` Choose this option if the bitmap is expected to be RLE compressible.
`RoaringBitmapWriter.Wizard<C,T>`	`runCompress(boolean runCompress)` By default the bitmap will be run-compressed on the fly, but it can be disabled (and run compressed at the end).
`protected abstract java.util.function.Supplier<C>`	`runSupplier()`

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

- 字段详细资料
  - initialCapacity
```
protected int initialCapacity
```
  - constantMemory
```
protected boolean constantMemory
```
  - partiallySortValues
```
protected boolean partiallySortValues
```
  - runCompress
```
protected boolean runCompress
```
  - containerSupplier
```
protected java.util.function.Supplier<C extends WordStorage<C>> containerSupplier
```
  - expectedContainerSize
```
protected int expectedContainerSize
```
- 方法详细资料
  - optimiseForArrays
```
public RoaringBitmapWriter.Wizard<C,T> optimiseForArrays()
```
    Choose this option if it is known that most containers will be sparse.
    
    返回:
    
    this
  - optimiseForRuns
```
public RoaringBitmapWriter.Wizard<C,T> optimiseForRuns()
```
    Choose this option if the bitmap is expected to be RLE compressible. Will buffer additions into a RunContainer.
    
    返回:
    
    this
  - runCompress
```
public RoaringBitmapWriter.Wizard<C,T> runCompress(boolean runCompress)
```
    By default the bitmap will be run-compressed on the fly, but it can be disabled (and run compressed at the end).
    
    参数:
    
    runCompress - whether to apply run compression on the fly.
    
    返回:
    
    this
  - expectedValuesPerContainer
```
public RoaringBitmapWriter.Wizard<C,T> expectedValuesPerContainer(int count)
```
    参数:
    
    count - how many values are expected to fall within any 65536 bit range.
    
    返回:
    
    this
  - fastRank
```
public RoaringBitmapWriter.Wizard<Container,FastRankRoaringBitmap> fastRank()
```
  - constantMemory
```
public RoaringBitmapWriter.Wizard<C,T> constantMemory()
```
    All writes are buffered into the same buffer of 8kB, before converting to the best container representation and appending to the bitmap. This option overrides any optimiseForArrays, optimiseForRuns and optimiseForBitmaps settings.
    
    返回:
    
    this
  - expectedDensity
```
public RoaringBitmapWriter.Wizard<C,T> expectedDensity(double density)
```
    Influence default container choice by how dense the bitmap is expected to be.
    
    参数:
    
    density - value in [0.0, 1.0], density of the bitmap
    
    返回:
    
    this
  - expectedRange
```
public RoaringBitmapWriter.Wizard<C,T> expectedRange(long min,
                                                     long max)
```
    Guesses the number of prefices required based on an estimate of the range the bitmap will contain, assumes that all prefices in the range will be required. This is a good heuristic for a contiguous bitmap, and, for instance, a very bad heuristic for a bitmap with just two values far apart.
    
    参数:
    
    min - the inclusive min value
    
    max - the exclusive max value
    
    返回:
    
    this
  - initialCapacity
```
public RoaringBitmapWriter.Wizard<C,T> initialCapacity(int count)
```
    Takes control of the size of the prefix array, in case it can be precalculated or estimated. This can potentially save many array allocations during building the bitmap.
    
    参数:
    
    count - an estimate of the number of prefix keys required.
    
    返回:
    
    this
  - doPartialRadixSort
```
public RoaringBitmapWriter.Wizard<C,T> doPartialRadixSort()
```
    Will partially sort values, which can allocate O(n) temporary memory but can significantly speed up adding unsorted values to a bitmap.
    
    返回:
    
    this
  - arraySupplier
```
protected abstract java.util.function.Supplier<C> arraySupplier()
```
  - runSupplier
```
protected abstract java.util.function.Supplier<C> runSupplier()
```
  - createUnderlying
```
protected abstract T createUnderlying(int initialCapacity)
```
  - get
```
public RoaringBitmapWriter<T> get()
```
    Builds a bitmap writer based on the supplied options. A call to this method is repeatable, and will not fail because the wizard should already be in a valid state.
    
    指定者:
    
    get 在接口中 java.util.function.Supplier<RoaringBitmapWriter<T extends BitmapDataProvider & AppendableStorage<C>>>
    
    返回:
    
    a new RoaringBitmapWriter

类 RoaringBitmapWriter.Wizard<C extends WordStorage<C>,T extends BitmapDataProvider & AppendableStorage<C>>

字段概要

方法概要

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

字段详细资料

initialCapacity

constantMemory

partiallySortValues

runCompress

containerSupplier

expectedContainerSize

方法详细资料

optimiseForArrays

optimiseForRuns

runCompress

expectedValuesPerContainer

fastRank

constantMemory

expectedDensity

expectedRange

initialCapacity

doPartialRadixSort

arraySupplier

runSupplier

createUnderlying

get