Merge pull request #21 from UBC-MDS/mean-function

Mean function

Author: nicolelink33

src/dumbpy/arithmetic_mean.py

@@ -0,0 +1,27 @@
+"""
+A module that calculates the arithmetic mean of a list of numbers
+
+"""
+
+from support_functions import *
+
+def arithmetic_mean(values: list[float | int]):
+    """
+    Calculate the arithmetich mean of the inputted list and return the result.
+
+    Parameters
+    ----------
+    values : list[float | int]
+        A list of numbers.
+
+    Returns
+    -------
+    float
+        The arithmetic mean of the list of numbers.
+
+    Examples
+    --------
+    >>> arithmetic_mean([1, 2, 3, 4])
+    2.5
+    """
+    pass

src/dumbpy/example.py

@@ -3,13 +3,15 @@
 
 """
 
-def std_deviation(input):
+from support_functions import *
+
+def std_deviation(values: list[float | int]):
     """
     Calculate the standard deviation of the inputted list and return the result.
 
     Parameters
     ----------
-    input : list
+    values : list[float | int]
         A list of numbers.
 
     Returns
@@ -21,8 +23,6 @@ def std_deviation(input):
     --------
     >>> std_deviation([1, 1, 1, 1])
     0
-    >>> add_numbers([1, 0, 1, 0])
-    0.5
-
     """
+    pass
 

src/dumbpy/std_deviation.py

@@ -0,0 +1,73 @@
+"""
+A module of support functions for the dumbpy main functionality
+
+"""
+
+from typing import Any
+
+def validate_types(values: Any):
+    """
+    Validate that the input is an iterable of numeric values.
+
+    This function checks whether the provided input is an iterable
+    containing only numeric types (integers or floats). If the input
+    is not iterable or contains non-numeric values, a TypeError is raised.
+
+    Parameters
+    ----------
+    values : Any
+        Any input provided by the user.
+
+    Raises
+    ------
+    TypeError
+        If `values` is not iterable or if any element in `values`
+        is not a numeric type.
+
+    Examples
+    --------
+    >>> validate_types([1, 2, 3.5])
+    >>> validate_types((1, 2, 3))
+    >>> validate_types([1, "a", 3])
+    Traceback (most recent call last):
+        ...
+    TypeError: All elements must be numeric.
+    """
+    pass
+
+def flatten_list(values: list):
+    """
+    Flatten a nested list into a single, one-dimensional list.
+
+    This function takes a list that may contain nested lists and
+    returns a new list with all elements flattened into a single
+    level, preserving their original order.
+
+    Parameters
+    ----------
+    values : list
+        A list that may contain nested lists of arbitrary depth.
+
+    Returns
+    -------
+    list
+        A flattened list containing all elements from `values`.
+
+    Raises
+    ------
+    TypeError
+        If `values` is not a list.
+
+    Examples
+    --------
+    >>> flatten_list([1, 2, [3, 4]])
+    [1, 2, 3, 4]
+
+    >>> flatten_list([[1, 2], [3, [4, 5]]])
+    [1, 2, 3, 4, 5]
+
+    >>> flatten_list([])
+    []
+    """
+    pass
+