org.nd4j.linalg.compression

Interface NDArrayCompressor

public interface NDArrayCompressor

NDArray compressor. Given a compression algorithm, it can compress/decompress databuffers and ndarrays.

Author:

[email protected]

Method Summary

Modifier and Type	Method and Description
DataBuffer	compress(DataBuffer buffer)
INDArray	compress(double[] data) This method creates compressed INDArray from Java double array, skipping usual INDArray instantiation routines Please note: This method compresses input data as vector
INDArray	compress(double[] data, int[] shape, char order) This method creates compressed INDArray from Java double array, skipping usual INDArray instantiation routines
INDArray	compress(float[] data) This method creates compressed INDArray from Java float array, skipping usual INDArray instantiation routines Please note: This method compresses input data as vector
INDArray	compress(float[] data, int[] shape, char order) This method creates compressed INDArray from Java float array, skipping usual INDArray instantiation routines
INDArray	compress(INDArray array) This method returns compressed copy of referenced array
void	compressi(INDArray array) Inplace compression of INDArray
void	configure(Object... vars) This method allows to pass compressor-dependent configuration options to this compressor PLEASE NOTE: Each compressor has own options, please check corresponding implementations javadoc
DataBuffer	decompress(DataBuffer buffer) Return a compressed databuffer
INDArray	decompress(INDArray array) This method returns decompressed copy of referenced array
void	decompressi(INDArray array) Inplace decompression of INDArray
CompressionType	getCompressionType() This method returns compression type provided by specific NDArrayCompressor implementation
String	getDescriptor() This method returns compression descriptor.

Method Detail

getDescriptor

String getDescriptor()

This method returns compression descriptor. It should be unique for any compressor implementation

Returns:

configure

void configure(Object... vars)

This method allows to pass compressor-dependent configuration options to this compressor PLEASE NOTE: Each compressor has own options, please check corresponding implementations javadoc

Parameters:

vars -

getCompressionType

CompressionType getCompressionType()

This method returns compression type provided by specific NDArrayCompressor implementation

Returns:

compress

INDArray compress(INDArray array)

This method returns compressed copy of referenced array

Parameters:

array -

Returns:

compressi

void compressi(INDArray array)

Inplace compression of INDArray

Parameters:

array -

compress

DataBuffer compress(DataBuffer buffer)

Parameters:

buffer -

Returns:

decompress

INDArray decompress(INDArray array)

This method returns decompressed copy of referenced array

Parameters:

array -

Returns:

decompressi

void decompressi(INDArray array)

Inplace decompression of INDArray

Parameters:

array -

decompress

DataBuffer decompress(DataBuffer buffer)

Return a compressed databuffer

Parameters:

buffer - the buffer to decompress

Returns:

the decompressed data buffer

compress

INDArray compress(float[] data)

This method creates compressed INDArray from Java float array, skipping usual INDArray instantiation routines Please note: This method compresses input data as vector

Parameters:

data -

Returns:

compress

INDArray compress(double[] data)

This method creates compressed INDArray from Java double array, skipping usual INDArray instantiation routines Please note: This method compresses input data as vector

Parameters:

data -

Returns:

compress

INDArray compress(float[] data,
                  int[] shape,
                  char order)

This method creates compressed INDArray from Java float array, skipping usual INDArray instantiation routines

Parameters:

data -

shape -

Returns:

compress

INDArray compress(double[] data,
                  int[] shape,
                  char order)

This method creates compressed INDArray from Java double array, skipping usual INDArray instantiation routines

Parameters:

data -

shape -

Returns: