---

gnn_weight_decay : Weight Decay Regularization.
[gnn_criterion : Basic Criterion Function.]

---

Detailed Description

This datatype implements the Weight Decay Regularization, given by

Where the are choosen parameters. They are usually those of a gnn_weight : Affine / Linear Transform linear transform node.

The gradient is:

Functions
double	gnn_weight_decay_e (gnn_criterion *crit, const gsl_vector *y, const gsl_vector *t)
	The evaluation function.
int	gnn_weight_decay_dy (gnn_criterion *crit, const gsl_vector *y, const gsl_vector *t, gsl_vector *dy)
	The gradient evaluation function.
void	gnn_weight_decay_destroy (gnn_criterion *crit)
	The destroy function.
gnn_criterion *	gnn_weight_decay_new (gnn_criterion *crit, double nu, gnn_node *node)
	Creates a Weight Decay regularization for gnn_weight : Affine / Linear Transform.
gnn_criterion *	gnn_weight_decay_new_with_type (gnn_criterion *crit, double nu, gnn_node *node, const char *type)
	Creates a Weight Decay regularization for a given type.
gnn_criterion *	gnn_weight_decay_new_with_pbundle (gnn_criterion *crit, double nu, gnn_pbundle *pb)
	Creates a Weight Decay regularization for a given parameter bundle.
int	gnn_weight_decay_set_nu (gnn_criterion *crit, double nu)
	Sets the regularization coefficient.
double	gnn_weight_decay_get_nu (gnn_criterion *crit)
	Gets the regularization coefficient.

---

Function Documentation

void gnn_weight_decay_destroy (  gnn_criterion *    crit )  [static]

This function implements destroy function. Parameters: crit  A pointer to a gnn_weight_decay criterion. Definition at line 204 of file gnn_weight_decay.c.

int gnn_weight_decay_dy (  gnn_criterion *    crit, const gsl_vector *    y, const gsl_vector *    t, gsl_vector *    dy )

This function implements criterion's gradient evaluation function. Parameters: crit  A pointer to a gnn_weight_decay criterion. y  A pointer to an estimation vector . t  A pointer to the desired target vector . dy  A pointer to a buffer vector where the result should be placed. Returns: Returns 0 if succeeded. Definition at line 153 of file gnn_weight_decay.c.

double gnn_weight_decay_e (  gnn_criterion *    crit, const gsl_vector *    y, const gsl_vector *    t )

This function corresponds to the evaluation function. Parameters: crit  A pointer to a gnn_weight_decay criterion. y  A pointer to an estimation vector . t  A pointer to the desired target vector . Returns: A real number corresponding to the value of the criterion. Definition at line 100 of file gnn_weight_decay.c.

double gnn_weight_decay_get_nu (  gnn_criterion *    crit )

This function gets the currently used regularization coefficient of the gnn_weight_decay regularizer. Parameters: crit  A pointer to a gnn_weight_decay criterion. Returns: Returns the regularization coefficient . Definition at line 429 of file gnn_weight_decay.c.

gnn_criterion* gnn_weight_decay_new (  gnn_criterion *    crit, double    nu, gnn_node *    node )

This function builds a new gnn_weight_decay regularizator for all gnn_weight : Affine / Linear Transform nodes contained in the given node node. Parameters: crit  A pointer to a gnn_weight_decay criterion. nu  The regularization coefficient . node  A pointer to a gnn_node. Returns: Returns a pointer to a gnn_weight_decay if succeeded or NULL. Definition at line 243 of file gnn_weight_decay.c.

gnn_criterion* gnn_weight_decay_new_with_pbundle (  gnn_criterion *    crit, double    nu, gnn_pbundle *    pb )

This function builds a new gnn_weight_decay regularizator for all parameters contained in the given parameter bundle pb. Parameters: crit  A pointer to a gnn_weight_decay criterion. nu  The regularization coefficient . pb  A gnn_pbundle. Returns: Returns a pointer to a gnn_weight_decay if succeeded or NULL. Definition at line 321 of file gnn_weight_decay.c.

gnn_criterion* gnn_weight_decay_new_with_type (  gnn_criterion *    crit, double    nu, gnn_node *    node, const char *    type )

This function builds a new gnn_weight_decay regularizator for all nodes of type type contained in the given node node. Parameters: crit  A pointer to a gnn_weight_decay criterion. nu  The regularization coefficient . node  A pointer to a gnn_node. type  A string containing the type. Returns: Returns a pointer to a gnn_weight_decay if succeeded or NULL. Definition at line 280 of file gnn_weight_decay.c.

int gnn_weight_decay_set_nu (  gnn_criterion *    crit, double    nu )

This function sets a new regularization coefficient for the gnn_weight_decay regularizer. It should be positive. Parameters: crit  A pointer to a gnn_weight_decay criterion. nu  The new regularization coefficient . Returns: Returns 0 if succeeded. Definition at line 401 of file gnn_weight_decay.c.

---