Module potential

Functions for calculating various optimisation potentials.

Functions

quad_pot(values, pot, lower, upper)
Calculate the flat-bottom quadratic energy potential.

Variables

__package__ = None
hash(x)

Function Details

quad_pot(values, pot, lower, upper)

Calculate the flat-bottom quadratic energy potential.

The formula used is:

                       / (x - x+)^2    if x > x+,
                       |                         
   V_pQuad(x;x+,x-) = <  (x - x-)^2    if x < x-,
                       |                         
                       \ 0             otherwise.

Where x+ and x- are the absolute bounds.

Parameters:

• values (numpy float array) - An array of values of x.
• pot (numpy float array) - The array to place the potential values (V_pQuad) into. This should have the same dimensions as the values array.
• lower (numpy float array) - The array of lower bounds. This should have the same dimensions as the values array.
• upper (numpy float array) - The array of upper bounds. This should have the same dimensions as the values array.