software.amazon.kinesis.utils.Statistics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amazon-kinesis-client Show documentation

The Amazon Kinesis Client Library for Java enables Java developers to easily consume and process data from Amazon Kinesis.

There is a newer version: 3.1.0

Show newest version

/*
 * Copyright 2024 Amazon.com, Inc. or its affiliates.
 * Licensed 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 software.amazon.kinesis.utils;

import java.util.AbstractMap;
import java.util.List;
import java.util.Map;

import software.amazon.kinesis.annotations.KinesisClientInternalApi;

@KinesisClientInternalApi
public class Statistics {

    /**
     * Calculates the simple mean of the given values
     * @param values list of values (double)
     * @return mean of the given values, if the {@param values} is empty then returns 0;
     */
    public static double calculateSimpleMean(final List values) {
        if (values.isEmpty()) {
            return 0D;
        }
        double sum = 0.0;
        for (final double i : values) {
            sum += i;
        }
        return sum / values.size();
    }

    /**
     * For the given values find the standard deviation (SD).
     * For details of SD calculation ref : 
     * @param values list of values (double)
     * @return Map.Entry of mean to standard deviation for {@param values}, if {@param values} is empty then return
     *          Map.Entry with 0 as mean and 0 as SD.
     */
    public static Map.Entry calculateStandardDeviationAndMean(final List values) {
        if (values.isEmpty()) {
            return new AbstractMap.SimpleEntry<>(0D, 0D);
        }
        final double mean = calculateSimpleMean(values);
        // calculate the standard deviation
        double standardDeviation = 0.0;
        for (final double num : values) {
            standardDeviation += Math.pow(num - mean, 2);
        }
        return new AbstractMap.SimpleEntry<>(mean, Math.sqrt(standardDeviation / values.size()));
    }
}