org.apache.sysds.runtime.transform.encode

Class EncoderComposite

java.lang.Object

org.apache.sysds.runtime.transform.encode.Encoder

org.apache.sysds.runtime.transform.encode.EncoderComposite

All Implemented Interfaces:

Serializable

public class EncoderComposite
extends Encoder

Simple composite encoder that applies a list of encoders in specified order. By implementing the default encoder API it can be used as a drop-in replacement for any other encoder.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EncoderComposite(List<Encoder> encoders)

Method Summary

Modifier and Type	Method and Description
MatrixBlock	apply(FrameBlock in, MatrixBlock out) Encode input data blockwise according to existing transform meta data (transform apply).
void	build(FrameBlock in) Build the transform meta data for the given block input.
MatrixBlock	encode(FrameBlock in, MatrixBlock out) Block encode: build and apply (transform encode).
MatrixBlock	getColMapping(FrameBlock meta, MatrixBlock out) Obtain the column mapping of encoded frames based on the passed meta data frame.
List<Encoder>	getEncoders()
FrameBlock	getMetaData(FrameBlock out) Construct a frame block out of the transform meta data.
int	getNumCols()
void	initMetaData(FrameBlock out) Sets up the required meta data for a subsequent call to apply.
void	mergeAt(Encoder other, int row, int col) Merges another encoder, of a compatible type, in after a certain position.
Encoder	subRangeEncoder(IndexRange ixRange) Returns a new Encoder that only handles a sub range of columns.
String	toString()
void	updateIndexRanges(long[] beginDims, long[] endDims) Update index-ranges to after encoding.

Methods inherited from class org.apache.sysds.runtime.transform.encode.Encoder

getColList, initColList, initColList, isApplicable, isApplicable, setColList

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EncoderComposite

public EncoderComposite(List<Encoder> encoders)

Method Detail

getNumCols

public int getNumCols()

Overrides:

getNumCols in class Encoder

getEncoders

public List<Encoder> getEncoders()

encode

public MatrixBlock encode(FrameBlock in,
                          MatrixBlock out)

Description copied from class: Encoder

Block encode: build and apply (transform encode).

Specified by:

encode in class Encoder

Parameters:

in - input frame block

out - output matrix block

Returns:

output matrix block

build

public void build(FrameBlock in)

Description copied from class: Encoder

Build the transform meta data for the given block input. This call modifies and keeps meta data as encoder state.

Specified by:

build in class Encoder

Parameters:

in - input frame block

apply

public MatrixBlock apply(FrameBlock in,
                         MatrixBlock out)

Description copied from class: Encoder

Encode input data blockwise according to existing transform meta data (transform apply).

Specified by:

apply in class Encoder

Parameters:

in - input frame block

out - output matrix block

Returns:

output matrix block

subRangeEncoder

public Encoder subRangeEncoder(IndexRange ixRange)

Description copied from class: Encoder

Returns a new Encoder that only handles a sub range of columns.

Overrides:

subRangeEncoder in class Encoder

Parameters:

ixRange - the range (1-based, begin inclusive, end exclusive)

Returns:

an encoder of the same type, just for the sub-range

mergeAt

public void mergeAt(Encoder other,
                    int row,
                    int col)

Description copied from class: Encoder

Merges another encoder, of a compatible type, in after a certain position. Resizes as necessary. Encoders are compatible with themselves and EncoderComposite is compatible with every other Encoder.

Overrides:

mergeAt in class Encoder

Parameters:

other - the encoder that should be merged in

row - the row where it should be placed (1-based)

col - the col where it should be placed (1-based)

updateIndexRanges

public void updateIndexRanges(long[] beginDims,
                              long[] endDims)

Description copied from class: Encoder

Update index-ranges to after encoding. Note that only Dummycoding changes the ranges.

Overrides:

updateIndexRanges in class Encoder

Parameters:

beginDims - begin dimensions of range

endDims - end dimensions of range

getMetaData

public FrameBlock getMetaData(FrameBlock out)

Description copied from class: Encoder

Construct a frame block out of the transform meta data.

Specified by:

getMetaData in class Encoder

Parameters:

out - output frame block

Returns:

output frame block?

initMetaData

public void initMetaData(FrameBlock out)

Description copied from class: Encoder

Sets up the required meta data for a subsequent call to apply.

Specified by:

initMetaData in class Encoder

Parameters:

out - frame block

getColMapping

public MatrixBlock getColMapping(FrameBlock meta,
                                 MatrixBlock out)

Description copied from class: Encoder

Obtain the column mapping of encoded frames based on the passed meta data frame.

Overrides:

getColMapping in class Encoder

Parameters:

meta - meta data frame block

out - output matrix

Returns:

matrix with column mapping (one row per attribute)

toString

public String toString()

Overrides:

toString in class Object