gemseo-multi-fidelity 0.0.1__py3-none-any.whl

gemseo_multi_fidelity/__init__.py

@@ -0,0 +1,17 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+"""Main entry point."""
+
+from __future__ import annotations

gemseo_multi_fidelity/core/MFMapperAdapter_input.json

@@ -0,0 +1,22 @@
+{
+  "name": "MFMapperAdapter_input",
+  "required": [
+    "x_best"
+  ],
+  "properties": {
+    "x_best": {},
+    "x_reference": {},
+    "output_reference": {
+      "type": "object"
+    },
+    "output_options": {
+      "type": "object"
+    },
+    "output_status": {
+      "type": "string"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "id": "#MFMapperAdapter_input"
+}

gemseo_multi_fidelity/core/MFMapperAdapter_output.json

@@ -0,0 +1,22 @@
+{
+  "name": "MFMapperAdapter_output",
+  "required": [
+    "x_start"
+  ],
+  "properties": {
+    "x_start": {},
+    "x_reference": {},
+    "output_reference": {
+      "type": "object"
+    },
+    "input_options": {
+      "type": "object"
+    },
+    "output_status": {
+      "type": "string"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "id": "#MFMapperAdapter_output"
+}

gemseo_multi_fidelity/core/MFMapperLinker_input.json

@@ -0,0 +1,22 @@
+{
+  "name": "MFMapperAdapter_output",
+  "required": [
+    "x_start"
+  ],
+  "properties": {
+    "x_start": {},
+    "x_reference": {},
+    "output_reference": {
+      "type": "object"
+    },
+    "input_options": {
+      "type": "object"
+    },
+    "output_status": {
+      "type": "string"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "id": "#MFMapperAdapter_output"
+}

gemseo_multi_fidelity/core/MFMapperLinker_output.json

@@ -0,0 +1,22 @@
+{
+  "name": "MFMapperAdapter_input",
+  "required": [
+    "x_best"
+  ],
+  "properties": {
+    "x_best": {},
+    "x_reference": {},
+    "output_reference": {
+      "type": "object"
+    },
+    "output_options": {
+      "type": "object"
+    },
+    "output_status": {
+      "type": "string"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "id": "#MFMapperAdapter_input"
+}

gemseo_multi_fidelity/core/MFScenarioAdapter_input.json

@@ -0,0 +1,39 @@
+{
+  "name": "MFScenarioAdapter_input",
+  "required": [
+    "x_start"
+  ],
+  "properties": {
+    "algo_name": {
+      "type": "string"
+    },
+    "max_iter": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "algo_options": {
+      "type": "object"
+    },
+    "x_start": {},
+    "input_options": {
+      "type": "object"
+    },
+    "x_reference": {},
+    "output_reference": {
+      "type": "object"
+    },
+    "on_entry_callbacks": {},
+    "return_callback": {},
+    "on_exit_callbacks": {},
+    "max_corr_rad": {
+      "type": "number",
+      "minimum": 0.0001
+    },
+    "hotstart_options": {},
+    "validation_map": {},
+    "validation_jac_map": {}
+  },
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "id": "#MFScenarioAdapter_input"
+}

gemseo_multi_fidelity/core/MFScenarioAdapter_output.json

@@ -0,0 +1,23 @@
+{
+  "name": "MFScenarioAdapter_output",
+  "required": [
+    "x_best",
+    "output_status"
+  ],
+  "properties": {
+    "x_best": {},
+    "output_status": {
+      "type": "string"
+    },
+    "output_options": {
+      "type": "object"
+    },
+    "x_reference": {},
+    "output_reference": {
+      "type": "object"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "id": "#MFScenarioAdapter_output"
+}

gemseo_multi_fidelity/core/__init__.py

@@ -0,0 +1,16 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+"""Core."""

gemseo_multi_fidelity/core/boxed_domain.py

@@ -0,0 +1,242 @@
+# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+# Copyright (c) 2018 AIRBUS OPERATIONS
+#
+# Contributors:
+#    INITIAL AUTHORS - API and implementation and/or documentation
+#      :author: Romain Olivanti
+#    OTHER AUTHORS   - MACROSCOPIC CHANGES
+"""Boxed Domain."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from numpy import all as np_all
+from numpy import any as np_any
+from numpy import array
+from numpy import array_equal
+from numpy import max as np_max
+from numpy import min as np_min
+from numpy import vstack
+from numpy import where
+from numpy import zeros
+
+from gemseo_multi_fidelity.core.errors import ConsistencyError
+
+if TYPE_CHECKING:
+    from numpy.typing import NDArray
+    from typing_extensions import Self
+
+
+class BoxedDomain:
+    """Basic boxed domain."""
+
+    def __init__(self, lower: NDArray, upper: NDArray) -> None:
+        """Initialize the boxed domain.
+
+        Args:
+            lower: The lower bounds, 1d array_like.
+            upper: The upper bounds, 1d array_like.
+        """
+        self.lower = array(lower, copy=True).flatten()
+        self.upper = array(upper, copy=True).flatten()
+
+        if self.lower.shape != self.upper.shape:
+            msg = "Dimension mismatch between lower and upper"
+            raise ConsistencyError(msg)
+
+        if np_any(self.upper < self.lower):
+            msg = "upper < lower"
+            raise ConsistencyError(msg)
+
+    def _check_vect(self, x_vect: NDArray) -> NDArray:
+        """Check if x_vect is consistent with the bounds of the domain.
+
+        Converts x_vect to an array if required.
+
+        Args:
+            x_vect: The 1d array_like.
+
+        Returns:
+            Array.
+
+        Raises:
+            ``ConsistencyError`` if the size of x_vect is not consistent with the bounds
+                of the domain.
+        """
+        x_vect = array(x_vect, copy=False)
+        if x_vect.shape != self.lower.shape:
+            msg = "Dimension mismatch between x_vect and bounds"
+            raise ConsistencyError(msg)
+        return x_vect
+
+    def contains(self, x_vect: NDArray, tol: float | NDArray = 0.0) -> bool:
+        """Check if x_vect belongs to the domain within the provided tolerance.
+
+        Args:
+            x_vect: The 1d array_like.
+            tol: The tolerance.
+
+        Returns:
+            ``True`` if x_vect belongs to the Domain, ``False`` otherwise.
+
+        Raises:
+            ``ConsistencyError`` if the size of x_vect is not consistent with the bounds
+                of the domain.
+        """
+        x_vect = self._check_vect(x_vect)
+        return np_all(x_vect >= self.lower - tol) and np_all(x_vect <= self.upper + tol)
+
+    def __contains__(self, x_vect: NDArray) -> bool:
+        """Override the default implementation using contains without a tolerance.
+
+        Args:
+            x_vect: 1d array_like.
+
+        Returns:
+            ``True`` if x_vect belongs to the domain, ``False`` otherwise.
+
+        Raises:
+            ``ConsistencyError`` if the size of x_vect is not consistent with the bounds
+                of the domain.
+        """
+        return self.contains(x_vect, tol=0.0)
+
+    def __eq__(self, other: object) -> bool:
+        """Override the default implementation.
+
+        Args:
+            other: The other object.
+
+        Returns:
+            ``True`` if other is a domain object with identical bounds.
+        """
+        ret = False
+        if (
+            isinstance(other, BoxedDomain)
+            and array_equal(self.lower, other.lower)
+            and array_equal(self.upper, other.upper)
+        ):
+            ret = True
+        return ret
+
+    def __ne__(self, other: object) -> bool:
+        """Override the default implementation.
+
+        Args:
+            other: The other object.
+
+        Returns:
+            Opposite of self.__eq__.
+        """
+        return not self.__eq__(other)
+
+    def get_dist_upper(self, x_vect: NDArray) -> NDArray:
+        """Get the difference: self.upper - x_vect.
+
+        Args:
+            x_vect: 1d array_like.
+
+        Returns:
+            The difference array.
+
+        Raises:
+            ``ConsistencyError`` if the size of x_vect is not consistent with the bounds
+                of the domain.
+        """
+        return self.upper - self._check_vect(x_vect)
+
+    def get_dist_lower(self, x_vect: NDArray) -> NDArray:
+        """Get the difference: x_vect - self.lower.
+
+        Args:
+            x_vect: 1d array_like.
+
+        Returns:
+            The difference array.
+
+        Raises:
+            ``ConsistencyError`` if the size of x_vect is not consistent with the bounds
+                of the domain.
+        """
+        return self._check_vect(x_vect) - self.lower
+
+    def intersect(self, other: Self) -> Self:
+        """Intersect self with another domain.
+
+        Args:
+            other: The BoxedDomain to intersect with.
+
+        Returns:
+            The intersection of BoxedDomains.
+
+        Raises:
+            ``ConsistencyError`` if other is not a domain object.
+        """
+        if not isinstance(other, BoxedDomain):
+            msg = "Can only intersect two BoxedDomain objects"
+            raise TypeError(msg)
+
+        if other.lower.shape != self.lower.shape:
+            msg = "Mismatch between bounds"
+            raise ConsistencyError(msg)
+
+        lower = np_max(vstack((self.lower, other.lower)), axis=0)
+        upper = np_min(vstack((self.upper, other.upper)), axis=0)
+
+        try:
+            return BoxedDomain(lower, upper)
+        except ConsistencyError:
+            # Empty intersection i.e. lower > upper
+            empty = zeros(self.lower.shape)
+            return BoxedDomain(empty, empty)
+
+    def project(self, x_vect: NDArray) -> NDArray:
+        """Project x_vect onto this domain.
+
+        Args:
+            x_vect: 1d array_like.
+
+        Returns:
+            The projection.
+
+        Raises:
+            ``ConsistencyError`` if the size of x_vect is not consistent with the bounds
+                of the domain.
+        """
+        x_vect = self._check_vect(x_vect)
+        projection = x_vect.copy()
+
+        inds_l = where(x_vect < self.lower)
+        inds_u = where(x_vect > self.upper)
+
+        projection[inds_l] = self.lower[inds_l]
+        projection[inds_u] = self.upper[inds_u]
+
+        return projection
+
+    def __str__(self) -> str:
+        """Custom string representation.
+
+        Returns:
+            The representation.
+        """
+        msg = "========= Domain ========="
+        for lower, upper in zip(self.lower, self.upper, strict=False):
+            msg += f"\r\n{lower: 9.3f} ------ {upper: 9.3f}"
+        msg += "\r\n=========================="
+        return msg