add docstring

Author: despadam

11_functional_programming.ipynb

@@ -635,7 +635,6 @@
     "def non_transparent_function() -> int:\n",
     "    return random.randint(0, 10)\n",
     "\n",
-    "\n",
     "# With a lamba we capture the expression x() + 5 in a function,\n",
     "# we get its value when we call it like a function\n",
     "y1 = lambda: non_transparent_function() + 5\n",
@@ -1065,10 +1064,15 @@
     "%%ipytest\n",
     "\n",
     "def solution_filter_even(input_data: list[int]) -> list[int]:\n",
+    "    \"\"\"A function that filters only the even elements of a given list.\n",
+    "\n",
+    "    Args:\n",
+    "        input_data: the initial list\n",
+    "    Returns:\n",
+    "        - the filtered list with only even elements\n",
     "    \"\"\"\n",
-    "    Write your solution here\n",
-    "    \"\"\"\n",
-    "    pass"
+    "\n",
+    "    return"
    ]
   },
   {
@@ -1090,10 +1094,15 @@
     "%%ipytest\n",
     "\n",
     "def solution_add_one(input_data: list[int]) -> list[int]:\n",
+    "    \"\"\"A function that adds the integer number 1 to each element of a given list.\n",
+    "\n",
+    "    Args:\n",
+    "        input_data: the initial list of integers\n",
+    "    Returns:\n",
+    "        - the edited list after adding 1 to each element\n",
     "    \"\"\"\n",
-    "    Write your solution here\n",
-    "    \"\"\"\n",
-    "    pass"
+    "\n",
+    "    return"
    ]
   },
   {
@@ -1313,10 +1322,16 @@
     "%%ipytest\n",
     "\n",
     "def solution_multiples_of_n(l: \"list[int]\", k: int):\n",
+    "    \"\"\"A function that keeps only the multiples of k from a given list.\n",
+    "\n",
+    "    Args:\n",
+    "        l: the initial list\n",
+    "        k: the integer number\n",
+    "    Returns:\n",
+    "        - the filtered list\n",
     "    \"\"\"\n",
-    "    Write your solution here\n",
-    "    \"\"\"\n",
-    "    pass"
+    "\n",
+    "    return"
    ]
   },
   {
@@ -1526,7 +1541,7 @@
     "### Exercise 1: Transposing a Matrix\n",
     "\n",
     "Consider a matrix `M` represented row-wise as a list of lists `[[1, 2, 3], [4, 5, 6], [7, 8, 8]]`.\n",
-    "Write a function  that returns the transpose of `M`, the matrix obtained by exchanging rows and columns\n",
+    "Write a function  that returns the transpose of `M`, the matrix obtained by exchanging rows and columns.\n",
     "\n",
     "- Example 1: given `M=[[1, 0], [0, 1]]`, the result must be `[[1, 0], [0, 1]]`\n",
     "- Example 2: given `M=[[1, 2, 3], [4, 5, 6], [7, 8, 8]]` the result must be `[1, 4, 7], [2, 5, 8], [3, 6, 8]]`\n",
@@ -1535,14 +1550,7 @@
     "\n",
     "<div class=\"alert alert-block alert-info\">\n",
     "    <h4><b>Hints</b></h4>\n",
-    "    <ul>\n",
-    "        <li>\n",
-    "            The <code>zip</code> function behaves similar to a transposition: <code>zip([1,2], [3,4]) = [(1,3), (3,4)])</code>\n",
-    "        </li>\n",
-    "        <li>\n",
-    "            Write your function in the cell below inside of the <code>solution_exercise1</code> function. The function receives a the \"matrix\"  as an input <code>m</code> and should return another list\n",
-    "        </li>\n",
-    "    </ul>\n",
+    "    The <code>zip</code> function behaves similar to a transposition: <code>zip([1,2], [3,4]) = [(1,3), (3,4)])</code>\n",
     "<div>\n"
    ]
   },
@@ -1559,10 +1567,16 @@
     "%%ipytest\n",
     "\n",
     "def solution_exercise1(m: \"list[list[int]]\") -> \"list[list[int]]\":\n",
+    "    \"\"\"A function that returns the transpose of a given matrix, by using the zip function.\n",
+    "    The transpose of a matrix is obtained by swapping the rows and columns of the matrix.\n",
+    "\n",
+    "    Args:\n",
+    "        m: the initial matrix\n",
+    "    Returns:\n",
+    "        - the transposed matrix\n",
     "    \"\"\"\n",
-    "    Write your solution here\n",
-    "    \"\"\"\n",
-    "    pass\n"
+    "\n",
+    "    return\n"
    ]
   },
   {
@@ -1579,14 +1593,7 @@
     "\n",
     "<div class=\"alert alert-block alert-info\">\n",
     "    <h4><b>Hints</b></h4>\n",
-    "    <ul>\n",
-    "        <li>\n",
-    "            This is a good exercise to use <code>functools.reduce</code> \n",
-    "        </li>\n",
-    "        <li>\n",
-    "            Write your function in the cell below inside of the <code>solution_exercise2</code> function. The function receives a list <code>l</code> as an input and should return another list\n",
-    "        </li>\n",
-    "    </ul>\n",
+    "    This is a good exercise to use <code>functools.reduce</code> \n",
     "<div>"
    ]
   },
@@ -1603,11 +1610,15 @@
     "%%ipytest\n",
     "\n",
     "def solution_exercise2(l: \"list[list[any]]\") -> \"list[any]\":\n",
