com.github.jessemull.microflexinteger.math

Class Addition

java.lang.Object

com.github.jessemull.microflexinteger.math.MathOperationBinary

com.github.jessemull.microflexinteger.math.Addition

public class Addition
extends MathOperationBinary

This class performs addition operations with two arguments for integer plate stacks, plates, wells and well sets. Operations can be performed on stacks, plates, sets or wells of uneven length using standard or strict functions. Standard functions treat all values missing from a data set as zeroes and combine all stacks, plates, sets and wells from both input objects. Strict functions omit all values, stacks, plates, wells and sets missing from one of the input objects:

Operation	Output
Standard	Treats missing values as zeroes Combines stacks, plates, sets, wells and values from both input objects
Strict	Omits all missing values Combines stacks, plates, sets, wells and values present in both input objects only

The functions within the MicroFlex library are designed to be flexible and classes extending the math operation binary object support operations using two stacks, plates, sets and well objects as input. In addition, they support operations using a single stack, plate, set or well object and a collection, array or constant, and also allow the developer to limit the operation to a subset of data:

Input 1	Input 2	Beginning Index	Length of Subset	Operation
Well	Well	+/-	+/-	Performs the operation using the values in the two wells
Well	Array	+/-	+/-	Performs the operation using the values in the array and the values in the well
Well	Collection	+/-	+/-	Performs the operation using the values in the collection and the values in the well
Well	Constant	+/-	+/-	Performs the operation using the constant value and each value in the well
Set	Set	+/-	+/-	Performs the operation on the values in each matching pair of wells in the two sets
Set	Array	+/-	+/-	Performs the operation using the values in the array and the values in each well of the set
Set	Collection	+/-	+/-	Performs the operation using the values in the collection and the values in each well of the set
Set	Constant	+/-	+/-	Performs the operation using the constant and each value in each well of the set
Plate	Plate	+/-	+/-	Performs the operation on the values in each matching pair of wells in the two plates
Plate	Array	+/-	+/-	Performs the operation using the values in the array and the values in each well of the plate
Plate	Collection	+/-	+/-	Performs the operation using the values in the collection and the values in each well of the plate
Plate	Constant	+/-	+/-	Performs the operation using the constant and each value in each well of the plate
Stack	Stack	+/-	+/-	Performs the operation on the values in each matching pair of wells in each matching plate in the stack
Stack	Array	+/-	+/-	Performs the operation using the values in the array and the values in each well of each plate in the stack
Stack	Collection	+/-	+/-	Performs the operation using the values in the collection and the values in each well of each plate in the stack
Stack	Constant	+/-	+/-	Performs the operation using the constant and each value in each well of each plate in the stack

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
Addition()

Method Summary

Modifier and Type	Method and Description
List<Integer>	calculate(List<Integer> list, Collection<Integer> collection) Adds the list values and the values within the collection.
List<Integer>	calculate(List<Integer> list, Collection<Integer> collection, int begin, int length) Adds the list values and the values within the collection.
List<Integer>	calculate(List<Integer> list, int constant) Adds the constant to each value in the list.
List<Integer>	calculate(List<Integer> list, int[] array) Adds the list values and the values within the array.
List<Integer>	calculate(List<Integer> list, int[] array, int begin, int length) Adds the list values and the values within the array using the values between the indices.
List<Integer>	calculate(List<Integer> list1, List<Integer> list2) Adds the lists and returns the result.
List<Integer>	calculate(List<Integer> list1, List<Integer> list2, int begin, int length) Adds the lists and returns the result using the values between the indices.
List<Integer>	calculateStrict(List<Integer> list, Collection<Integer> collection) Adds the list values and the values within the collection.
List<Integer>	calculateStrict(List<Integer> list, Collection<Integer> collection, int begin, int length) Adds the list the values and the values within the collection using the values between the indices.
List<Integer>	calculateStrict(List<Integer> list, int[] array) Adds the list values and the values within the array.
List<Integer>	calculateStrict(List<Integer> list, int[] array, int begin, int length) Adds the list values and the values within the array using the values between the indices.
List<Integer>	calculateStrict(List<Integer> list1, List<Integer> list2) Adds the lists and returns the result.
List<Integer>	calculateStrict(List<Integer> list1, List<Integer> list2, int begin, int length) Adds the lists and returns the result using the values between the indices.

Methods inherited from class com.github.jessemull.microflexinteger.math.MathOperationBinary

plates, plates, plates, plates, plates, plates, plates, platesStrict, platesStrict, platesStrict, platesStrict, platesStrict, platesStrict, sets, sets, sets, sets, sets, sets, sets, setsStrict, setsStrict, setsStrict, setsStrict, setsStrict, setsStrict, stacks, stacks, stacks, stacks, stacks, stacks, stacks, stacksStrict, stacksStrict, stacksStrict, stacksStrict, stacksStrict, stacksStrict, wells, wells, wells, wells, wells, wells, wells, wellsStrict, wellsStrict, wellsStrict, wellsStrict, wellsStrict, wellsStrict

