.. include:: ../../toolkit-substitutions

.. oe:namespace:: OESpruce

..  _OESpruce_OEIsRedundantDesignUnit:

.. oe:function:: OEIsRedundantDesignUnit

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEIsRedundantDesignUnit(const std::vector<OEBio::OEDesignUnit*>& dus,
                                      const OEBio::OEDesignUnit& du,
                                      const OESpruce::OEDesignUnitEnumerateSitesOptions& opts)

   .. oe:language:: python

      .. oe:api:: python

         OEIsRedundantDesignUnit(dus: OEDesignUnitVector, du: OEDesignUnit,
                                 opts: OEDesignUnitEnumerateSitesOptions) -> bool

   Returns ``true`` if the :ref:`OEDesignUnit <OEBio_OEDesignUnit>` ``du`` is
   considered redundant with respect to the existing set of design units ``dus``,
   using the criteria defined by the supplied
   :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>`
   ``opts``. A design unit is redundant when duplicate-removal logic (controlled
   by :oe:meth:`OESpruce::OEDesignUnitEnumerateSitesOptions::SetDuplicateRemoval`)
   identifies it as equivalent to one already present in ``dus``.

   The input ``du`` must have 3D coordinates assigned.

   .. seealso::

      * :oe:func:`OESpruce::OEEnumerateSites` function
      * :oe:func:`OESpruce::OEMakeDesignUnits` function
      * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>` class
