orbithunter.EquilibriumOrbitKS.precondition

EquilibriumOrbitKS.precondition(**kwargs)[source]

Precondition a vector with the inverse (aboslute value) of linear spatial terms

Parameters:

kwargsdict

pmulttuple of tuples: Values for the frequencies to use in the rescaling
pexptuple of int: The exponentiation factor used to rescale parameter corrections.

Returns:

targetOrbitKS: Return the OrbitKS instance, modified by preconditioning.

Notes

Often we want to precondition a state derived from a mapping or rmatvec (gradient descent step), with respect to ANOTHER orbit’s (current state’s) parameters.