CompressionDescriptor

java.lang.Object
- org.nd4j.linalg.compression.CompressionDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CompressionDescriptor
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
A compression descriptor containing the compression opType, compression algorithm, original length, compressed length, number of elements, and the original element size

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int COMPRESSION_BYTE_BUFFER_LENGTH

Fields
Modifier and Type	Field and Description
`static int`	`COMPRESSION_BYTE_BUFFER_LENGTH`

Constructor Summary

Constructors
Constructor and Description
`CompressionDescriptor()`
`CompressionDescriptor(DataBuffer buffer)` Create a compression descriptor from the given data buffer elements
`CompressionDescriptor(DataBuffer buffer, NDArrayCompressor compressor)` Initialize a compression descriptor based on the given data buffer (for the sizes) and the compressor to get the opType
`CompressionDescriptor(DataBuffer buffer, java.lang.String algorithm)` Initialize a compression descriptor based on the given algorithm and data buffer

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompressionDescriptor`	`clone()`
`static CompressionDescriptor`	`fromByteBuffer(java.nio.ByteBuffer byteBuffer)` Instantiate a compression descriptor from the given bytebuffer
`java.nio.ByteBuffer`	`toByteBuffer()` Return a direct allocated bytebuffer from the compression codec.

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

- Field Detail
  - COMPRESSION_BYTE_BUFFER_LENGTH
```
public static final int COMPRESSION_BYTE_BUFFER_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CompressionDescriptor
```
public CompressionDescriptor()
```
  - CompressionDescriptor
```
public CompressionDescriptor(DataBuffer buffer)
```
    Create a compression descriptor from the given data buffer elements
    
    Parameters:
    
    buffer - the databuffer to create the compression descriptor from
  - CompressionDescriptor
```
public CompressionDescriptor(DataBuffer buffer,
                             java.lang.String algorithm)
```
    Initialize a compression descriptor based on the given algorithm and data buffer
    
    Parameters:
    
    buffer - the data buffer to base the sizes off of
    
    algorithm - the algorithm used in the descriptor
  - CompressionDescriptor
```
public CompressionDescriptor(DataBuffer buffer,
                             NDArrayCompressor compressor)
```
    Initialize a compression descriptor based on the given data buffer (for the sizes) and the compressor to get the opType
    
    Parameters:
    
    buffer -
    
    compressor -
- Method Detail
  - fromByteBuffer
```
public static CompressionDescriptor fromByteBuffer(java.nio.ByteBuffer byteBuffer)
```
    Instantiate a compression descriptor from the given bytebuffer
    
    Parameters:
    
    byteBuffer - the bytebuffer to instantiate the descriptor from
    
    Returns:
    
    the instantiated descriptor based on the given bytebuffer
  - toByteBuffer
```
public java.nio.ByteBuffer toByteBuffer()
```
    Return a direct allocated bytebuffer from the compression codec. The size of the bytebuffer is calculated to be: 40: 8 + 32 two ints representing their enum values for the compression algorithm and opType and 4 longs for the compressed and original sizes
    
    Returns:
    
    the bytebuffer described above
  - clone
```
public CompressionDescriptor clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class CompressionDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMPRESSION_BYTE_BUFFER_LENGTH

Constructor Detail

CompressionDescriptor

CompressionDescriptor

CompressionDescriptor

CompressionDescriptor

Method Detail

fromByteBuffer

toByteBuffer

clone