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

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_vietoris_rips_plot_vector_index_tool.py:


Vector Index Tool
========================================

.. GENERATED FROM PYTHON SOURCE LINES 7-13

.. code-block:: Python

    import oat_python as oat

    from fractions import Fraction
    import numpy as np
    import pandas as pd








.. GENERATED FROM PYTHON SOURCE LINES 14-15

Create a Vietoris-Rips complex from a points of points

.. GENERATED FROM PYTHON SOURCE LINES 15-20

.. code-block:: Python

    points                      =   np.random.rand(5, 3)
    dissimilarity_matrix        =   oat.dissimilarity.sparse_matrix_for_points(points, max_dissimilarity=np.inf)
    vietoris_rips_complex       =   oat.core.vietoris_rips.VietorisRipsComplex(dissimilarity_matrix)
    boundary_matrix             =   vietoris_rips_complex.boundary_matrix_oracle()








.. GENERATED FROM PYTHON SOURCE LINES 21-22

Generate a VectorIndexTool

.. GENERATED FROM PYTHON SOURCE LINES 22-25

.. code-block:: Python

    vector_index_tool           =   vietoris_rips_complex.vector_index_tool(dimensions=[0,1])
    vector_index_tool





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

 .. code-block:: none


    <VectorIndexTool with 15 unique simplices>



.. GENERATED FROM PYTHON SOURCE LINES 26-27

Convert a dataframe to a dense 1d numpy.ndarray

.. GENERATED FROM PYTHON SOURCE LINES 27-38

.. code-block:: Python

    simplices_in_index_tool     =   vector_index_tool.simplices()
    vector_as_dataframe         =   boundary_matrix.column_for_simplex([0,1,2])
    vector_as_ndarray           =   vector_index_tool.dense_array_for_dataframe(vector_as_dataframe)

    html                        =   oat.plot.display_dataframes_side_by_side(
                                        vector_as_dataframe, pd.DataFrame(dict(coefficient=vector_as_ndarray)), simplices_in_index_tool,
                                        titles=['Vector as DataFrame', 'Vector as dense array', 'Simplices in index tool']
                                    )
    html







.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div style="display:inline-block; vertical-align:top; margin-right:20px;"><h4>Vector as DataFrame</h4><table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>simplex</th>
          <th>filtration</th>
          <th>coefficient</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>(0, 2)</td>
          <td>0.342480</td>
          <td>-1</td>
        </tr>
        <tr>
          <th>1</th>
          <td>(0, 1)</td>
          <td>0.377622</td>
          <td>1</td>
        </tr>
        <tr>
          <th>2</th>
          <td>(1, 2)</td>
          <td>0.559060</td>
          <td>1</td>
        </tr>
      </tbody>
    </table></div><div style="display:inline-block; vertical-align:top; margin-right:20px;"><h4>Vector as dense array</h4><table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>coefficient</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>1</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>2</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>3</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>4</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>5</th>
          <td>-1.0</td>
        </tr>
        <tr>
          <th>6</th>
          <td>1.0</td>
        </tr>
        <tr>
          <th>7</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>8</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>9</th>
          <td>1.0</td>
        </tr>
        <tr>
          <th>10</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>11</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>12</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>13</th>
          <td>0.0</td>
        </tr>
        <tr>
          <th>14</th>
          <td>0.0</td>
        </tr>
      </tbody>
    </table></div><div style="display:inline-block; vertical-align:top; margin-right:20px;"><h4>Simplices in index tool</h4><table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>simplex</th>
          <th>filtration</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>(0,)</td>
          <td>0.000000</td>
        </tr>
        <tr>
          <th>1</th>
          <td>(1,)</td>
          <td>0.000000</td>
        </tr>
        <tr>
          <th>2</th>
          <td>(2,)</td>
          <td>0.000000</td>
        </tr>
        <tr>
          <th>3</th>
          <td>(3,)</td>
          <td>0.000000</td>
        </tr>
        <tr>
          <th>4</th>
          <td>(4,)</td>
          <td>0.000000</td>
        </tr>
        <tr>
          <th>5</th>
          <td>(0, 2)</td>
          <td>0.342480</td>
        </tr>
        <tr>
          <th>6</th>
          <td>(0, 1)</td>
          <td>0.377622</td>
        </tr>
        <tr>
          <th>7</th>
          <td>(0, 3)</td>
          <td>0.389864</td>
        </tr>
        <tr>
          <th>8</th>
          <td>(1, 3)</td>
          <td>0.497502</td>
        </tr>
        <tr>
          <th>9</th>
          <td>(1, 2)</td>
          <td>0.559060</td>
        </tr>
        <tr>
          <th>10</th>
          <td>(2, 3)</td>
          <td>0.586859</td>
        </tr>
        <tr>
          <th>11</th>
          <td>(0, 4)</td>
          <td>0.752891</td>
        </tr>
        <tr>
          <th>12</th>
          <td>(3, 4)</td>
          <td>0.790280</td>
        </tr>
        <tr>
          <th>13</th>
          <td>(2, 4)</td>
          <td>0.812302</td>
        </tr>
        <tr>
          <th>14</th>
          <td>(1, 4)</td>
          <td>1.116900</td>
        </tr>
      </tbody>
    </table></div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 39-40

Convert the dense 1d numpy.ndarray back to a dataframe

.. GENERATED FROM PYTHON SOURCE LINES 40-44

.. code-block:: Python

    vector_as_dataframe.equals( 
        vector_index_tool.dataframe_for_dense_array(vector_as_ndarray) 
    )





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

 .. code-block:: none


    False



.. GENERATED FROM PYTHON SOURCE LINES 45-46

Look up the index for a given simplex

.. GENERATED FROM PYTHON SOURCE LINES 46-48

.. code-block:: Python

    vector_index_tool.index_number_for_simplex((1,3))





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

 .. code-block:: none


    8



.. GENERATED FROM PYTHON SOURCE LINES 49-50

Errors for invalid simplices

.. GENERATED FROM PYTHON SOURCE LINES 50-60

.. code-block:: Python

    try:
        vector_index_tool.index_number_for_simplex((3,2,1)) # not strictly sorted
    except Exception as e:
        print(f"Caught error: {type(e).__name__}: {e}")

    try:
        vector_index_tool.index_number_for_simplex((10,20)) # not in the Vietoris-Rips complex
    except Exception as e:
        print(f"Caught error: {type(e).__name__}: {e}")    





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

 .. code-block:: none

    Caught error: TypeError: The VectorIndexTool does not contain a simplex represented by [3, 2, 1].
    Caught error: TypeError: The VectorIndexTool does not contain a simplex represented by [10, 20].




.. GENERATED FROM PYTHON SOURCE LINES 61-62

Check that a simplex is in the index tool

.. GENERATED FROM PYTHON SOURCE LINES 62-64

.. code-block:: Python

    vector_index_tool.contains_simplex((1,4))





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

 .. code-block:: none


    True



.. GENERATED FROM PYTHON SOURCE LINES 65-66

Check that a simplex is not in the index tool

.. GENERATED FROM PYTHON SOURCE LINES 66-66

.. code-block:: Python

    vector_index_tool.contains_simplex((1,5))



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

 .. code-block:: none


    False




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

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


.. _sphx_glr_download_auto_examples_vietoris_rips_plot_vector_index_tool.py:

.. only:: html

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

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

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

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

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

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_vector_index_tool.zip <plot_vector_index_tool.zip>`


.. only:: html

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

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