.. oe:namespace:: OEBio


.. _OEBio_OEIsUnpairedInteractionHint:

.. oe:class:: OEIsUnpairedInteractionHint

   .. oe:api::

      class OEIsUnpairedInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` functor that
   identifies **unpaired** interactions — hydrogen bond donors or acceptors, and
   charged groups in salt-bridge positions, that have no complementary partner
   in the active site.

   .. note::

      This predicate covers both unpaired hydrogen bond interactions
      (:oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandAcceptor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinAcceptor`) and
      unpaired salt-bridge interactions
      (:oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandPositive`,
      :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandNegative`,
      :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinPositive`,
      :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinNegative`).

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>` predicate
      * :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>` predicate
      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` predicate

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEIsUnpairedInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsUnpairedInteractionHint() -> OEIsUnpairedInteractionHint
            OEIsUnpairedInteractionHint(arg2: OEIsUnpairedInteractionHint) -> OEIsUnpairedInteractionHint

      Default constructor.


   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEIsUnpairedInteractionHint & operator=(const OEIsUnpairedInteractionHint &)

      Assignment operator.



   .. oe:method:: operator()

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction is an unpaired hydrogen bond
      or unpaired salt-bridge interaction. This is equivalent to
      :ref:`OEIsUnpairedLigandInteractionHint <OEBio_OEIsUnpairedLigandInteractionHint>` ``||``
      :ref:`OEIsUnpairedProteinInteractionHint <OEBio_OEIsUnpairedProteinInteractionHint>`.


   .. oe:method:: CreateCopy

      .. oe:language:: c++ java csharp

         .. oe:api::

            OESystem::OEUnaryFunction<OEInteractionHint, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
      object is dynamically allocated and owned by the caller.

      .. oe:language:: c++

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak.
