Skip to content

Added different types of Mean #4339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Sep 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.thealgorithms</groupId>
<artifactId>Java</artifactId>
Expand Down Expand Up @@ -52,6 +52,11 @@
<artifactId>commons-lang3</artifactId>
<version>3.12.0</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-collections4</artifactId>
<version>4.4</version>
</dependency>
</dependencies>

<build>
Expand Down
54 changes: 54 additions & 0 deletions src/main/java/com/thealgorithms/maths/Means.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package com.thealgorithms.maths;

import java.util.stream.StreamSupport;
import org.apache.commons.collections4.IterableUtils;

/**
* https://en.wikipedia.org/wiki/Mean
* <p>
* by: Punit Patel
*/
public final class Means {

private Means() {
}

/**
* @brief computes the [Arithmetic Mean](https://en.wikipedia.org/wiki/Arithmetic_mean) of the input
* @param numbers the input numbers
* @throws IllegalArgumentException empty input
* @return the arithmetic mean of the input numbers
*/
public static Double arithmetic(final Iterable<Double> numbers) {
checkIfNotEmpty(numbers);
return StreamSupport.stream(numbers.spliterator(), false).reduce((x, y) -> x + y).get() / IterableUtils.size(numbers);
}

/**
* @brief computes the [Geometric Mean](https://en.wikipedia.org/wiki/Geometric_mean) of the input
* @param numbers the input numbers
* @throws IllegalArgumentException empty input
* @return the geometric mean of the input numbers
*/
public static Double geometric(final Iterable<Double> numbers) {
checkIfNotEmpty(numbers);
return Math.pow(StreamSupport.stream(numbers.spliterator(), false).reduce((x, y) -> x * y).get(), 1d / IterableUtils.size(numbers));
}

/**
* @brief computes the [Harmonic Mean](https://en.wikipedia.org/wiki/Harmonic_mean) of the input
* @param numbers the input numbers
* @throws IllegalArgumentException empty input
* @return the harmonic mean of the input numbers
*/
public static Double harmonic(final Iterable<Double> numbers) {
checkIfNotEmpty(numbers);
return IterableUtils.size(numbers) / StreamSupport.stream(numbers.spliterator(), false).reduce(0d, (x, y) -> x + 1d / y);
}

private static void checkIfNotEmpty(final Iterable<Double> numbers) {
if (!numbers.iterator().hasNext()) {
throw new IllegalArgumentException("Emtpy list given for Mean computation.");
}
}
}
71 changes: 71 additions & 0 deletions src/test/java/com/thealgorithms/maths/MeansTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
package com.thealgorithms.maths;

import static org.junit.jupiter.api.Assertions.*;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.Vector;
import org.assertj.core.util.Lists;
import org.assertj.core.util.Sets;
import org.junit.jupiter.api.Test;

class MeansTest {

@Test
void arithmeticMeanZeroNumbers() throws IllegalArgumentException {
List<Double> numbers = new ArrayList<>();
assertThrows(IllegalArgumentException.class, () -> Means.arithmetic(numbers));
}

@Test
void geometricMeanZeroNumbers() throws IllegalArgumentException {
List<Double> numbers = new ArrayList<>();
assertThrows(IllegalArgumentException.class, () -> Means.geometric(numbers));
}

@Test
void harmonicMeanZeroNumbers() throws IllegalArgumentException {
List<Double> numbers = new ArrayList<>();
assertThrows(IllegalArgumentException.class, () -> Means.harmonic(numbers));
}

@Test
void arithmeticMeanSingleNumber() {
List<Double> numbers = Lists.newArrayList(2.5);
assertEquals(2.5, Means.arithmetic(numbers));
}

@Test
void geometricMeanSingleNumber() {
Set<Double> numbers = Sets.newHashSet(Lists.newArrayList(2.5));
assertEquals(2.5, Means.geometric(numbers));
}

@Test
void harmonicMeanSingleNumber() {
LinkedHashSet<Double> numbers = Sets.newLinkedHashSet(2.5);
assertEquals(2.5, Means.harmonic(numbers));
}

@Test
void arithmeticMeanMultipleNumbers() {
Set<Double> numbers = Sets.newTreeSet(1d, 2.5, 83.3, 25.9999, 46.0001, 74.7, 74.5);
assertEquals(44, Means.arithmetic(numbers));
}

@Test
void geometricMeanMultipleNumbers() {
LinkedList<Double> numbers = new LinkedList<>() {};
numbers.addAll(Lists.newArrayList(1d, 2d, 3d, 4d, 5d, 6d, 1.25));
assertEquals(2.6426195539300585, Means.geometric(numbers));
}

@Test
void harmonicMeanMultipleNumbers() {
Vector<Double> numbers = new Vector<>(Lists.newArrayList(1d, 2.5, 83.3, 25.9999, 46.0001, 74.7, 74.5));
assertEquals(4.6697322801074135, Means.harmonic(numbers));
}
}