com.github.jessemull.microflexbiginteger.stat.Quartiles Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microflex-biginteger 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.microflexbiginteger.stat;

/* ------------------------------ Dependencies ------------------------------ */

import java.math.BigDecimal;
import java.math.MathContext;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * This class returns the quartiles for big integer plate stacks, plates, wells 
 * and well sets.
 * 
 * 


 * 
 * Statistical operations can be performed on stacks, plates, sets and wells using
 * standard or aggregated functions. Standard functions calculate the desired
 * statistic for each well in the stack, plate or set. Aggregated functions aggregate
 * the values from all the wells in the stack, plate or set and perform the statistical
 * operation on the aggregated values. Both standard and aggregated functions can
 * be performed on a subset of data within the stack, plate, set or well.
 * 
 * 


 * 
 * The methods within the MicroFlex library are meant to be flexible and the
 * descriptive statistic object supports operations using a single stack, plate,
 * set or well as well as collections and arrays of stacks, plates, sets or wells. 
 *  
 * 
 *    
 *    
 *    
 *    
 *    
 *       
 *       
 *       
 *       
 *    
 *    
 *       
 *       
 *       
 *       
 *    
 * Operation Beginning
Index Length of
Subset Input/Output

 *          
 *             
 *                
 *             
 *          Standard  
 *       
 *          
 *             
 *                
 *             
 *          +/-  
 *       
 *          
 *             
 *                
 *             
 *          +/-  
 *       
 *          
 *             
 *                
 *             
 *             
 *                
 *             
 *          Accepts a single well, set, plate or stack as input
Calculates the statistic for each well in a well, set, plate or stack  
 *       

 *          
 *             
 *                
 *             
 *          Aggregated  
 *       
 *          
 *             
 *                
 *             
 *          +/-  
 *       
 *          
 *             
 *                
 *             
 *          +/-  
 *       
 *          
 *             
 *                
 *             
 *              
 *                
 *             
 *          Accepts a single well/set/plate/stack or a collection/array of wells/sets/plates/stacks as input
Aggregates the data from all the wells in a well/set/plate/stack and calculates the statistic using the aggregated data  
 *       
 * 
 * @author Jesse L. Mull
 * @update Updated Oct 18, 2016
 * @address http://www.jessemull.com
 * @email [email protected]
 */
public class Quartiles extends DescriptiveStatisticListContext {
	
	/**
     * Returns the quartiles for the data set.
     * @param    List    the list
     * @param    MathContext         the math context
     * @return                       the result
     */
	public List calculate(List list, MathContext mc) {
		
		List result = new ArrayList();
		
		result.add(this.percentile(list, 25));
		result.add(this.percentile(list, 50));
		result.add(this.percentile(list, 75));
		
		return result;
    }
    
    /**
     * Returns the quartiles for the data set using the values between the indices.
     * @param    List    the list
     * @param    int                 beginning index of subset
     * @param    int                 length of subset
     * @param    MathContext         the math context
     * @return                       the result
     */
    public List calculate(List list, int begin, int length, MathContext mc) {
    	return calculate(list.subList(begin, begin + length), mc);
    }
    
    /**
     * Returns the percentile for the data set.
     * @param    List list    the input list
     * @param    int			    	  the percentile
     * @return                            the result
     */
    private BigDecimal percentile(List list, int p) {
    	
        int n = list.size();
    	
    	if(n == 1) {
    		return list.get(0);
    	}
    	
        Collections.sort(list);        
        double pos = (p * (n + 1)) / 100.0;
        
        if(pos < 1) {
        	return list.get(0);
        }
        
        if(pos >= n) {
        	return list.get(list.size() - 1);
        }
        
        if(pos == Math.floor(pos) && !Double.isInfinite(pos)) {       
        	return list.get((int) pos - 1);
        }
        	
        int lowerIndex = (int) Math.floor(pos) - 1;
        int upperIndex = lowerIndex + 1;
        
        BigDecimal lower = list.get(lowerIndex);
        BigDecimal upper = list.get(upperIndex);      
        BigDecimal d = new BigDecimal((pos - 1 - lowerIndex) + "");
        
        return upper.subtract(lower).multiply(d).add(lower);
    }

}