:py:mod:`qsearch.evaluation`
============================

.. py:module:: qsearch.evaluation

.. autoapi-nested-parse::

   This module contains functions for comparing and otherwise evaluating matrices, including distance functions, cost functions, and constraint functions.

   The standarized format for these types of functions is as follows:

       def my_func(circuit, parameters, target, options):
           return <one or more real-valued numbers>

       def my_func_jac(circuit, parameters, target, jacs, options):
           return <one or more real-valued numbers>



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


Functions
~~~~~~~~~

.. autoapisummary::

   qsearch.evaluation.error_distsq
   qsearch.evaluation.error_distsq_jac
   qsearch.evaluation.error_stateprep_distsq
   qsearch.evaluation.error_stateprep_distsq_jac
   qsearch.evaluation.residuals_product
   qsearch.evaluation.residuals_product_jac
   qsearch.evaluation.residuals_difference
   qsearch.evaluation.residuals_difference_jac
   qsearch.evaluation.residuals_slice
   qsearch.evaluation.residuals_slice_jac
   qsearch.evaluation.residuals_blacklist
   qsearch.evaluation.residuals_blacklist_jac
   qsearch.evaluation.cost_linear
   qsearch.evaluation.cost_linear_jac
   qsearch.evaluation.constraint_distsq
   qsearch.evaluation.constraint_distsq_jac
   qsearch.evaluation.cost_combo_linear
   qsearch.evaluation.cost_combo_linear_jac



.. py:function:: error_distsq(circuit, parameters, target, options)


.. py:function:: error_distsq_jac(circuit, parameters, target, jacs, options)


.. py:function:: error_stateprep_distsq(circuit, parameters, target, options)


.. py:function:: error_stateprep_distsq_jac(circuit, parameters, target, options)


.. py:function:: residuals_product(circuit, parameters, target, options)


.. py:function:: residuals_product_jac(circuit, parameters, target, options)


.. py:function:: residuals_difference(circuit, parameters, target, options)


.. py:function:: residuals_difference_jac(circuit, parameters, target, options)


.. py:function:: residuals_slice(circuit, parameters, target, options)


.. py:function:: residuals_slice_jac(circuit, parameters, target, options)


.. py:function:: residuals_blacklist(circuit, parameters, target, options)


.. py:function:: residuals_blacklist_jac(circuit, parameters, target, options)


.. py:function:: cost_linear(circuit, parameters, target, options)


.. py:function:: cost_linear_jac(circuit, parameters, target, options)


.. py:function:: constraint_distsq(circuit, parameters, target, options)


.. py:function:: constraint_distsq_jac(circuit, parameters, target, jacs, options)


.. py:function:: cost_combo_linear(circuit, parameters, target, options)


.. py:function:: cost_combo_linear_jac(circuit, parameters, target, jacs, options)