org.rcsb.mmtf.codec

Enum FloatCodecs

java.lang.Object

java.lang.Enum<FloatCodecs>

org.rcsb.mmtf.codec.FloatCodecs

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FloatCodecs>, CodecInterface, FloatCodecInterface

public enum FloatCodecs
extends java.lang.Enum<FloatCodecs>
implements FloatCodecInterface, CodecInterface

An enum defining the encoding and decoding strategies.

Author:

Anthony Bradley

Enum Constant Summary

Enum Constants

Enum Constant and Description
INT_DELTA_RECURSIVE Encoding a list of floats (e.g.
INT_RUNLENGTH Encoding a list of floats (e.g.

Method Summary

Modifier and Type	Method and Description
static float[]	decodeArr(byte[] inputData) Decode a byte array from an input array.
static FloatCodecs	getCodec(int codecId) Get the codec from an input byte.
int	getCodecId()
java.lang.String	getCodecName()
static FloatCodecs	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FloatCodecs[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.rcsb.mmtf.codec.FloatCodecInterface

decode, encode

Enum Constant Detail

INT_DELTA_RECURSIVE

public static final FloatCodecs INT_DELTA_RECURSIVE

Encoding a list of floats (e.g. coordinates) using integer encoding (3DP accuracy), delta encoding and then recursive indexing.

INT_RUNLENGTH

public static final FloatCodecs INT_RUNLENGTH

Encoding a list of floats (e.g. occupancy) using integer encoding (2DP accuracy) and then run length encoding.

Method Detail

values

public static FloatCodecs[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FloatCodecs c : FloatCodecs.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FloatCodecs valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCodec

public static FloatCodecs getCodec(int codecId)

Get the codec from an input byte.

Parameters:

codecId - the integer defining the coding

Returns:

the enum of the codec

decodeArr

public static float[] decodeArr(byte[] inputData)

Decode a byte array from an input array.

Parameters:

inputData - the byte array of data

Returns:

the decoded array as a float array

getCodecName

public java.lang.String getCodecName()

Specified by:

getCodecName in interface CodecInterface

Returns:

the codec name. A string naming the codec

getCodecId

public int getCodecId()

Specified by:

getCodecId in interface CodecInterface

Returns:

the codecId. A byte describing the codec.