pycif.plugins.simulators.dummy — API reference

Contents

pycif.plugins.simulators.dummy — API reference#

Configuration reference: dummy plugin

pycif.plugins.simulators.dummy.simul.simul(self, chi, grad=True, run_id=-1, **kwargs)[source]#

Evaluate the analytical quadratic-bowl cost function and its gradient.

Computes

\[J(\boldsymbol{\chi}) = \sum_{i=0}^{n-1}(\chi_i - i)^2, \qquad \nabla J(\boldsymbol{\chi}) = 2\,(\boldsymbol{\chi} - \mathbf{i})\]

with the global minimum at \(\chi^*_i = i\). No obs-operator or observation vector is required.

Parameters:

  • self (Plugin) – dummy simulator plugin instance.

  • chi (np.ndarray) – current iterate \(\boldsymbol{\chi}\), shape (n,).

  • grad (bool) – if True (default), return both cost and gradient.

  • run_id (int) – unused; accepted for interface consistency.

  • **kwargs – unused; accepted for interface consistency.

Returns:

(zcost, zgrad) when grad=True; zcost when grad=False.

Return type:

tuple or float

Contents