ArrayConverters (mmtf 1.0.0 API)

java.lang.Object
- org.rcsb.mmtf.codec.ArrayConverters

```
public class ArrayConverters
extends Object
```
Class of functions to convert arrays to readable types. e.g. byte arrays to integer arrays.

Author:

Anthony Bradley

Constructor Summary

Constructors
Constructor and Description

ArrayConverters()

Constructors
Constructor and Description
`ArrayConverters()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int[]`	`combineIntegers(int[] twoByteIntArray, int[] fourByteIntArray)` Combine integer arrays.
`static int[]`	`convertByteToIntegers(byte[] byteArray)` Convert a byte array containing two bytes to integers in an integer array.
`static int[]`	`convertCharToIntegers(char[] charArray)` Convert a char array to an integer array using the ASCII code for characters
`static int[]`	`convertFloatsToInts(float[] floatArray, float floatMultiplier)` Convert an integer array to a float array by multiplying by a float.
`static int[]`	`convertFourByteToIntegers(byte[] byteArray)` Convert a byte array containing four bytes to integers in an integer array.
`static byte[]`	`convertIntegersToBytes(int[] intArray)` Convert an integer array to byte array, where each integer is encoded by a single byte.
`static byte[]`	`convertIntegersToFourByte(int[] intArray)` Convert an integer array to byte array, where each integer is encoded by a four bytes.
`static byte[]`	`convertIntegersToTwoBytes(int[] intArray)` Convert an integer array to byte array, where each integer is encoded by a two bytes.
`static char[]`	`convertIntegerToChar(int[] integerArray)` Convert an integer array to a char array.
`static float[]`	`convertIntsToFloats(int[] intArray, float floatDivider)` Convert an integer array to a float array by dividing by a float.
`static byte[]`	`convertShortsToTwoBytes(short[] shortArray)` Convert a short array to byte array, where each short is encoded by a two bytes.
`static short[]`	`convertTwoBytesToShorts(byte[] byteArray)` Convert to byte integers to a short array.
`static int[]`	`convertTwoByteToIntegers(byte[] byteArray)` Convert a byte array containing two bytes to integers in an integer array.
`static String[]`	`decodeChainList(byte[] currentChainList, int length)` Find all the chain ids from a single byte array.
`static byte[]`	`encodeChainList(String[] chainNames, int length)` Convert the chain names to a byte array.
`static int[]`	`recursiveIndexDecode(int[] in)` Decodes an input array of integers following a Recursive Indexing strategy.
`static int[]`	`recursiveIndexEncode(int[] in)` Encodes an input array of integers following a Recursive Indexing strategy (uses a reduced alphabet with fixed limits).
`static List<int[]>`	`splitIntegers(int[] inputArray)` Convert an input array of integers to two arrays.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArrayConverters
```
public ArrayConverters()
```
- Method Detail
  - decodeChainList
```
public static String[] decodeChainList(byte[] currentChainList,
                                       int length)
```
    Find all the chain ids from a single byte array. Each byte encodes a different ASCII character.
    
    Parameters:
    
    currentChainList - the byte array of the chain list input.
    
    length - the number of bytes array takes
    
    Returns:
    
    the string array of the parsed chain ids
  - convertIntsToFloats
```
public static float[] convertIntsToFloats(int[] intArray,
                                          float floatDivider)
```
    Convert an integer array to a float array by dividing by a float.
    
    Parameters:
    
    intArray - the input integer array to be divided
    
    floatDivider - the float divider to divide the integers by.
    
    Returns:
    
    a float array converted from the input.
  - convertByteToIntegers
```
public static int[] convertByteToIntegers(byte[] byteArray)
```
    Convert a byte array containing two bytes to integers in an integer array.
    
    Parameters:
    
    byteArray - the input byte array
    
    Returns:
    
    the converted integer array
  - convertTwoByteToIntegers
```
public static int[] convertTwoByteToIntegers(byte[] byteArray)
```
    Convert a byte array containing two bytes to integers in an integer array.
    
    Parameters:
    
    byteArray - the input byte array
    
    Returns:
    
    the converted integer array
  - convertTwoBytesToShorts
```
public static short[] convertTwoBytesToShorts(byte[] byteArray)
```
    Convert to byte integers to a short array.
    
    Parameters:
    
    byteArray - the input byte array
    
    Returns:
    
    the short array converted
  - convertFourByteToIntegers
```
public static int[] convertFourByteToIntegers(byte[] byteArray)
```
    Convert a byte array containing four bytes to integers in an integer array.
    
    Parameters:
    
    byteArray - the input byte array
    
    Returns:
    
    the converted integer array
  - combineIntegers
