.. include:: ../substitutions

.. oe:namespace:: OEChem

.. meta::
   :keywords: OETranslate

.. oe:function:: OETranslate

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

      .. oe:api::

         void OETranslate(OEMolBase& mol, const float* v)
         void OETranslate(OEMolBase& mol, const double* v)
         void OETranslate(OEConfBase& conf, const float* v)
         void OETranslate(OEConfBase& conf, const double* v)
         void OETranslate(OEMCMolBase& mcmol, const float* v)
         void OETranslate(OEMCMolBase& mcmol, const double* v)

   .. oe:language:: python

      .. oe:api:: python

         OETranslate(mol: Union[OEGraphMol,OEQMol], v: OEFloatArray) -> None
         OETranslate(mol: Union[OEGraphMol,OEQMol], v: OEDoubleArray) -> None
         OETranslate(conf: OEConfBase, v: OEFloatArray) -> None
         OETranslate(conf: OEConfBase, v: OEDoubleArray) -> None
         OETranslate(mcmol: OEMol, v: OEFloatArray) -> None
         OETranslate(mcmol: OEMol, v: OEDoubleArray) -> None

   Translates the molecule by the vector passed as the argument 'v'.  The
   vector 'v' must be of size three and contain the Cartesian
   translation vectors.  The overloads for :ref:`OEConfBase <OEChem_OEConfBase>`
   and :oe:cls:`OEMCMolBase<OEChem::OEMCMolBase>` are for efficiency.

   *mol*
      The molecule to translate.

   *conf*
      The conformer to translate.

   *mcmol*
      The multi-conformer molecule to translate.

   *v*
      The translation vector.

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`mcs3dalign.cpp<section_example_oechem_mcs3dalign>`

  .. oe:language:: python

      * Example program :ref:`mcs3dalign.py<section_example_oechem_mcs3dalign>`

  .. oe:language:: java

      * Example program :ref:`MCS3DAlign.java<section_example_oechem_mcs3dalign>`

  .. oe:language:: csharp

      * Example program :ref:`MCS3DAlign.cs<section_example_oechem_mcs3dalign>`

