RIAssigner.compute.ComputationMethod
====================================

.. py:module:: RIAssigner.compute.ComputationMethod


Classes
-------

.. autoapisummary::

   RIAssigner.compute.ComputationMethod.ComputationMethod


Module Contents
---------------

.. py:class:: ComputationMethod

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: compute(query: RIAssigner.data.Data, reference: RIAssigner.data.Data) -> List[RIAssigner.data.Data.RetentionIndexType]
      :abstractmethod:


      Abstract method for RI computation

      :param query: Dataset for which to compute the RI
      :type query: Data
      :param reference: Dataset with retention times & retention index for reference.
      :type reference: Data

      :returns: Computed retention indices
      :rtype: List[float]



   .. py:method:: _check_data_args(query: RIAssigner.data.Data, reference: RIAssigner.data.Data)

      Checks query and reference data for 'None'.

      :param query: Data for which to compute retention indices
      :type query: Data
      :param reference: Retention indexed reference data
      :type reference: Data



   .. py:method:: __eq__(o: object) -> bool