0.14.6

new method check_type

Author: bartzbeielstein

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spotPython"
-version = "0.14.5"
+version = "0.14.6"
 authors = [
   { name="T. Bartz-Beielstein", email="tbb@bartzundbartz.de" }
 ]

src/spotPython/spot/spot.py

@@ -1048,6 +1048,17 @@ def fit_surrogate(self) -> None:
             self.plot_model()
 
     def show_progress_if_needed(self, timeout_start) -> None:
+        """Show progress bar if `show_progress` is `True`. If
+        self.progress_file is not `None`, the progress bar is saved
+        in the file with the name `self.progress_file`.
+
+        Args:
+            self (object): Spot object
+            timeout_start (float): start time
+
+        Returns:
+            (NoneType): None
+        """
         if not self.show_progress:
             return
         if isfinite(self.fun_evals):

src/spotPython/utils/convert.py

@@ -179,3 +179,32 @@ def sort_by_kth_and_return_indices(array, k) -> list:
     sorted_indices = [index for index, value in sorted(enumerate(array), key=lambda x: x[1][k], reverse=True)]
 
     return sorted_indices
+
+
+def check_type(value):
+    """Check the type of the input value and return the type as a string.
+
+    Args:
+        value (object): The input value.
+
+    Returns:
+        str: The type of the input value as a string.
+        Possible values are "int", "float", "str", "bool", or None.
+        Checks for numpy types as well, i.e., np.integer, np.floating, np.str_, np.bool_.
+
+    Examples:
+        >>> from spotPython.utils.convert import check_type
+        >>> check_type(5)
+        "int"
+
+    """
+    if isinstance(value, (int, np.integer)):
+        return "int"
+    elif isinstance(value, (float, np.floating)):
+        return "float"
+    elif isinstance(value, (str, np.str_)):
+        return "str"
+    elif isinstance(value, (bool, np.bool_)):
+        return "bool"
+    else:
+        return None