com.github.jessemull.microflexbigdecimal.math.MathOperationBinaryContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of microflex-bigdecimal Show documentation
Show all versions of microflex-bigdecimal Show documentation
Microplate library for parsing wet lab data.
The newest version!
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/* -------------------------------- Package --------------------------------- */
package com.github.jessemull.microflexbigdecimal.math;
/* ------------------------------ Dependencies ------------------------------ */
import java.math.BigDecimal;
import java.math.MathContext;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import com.github.jessemull.microflexbigdecimal.plate.Plate;
import com.github.jessemull.microflexbigdecimal.plate.Stack;
import com.github.jessemull.microflexbigdecimal.plate.Well;
import com.github.jessemull.microflexbigdecimal.plate.WellSet;
/**
* This class performs mathematical operations with two arguments for BigDecimal
* plate stacks, plates, wells and well sets. To create a custom mathematical
* operation extend this class and override the calculate methods using the
* appropriate operation.
*
* 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 the
* math operation binary object supports operations using two stacks, plates, sets
* and well objects as input. In addition it supports operations using a single
* stack, plate, set or well object and a collection, array or constant. It also
* allows 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
*
*
*
* MicroFlex currently supports the following binary mathematical operations
* for BigDecimal objects:
*
*
* Operations
*
* Addition
*
*
* Subtraction
*
*
* Multiplication
*
*
* Division
*
*
* Modulus
*
*
*
* @author Jesse L. Mull
* @update Updated Oct 18, 2016
* @address http://www.jessemull.com
* @email [email protected]
*/
public abstract class MathOperationBinaryContext {
/* ---------------------------- Constructors ---------------------------- */
/**
* Creates a new math operation.
*/
public MathOperationBinaryContext() {}
/* ----------------------------- Well Methods --------------------------- */
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Well the first well
* @param Well the second well
* @param MathContext the math context
* @return result of the operation
*/
public List wells(Well well1, Well well2, MathContext mc) {
this.validateArgs(well1, well2);
return calculate(well1.data(), well2.data(), mc);
}
/**
* Returns the result of the mathematical operation using the data between
* the indices. Missing data points due to uneven data set lengths are treated as
* zeroes.
* @param Well the first well
* @param Well the second well
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public List wells(Well well1, Well well2, int begin, int length, MathContext mc) {
this.validateArgs(well1, well2, begin, length);
return calculate(well1.data(), well2.data(), begin, length, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points
* due to uneven data set lengths are omitted.
* @param Well the first well
* @param Well the second well
* @param MathContext the math context
* @return result of the operation
*/
public List wellsStrict(Well well1, Well well2, MathContext mc) {
this.validateArgs(well1, well2);
return calculateStrict(well1.data(), well2.data(), mc);
}
/**
* Returns the result of the mathematical operation using the data between
* the indices. Missing data points due to uneven data set lengths are omitted.
* @param Well the first well
* @param Well the second well
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public List wellsStrict(Well well1, Well well2, int begin, int length, MathContext mc) {
this.validateArgs(well1, well2, begin, length);
return calculateStrict(well1.data(), well2.data(), begin, length, mc);
}
/**
* Returns the result of the mathematical operation.
* @param Well the well
* @param BigDecimal constant for operation
* @param MathContext the math context
* @return result of the operation
*/
public List wells(Well well, BigDecimal constant, MathContext mc) {
this.validateArgs(well);
return this.calculate(well.data(), constant, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Well the well
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public List wells(Well well, BigDecimal[] array, MathContext mc) {
this.validateArgs(well, array);
return this.calculate(well.data(), array, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Well the well
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public List wells(Well well, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(well, array, begin, length);
return this.calculate(well.data(), array, begin, length, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Well the well
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public List wells(Well well, Collection collection, MathContext mc) {
this.validateArgs(well, collection);
return this.calculate(well.data(), collection, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Well the well
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public List wells(Well well, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(well, collection, begin, length);
return this.calculate(well.data(), collection, begin, length, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Well the well
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public List wellsStrict(Well well, BigDecimal[] array, MathContext mc) {
this.validateArgs(well, array);
return this.calculateStrict(well.data(), array, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Well the well
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public List wellsStrict(Well well, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(well, array, begin, length);
return this.calculateStrict(well.data(), array, begin, length, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Well the well
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public List wellsStrict(Well well, Collection collection, MathContext mc) {
this.validateArgs(well, collection);
return this.calculateStrict(well.data(), collection, mc);
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Well the well
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public List wellsStrict(Well well, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(well, collection, begin, length);
return this.calculateStrict(well.data(), collection, begin, length, mc);
}
/* ---------------------------- Plate Methods --------------------------- */
/**
* Returns the result of the mathematical operation. Missing data points due
* to unequal data set lengths are treated as zero values.
* @param Plate the first plate
* @param Plate the second plate
* @param MathContext the math context
* @return result of the operation
*/
public Plate plates(Plate plate1, Plate plate2, MathContext mc) {
this.validateArgs(plate1, plate2);
Plate result = new Plate(plate1.rows(), plate1.columns());
for(WellSet set : plate1.allGroups()) {
result.addGroups(set.wellList());
}
for(WellSet set : plate2.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.sets(plate1.dataSet(), plate2.dataSet(), mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation using the values between
* the indices. Missing data points due to data sets of unequal length are
* treated as zero values.
* @param Plate the first plate
* @param Plate the second plate
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Plate plates(Plate plate1, Plate plate2, int begin, int length, MathContext mc) {
this.validateArgs(plate1, plate2);
Plate result = new Plate(plate1.rows(), plate1.columns());
for(WellSet set : plate1.allGroups()) {
result.addGroups(set.wellList());
}
for(WellSet set : plate2.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.sets(plate1.dataSet(), plate2.dataSet(), begin, length, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to unequal data set lengths are omitted.
* @param Plate the first plate
* @param Plate the second plate
* @param MathContext the math context
* @return result of the operation
*/
public Plate platesStrict(Plate plate1, Plate plate2, MathContext mc) {
this.validateArgs(plate1, plate2);
Plate result = new Plate(plate1.rows(), plate1.columns());
for(WellSet set : plate1.allGroups()) {
result.addGroups(set.wellList());
}
for(WellSet set : plate2.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.setsStrict(plate1.dataSet(), plate2.dataSet(), mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation using the values between
* the indices. Missing data points due to unequal data set lengths are omitted.
* @param Plate the first plate
* @param Plate the second plate
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Plate platesStrict(Plate plate1, Plate plate2, int begin, int length, MathContext mc) {
this.validateArgs(plate1, plate2);
Plate result = new Plate(plate1.rows(), plate1.columns());
Set groups1 = plate1.allGroups();
Set groups2 = plate2.allGroups();
groups1.retainAll(groups2);
for(WellSet set : groups1) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.setsStrict(plate1.dataSet(), plate2.dataSet(), begin, length, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation.
* @param Plate the plate
* @param BigDecimal constant for operation
* @param MathContext the math context
* @return result of the operation
*/
public Plate plates(Plate plate, BigDecimal constant, MathContext mc) {
this.validateArgs(plate);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.sets(plate.dataSet(), constant, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Plate the plate
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Plate plates(Plate plate, BigDecimal[] array, MathContext mc) {
this.validateArgs(plate, array);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.sets(plate.dataSet(), array, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Plate the plate
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Plate plates(Plate plate, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(plate, array);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.sets(plate.dataSet(), array, begin, length, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Plate the plate
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Plate plates(Plate plate, Collection collection, MathContext mc) {
this.validateArgs(plate, collection);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.sets(plate.dataSet(), collection, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param Plate the plate
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Plate plates(Plate plate, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(plate, collection);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.sets(plate.dataSet(), collection, begin, length, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Plate the plate
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Plate platesStrict(Plate plate, BigDecimal[] array, MathContext mc) {
this.validateArgs(plate, array);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.setsStrict(plate.dataSet(), array, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Plate the plate
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Plate platesStrict(Plate plate, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(plate, array);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.setsStrict(plate.dataSet(), array, begin, length, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Plate the plate
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Plate platesStrict(Plate plate, Collection collection, MathContext mc) {
this.validateArgs(plate, collection);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.setsStrict(plate.dataSet(), collection, mc);
result.addWells(resultSet);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param Plate the plate
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Plate platesStrict(Plate plate, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(plate, collection);
Plate result = new Plate(plate.rows(), plate.columns());
for(WellSet set : plate.allGroups()) {
result.addGroups(set.wellList());
}
WellSet resultSet = this.setsStrict(plate.dataSet(), collection, begin, length, mc);
result.addWells(resultSet);
return result;
}
/* ----------------------------- Set Methods ---------------------------- */
/**
* Returns the result of the mathematical operation. Missing data points due
* to unequal data set lengths are treated as zero values.
* @param WellSet the first set
* @param WellSet the second set
* @param MathContext the math context
* @return result of the operation
*/
public WellSet sets(WellSet set1, WellSet set2, MathContext mc) {
this.validateArgs(set1, set2);
WellSet result = new WellSet();
WellSet clone1 = new WellSet(set1);
WellSet clone2 = new WellSet(set2);
WellSet set1Excluded = new WellSet(set1);
WellSet set2Excluded = new WellSet(set2);
set1Excluded.remove(set2);
set2Excluded.remove(set1);
clone1.retain(set2);
clone2.retain(set1);
Iterator iter1 = clone1.iterator();
Iterator iter2 = clone2.iterator();
while(iter1.hasNext()) {
Well well1 = iter1.next();
Well well2 = iter2.next();
List list = this.calculate(well1.data(), well2.data(), mc);
result.add(new Well(well1.row(), well1.column(), list));
}
result.add(set1Excluded);
result.add(set2Excluded);
return result;
}
/**
* Returns the result of the mathematical operation using the values between
* the indices. Missing data points due to data sets of unequal length are
* treated as zero values.
* @param WellSet the first set
* @param WellSet the second set
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public WellSet sets(WellSet set1, WellSet set2, int begin, int length, MathContext mc) {
this.validateArgs(set1, set2);
WellSet result = new WellSet();
WellSet clone1 = new WellSet(set1);
WellSet clone2 = new WellSet(set2);
WellSet set1Excluded = new WellSet(set1);
WellSet set2Excluded = new WellSet(set2);
set1Excluded.remove(set2);
set2Excluded.remove(set1);
clone1.retain(set2);
clone2.retain(set1);
Iterator iter1 = clone1.iterator();
Iterator iter2 = clone2.iterator();
while(iter1.hasNext()) {
Well well1 = iter1.next();
Well well2 = iter2.next();
validateArgs(well1, begin, length);
validateArgs(well2, begin, length);
List list = this.calculate(well1.data(), well2.data(), begin, length, mc);
result.add(new Well(well1.row(), well1.column(), list));
}
for(Well well : set1Excluded) {
well = well.subList(begin, length);
}
for(Well well : set2Excluded) {
well = well.subList(begin, length);
}
result.add(set1Excluded);
result.add(set2Excluded);
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to unequal data set lengths are omitted.
* @param WellSet the first set
* @param WellSet the second set
* @param MathContext the math context
* @return result of the operation
*/
public WellSet setsStrict(WellSet set1, WellSet set2, MathContext mc) {
this.validateArgs(set1, set2);
WellSet result = new WellSet();
WellSet clone1 = new WellSet(set1);
WellSet clone2 = new WellSet(set2);
WellSet set1Excluded = new WellSet(clone1);
WellSet set2Excluded = new WellSet(clone2);
set1Excluded.remove(clone2);
set2Excluded.remove(clone1);
clone1.retain(set2);
clone2.retain(set1);
Iterator iter1 = clone1.iterator();
Iterator iter2 = clone2.iterator();
while(iter1.hasNext()) {
Well well1 = iter1.next();
Well well2 = iter2.next();
validateArgs(well1, well2);
List list = this.calculateStrict(well1.data(), well2.data(), mc);
result.add(new Well(well1.row(), well1.column(), list));
}
return result;
}
/**
* Returns the result of the mathematical operation using the values between
* the indices. Missing data points due to unequal data set lengths are omitted.
* @param WellSet the first set
* @param WellSet the second set
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public WellSet setsStrict(WellSet set1, WellSet set2, int begin, int length, MathContext mc) {
this.validateArgs(set1, set2);
WellSet result = new WellSet();
WellSet clone1 = new WellSet(set1);
WellSet clone2 = new WellSet(set2);
clone1.retain(set2);
clone2.retain(set1);
Iterator iter1 = clone1.iterator();
Iterator iter2 = clone2.iterator();
while(iter1.hasNext()) {
Well well1 = iter1.next();
Well well2 = iter2.next();
validateArgs(well1, begin, length);
validateArgs(well2, begin, length);
List list = this.calculateStrict(well1.data(), well2.data(), begin, length, mc);
result.add(new Well(well1.row(), well1.column(), list));
}
return result;
}
/**
* Returns the result of the mathematical operation.
* @param WellSet the well set
* @param BigDecimal constant for operation
* @param MathContext the math context
* @return result of the operation
*/
public WellSet sets(WellSet set, BigDecimal constant, MathContext mc) {
this.validateArgs(set);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
result.add(new Well(well.row(), well.column(),
this.calculate(well.data(), constant, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param WellSet the well set
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public WellSet sets(WellSet set, BigDecimal[] array, MathContext mc) {
this.validateArgs(set, array);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
result.add(new Well(well.row(), well.column(),
this.calculate(well.data(), array, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param WellSet the well set
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public WellSet sets(WellSet set, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(set, array);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
this.validateArgs(well, begin, length);
result.add(new Well(well.row(), well.column(),
this.calculate(well.data(), array, begin, length, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param WellSet the well set
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public WellSet sets(WellSet set, Collection collection, MathContext mc) {
this.validateArgs(set, collection);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
result.add(new Well(well.row(), well.column(), this.calculate(well.data(), collection, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are treated as zeroes.
* @param WellSet the well set
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public WellSet sets(WellSet set, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(set, collection);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
this.validateArgs(well, begin, length);
result.add(new Well(well.row(), well.column(),
this.calculate(well.data(), collection, begin, length, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param WellSet the well set
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public WellSet setsStrict(WellSet set, BigDecimal[] array, MathContext mc) {
this.validateArgs(set, array);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
result.add(new Well(well.row(), well.column(), this.calculateStrict(well.data(), array, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param WellSet the well set
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public WellSet setsStrict(WellSet set, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(set, array);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
this.validateArgs(well, begin, length);
result.add(new Well(well.row(), well.column(), this.calculateStrict(well.data(), array, begin, length, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param WellSet the well set
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public WellSet setsStrict(WellSet set, Collection collection, MathContext mc) {
this.validateArgs(set, collection);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
result.add(new Well(well.row(), well.column(), this.calculateStrict(well.data(), collection, mc)));
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data set lengths are omitted.
* @param WellSet the well set
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public WellSet setsStrict(WellSet set, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(set, collection);
WellSet result = new WellSet();
result.setLabel(set.label());
for(Well well : set) {
this.validateArgs(well, begin, length);
result.add(new Well(well.row(), well.column(), this.calculateStrict(well.data(), collection, begin, length, mc)));
}
return result;
}
/* ---------------------------- Stack Methods --------------------------- */
/**
* Returns the result of the mathematical operation. Missing data points due
* to data sets of unequal length are treated as zero values.
* @param Stack the first stack
* @param Stack the second stack
* @param MathContext the math context
* @return the result of the operation
*/
public Stack stacks(Stack stack1, Stack stack2, MathContext mc) {
this.validateArgs(stack1, stack2);
Stack result = new Stack(stack1.rows(), stack2.columns());
Iterator iter1 = stack1.iterator();
Iterator iter2 = stack2.iterator();
while(iter1.hasNext() && iter2.hasNext()) {
Plate resultPlate = this.plates(iter1.next(), iter2.next(), mc);
result.add(resultPlate);
}
while(iter1.hasNext()) {
result.add(iter1.next());
}
while(iter2.hasNext()) {
result.add(iter2.next());
}
return result;
}
/**
* Returns the result of the mathematical operation using the values between
* the indices. Missing data points due to data sets of unequal length are
* treated as zero values.
* @param Stack the first stack
* @param Stack the second stack
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return the result of the addition
*/
public Stack stacks(Stack stack1, Stack stack2, int begin, int length, MathContext mc) {
this.validateArgs(stack1, stack2);
Stack result = new Stack(stack1.rows(), stack2.columns());
Iterator iter1 = stack1.iterator();
Iterator iter2 = stack2.iterator();
while(iter1.hasNext() && iter2.hasNext()) {
Plate resultPlate = this.plates(iter1.next(), iter2.next(), begin, length, mc);
result.add(resultPlate);
}
while(iter1.hasNext()) {
Plate plate = iter1.next();
for(Well well : plate) {
well = well.subList(begin, length);
}
result.add(iter1.next());
}
while(iter2.hasNext()) {
Plate plate = iter2.next();
for(Well well : plate) {
well = well.subList(begin, length);
}
result.add(iter2.next());
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to data sets of unequal length are omitted.
* @param Stack the first stack
* @param Stack the second stack
* @param MathContext the math context
* @return the result of the operation
*/
public Stack stacksStrict(Stack stack1, Stack stack2, MathContext mc) {
this.validateArgs(stack1, stack2);
Stack result = new Stack(stack1.rows(), stack2.columns());
Iterator iter1 = stack1.iterator();
Iterator iter2 = stack2.iterator();
while(iter1.hasNext() && iter2.hasNext()) {
Plate resultPlate = this.platesStrict(iter1.next(), iter2.next(), mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation using the values between
* the indices. Missing data points due to data sets of unequal length are
* omitted.
* @param Stack the first stack
* @param Stack the second stack
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return the result of the addition
*/
public Stack stacksStrict(Stack stack1, Stack stack2, int begin, int length, MathContext mc) {
this.validateArgs(stack1, stack2);
Stack result = new Stack(stack1.rows(), stack2.columns());
Iterator iter1 = stack1.iterator();
Iterator iter2 = stack2.iterator();
while(iter1.hasNext() && iter2.hasNext()) {
Plate resultPlate = this.platesStrict(iter1.next(), iter2.next(), begin, length, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation.
* @param Stack the stack
* @param BigDecimal constant for operation
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacks(Stack stack, BigDecimal constant, MathContext mc) {
this.validateArgs(stack);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.plates(iter1.next(), constant, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are treated as zeroes.
* @param Stack the stack
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacks(Stack stack, BigDecimal[] array, MathContext mc) {
this.validateArgs(stack, array);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.plates(iter1.next(), array, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are treated as zeroes.
* @param Stack the stack
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacks(Stack stack, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(stack, array);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.plates(iter1.next(), array, begin, length, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are treated as zeroes.
* @param Stack the stack
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacks(Stack stack, Collection collection, MathContext mc) {
this.validateArgs(stack, collection);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.plates(iter1.next(), collection, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are treated as zeroes.
* @param Stack the stack
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacks(Stack stack, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(stack, collection);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.plates(iter1.next(), collection, begin, length, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are omitted.
* @param Stack the stack
* @param BigDecimal[] array for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacksStrict(Stack stack, BigDecimal[] array, MathContext mc) {
this.validateArgs(stack);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.platesStrict(iter1.next(), array, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are omitted.
* @param Stack the stack
* @param BigDecimal[] array for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacksStrict(Stack stack, BigDecimal[] array, int begin, int length, MathContext mc) {
this.validateArgs(stack);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.platesStrict(iter1.next(), array, begin, length, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are omitted.
* @param Stack the stack
* @param Collection collection for the operation
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacksStrict(Stack stack, Collection collection, MathContext mc) {
this.validateArgs(stack);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.platesStrict(iter1.next(), collection, mc);
result.add(resultPlate);
}
return result;
}
/**
* Returns the result of the mathematical operation. Missing data points due
* to uneven data stack lengths are omitted.
* @param Stack the stack
* @param Collection collection for the operation
* @param int beginning index of subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the operation
*/
public Stack stacksStrict(Stack stack, Collection collection, int begin, int length, MathContext mc) {
this.validateArgs(stack);
Stack result = new Stack(stack.rows(), stack.columns());
Iterator iter1 = stack.iterator();
while(iter1.hasNext()) {
Plate resultPlate = this.platesStrict(iter1.next(), collection, begin, length, mc);
result.add(resultPlate);
}
return result;
}
/*---------------- Methods for Validating Well Arguments -----------------*/
/**
* Validates well arguments.
* @param Well the well
*/
private void validateArgs(Well well) {
if(well == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates well arguments.
* @param Well the first well
* @param Well the second well
*/
private void validateArgs(Well well1, Well well2) {
if(well1 == null || well2 == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates well and index arguments.
* @param Well the first well
* @param Well the second well
* @param int beginning index of the subset
* @param int length of the subset
*/
private void validateArgs(Well well1, int begin, int length) {
this.validateArgs(well1);
if(well1.size() < begin + length) {
throw new IllegalArgumentException("Invalid indices.");
}
}
/**
* Validates well and index arguments.
* @param Well the first well
* @param Well the second well
* @param int beginning index of the subset
* @param int length of the subset
*/
private void validateArgs(Well well1, Well well2, int begin, int length) {
this.validateArgs(well1, well2);
if(well1.size() < begin + length && well2.size() < begin + length) {
throw new IllegalArgumentException("Invalid indices.");
}
}
/**
* Validates well arguments.
* @param Well the well
* @param BigDecimal[] array of values
*/
private void validateArgs(Well well, BigDecimal[] array) {
if(well == null || array == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates well and index arguments.
* @param Well the well
* @param BigDecimal[] array of values
* @param int beginning index of the subset
* @param int length of the subset
*/
private void validateArgs(Well well, BigDecimal[] array, int begin, int length) {
this.validateArgs(well, array);
if(well.size() < begin + length) {
throw new IllegalArgumentException("Invalid indices.");
}
}
/**
* Validates well arguments.
* @param Well the well
* @param Collection collection of values
*/
private void validateArgs(Well well, Collection collection) {
if(well == null || collection == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates well and index arguments.
* @param Well the well
* @param BigDecimal[] array of values
* @param int beginning index of the subset
* @param int length of the subset
*/
private void validateArgs(Well well, Collection collection, int begin, int length) {
this.validateArgs(well, collection);
if(well.size() < begin + length) {
throw new IllegalArgumentException("Invalid indices.");
}
}
/*-------------- Methods for Validating Well Set Arguments ---------------*/
/**
* Validates well set arguments.
* @param WellSet the set
*/
private void validateArgs(WellSet set) {
if(set == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates well set arguments.
* @param WellSet the first set
* @param WellSet the second set
*/
private void validateArgs(WellSet set1, WellSet set2) {
if(set1 == null || set2 == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates set arguments.
* @param WellSet the set
* @param BigDecimal[] array of values
*/
private void validateArgs(WellSet set, BigDecimal[] array) {
if(set == null || array == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates set arguments.
* @param WellSet the set
* @param Collection collection of values
*/
private void validateArgs(WellSet set, Collection collection) {
if(set == null || collection == null) {
throw new NullPointerException("Null argument.");
}
}
/*---------------- Methods for Validating Plate Arguments ----------------*/
/**
* Validates plate arguments.
* @param Plate the plate
*/
private void validateArgs(Plate plate) {
if(plate == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates plate arguments.
* @param Plate the first plate
* @param Plate the second plate
*/
private void validateArgs(Plate plate1, Plate plate2) {
if(plate1 == null || plate2 == null) {
throw new NullPointerException("Null argument.");
}
if(plate1.rows() != plate2.rows() || plate1.columns() != plate2.columns()) {
throw new IllegalArgumentException("Unequal plate dimensios.");
}
}
/**
* Validates plate arguments.
* @param Plate the plate
* @param BigDecimal[] array of values
*/
private void validateArgs(Plate plate, BigDecimal[] array) {
if(plate == null || array == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates plate arguments.
* @param Plate the plate
* @param Collection collection of values
*/
private void validateArgs(Plate plate, Collection collection) {
if(plate == null || collection == null) {
throw new NullPointerException("Null argument.");
}
}
/*---------------- Methods for Validating Stack Arguments ----------------*/
/**
* Validates stack arguments.
* @param Stack the stack
*/
private void validateArgs(Stack stack) {
if(stack == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates stack arguments.
* @param Stack the first stack
* @param Stack the second stack
*/
private void validateArgs(Stack stack1, Stack stack2) {
if(stack1 == null || stack2 == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates stack arguments.
* @param Stack the stack
* @param BigDecimal[] array of values
*/
private void validateArgs(Stack stack, BigDecimal[] array) {
if(stack == null || array == null) {
throw new NullPointerException("Null argument.");
}
}
/**
* Validates stack arguments.
* @param Stack the stack
* @param Collection collection of values
*/
private void validateArgs(Stack stack, Collection collection) {
if(stack == null || collection == null) {
throw new NullPointerException("Null argument.");
}
}
/*------------------------ List Operation Methods ------------------------*/
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are treated as zero values.
* @param List the first list
* @param List the second list
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculate(List list1, List list2, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are omitted.
* @param List the first list
* @param List the second list
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculateStrict(List list1, List list2, MathContext mc);
/**
* Performs the mathematical operation for the two lists using the values
* between the indices. Missing data points due to data sets of unequal
* length are treated as zero values.
* @param List the first list
* @param List the second list
* @param int the beginning index of the subset
* @param int the length of the subset
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculate(List list1, List list2, int begin, int length, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are omitted.
* @param List the first list
* @param List the second list
* @param int the beginning index of the subset
* @param int the length of the subset
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculateStrict(List list1, List list2, int begin, int length, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are treated as zero values.
* @param List the first list
* @param BigDecimal the constant value
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculate(List list, BigDecimal constant, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are treated as zero values.
* @param List the first list
* @param BigDecimal[] the array values
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculate(List list, BigDecimal[] array, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are treated as zero values.
* @param List the first list
* @param BigDecimal[] the array values
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculate(List list, BigDecimal[] array, int begin, int length, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are treated as zero values.
* @param List the first list
* @param Collection the array values
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculate(List list, Collection collection, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are treated as zero values.
* @param List the first list
* @param Collection the array values
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculate(List list, Collection collection, int begin, int length, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are omitted.
* @param List the first list
* @param BigDecimal[] the array values
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculateStrict(List list, BigDecimal[] array, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are omitted.
* @param List the first list
* @param BigDecimal[] the array values
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculateStrict(List list, BigDecimal[] array, int begin, int length, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are omitted.
* @param List the first list
* @param Collection the array values
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculateStrict(List list, Collection collection, MathContext mc);
/**
* Performs the mathematical operation for the two lists. Missing data points
* due to data sets of unequal length are omitted.
* @param List the first list
* @param Collection the array values
* @param int beginning index of the subset
* @param int length of the subset
* @param MathContext the math context
* @return result of the mathematical operation
*/
public abstract List calculateStrict(List list, Collection collection, int begin, int length, MathContext mc);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy