TDigest (RedisBloom 2.0.0 API)

java.lang.Object
- org.redisson.RedissonObject
- - io.github.dengliming.redismodule.redisbloom.TDigest

所有已实现的接口:

org.redisson.api.RObject, org.redisson.api.RObjectAsync
```
public class TDigest
extends org.redisson.RedissonObject
```

字段概要
- 从类继承的字段 org.redisson.RedissonObject
  codec, commandExecutor, name

构造器概要

构造器
构造器和说明
`TDigest(org.redisson.client.codec.Codec codec, org.redisson.command.CommandAsyncExecutor commandExecutor, String name)`
`TDigest(org.redisson.command.CommandAsyncExecutor commandExecutor, String name)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`add(List<AbstractMap.SimpleEntry<Double,Double>> vals)` Adds one or more samples to a sketch.
`org.redisson.api.RFuture<Boolean>`	`addAsync(List<AbstractMap.SimpleEntry<Double,Double>> vals)`
`boolean`	`create(long compression)` Initializes a t-digest with specified parameters TDIGEST.CREATE t-digest 100
`org.redisson.api.RFuture<Boolean>`	`createAsync(long compression)`
`Double`	`getCdf(double value)` Returns the fraction of all points added which are <= value.
`org.redisson.api.RFuture<Double>`	`getCdfAsync(double value)`
`TDigestInfo`	`getInfo()` TDIGEST.INFO {key}
`org.redisson.api.RFuture<TDigestInfo>`	`getInfoAsync()`
`Double`	`getMax()` Get maximum value from the sketch.
`org.redisson.api.RFuture<Double>`	`getMaxAsync()`
`Double`	`getMin()` Get minimum value from the sketch.
`org.redisson.api.RFuture<Double>`	`getMinAsync()`
`Double`	`getQuantile(double quantile)` Returns an estimate of the cutoff such that a specified fraction of the data added to this TDigest would be less than or equal to the cutoff.
`org.redisson.api.RFuture<Double>`	`getQuantileAsync(double quantile)`
`boolean`	`mergeTo(String toKey)` Merges all of the values from 'this' to 'toKey' sketch.
`org.redisson.api.RFuture<Boolean>`	`mergeToAsync(String toKey)`
`boolean`	`reset()` Reset the sketch to zero - empty out the sketch and re-initialize it.
`org.redisson.api.RFuture<Boolean>`	`resetAsync()`

从类继承的方法 org.redisson.RedissonObject
addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

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

- 构造器详细资料
  - TDigest
```
public TDigest(org.redisson.client.codec.Codec codec,
               org.redisson.command.CommandAsyncExecutor commandExecutor,
               String name)
```
  - TDigest
```
public TDigest(org.redisson.command.CommandAsyncExecutor commandExecutor,
               String name)
```
- 方法详细资料
  - create
```
public boolean create(long compression)
```
    Initializes a t-digest with specified parameters
    TDIGEST.CREATE t-digest 100
    
    参数:
    
    compression - The compression parameter. 100 is a common value for normal uses. 1000 is extremely large.
    
    返回:
  - createAsync
```
public org.redisson.api.RFuture<Boolean> createAsync(long compression)
```
  - reset
```
public boolean reset()
```
    Reset the sketch to zero - empty out the sketch and re-initialize it.
    TDIGEST.RESET {key}
    
    返回:
  - resetAsync
```
public org.redisson.api.RFuture<Boolean> resetAsync()
```
  - add
```
public boolean add(List<AbstractMap.SimpleEntry<Double,Double>> vals)
```
    Adds one or more samples to a sketch.
    TDIGEST.ADD {key} {val} {weight} [ {val} {weight} ] ...
    key : The name of the sketch. val : The value to add. weight : The weight of this point.
    
    参数:
    
    vals -
    
    返回:
  - addAsync
```
public org.redisson.api.RFuture<Boolean> addAsync(List<AbstractMap.SimpleEntry<Double,Double>> vals)
```
  - getMin
```
public Double getMin()
```
    Get minimum value from the sketch. Will return DBL_MAX if the sketch is empty.
    TDIGEST.MIN {key}
    
    返回:
  - getMinAsync
```
public org.redisson.api.RFuture<Double> getMinAsync()
```
  - getMax
```
public Double getMax()
```
    Get maximum value from the sketch. Will return DBL_MIN if the sketch is empty.
    TDIGEST.MAX {key}
    
    返回:
  - getMaxAsync
```
public org.redisson.api.RFuture<Double> getMaxAsync()
```
  - getQuantile
```
public Double getQuantile(double quantile)
```
    Returns an estimate of the cutoff such that a specified fraction of the data added to this TDigest would be less than or equal to the cutoff.
    TDIGEST.QUANTILE {key} {quantile}
    
    返回:
  - getQuantileAsync
```
public org.redisson.api.RFuture<Double> getQuantileAsync(double quantile)
```
  - getCdf
```
public Double getCdf(double value)
```
    Returns the fraction of all points added which are <= value.
    TDIGEST.CDF {key} {value}
    
    参数:
    
    value -
    
    返回:
  - getCdfAsync
```
public org.redisson.api.RFuture<Double> getCdfAsync(double value)
```
  - mergeTo
```
public boolean mergeTo(String toKey)
```
    Merges all of the values from 'this' to 'toKey' sketch.
    
    参数:
    
    toKey -
    
    返回:
  - mergeToAsync
```
public org.redisson.api.RFuture<Boolean> mergeToAsync(String toKey)
```
  - getInfo
```
public TDigestInfo getInfo()
```
    TDIGEST.INFO {key}
    
    返回:
    
    Returns compression, capacity, total merged and unmerged nodes, the total compressions made up to date on that key, and merged and unmerged weight.
  - getInfoAsync
```
public org.redisson.api.RFuture<TDigestInfo> getInfoAsync()
```

类 TDigest

字段概要

从类继承的字段 org.redisson.RedissonObject

构造器概要

方法概要

从类继承的方法 org.redisson.RedissonObject

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

构造器详细资料

TDigest

TDigest

方法详细资料

create

createAsync

reset

resetAsync

add

addAsync

getMin

getMinAsync

getMax

getMaxAsync

getQuantile

getQuantileAsync

getCdf

getCdfAsync

mergeTo

mergeToAsync

getInfo

getInfoAsync