constraints.solve.constraint_residuals

constraints.solve.constraint_residuals(free_params, metadata)

Evaluate the constraint residuals at free_params.

Parameters

Name Type Description Default
free_params dict[str, Array] Name-keyed parameter arrays. required
metadata dict[str, Parameter] Name-keyed Parameter objects (carries constraint info). required

Returns

Name Type Description
Array Flat residual array (length = total constraint equations). Empty array
Array if there are no constraints.