pyHarm.Predictors.PredictorTangent
==================================

.. py:module:: pyHarm.Predictors.PredictorTangent


Classes
-------

.. autoapisummary::

   pyHarm.Predictors.PredictorTangent.PredictorTangent


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

.. py:class:: PredictorTangent(sign_ds, logger: Optional[logging.Logger] = None, **kwargs)

   Bases: :py:obj:`pyHarm.Predictors.ABCPredictor.ABCPredictor`


   Define the tangent type of predictor. Using the Jacobian at solution point, a tangent to R(x)=0 solution is drawn and used as a prediction direction.

   The tangent is computed using a QR decomposition of the Jacobian at the solution point.


   .. py:attribute:: predictor_name
      :value: 'Tangent Predictor'



   .. py:attribute:: factory_keyword
      :type:  str
      :value: 'tangent'


      keyword that is used to call the creation of this class in the system factory.

      :type: str


   .. py:method:: predict(sollist: list[pyHarm.Solver.SystemSolution], ds: float, k_imposed=None) -> tuple[numpy.ndarray, pyHarm.Solver.SystemSolution, float]

      Predicts the next starting point using the tangent.

      :param sollist: list of SystemSolution already solved during the analysis.
      :type sollist: list[SystemSolution]
      :param ds: step size for the prediction.
      :type ds: float
      :param k_imposed: if not None, uses the k_imposed as the index of the last solution pointer.
      :type k_imposed: None | int

      :returns: next predicted starting point.
                SystemSolution: last accepted point in the list of solutions.
                float: sign of the prediction used (-1 | 1)
      :rtype: np.ndarray