```
public static int[] combineIntegers(int[] twoByteIntArray,
                                    int[] fourByteIntArray)
```
    Combine integer arrays. The first is an array purely of integers to be added. The second contains integers in pairs. The first in the pair is to be added. The second in the pair is the number of integers to read from the first array.
    
    Parameters:
    
    twoByteIntArray - an array of integers
    
    fourByteIntArray - an array of integers in pairs. The first in the pair is to be added to the output array. The second in the pair is the number of integers to read from the first array.
    
    Returns:
    
    the integer array output.
  - convertIntegerToChar
```
public static char[] convertIntegerToChar(int[] integerArray)
```
    Convert an integer array to a char array. Cast each integer to a char using the int as the ASCII value.
    
    Parameters:
    
    integerArray - the input integer array
    
    Returns:
    
    the converted char array
  - convertIntegersToBytes
```
public static byte[] convertIntegersToBytes(int[] intArray)
```
    Convert an integer array to byte array, where each integer is encoded by a single byte.
    
    Parameters:
    
    intArray - the input array of integers
    
    Returns:
    
    the byte array of the integers
  - convertIntegersToTwoBytes
```
public static byte[] convertIntegersToTwoBytes(int[] intArray)
```
    Convert an integer array to byte array, where each integer is encoded by a two bytes.
    
    Parameters:
    
    intArray - the input array of integers
    
    Returns:
    
    the byte array of the integers
  - convertShortsToTwoBytes
```
public static byte[] convertShortsToTwoBytes(short[] shortArray)
```
    Convert a short array to byte array, where each short is encoded by a two bytes.
    
    Parameters:
    
    shortArray - the input array of integers
    
    Returns:
    
    the byte array of the integers
  - convertIntegersToFourByte
```
public static byte[] convertIntegersToFourByte(int[] intArray)
```
    Convert an integer array to byte array, where each integer is encoded by a four bytes.
    
    Parameters:
    
    intArray - the input array of integers
    
    Returns:
    
    the byte array of the integers
  - convertFloatsToInts
```
public static int[] convertFloatsToInts(float[] floatArray,
                                        float floatMultiplier)
```
    Convert an integer array to a float array by multiplying by a float.
    
    Parameters:
    
    floatArray - the input float array to be converted to ints
    
    floatMultiplier - the float divider to multiply the floats by.
    
    Returns:
    
    an int array converted from the input.
  - splitIntegers
```
public static List<int[]> splitIntegers(int[] inputArray)
```
    Convert an input array of integers to two arrays. The first output array is a four byte integer array. The integers in this array are in pairs. The first in each pair is part of the
    
    Parameters:
    
    inputArray - the array of integers to be split.
    
    Returns:
    
    a list of two integer arrays. The first is of four byte integers.
  - convertCharToIntegers
```
public static int[] convertCharToIntegers(char[] charArray)
```
    Convert a char array to an integer array using the ASCII code for characters
    
    Parameters:
    
    charArray - the input character array
    
    Returns:
    
    an integer array of ASCII decoded chars
  - encodeChainList
```
public static byte[] encodeChainList(String[] chainNames,
                                     int length)
```
    Convert the chain names to a byte array.
    
    Parameters:
    
    chainNames - the list of chain names as string
    
    length - max length of chars in a string
    
    Returns:
    
    the byte array of the chain names
  - recursiveIndexEncode
```
public static int[] recursiveIndexEncode(int[] in)
```
    Encodes an input array of integers following a Recursive Indexing strategy (uses a reduced alphabet with fixed limits). To encode a number N that exceed an upper limit of the reduced alphabet (Smax), the encoder keeps reducing this number by subtracting (adding if N is negative) Smax from N, stopping when the number lies in the limits of a reduced alphabet.
    
    Parameters:
    
    in - the array of integer values to be encoded
    
    Returns:
    
    the encoded array
  - recursiveIndexDecode
```
public static int[] recursiveIndexDecode(int[] in)
```
    Decodes an input array of integers following a Recursive Indexing strategy. To decode the array, the coder keeps adding all the elements of the index, stopping when the index value is between (inclusive of ends) the limits of the reduced alphabet.
    
    Parameters:
    
    in - the array of integer values to be decoded
    
    Returns:
    
    the decoded array

Class ArrayConverters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArrayConverters

Method Detail

decodeChainList

convertIntsToFloats

convertByteToIntegers

convertTwoByteToIntegers

convertTwoBytesToShorts

convertFourByteToIntegers

combineIntegers

convertIntegerToChar

convertIntegersToBytes

convertIntegersToTwoBytes

convertShortsToTwoBytes

convertIntegersToFourByte

convertFloatsToInts

splitIntegers

convertCharToIntegers

encodeChainList

recursiveIndexEncode

recursiveIndexDecode