Methods inherited from class java.lang.Object

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

Constructor Detail

Addition

public Addition()

Method Detail

calculate

public List<Integer> calculate(List<Integer> list1,
                               List<Integer> list2)

Adds the lists and returns the result. Missing data points due to uneven list lengths are treated as zeroes.

Specified by:

calculate in class MathOperationBinary

Parameters:

List - list1 the first list

List - list2 the second list

Returns:

the result

calculateStrict

public List<Integer> calculateStrict(List<Integer> list1,
                                     List<Integer> list2)

Adds the lists and returns the result. Missing data points due to uneven list lengths are omitted.

Specified by:

calculateStrict in class MathOperationBinary

Parameters:

List - list1 the first list

List - list2 the second list

Returns:

the result

calculate

public List<Integer> calculate(List<Integer> list1,
                               List<Integer> list2,
                               int begin,
                               int length)

Adds the lists and returns the result using the values between the indices. Missing data points due to uneven list lengths are treated as zeroes.

Specified by:

calculate in class MathOperationBinary

Parameters:

List - list1 the first list

List - list2 the second list

int - begin beginning index of the subset

int - length length of the subset

Returns:

the result

calculateStrict

public List<Integer> calculateStrict(List<Integer> list1,
                                     List<Integer> list2,
                                     int begin,
                                     int length)

Adds the lists and returns the result using the values between the indices. Missing data points due to uneven list lengths are omitted.

Specified by:

calculateStrict in class MathOperationBinary

Parameters:

List - list1 the first list

List - list2 the second list

int - begin beginning index of the subset

int - length length of the subset

Returns:

the result

calculate

public List<Integer> calculate(List<Integer> list,
                               int constant)

Adds the constant to each value in the list.

Specified by:

calculate in class MathOperationBinary

Parameters:

List - list the list

int - constant the constant value

Returns:

the result

calculate

public List<Integer> calculate(List<Integer> list,
                               int[] array)

Adds the list values and the values within the array. Missing data points due to uneven list and array sizes are treated as zeroes.

Specified by:

calculate in class MathOperationBinary

Parameters:

List - list the list

int[] - array the array

Returns:

the result

calculate

public List<Integer> calculate(List<Integer> list,
                               int[] array,
                               int begin,
                               int length)

Adds the list values and the values within the array using the values between the indices. Missing data points due to uneven list and array sizes are treated as zeroes.

Specified by:

calculate in class MathOperationBinary

Parameters:

List - list the list

int[] - array the array

int - begin beginning index of the subset

int - length length of the subset

Returns:

the result

calculate

public List<Integer> calculate(List<Integer> list,
                               Collection<Integer> collection)

Adds the list values and the values within the collection. Missing data points due to uneven list and collection sizes are treated as zeroes.

Specified by:

calculate in class MathOperationBinary

Parameters:

List - list the list

Collection - collection the collection of values

Returns:

the result

calculate

public List<Integer> calculate(List<Integer> list,
                               Collection<Integer> collection,
                               int begin,
                               int length)

Adds the list values and the values within the collection. Missing data points due to uneven list and collection sizes are treated as zeroes.

Specified by:

calculate in class MathOperationBinary

Parameters:

List - list the list

Collection - collection the collection of values

int - begin beginning index of the subset

int - length length of the subset

Returns:

the result

calculateStrict

public List<Integer> calculateStrict(List<Integer> list,
                                     int[] array)

Adds the list values and the values within the array. Missing data points due to uneven list and array sizes are omitted.

Specified by:

calculateStrict in class MathOperationBinary

Parameters:

List - list the list

int[] - array the array

Returns:

the result

calculateStrict

public List<Integer> calculateStrict(List<Integer> list,
                                     int[] array,
                                     int begin,
                                     int length)

Adds the list values and the values within the array using the values between the indices. Missing data points due to uneven list and array sizes are omitted.

Specified by:

calculateStrict in class MathOperationBinary

Parameters:

List - list the list

int[] - array the array

int - begin beginning index of the subset

int - length length of the subset

Returns:

the result

calculateStrict

public List<Integer> calculateStrict(List<Integer> list,
                                     Collection<Integer> collection)

Adds the list values and the values within the collection. Missing data points due to uneven list and array sizes are omitted.

Specified by:

calculateStrict in class MathOperationBinary

Parameters:

List - list the list

Collection - collection the collection

Returns:

the result

calculateStrict

public List<Integer> calculateStrict(List<Integer> list,
                                     Collection<Integer> collection,
                                     int begin,
                                     int length)

Adds the list the values and the values within the collection using the values between the indices. Missing data points due to uneven list and collection sizes are omitted.

Specified by:

calculateStrict in class MathOperationBinary

Parameters:

List - list the list

Collection - collection the collection

int - begin beginning index of the subset

int - length length of the subset

Returns:

the result