.. _State_Comp_Functions:

****************
State Comparison
****************

Overloaded operators (:ref:`greater<State_Comp_Functions_greater>`, :ref:`lesser<State_Comp_Functions_lesser>`, and :ref:`equal<State_Comp_Functions_equal>`) are defined with the integers stored in :ref:`data<State_data>`.
We further provide the same set of functions based on the qudit level within a range **start** to **end**.


.. _State_Comp_Functions_greater:

.. doxygenfunction:: danceq::internal::State::operator>(const State<MaxSites,Q,IntType,Nbits,NInt>& state_input) const;

.. _State_Comp_Functions_lesser:

.. doxygenfunction:: danceq::internal::State::operator<(const State<MaxSites,Q,IntType,Nbits,NInt>& state_input) const;

.. _State_Comp_Functions_equal:

.. doxygenfunction:: danceq::internal::State::operator==(const State<MaxSites,Q,IntType,Nbits,NInt>& state_input) const;

.. doxygenfunction:: danceq::internal::State::greater_state_level(const State<MaxSites,Q,IntType,Nbits,NInt>&, uint64_t start = 0, uint64_t end = MaxSites) const;

.. doxygenfunction:: danceq::internal::State::lesser_state_level(const State<MaxSites,Q,IntType,Nbits,NInt>&, uint64_t start = 0, uint64_t end = MaxSites) const;

.. doxygenfunction:: danceq::internal::State::equal_state_level(const State<MaxSites,Q,IntType,Nbits,NInt>&, uint64_t start = 0, uint64_t end = MaxSites) const;