algorithm/Java
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/Java.git synced 2025-07-06 17:29:31 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: cleanup EulersFunction (#5388)

Browse Source
This commit is contained in:
Alex Klymenko
2024-08-25 21:44:55 +02:00
committed by GitHub
parent f3851e3adc
commit 25b8010ea8
2 changed files with 35 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/main/java/com/thealgorithms/others/EulersFunction.java
View File

@ -1,12 +1,19 @@
package com.thealgorithms.others;
/**
* @brief utility class for <a href="https://en.wikipedia.org/wiki/Euler%27s_totient_function">Euler's totient function</a>
* Utility class for computing
* <a href="https://en.wikipedia.org/wiki/Euler%27s_totient_function">Euler's totient function</a>.
*/
public final class EulersFunction {
private EulersFunction() {
}
/**
* Validates that the input is a positive integer.
*
* @param n the input number to validate
* @throws IllegalArgumentException if {@code n} is non-positive
*/
private static void checkInput(int n) {
if (n <= 0) {
throw new IllegalArgumentException("n must be positive.");
@ -14,11 +21,12 @@ public final class EulersFunction {
}
/**
* @brief computes the value of Euler's totient function for given input
* @details has time complexity of O(sqrt(n))
* @param n the input
* @exception IllegalArgumentException n is non-positive
* @return the value of Euler's totient function for the input
* Computes the value of Euler's totient function for a given input.
* This function has a time complexity of O(sqrt(n)).
*
* @param n the input number
* @return the value of Euler's totient function for the given input
* @throws IllegalArgumentException if {@code n} is non-positive
*/
public static int getEuler(int n) {
checkInput(n);