com.github.jessemull.microflexbigdecimal.math.Decrement 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

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.util.ArrayList;
import java.util.List;

/**
 * This class performs the decrement operation for BigDecimal plate stacks, plates, 
 * wells and well sets. Unary operations can also be performed on a subset of
 * data using a beginning index and subset length. 
 * @author Jesse L. Mull
 * @update Updated Oct 18, 2016
 * @address http://www.jessemull.com
 * @email [email protected]
 */
public class Decrement extends MathOperationBigDecimalUnary {

    /**
     * Decrements the values in the list.
     * @param    List    the list
     * @return                       the result
     */
    public List calculate(List list) {

        List result = new ArrayList();
        
        for(BigDecimal bd : list) {
            result.add(bd.subtract(BigDecimal.ONE));
        }
        
        return result;
    }

    /**
     * Decrements the values in the list between the indices.
     * @param    List    the list
     * @return                       the result
     */
    public List calculate(List list, int begin, int length) {
        
        List result = new ArrayList();
        
        for(int i = begin; i < begin + length; i++) {
            result.add(list.get(i).subtract(BigDecimal.ONE));
        }
        
        return result;
    }
    
}