.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/cache/plot_memory_cache.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_cache_plot_memory_cache.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_cache_plot_memory_cache.py:


Memory full cache
=================
This example shows how to manipulate an :class:`.MemoryFullCache` object.

.. GENERATED FROM PYTHON SOURCE LINES 26-34

.. code-block:: default

    from __future__ import annotations

    from gemseo import configure_logger
    from gemseo.caches.memory_full_cache import MemoryFullCache
    from numpy import array

    configure_logger()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 35-39

Import
------

First, we import the `array` and the :class:`MemoryError` classes.

.. GENERATED FROM PYTHON SOURCE LINES 42-53

Create
------

We can create an instance of the :class:`.MemoryFullCache` class. We can then
print it, and we can see it is empty.

.. warning::
    The :class:`.MemoryFullCache` relies on some multiprocessing features.
    When working on Windows, the execution of scripts containing instances of
    :class:`.MemoryFullCache` must be protected by an
    ``if __name__ == '__main__':`` statement.

.. GENERATED FROM PYTHON SOURCE LINES 53-57

.. code-block:: default


    cache = MemoryFullCache()
    cache






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='background-color: #fafae2; padding: 10px;'>Name: MemoryFullCache<br/><ul><li>Type: MemoryFullCache</li><li>Tolerance: 0.0</li><li>Input names: []</li><li>Output names: []</li><li>Length: 0</li></ul></div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 58-64

Cache
-----

We can manually add data into the cache. However, it has to be noted that
most of the time a cache is attached to an :class:`.MDODiscipline`. Then, the
cache feeding has not to be performed explicitly by the user.

.. GENERATED FROM PYTHON SOURCE LINES 64-69

.. code-block:: default


    cache[{"x": array([1.0])}] = ({"y": array([2.0])}, None)
    cache[{"x": array([2.0])}] = ({"y": array([3.0])}, None)
    cache






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='background-color: #fafae2; padding: 10px;'>Name: MemoryFullCache<br/><ul><li>Type: MemoryFullCache</li><li>Tolerance: 0.0</li><li>Input names: ['x']</li><li>Output names: ['y']</li><li>Length: 2</li></ul></div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 70-74

Get all data
------------

We can now print some information from the cache, such as its length:

.. GENERATED FROM PYTHON SOURCE LINES 74-76

.. code-block:: default

    len(cache)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    2



.. GENERATED FROM PYTHON SOURCE LINES 77-79

We can
also display all the cached data so far.

.. GENERATED FROM PYTHON SOURCE LINES 79-81

.. code-block:: default

    [entry for entry in cache]





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    [CacheEntry(inputs={'x': array([1.])}, outputs={'y': array([2.])}, jacobian=None), CacheEntry(inputs={'x': array([2.])}, outputs={'y': array([3.])}, jacobian=None)]



.. GENERATED FROM PYTHON SOURCE LINES 82-87

Get last cached data
--------------------

The user can access the last entry (inputs or outputs) which have been
entered in the cache.

.. GENERATED FROM PYTHON SOURCE LINES 87-91

.. code-block:: default


    last_entry = cache.last_entry
    last_entry.inputs, last_entry.outputs





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    ({'x': array([2.])}, {'y': array([3.])})



.. GENERATED FROM PYTHON SOURCE LINES 92-96

Clear
-----
The user can clear a cache of all its entries by using the
:meth:`.MemoryFullCache.clear` method:

.. GENERATED FROM PYTHON SOURCE LINES 96-98

.. code-block:: default

    cache.clear()
    cache





.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style='background-color: #fafae2; padding: 10px;'>Name: MemoryFullCache<br/><ul><li>Type: MemoryFullCache</li><li>Tolerance: 0.0</li><li>Input names: []</li><li>Output names: []</li><li>Length: 0</li></ul></div>
    </div>
    <br />
    <br />


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.012 seconds)


.. _sphx_glr_download_examples_cache_plot_memory_cache.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example




    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_memory_cache.py <plot_memory_cache.py>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_memory_cache.ipynb <plot_memory_cache.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_