`lqr_carver_set_gradient_function`
Prev | Energy | Next

## Name

lqr_carver_set_gradient_function — set the gradient function for an `LqrCarver` object

## Synopsis

    #include <lqr.h>

`void lqr_carver_set_gradient_function(` | LqrCarver* carver,
| LqrGradFuncType gf_ind`)`;

## Description

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:

`LqrGradFuncType` | `LqrEnergyFuncBuiltinType`
--- | ---
`LQR_GF_XABS` | `LQR_EF_GRAD_XABS`
`LQR_GF_SUMABS` | `LQR_EF_GRAD_SUMABS`
`LQR_GF_NORM` | `LQR_EF_GRAD_NORM`
`LQR_GF_NULL` | `LQR_EF_NULL`

## See also

`lqr_carver_set_energy_function_builtin`(3), `lqr_carver_set_energy_function`(3)

Prev | Up | Next
`lqr_rwindow_get_channels` | Home | Bias