+    "    \"\"\"A function that returns a flattened list from a given list of lists, by using funtools.reduce\n",
+    "\n",
+    "    Args:\n",
+    "        l: the initial list of lists\n",
+    "    Returns:\n",
+    "        - the flattened list\n",
     "    \"\"\"\n",
-    "    Write your solution here\n",
-    "    \"\"\"\n",
-    "    pass\n",
-    "\n"
+    "\n",
+    "    return\n"
    ]
   },
   {
@@ -1630,9 +1641,6 @@
     "            Consider the functions <code>sorted</code> and <code>itertools.groupby</code> from the Python standard library.\n",
     "        </li>\n",
     "        <li>\n",
-    "            Write your function in the cell below inside of the <code>solution_exercise3</code> function. The function receives a list <code>w</code> as an input and should return another list\n",
-    "        </li>\n",
-    "        <li>\n",
     "            To ensure consistent capitalization you can use the <code>lower()</code> method of <code>str</code>\n",
     "        </li>\n",
     "    </ul>\n",
@@ -1653,11 +1661,18 @@
     "%%ipytest\n",
     "\n",
     "def solution_exercise3(w: list[str]) -> list[(str, int)]:\n",
+    "    \"\"\"A function that counts the number of words from a given list that start with each letter of the alphabet.\n",
+    "    The function should be case insensitive.\n",
+    "    It should return a list of tuples, where each tuple contains a letter and the number of words that start with that letter.\n",
+    "    This tuple should be sorted in alphabetical order.\n",
+    "\n",
+    "    Args:\n",
+    "        w: the initial list of words\n",
+    "    Returns:\n",
+    "        - the alphabetically sorted list of tuples\n",
     "    \"\"\"\n",
-    "    Write your solution here\n",
-    "    \"\"\"\n",
-    "    pass\n",
-    "\n"
+    "\n",
+    "    return\n"
    ]
   },
   {
@@ -1673,20 +1688,12 @@
     "If you cannot, do not worry: you will receive the correct input automatically as `l` inside the function `solution_exercise4`\n",
     "\n",
     "\n",
-    "Write a function that computes the *relative frequency* of each letter in the list `l`. \n",
+    "Write a function that computes the *relative frequency* of each letter in the list `l` and returns a list of tuples `(letter, frequency)`.\n",
     "\n",
     "\n",
     "<div class=\"alert alert-block alert-info\">\n",
     "    <h4><b>Hints</b></h4>\n",
-    "    <ul>\n",
-    "        <li>\n",
-    "            The relative frequence of a value <code>a</code> in a list is simply the number of time it appears in that\n",
-    "            list over the total lenght of the list\n",
-    "        </li>\n",
-    "        <li>\n",
-    "            Write your function in the cell below inside of the <code>solution_exercise4</code> function. The function receives a list <code>l</code> as an input and should return another list\n",
-    "        </li>\n",
-    "    </ul>\n",
+    "    The relative frequence of a value <code>a</code> in a list is simply the number of time it appears in that list over the total lenght of the list.\n",
     "<div>"
    ]
   },
@@ -1703,7 +1710,16 @@
     "%%ipytest\n",
     "\n",
     "def solution_exercise4(l: \"list[(str, int)]\") -> \"list[(str, float)]\":\n",
-    "    pass"
+    "    \"\"\"A function that computes the relative frequency of each letter from a given list of tuples.\n",
+    "    The relative frequency is calculated as the number of occurrences of a letter in the list, divided by the length of the list.\n",
+    "\n",
+    "    Args:\n",
+    "        l: the initial list of tuples\n",
+    "    Returns:\n",
+    "        - the list of tuples with the relative frequency of each letter\n",
+    "    \"\"\"\n",
+    "\n",
+    "    return"
    ]
   },
   {
@@ -1715,25 +1731,22 @@
    },
    "source": [
     "### Exercise 5: Finding palindromes\n",
-    "Consider again the `words` list of strings. Write a function  that returns the list of all *palindromes*. A *palindrome* is a word (any string longer than 1) that reads the same left-to-right and right-to-left.\n",
+    "Consider again the `words` list of strings. Write a function that returns the list of all *palindromes*. A *palindrome* is a word (any string longer than 1) that reads the same left-to-right and right-to-left.\n",
     "\n",
     "For example:\n",
     "- rotator\n",
     "- wow\n",
     "- noon\n",
     "- radar\n",
     "\n",
-    "\n",
-    "\n",
-    "\n",
     "<div class=\"alert alert-block alert-info\">\n",
     "    <h4><b>Hints</b></h4>\n",
     "    <ul>\n",
     "        <li>\n",
     "            A single character does not count as a palindrome.\n",
     "        </li>\n",
     "        <li>\n",
-    "            The words are available as the input <code>words</code> to <code>solution_exercise5</code>.\n",
+    "            The words are available as the input to <code>solution_exercise3</code>.\n",
     "        </li>\n",
     "    </ul>\n",
     "<div>\n"
@@ -1752,7 +1765,16 @@
     "%%ipytest\n",
     "\n",
     "def solution_exercise5(words: \"list[str]\") -> \"list[str]\":\n",
-    "    pass"
+    "    \"\"\"A function that returns a list of words from a given list of words, that are palindromes.\n",
+    "    A palindrome is a word that reads the same backwards as forward.\n",
+    "\n",
+    "    Args:\n",
+    "        words: the initial list of words\n",
+    "    Returns:\n",
+    "        - the list of palindromes\n",
+    "    \"\"\"\n",
+    "\n",
+    "    return"
    ]
   }
  ],