---

gnn_phandle.h

Go to the documentation of this file.

/***************************************************************************
 *  @file  gnn_phandle.h
 *  @brief gnn_phandle Header File.
 *
 *  @date   : 15-08-03 01:44
 *  @author : Pedro Ortega C. <peortega@dcc.uchile.cl>
 *  Copyright  2003  Pedro Ortega C.
 ****************************************************************************/
/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Library General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */



#ifndef _GNN_PHANDLE_H_
#define _GNN_PHANDLE_H_

/******************************************/
/* Include Files                          */
/******************************************/

#include "gnn_globals.h"



/******************************************/
/* Typedefs                               */
/******************************************/

/**
 * @brief A type for update flags.
 * @ingroup gnn_phandle_doc
 *
 * This flag type is used for keeping track of the updates that are necessary.
 */
typedef enum _phandle_update phandle_update;

enum _phandle_update
{
    PHandleCountFlags = 1,
    PHandleUseFlags   = 2
};

/**
 * @brief The gnn_phandle type.
 * @ingroup gnn_phandle_doc
 *
 * This type holds the necessary information for handling parameters. It stores
 * the actual parameter vector, an additional vector for the parameter gradient
 * values, and a last vector for marking the frozen parameters.
 */
typedef struct
{
    size_t          rc;       /**< Reference counter.                        */
    size_t          l;        /**< Number of the phandle's parameters.       */
    size_t          free;     /**< Number of free parameters.                */
    phandle_update  modified; /**< Modification flags.                       */
    gsl_vector     *w;        /**< Pointer to the parameter vector.          */
    gsl_vector     *dw;       /**< Pointer to the parameter gradient vector. */
    gsl_vector_int *f;        /**< Pointer to the parameter freeze flags.    */
} gnn_phandle;



/******************************************/
/* Public Interface                       */
/******************************************/

gnn_phandle *
gnn_phandle_new (size_t size);

int
gnn_phandle_unref (gnn_phandle *ph);

int
gnn_phandle_ref (gnn_phandle *ph);

gsl_vector *
gnn_phandle_get_w (gnn_phandle *ph);

gsl_vector *
gnn_phandle_get_dw (gnn_phandle *ph);

gsl_vector_int *
gnn_phandle_get_f (gnn_phandle *ph);

int
gnn_phandle_update (gnn_phandle *ph);



#endif /* _GNN_PHANDLE_H_ */

---