debian man page for lqr_carver_set_gradient_function

LQR_CARVER_SET_GRADIENT_FUN(3)				     LqR library API reference				    LQR_CARVER_SET_GRADIENT_FUN(3)

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)

COPYRIGHT
       Copyright (C) 2007-2009 Carlo Baldassi

LqR library 0.4.1 API (3:1:3)					    10 Maj 2009 				    LQR_CARVER_SET_GRADIENT_FUN(3)