---

gnn_utilities.h

Go to the documentation of this file.

/***************************************************************************
 *  @file gnn_utilities.h
 *  @brief General \ref libgnn utilities.
 *
 *  @date   : 06-08-03 09:34
 *  @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_UTILITIES_H_
#define _GNN_UTILITIES_H_

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

#include <gsl/gsl_vector.h>
#include <gsl/gsl_matrix.h>
#include <gsl/gsl_rng.h>

/******************************************/
/* Macros and Definitions                 */
/******************************************/

/**
 * @brief gets the minimum of two values.
 * @ingroup gnn_utilities_doc
 */
#define GNN_MIN(x,y) ( ((x) < (y))? (x) : (y) )

/**
 * @brief gets the maximum of two values.
 * @ingroup gnn_utilities_doc
 */
#define GNN_MAX(x,y) ( ((x) > (y))? (x) : (y) )

/**
 * @brief gets the sign of a value.
 * @ingroup gnn_utilities_doc
 */
#define GNN_SIGN(x) ( ((x) > 0)? 1 : -1 )

/**
 * @brief shifts two to the left.
 * @ingroup gnn_utilities_doc
 */
#define GNN_SHIFT2(a,b,c)   (a)=(b);(b)=(c);

/**
 * @brief shifts three to the left.
 * @ingroup gnn_utilities_doc
 */
#define GNN_SHIFT3(a,b,c,d) (a)=(b);(b)=(c);(c)=(d);

/**
 * @brief use \c b's sign for \c a.
 * @ingroup gnn_utilities_doc
 */
#define GNN_USE_SIGN(a, b)  ( (b) >= 0.0 ? fabs(a) : -fabs(a) )



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

gsl_rng *
gnn_get_rng ();

int
gnn_vector_resize (gsl_vector **v, int new_size);

int
gnn_vector_sum_elements (gsl_vector *v);

double
gnn_vector_euclidian_dist (const gsl_vector *v, const gsl_vector *u);


int
gnn_matrix_check_sizes_from_stream (FILE *stream, size_t *m, size_t *n);

gsl_vector *
gnn_vector_load (const char *filename);

int
gnn_vector_save (const char *filename, gsl_vector *v);

gsl_matrix *
gnn_matrix_load (const char *filename);

int
gnn_matrix_save (const char *filename, gsl_matrix *A);



#endif /* _GNN_UTILITIES_H_ */

---