chore: rename gcd to greatest_common_divisor (TheAlgorithms#6265)

ksharma20 · dhruvmanila · web-flow · commit 7d9ebee75fd9 · 2022-07-24T21:33:10.000+05:30
As described in CONTRIBUTING.md

&gt; Expand acronyms because gcd() is hard to understand but greatest_common_divisor() is not.

Co-authored-by: Dhruv Manilawala &lt;dhruvmanila@gmail.com&gt;
diff --git a/project_euler/problem_005/sol2.py b/project_euler/problem_005/sol2.py
@@ -16,28 +16,28 @@
 """
 
 
-def gcd(x: int, y: int) -> int:
+def greatest_common_divisor(x: int, y: int) -> int:
     """
-    Euclidean GCD algorithm (Greatest Common Divisor)
+    Euclidean Greatest Common Divisor algorithm
 
-    >>> gcd(0, 0)
+    >>> greatest_common_divisor(0, 0)
     0
-    >>> gcd(23, 42)
+    >>> greatest_common_divisor(23, 42)
     1
-    >>> gcd(15, 33)
+    >>> greatest_common_divisor(15, 33)
     3
-    >>> gcd(12345, 67890)
+    >>> greatest_common_divisor(12345, 67890)
     15
     """
 
-    return x if y == 0 else gcd(y, x % y)
+    return x if y == 0 else greatest_common_divisor(y, x % y)
 
 
 def lcm(x: int, y: int) -> int:
     """
     Least Common Multiple.
 
-    Using the property that lcm(a, b) * gcd(a, b) = a*b
+    Using the property that lcm(a, b) * greatest_common_divisor(a, b) = a*b
 
     >>> lcm(3, 15)
     15
@@ -49,7 +49,7 @@ def lcm(x: int, y: int) -> int:
     192
     """
 
-    return (x * y) // gcd(x, y)
+    return (x * y) // greatest_common_divisor(x, y)
 
 
 def solution(n: int = 20) -> int:

Original file line number	Diff line number	Diff line change
`@@ -16,28 +16,28 @@`
`16`	`16`	`"""`
`17`	`17`
`18`	`18`
`19`		`-def gcd(x: int, y: int) -> int:`
	`19`	`+def greatest_common_divisor(x: int, y: int) -> int:`
`20`	`20`	`"""`
`21`		`- Euclidean GCD algorithm (Greatest Common Divisor)`
	`21`	`+ Euclidean Greatest Common Divisor algorithm`
`22`	`22`
`23`		`- >>> gcd(0, 0)`
	`23`	`+ >>> greatest_common_divisor(0, 0)`
`24`	`24`	`0`
`25`		`- >>> gcd(23, 42)`
	`25`	`+ >>> greatest_common_divisor(23, 42)`
`26`	`26`	`1`
`27`		`- >>> gcd(15, 33)`
	`27`	`+ >>> greatest_common_divisor(15, 33)`
`28`	`28`	`3`
`29`		`- >>> gcd(12345, 67890)`
	`29`	`+ >>> greatest_common_divisor(12345, 67890)`
`30`	`30`	`15`
`31`	`31`	`"""`
`32`	`32`
`33`		`- return x if y == 0 else gcd(y, x % y)`
	`33`	`+ return x if y == 0 else greatest_common_divisor(y, x % y)`
`34`	`34`
`35`	`35`
`36`	`36`	`def lcm(x: int, y: int) -> int:`
`37`	`37`	`"""`
`38`	`38`	`Least Common Multiple.`
`39`	`39`
`40`		`- Using the property that lcm(a, b) * gcd(a, b) = a*b`
	`40`	`+ Using the property that lcm(a, b) * greatest_common_divisor(a, b) = a*b`
`41`	`41`
`42`	`42`	`>>> lcm(3, 15)`
`43`	`43`	`15`
`@@ -49,7 +49,7 @@ def lcm(x: int, y: int) -> int:`
`49`	`49`	`192`
`50`	`50`	`"""`
`51`	`51`
`52`		`- return (x * y) // gcd(x, y)`
	`52`	`+ return (x * y) // greatest_common_divisor(x, y)`
`53`	`53`
`54`	`54`
`55`	`55`	`def solution(n: int = 20) -> int:`