CpuThreshold (deeplearning4j 1.0.0-beta7 API)

java.lang.Object
- org.nd4j.compression.impl.AbstractCompressor
- - org.nd4j.linalg.cpu.nativecpu.compression.CpuThreshold

All Implemented Interfaces:

NDArrayCompressor

Direct Known Subclasses:

CpuFlexibleThreshold
```
public class CpuThreshold
extends AbstractCompressor
```
This compression is very special case, and shouldn't be ever used outside of ParallelWrapper/ParameterServer implementation. It encodes data as delta between zero and abs threshold. PLEASE NOTE: DO NOT USE THIS COMPRESSOR UNLESS YOU'RE 100% SURE WHAT YOU DO!

Author:

raver119@gmail.com

Field Summary

Fields
Modifier and Type Field and Description

protected float threshold

Fields
Modifier and Type	Field and Description
`protected float`	`threshold`

Constructor Summary

Constructors
Constructor and Description

CpuThreshold()

Constructors
Constructor and Description
`CpuThreshold()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataBuffer`	`compress(DataBuffer buffer)`
`INDArray`	`compress(INDArray array)` This method returns compressed copy of referenced array
`protected CompressedDataBuffer`	`compressPointer(DataTypeEx srcType, org.bytedeco.javacpp.Pointer srcPointer, int length, int elementSize)`
`void`	`configure(Object... vars)` This method allows you to configure threshold for delta extraction.
`DataBuffer`	`decompress(DataBuffer buffer, DataType dataType)` Return a compressed databuffer
`CompressionType`	`getCompressionType()` This method returns compression opType provided by specific NDArrayCompressor implementation
`String`	`getDescriptor()` This method returns compression descriptor.

Methods inherited from class org.nd4j.compression.impl.AbstractCompressor
compress, compress, compress, compress, compressi, convertType, decompress, decompressi, getBufferTypeEx, getGlobalTypeEx

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - threshold
```
protected float threshold
```
- Constructor Detail
  - CpuThreshold
```
public CpuThreshold()
```
- Method Detail
  - getDescriptor
```
public String getDescriptor()
```
    This method returns compression descriptor. It should be unique for any compressor implementation
    
    Returns:
  - configure
```
public void configure(Object... vars)
```
    This method allows you to configure threshold for delta extraction. Pass it as float/double value Default value: 1e-3
    
    Specified by:
    
    configure in interface NDArrayCompressor
    
    Overrides:
    
    configure in class AbstractCompressor
    
    Parameters:
    
    vars -
  - compress
```
public INDArray compress(INDArray array)
```
    Description copied from interface: NDArrayCompressor
    
    This method returns compressed copy of referenced array
    
    Specified by:
    
    compress in interface NDArrayCompressor
    
    Overrides:
    
    compress in class AbstractCompressor
    
    Returns:
  - getCompressionType
```
public CompressionType getCompressionType()
```
    Description copied from interface: NDArrayCompressor
    
    This method returns compression opType provided by specific NDArrayCompressor implementation
    
    Returns:
  - decompress
```
public DataBuffer decompress(DataBuffer buffer,
                             DataType dataType)
```
    Description copied from interface: NDArrayCompressor
    
    Return a compressed databuffer
    
    Specified by:
    
    decompress in interface NDArrayCompressor
    
    Specified by:
    
    decompress in class AbstractCompressor
    
    Parameters:
    
    buffer - the buffer to decompress
    
    Returns:
    
    the decompressed data buffer
  - compress
```
public DataBuffer compress(DataBuffer buffer)
```
    Specified by:
    
    compress in interface NDArrayCompressor
    
    Specified by:
    
    compress in class AbstractCompressor
    
    Returns:
  - compressPointer
```
protected CompressedDataBuffer compressPointer(DataTypeEx srcType,
                                               org.bytedeco.javacpp.Pointer srcPointer,
                                               int length,
                                               int elementSize)
```
    Specified by:
    
    compressPointer in class AbstractCompressor

Class CpuThreshold

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.nd4j.compression.impl.AbstractCompressor

Methods inherited from class java.lang.Object

Field Detail

threshold

Constructor Detail

CpuThreshold

Method Detail

getDescriptor

configure

compress

getCompressionType

decompress

compress

compressPointer