import numpy as np
[docs]def dottest(Op, nr, nc, tol=1e-6, complexflag=0, raiseerror=True, verb=False):
r"""Dot test.
Generate random vectors :math:`\mathbf{u}` and :math:`\mathbf{v}`
and perform dot-test to verify the validity of forward and adjoint operators.
This test can help to detect errors in the operator implementation.
Parameters
----------
Op : :obj:`pylops.LinearOperator`
Linear operator to test.
nr : :obj:`int`
Number of rows of operator (i.e., elements in data)
nc : :obj:`int`
Number of columns of operator (i.e., elements in model)
tol : :obj:`float`, optional
Dottest tolerance
complexflag : :obj:`bool`, optional
generate random vectors with real (0) or complex numbers
(1: only model, 2: only data, 3:both)
raiseerror : :obj:`bool`, optional
Raise error or simply return ``False`` when dottest fails
verb : :obj:`bool`, optional
Verbosity
Raises
------
ValueError
If dot-test is not verified within chosen tolerance.
Notes
-----
A dot-test is mathematical tool used in the development of numerical linear operators.
More specifically, a correct implementation of forward and adjoint for
a linear operator should verify the the following *equality*
within a numerical tolerance:
.. math::
(\mathbf{Op}*\mathbf{u})^H*\mathbf{v} = \mathbf{u}^H*(\mathbf{Op}^H*\mathbf{v})
"""
if complexflag in (0, 2):
u = np.random.randn(nc)
else:
u = np.random.randn(nc)+1j*np.random.randn(nc)
if complexflag in (0, 1):
v = np.random.randn(nr)
else:
v = np.random.randn(nr)+1j*np.random.randn(nr)
y = Op.matvec(u) # Op * u
x = Op.rmatvec(v) # Op'* v
if complexflag == 0:
yy = np.dot(y, v) # (Op * u)' * v
xx = np.dot(u, x) # u' * (Op' * v)
else:
yy = np.vdot(y, v) # (Op * u)' * v
xx = np.vdot(u, x) # u' * (Op' * v)
if complexflag == 0:
if np.abs((yy-xx)/((yy+xx+1e-15)/2)) < tol:
if verb: print('Dot test passed, v^T(Opu)=%f - u^T(Op^Tv)=%f'
% (yy, xx))
return True
else:
if raiseerror:
raise ValueError('Dot test failed, v^T(Opu)=%f - u^T(Op^Tv)=%f'
% (yy, xx))
if verb: print('Dot test failed, v^T(Opu)=%f - u^T(Op^Tv)=%f'
% (yy, xx))
return False
else:
checkreal = np.abs((np.real(yy) - np.real(xx)) /
((np.real(yy) + np.real(xx)+1e-15) / 2)) < tol
checkimag = np.abs((np.real(yy) - np.real(xx)) /
((np.real(yy) + np.real(xx)+1e-15) / 2)) < tol
if checkreal and checkimag:
if verb: print('Dot test passed, v^T(Opu)=%f - u^T(Op^Tv)=%f'
% (yy, xx))
return True
else:
if raiseerror:
raise ValueError('Dot test failed, v^H(Opu)=%f - u^H(Op^Hv)=%f'
% (yy, xx))
if verb: print('Dot test failed, v^H(Opu)=%f - u^H(Op^Hv)=%f'
% (yy, xx))
return False