carta
lqr_carver_set_gradient_function(3)

lqr_carver_set_gradient_function3

Set the gradient function for an lqrcarver object

Overview

The function lqr_carver_set_gradient_function is deprecated and should not be used in newly written code. The function lqr_carver_set_energy_function_builtin(3) should be used instead.

The function lqr_carver_set_gradient_function is still maintained for backwards compatibility reasons; its result is equivalent to calling lqr_carver_set_energy_function_builtin, with the following mapping between the argument gs_ind of the former and the argument ef_ind of the latter:

LqrGradFuncTypeLqrEnergyFuncBuiltinType
LQR_GF_XABSLQR_EF_GRAD_XABS
LQR_GF_SUMABSLQR_EF_GRAD_SUMABS
LQR_GF_NORMLQR_EF_GRAD_NORM
LQR_GF_NULLLQR_EF_NULL

From liblqr-1-0-dev 0.4.1-2 in Debian 7 (Wheezy). Parsed by carta from the page's man source.