mirror of
https://hub.njuu.cf/TheAlgorithms/Python.git
synced 2023-10-11 13:06:12 +08:00
Format docs (#7821)
* Reformat docs for odd_even_sort.py * Fix docstring formatting * Apply suggestions from code review Co-authored-by: Caeden Perelli-Harris <caedenperelliharris@gmail.com> Co-authored-by: Caeden Perelli-Harris <caedenperelliharris@gmail.com>
This commit is contained in:
parent
762afc086f
commit
cf08d9f5e7
@ -1,5 +1,7 @@
|
|||||||
"""
|
"""
|
||||||
Normalization Wikipedia: https://en.wikipedia.org/wiki/Normalization
|
Normalization.
|
||||||
|
|
||||||
|
Wikipedia: https://en.wikipedia.org/wiki/Normalization
|
||||||
Normalization is the process of converting numerical data to a standard range of values.
|
Normalization is the process of converting numerical data to a standard range of values.
|
||||||
This range is typically between [0, 1] or [-1, 1]. The equation for normalization is
|
This range is typically between [0, 1] or [-1, 1]. The equation for normalization is
|
||||||
x_norm = (x - x_min)/(x_max - x_min) where x_norm is the normalized value, x is the
|
x_norm = (x - x_min)/(x_max - x_min) where x_norm is the normalized value, x is the
|
||||||
@ -28,7 +30,8 @@ from statistics import mean, stdev
|
|||||||
|
|
||||||
def normalization(data: list, ndigits: int = 3) -> list:
|
def normalization(data: list, ndigits: int = 3) -> list:
|
||||||
"""
|
"""
|
||||||
Returns a normalized list of values
|
Return a normalized list of values.
|
||||||
|
|
||||||
@params: data, a list of values to normalize
|
@params: data, a list of values to normalize
|
||||||
@returns: a list of normalized values (rounded to ndigits decimal places)
|
@returns: a list of normalized values (rounded to ndigits decimal places)
|
||||||
@examples:
|
@examples:
|
||||||
@ -46,7 +49,8 @@ def normalization(data: list, ndigits: int = 3) -> list:
|
|||||||
|
|
||||||
def standardization(data: list, ndigits: int = 3) -> list:
|
def standardization(data: list, ndigits: int = 3) -> list:
|
||||||
"""
|
"""
|
||||||
Returns a standardized list of values
|
Return a standardized list of values.
|
||||||
|
|
||||||
@params: data, a list of values to standardize
|
@params: data, a list of values to standardize
|
||||||
@returns: a list of standardized values (rounded to ndigits decimal places)
|
@returns: a list of standardized values (rounded to ndigits decimal places)
|
||||||
@examples:
|
@examples:
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
"""
|
"""
|
||||||
Find the kinetic energy of an object, give its mass and velocity
|
Find the kinetic energy of an object, given its mass and velocity.
|
||||||
|
|
||||||
Description : In physics, the kinetic energy of an object is the energy that it
|
Description : In physics, the kinetic energy of an object is the energy that it
|
||||||
possesses due to its motion. It is defined as the work needed to accelerate a body of a
|
possesses due to its motion. It is defined as the work needed to accelerate a body of a
|
||||||
given mass from rest to its stated velocity. Having gained this energy during its
|
given mass from rest to its stated velocity. Having gained this energy during its
|
||||||
@ -19,6 +20,8 @@ Reference : https://en.m.wikipedia.org/wiki/Kinetic_energy
|
|||||||
|
|
||||||
def kinetic_energy(mass: float, velocity: float) -> float:
|
def kinetic_energy(mass: float, velocity: float) -> float:
|
||||||
"""
|
"""
|
||||||
|
Calculate kinetick energy.
|
||||||
|
|
||||||
The kinetic energy of a non-rotating object of mass m traveling at a speed v is ½mv²
|
The kinetic energy of a non-rotating object of mass m traveling at a speed v is ½mv²
|
||||||
|
|
||||||
>>> kinetic_energy(10,10)
|
>>> kinetic_energy(10,10)
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
"""
|
"""
|
||||||
This is a pure Python implementation of the merge sort algorithm
|
This is a pure Python implementation of the merge sort algorithm.
|
||||||
|
|
||||||
For doctests run following command:
|
For doctests run following command:
|
||||||
python -m doctest -v merge_sort.py
|
python -m doctest -v merge_sort.py
|
||||||
or
|
or
|
||||||
@ -10,7 +11,7 @@ python merge_sort.py
|
|||||||
|
|
||||||
|
|
||||||
def merge_sort(collection: list) -> list:
|
def merge_sort(collection: list) -> list:
|
||||||
"""Pure implementation of the merge sort algorithm in Python
|
"""
|
||||||
:param collection: some mutable ordered collection with heterogeneous
|
:param collection: some mutable ordered collection with heterogeneous
|
||||||
comparable items inside
|
comparable items inside
|
||||||
:return: the same collection ordered by ascending
|
:return: the same collection ordered by ascending
|
||||||
@ -24,7 +25,9 @@ def merge_sort(collection: list) -> list:
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
def merge(left: list, right: list) -> list:
|
def merge(left: list, right: list) -> list:
|
||||||
"""merge left and right
|
"""
|
||||||
|
Merge left and right.
|
||||||
|
|
||||||
:param left: left collection
|
:param left: left collection
|
||||||
:param right: right collection
|
:param right: right collection
|
||||||
:return: merge result
|
:return: merge result
|
||||||
|
@ -1,10 +1,15 @@
|
|||||||
"""For reference
|
"""
|
||||||
|
Odd even sort implementation.
|
||||||
|
|
||||||
https://en.wikipedia.org/wiki/Odd%E2%80%93even_sort
|
https://en.wikipedia.org/wiki/Odd%E2%80%93even_sort
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
def odd_even_sort(input_list: list) -> list:
|
def odd_even_sort(input_list: list) -> list:
|
||||||
"""this algorithm uses the same idea of bubblesort,
|
"""
|
||||||
|
Sort input with odd even sort.
|
||||||
|
|
||||||
|
This algorithm uses the same idea of bubblesort,
|
||||||
but by first dividing in two phase (odd and even).
|
but by first dividing in two phase (odd and even).
|
||||||
Originally developed for use on parallel processors
|
Originally developed for use on parallel processors
|
||||||
with local interconnections.
|
with local interconnections.
|
||||||
|
Loading…
Reference in New Issue
Block a user