Source code for pints.toy._parabola

#
# Parabolic error measure.
#
# This file is part of PINTS (https://github.com/pints-team/pints/) which is
# released under the BSD 3-clause license. See accompanying LICENSE.md for
# copyright notice and full license details.
#
import pints
import numpy as np




class ParabolicError(pints.ErrorMeasure):
    r"""
    Error measure based on a simple parabola centered around a user specified
    point.

    .. math::
        f(x) = \sum (x - c)^2

    Extends :class:`pints.ErrorMeasure`.

    Parameters
    ----------
    c : sequence
        The center of the parabola.
    """
    def __init__(self, c=[0, 0]):
        self._c = pints.vector(c)
        self._n = len(self._c)

    def __call__(self, x):
        y = pints.vector(x).reshape(self._n)
        return np.sum((self._c - y)**2)



    def evaluateS1(self, x):
        """ See :meth:`pints.ErrorMeasure.evaluateS1()`. """
        x = pints.vector(x) - self._c
        return np.sum(x**2), 2 * x




    def n_parameters(self):
        """ See :meth:`pints.ErrorMeasure.n_parameters()`. """
        return self._n




    def optimum(self):
        """
        Returns the global optimum for this function.
        """
        return np.array(self._c, copy=True)