Java BigInteger Average average(BigInteger... integers)

Description

Returns the average or mean from the given list of integer numbers.

License

Open Source License

Parameter

Parameter	Description
integers	A list of integer numbers.

Return

The average or mean value of the given list of values.

Declaration

public static BigInteger average(BigInteger... integers) 

Method Source Code

//package com.java2s;
/*//from  ww  w .ja v  a 2 s . c om
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Lachlan Dowding
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import java.math.BigInteger;

public class Main {
    /**
     * Returns the average or mean from the given list of integer numbers.
     *
     * @param integers A list of integer numbers.
     * @return The average or mean value of the given list of values.
     */
    public static BigInteger average(BigInteger... integers) {
        BigInteger result = null;

        if (integers != null) {
            int length = 0;
            for (BigInteger integer : integers) {
                if (integer != null) {
                    if (result == null) {
                        result = integer;
                    } else {
                        result = result.add(integer);
                    }
                    length++;
                }
            }
            if (result != null) {
                result = divide(result, BigInteger.valueOf(length));
            }
        }

        return result;
    }

    /**
     * Returns the sum of all the given integers.
     *
     * @param operands The integer numbers to be summed.
     * @return The sum of all the given integer numbers.
     */
    public static BigInteger add(BigInteger... operands) {
        BigInteger result = null;

        if (operands != null) {
            for (BigInteger operand : operands) {
                if (operand != null) {
                    if (result == null) {
                        result = operand;
                    } else {
                        result = result.add(operand);
                    }
                }
            }
        }

        return result;
    }

    /**
     * Divides the given dividend by the divisor.
     *
     * @param dividend The integer to be divided.
     * @param divisor  The integer to divide by.
     * @return The result of dividing the dividend by the divisor.
     */
    public static BigInteger divide(BigInteger dividend, BigInteger divisor) {
        BigInteger result = null;

        if (dividend != null && divisor != null) {
            result = dividend.divide(divisor);
        }

        return result;
    }
}

Related

1. average(BigInteger... values)