.\"     Title: \fBlqr_carver_set_gradient_function\fR
.\"    Author: Carlo Baldassi
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 10 Maj 2009
.\"    Manual: LqR library API reference
.\"    Source: LqR library 0.4.1 API (3:1:3)
.\"
.TH "\FBLQR_CARVER_SET_GRADIENT_FUN" "3" "10 Maj 2009" "LqR library 0.4.1 API (3:1:3)" "LqR library API reference"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
lqr_carver_set_gradient_function \- set the gradient function for an LqrCarver object
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <lqr\&.h>
.fi
.ft
.HP 38
.BI "void lqr_carver_set_gradient_function(LqrCarver*\ " "carver" ", LqrGradFuncType\ " "gf_ind" ");"
.SH "DESCRIPTION"
.PP
The function
\fBlqr_carver_set_gradient_function\fR
is deprecated and should not be used in newly written code\&. The function
\fBlqr_carver_set_energy_function_builtin\fR(3)
should be used instead\&.
.PP
The function
\fBlqr_carver_set_gradient_function\fR
is still maintained for backwards compatibility reasons; its result is equivalent to calling
\fBlqr_carver_set_energy_function_builtin\fR, with the following mapping between the argument
\fIgs_ind\fR
of the former and the argument
\fIef_ind\fR
of the latter:
.TS
allbox tab(:);
lB lB.
T{
\fBLqrGradFuncType\fR
T}:T{
\fBLqrEnergyFuncBuiltinType\fR
T}
.T&
l l
l l
l l
l l.
T{
LQR_GF_XABS
T}:T{
LQR_EF_GRAD_XABS
T}
T{
LQR_GF_SUMABS
T}:T{
LQR_EF_GRAD_SUMABS
T}
T{
LQR_GF_NORM
T}:T{
LQR_EF_GRAD_NORM
T}
T{
LQR_GF_NULL
T}:T{
LQR_EF_NULL
T}
.TE
.sp
.SH "SEE ALSO"
.PP

\fBlqr_carver_set_energy_function_builtin\fR(3), \fBlqr_carver_set_energy_function\fR(3)
.SH "COPYRIGHT"
Copyright \(co 2007-2009 Carlo Baldassi
.br