Module org.tensorflow.ndarray

Package org.tensorflow.ndarray.impl.buffer.layout

Class StringLayout

java.lang.Object

org.tensorflow.ndarray.impl.buffer.layout.StringLayout

All Implemented Interfaces:

DataLayout<DataBuffer<byte[]>,String>

public final class StringLayout
extends Object
implements DataLayout<DataBuffer<byte[]>,String>

Data layout that converts a String to/from a sequence of bytes applying a given charset.

Method Summary

Modifier and Type	Method	Description
static StringLayout	of(Charset charset)
String	readObject(DataBuffer<byte[]> buffer, long index)	Reads n = scale() values from the buffer at the given index and return them as a single value in the user type.
void	writeObject(DataBuffer<byte[]> buffer, String value, long index)	Writes a user value into the buffer at the given index after converting it to the buffer type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tensorflow.ndarray.buffer.layout.DataLayout

applyTo, scale

Method Detail

of

public static StringLayout of(Charset charset)

writeObject

public void writeObject(DataBuffer<byte[]> buffer,
                        String value,
                        long index)

Description copied from interface: DataLayout

Writes a user value into the buffer at the given index after converting it to the buffer type.

It is the responsibility of the implementors of this interface to write the converted value to the given buffer before this call returns, using the most appropriate method. For example, for a layout converting a BigInteger to a single long,

 @Override
 public void writeObject(LongDataBuffer buffer, BigInteger value, long index) {
   buffer.setLong(value.longValue(), index);
 }
 

If a single user value scales over more than one buffer values, index indicates the starting position of the sequence to be written to the buffer.

Specified by:

writeObject in interface DataLayout<DataBuffer<byte[]>,String>

Parameters:

buffer - the buffer to write to

value - the value in the user type to convert and write

index - index in the buffer where the converted value should be written

readObject

public String readObject(DataBuffer<byte[]> buffer,
                         long index)

Description copied from interface: DataLayout

Reads n = scale() values from the buffer at the given index and return them as a single value in the user type.

It is the responsibility of the implementors of this interface to read the value to be converted from the given buffer, using the most appropriate method. For example, for a layout that converting a single long to a BigInteger,

 @Override
 public BigInteger readObject(LongDataBuffer buffer, long index) {
   return BigInteger.valueOf(buffer.getLong(index));
 }
 

If a single user value scales over more than one buffer values, index indicates the starting position of the sequence to be read from the buffer.

Specified by:

readObject in interface DataLayout<DataBuffer<byte[]>,String>

Parameters:

buffer - the buffer to read from

index - position of the buffer to read in the buffer

Returns:

the converted value