Source code for gemseo.caches.cache_entry

# 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.
"""A cache entry."""

from __future__ import annotations

from typing import TYPE_CHECKING
from typing import NamedTuple

if TYPE_CHECKING:
    from gemseo.typing import JacobianData
    from gemseo.typing import StrKeyMapping




class CacheEntry(NamedTuple):
    """An entry of a cache."""

    # TODO: API: remove this since a mapping's value does not need to return its key.
    inputs: StrKeyMapping
    """The input data."""

    outputs: StrKeyMapping
    """The output data."""

    jacobian: JacobianData
    """The Jacobian data."""