org.nd4j.linalg.compression

Class BasicNDArrayCompressor

java.lang.Object

org.nd4j.linalg.compression.BasicNDArrayCompressor

public class BasicNDArrayCompressor
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,NDArrayCompressor>	codecs
protected String	defaultCompression

Method Summary

Modifier and Type	Method and Description
void	autoDecompress(INDArray... arrays) Decompress several ndarrays
void	autoDecompress(INDArray array)
DataBuffer	compress(DataBuffer buffer) Compress the given data buffer given the default compression algorithm
DataBuffer	compress(DataBuffer buffer, String algorithm) Compress the data buffer given a specified algorithm
INDArray	compress(double[] array) This method returns compressed INDArray instance which contains JVM array passed in
INDArray	compress(float[] array) This method returns compressed INDArray instance which contains JVM array passed in
INDArray	compress(INDArray array)
INDArray	compress(INDArray array, String algorithm) Returns a compressed version of the given ndarray
void	compressi(INDArray array) In place compression of the passed in ndarray with the default compression algorithm
void	compressi(INDArray array, String algorithm) In place Compress the given ndarray with the given algorithm
DataBuffer	decompress(DataBuffer buffer, DataType targetType) Decompress the given databuffer
INDArray	decompress(INDArray array)
void	decompressi(INDArray array) in place decompression of the given ndarray.
Set<String>	getAvailableCompressors() Get the set of available codecs for compression
NDArrayCompressor	getCompressor(@NonNull String name)
String	getDefaultCompression() Get the default compression algorithm as a string.
static BasicNDArrayCompressor	getInstance() Get the ndarray compressor singleton
protected void	loadCompressors()
void	printAvailableCompressors() Prints available compressors to standard out
BasicNDArrayCompressor	setDefaultCompression(@NonNull String algorithm) Set the default compression algorithm

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

codecs

protected Map<String,NDArrayCompressor> codecs

defaultCompression

protected String defaultCompression

Method Detail

loadCompressors

protected void loadCompressors()

getAvailableCompressors

public Set<String> getAvailableCompressors()

Get the set of available codecs for compression

Returns:

printAvailableCompressors

public void printAvailableCompressors()

Prints available compressors to standard out

getInstance

public static BasicNDArrayCompressor getInstance()

Get the ndarray compressor singleton

Returns:

setDefaultCompression

public BasicNDArrayCompressor setDefaultCompression(@NonNull
                                                    @NonNull String algorithm)

Set the default compression algorithm

Parameters:

algorithm - the algorithm to set

Returns:

getDefaultCompression

public String getDefaultCompression()

Get the default compression algorithm as a string. This is an all caps algorithm with a representation in the CompressionAlgorithm enum

Returns:

compress

public DataBuffer compress(DataBuffer buffer)

Compress the given data buffer given the default compression algorithm

Parameters:

buffer - the data buffer to compress

Returns:

the compressed version of the data buffer

compress

public DataBuffer compress(DataBuffer buffer,
                           String algorithm)

Compress the data buffer given a specified algorithm

Parameters:

buffer - the buffer to compress

algorithm - the algorithm to compress use

Returns:

the compressed data buffer

compress

public INDArray compress(INDArray array)

compressi

public void compressi(INDArray array)

In place compression of the passed in ndarray with the default compression algorithm

Parameters:

array -

compress

public INDArray compress(INDArray array,
                         String algorithm)

Returns a compressed version of the given ndarray

Parameters:

array - the array to compress

algorithm - the algorithm to compress with

Returns:

a compressed copy of this ndarray

compressi

public void compressi(INDArray array,
                      String algorithm)

In place Compress the given ndarray with the given algorithm

Parameters:

array - the array to compress

algorithm -

decompress

public DataBuffer decompress(DataBuffer buffer,
                             DataType targetType)

Decompress the given databuffer

Parameters:

buffer - the databuffer to compress

Returns:

the decompressed databuffer

getCompressor

public NDArrayCompressor getCompressor(@NonNull
                                       @NonNull String name)

decompress

public INDArray decompress(INDArray array)

Parameters:

array -

Returns:

decompressi

public void decompressi(INDArray array)

in place decompression of the given ndarray. If the ndarray isn't compressed this will do nothing

Parameters:

array - the array to decompressed if it is comprssed

autoDecompress

public void autoDecompress(INDArray... arrays)

Decompress several ndarrays

Parameters:

arrays -

autoDecompress

public void autoDecompress(INDArray array)

Parameters:

array -

compress

public INDArray compress(float[] array)

This method returns compressed INDArray instance which contains JVM array passed in

Parameters:

array -

Returns:

compress

public INDArray compress(double[] array)

This method returns compressed INDArray instance which contains JVM array passed in

Parameters:

array -

Returns: