..
   Generated automatically by cpp2rst

.. highlight:: c
.. role:: red
.. role:: green
.. role:: param


.. _triqs__hilbert_space__sub_hilbert_space:

triqs::hilbert_space::sub_hilbert_space
=======================================

*#include <triqs/hilbert_space/hilbert_space.hpp>*

.. rst-class:: cppsynopsis

      class  :red:`sub_hilbert_space`

Hilbert subspace, as an ordered set of basis Fock states.

 Subspaces carry an integer index, which allows them to be destinguished as parts of a full Hilbert space.


Member functions
----------------

.. table::
   :widths: 40 60


   +-------------------------------------------------------------------------------------------+--+
   | :ref:`(constructor) <triqs__hilbert_space__sub_hilbert_space__constructor>`               |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`add_fock_state <triqs__hilbert_space__sub_hilbert_space__add_fock_state>`           |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`size <triqs__hilbert_space__sub_hilbert_space__size>`                               |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`operator== <triqs__hilbert_space__sub_hilbert_space__operator==>`                   |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`operator!= <triqs__hilbert_space__sub_hilbert_space__operator!=>`                   |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`get_state_index <triqs__hilbert_space__sub_hilbert_space__get_state_index>`         |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`has_state <triqs__hilbert_space__sub_hilbert_space__has_state>`                     |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`get_fock_state <triqs__hilbert_space__sub_hilbert_space__get_fock_state>`           |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`get_all_fock_states <triqs__hilbert_space__sub_hilbert_space__get_all_fock_states>` |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`get_index <triqs__hilbert_space__sub_hilbert_space__get_index>`                     |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`set_index <triqs__hilbert_space__sub_hilbert_space__set_index>`                     |  |
   +-------------------------------------------------------------------------------------------+--+
   | :ref:`hdf5_format <triqs__hilbert_space__sub_hilbert_space__hdf5_format>`                 |  |
   +-------------------------------------------------------------------------------------------+--+

.. toctree::
    :hidden:

    sub_hilbert_space/constructor
    sub_hilbert_space/add_fock_state
    sub_hilbert_space/size
    sub_hilbert_space/operator==
    sub_hilbert_space/operator!=
    sub_hilbert_space/get_state_index
    sub_hilbert_space/has_state
    sub_hilbert_space/get_fock_state
    sub_hilbert_space/get_all_fock_states
    sub_hilbert_space/get_index
    sub_hilbert_space/set_index
    sub_hilbert_space/hdf5_format


Non Member functions
--------------------

.. table::
   :widths: 40 60


   +---------------------------------------------------------------------+--+
   | :ref:`h5_write <triqs__hilbert_space__sub_hilbert_space__h5_write>` |  |
   +---------------------------------------------------------------------+--+
   | :ref:`h5_read <triqs__hilbert_space__sub_hilbert_space__h5_read>`   |  |
   +---------------------------------------------------------------------+--+

.. toctree::
    :hidden:

    sub_hilbert_space/h5_write
    sub_hilbert_space/h5_read