.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "generated_examples\savings\plot_ex2_av_to_pols.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

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

        Click :ref:`here <sphx_glr_download_generated_examples_savings_plot_ex2_av_to_pols.py>`
        to download the full example code

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

.. _sphx_glr_generated_examples_savings_plot_ex2_av_to_pols.py:


Account value to number of policies
=========================================

This graph uses the ``CashValue_ME_EX2`` model
from :doc:`/libraries/savings/savings_example2`,
and shows path dependency of policy decrement.

The scatter plot shows how the number of policies at maturity varies
by the level of account value at maturity, and the graphs on the sides
show the distributions of the two factors.


.. seealso::

    * :doc:`/libraries/savings/savings_example2` notebook in the :mod:`~savings` library

.. GENERATED FROM PYTHON SOURCE LINES 19-73



.. image-sg:: /generated_examples/savings/images/sphx_glr_plot_ex2_av_to_pols_001.png
   :alt: plot ex2 av to pols
   :srcset: /generated_examples/savings/images/sphx_glr_plot_ex2_av_to_pols_001.png
   :class: sphx-glr-single-img





.. code-block:: default


    # The code below is based on the sample script available on
    # https://matplotlib.org/stable/gallery/lines_bars_and_markers/scatter_hist.html
    # See accompanying LICENSE_MATPLOT.txt for its terms of conditions.

    import numpy as np
    import matplotlib.pyplot as plt
    import modelx as mx

    def scatter_hist(x, y, ax, ax_histx, ax_histy):
        # no labels
        ax_histx.tick_params(axis="x", labelbottom=False)
        ax_histy.tick_params(axis="y", labelleft=False)

        # the scatter plot:
        ax.scatter(x, y)

        def get_bins(data, binsize):
            ub, lb = np.max(data), np.min(data)
            binwidth = ((ub - lb) / binsize)
            return np.arange(lb, ub + binwidth, binwidth)

        xbins = get_bins(x, 100)
        ybins = get_bins(y, 100)
        ax_histx.hist(x, bins=xbins)
        ax_histy.hist(y, bins=ybins, orientation='horizontal')
    
    
    # definitions for the axes
    left, width = 0.1, 0.65
    bottom, height = 0.1, 0.65
    spacing = 0.005

    rect_scatter = [left, bottom, width, height]
    rect_histx = [left, bottom + height + spacing, width, 0.2]
    rect_histy = [left + width + spacing, bottom, 0.2, height]

    # start with a square Figure
    fig = plt.figure(figsize=(8, 8))

    ax = fig.add_axes(rect_scatter)
    ax_histx = fig.add_axes(rect_histx, sharex=ax)
    ax_histy = fig.add_axes(rect_histy, sharey=ax)
    ax.grid(True), ax_histx.grid(True), ax_histy.grid(True)

    m = mx.read_model('CashValue_ME_EX2')

    x = m.Projection[5].claims_from_av(120, 'MATURITY')
    y = m.Projection[5].pols_maturity(120)

    # use the previously defined function
    scatter_hist(x, y, ax, ax_histx, ax_histy)

    m.close()


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

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


.. _sphx_glr_download_generated_examples_savings_plot_ex2_av_to_pols.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_ex2_av_to_pols.py <plot_ex2_av_to_pols.py>`

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

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


.. only:: html

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

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