simpeg.maps.IdentityMap.test#

IdentityMap.test(m=None, num=4, random_seed=None, **kwargs)[source]#

Derivative test for the mapping.

This test validates the mapping by performing a convergence test.

Parameters:

m(nP) numpy.ndarray: Starting vector of model parameters for the derivative test
numint: Number of iterations for the derivative test
random_seedNone or RandomSeed, optional: Random seed used for generating a random array for m if it’s None. It can either be an int, a predefined Numpy random number generator, or any valid input to numpy.random.default_rng.
kwargs: dict: Keyword arguments and associated values in the dictionary must match those used in discretize.tests.check_derivative()

Returns: