1 /* matrix/gsl_matrix_double.h
3 * Copyright (C) 1996, 1997, 1998, 1999, 2000, 2007 Gerard Jungman, Brian Gough
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or (at
8 * your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 #ifndef __GSL_MATRIX_DOUBLE_H__
21 #define __GSL_MATRIX_DOUBLE_H__
24 #include <gsl/gsl_types.h>
25 #include <gsl/gsl_errno.h>
26 #include <gsl/gsl_check_range.h>
27 #include <gsl/gsl_vector_double.h>
32 # define __BEGIN_DECLS extern "C" {
33 # define __END_DECLS }
35 # define __BEGIN_DECLS /* empty */
36 # define __END_DECLS /* empty */
56 typedef _gsl_matrix_view gsl_matrix_view;
61 } _gsl_matrix_const_view;
63 typedef const _gsl_matrix_const_view gsl_matrix_const_view;
68 gsl_matrix_alloc (const size_t n1, const size_t n2);
71 gsl_matrix_calloc (const size_t n1, const size_t n2);
74 gsl_matrix_alloc_from_block (gsl_block * b,
81 gsl_matrix_alloc_from_matrix (gsl_matrix * m,
88 gsl_vector_alloc_row_from_matrix (gsl_matrix * m,
92 gsl_vector_alloc_col_from_matrix (gsl_matrix * m,
95 void gsl_matrix_free (gsl_matrix * m);
100 gsl_matrix_submatrix (gsl_matrix * m,
101 const size_t i, const size_t j,
102 const size_t n1, const size_t n2);
105 gsl_matrix_row (gsl_matrix * m, const size_t i);
108 gsl_matrix_column (gsl_matrix * m, const size_t j);
111 gsl_matrix_diagonal (gsl_matrix * m);
114 gsl_matrix_subdiagonal (gsl_matrix * m, const size_t k);
117 gsl_matrix_superdiagonal (gsl_matrix * m, const size_t k);
120 gsl_matrix_subrow (gsl_matrix * m, const size_t i,
121 const size_t offset, const size_t n);
124 gsl_matrix_subcolumn (gsl_matrix * m, const size_t j,
125 const size_t offset, const size_t n);
128 gsl_matrix_view_array (double * base,
133 gsl_matrix_view_array_with_tda (double * base,
140 gsl_matrix_view_vector (gsl_vector * v,
145 gsl_matrix_view_vector_with_tda (gsl_vector * v,
151 _gsl_matrix_const_view
152 gsl_matrix_const_submatrix (const gsl_matrix * m,
153 const size_t i, const size_t j,
154 const size_t n1, const size_t n2);
156 _gsl_vector_const_view
157 gsl_matrix_const_row (const gsl_matrix * m,
160 _gsl_vector_const_view
161 gsl_matrix_const_column (const gsl_matrix * m,
164 _gsl_vector_const_view
165 gsl_matrix_const_diagonal (const gsl_matrix * m);
167 _gsl_vector_const_view
168 gsl_matrix_const_subdiagonal (const gsl_matrix * m,
171 _gsl_vector_const_view
172 gsl_matrix_const_superdiagonal (const gsl_matrix * m,
175 _gsl_vector_const_view
176 gsl_matrix_const_subrow (const gsl_matrix * m, const size_t i,
177 const size_t offset, const size_t n);
179 _gsl_vector_const_view
180 gsl_matrix_const_subcolumn (const gsl_matrix * m, const size_t j,
181 const size_t offset, const size_t n);
183 _gsl_matrix_const_view
184 gsl_matrix_const_view_array (const double * base,
188 _gsl_matrix_const_view
189 gsl_matrix_const_view_array_with_tda (const double * base,
194 _gsl_matrix_const_view
195 gsl_matrix_const_view_vector (const gsl_vector * v,
199 _gsl_matrix_const_view
200 gsl_matrix_const_view_vector_with_tda (const gsl_vector * v,
207 double gsl_matrix_get(const gsl_matrix * m, const size_t i, const size_t j);
208 void gsl_matrix_set(gsl_matrix * m, const size_t i, const size_t j, const double x);
210 double * gsl_matrix_ptr(gsl_matrix * m, const size_t i, const size_t j);
211 const double * gsl_matrix_const_ptr(const gsl_matrix * m, const size_t i, const size_t j);
213 void gsl_matrix_set_zero (gsl_matrix * m);
214 void gsl_matrix_set_identity (gsl_matrix * m);
215 void gsl_matrix_set_all (gsl_matrix * m, double x);
217 int gsl_matrix_fread (FILE * stream, gsl_matrix * m) ;
218 int gsl_matrix_fwrite (FILE * stream, const gsl_matrix * m) ;
219 int gsl_matrix_fscanf (FILE * stream, gsl_matrix * m);
220 int gsl_matrix_fprintf (FILE * stream, const gsl_matrix * m, const char * format);
222 int gsl_matrix_memcpy(gsl_matrix * dest, const gsl_matrix * src);
223 int gsl_matrix_swap(gsl_matrix * m1, gsl_matrix * m2);
225 int gsl_matrix_swap_rows(gsl_matrix * m, const size_t i, const size_t j);
226 int gsl_matrix_swap_columns(gsl_matrix * m, const size_t i, const size_t j);
227 int gsl_matrix_swap_rowcol(gsl_matrix * m, const size_t i, const size_t j);
228 int gsl_matrix_transpose (gsl_matrix * m);
229 int gsl_matrix_transpose_memcpy (gsl_matrix * dest, const gsl_matrix * src);
231 double gsl_matrix_max (const gsl_matrix * m);
232 double gsl_matrix_min (const gsl_matrix * m);
233 void gsl_matrix_minmax (const gsl_matrix * m, double * min_out, double * max_out);
235 void gsl_matrix_max_index (const gsl_matrix * m, size_t * imax, size_t *jmax);
236 void gsl_matrix_min_index (const gsl_matrix * m, size_t * imin, size_t *jmin);
237 void gsl_matrix_minmax_index (const gsl_matrix * m, size_t * imin, size_t * jmin, size_t * imax, size_t * jmax);
239 int gsl_matrix_isnull (const gsl_matrix * m);
240 int gsl_matrix_ispos (const gsl_matrix * m);
241 int gsl_matrix_isneg (const gsl_matrix * m);
242 int gsl_matrix_isnonneg (const gsl_matrix * m);
244 int gsl_matrix_add (gsl_matrix * a, const gsl_matrix * b);
245 int gsl_matrix_sub (gsl_matrix * a, const gsl_matrix * b);
246 int gsl_matrix_mul_elements (gsl_matrix * a, const gsl_matrix * b);
247 int gsl_matrix_div_elements (gsl_matrix * a, const gsl_matrix * b);
248 int gsl_matrix_scale (gsl_matrix * a, const double x);
249 int gsl_matrix_add_constant (gsl_matrix * a, const double x);
250 int gsl_matrix_add_diagonal (gsl_matrix * a, const double x);
252 /***********************************************************************/
253 /* The functions below are obsolete */
254 /***********************************************************************/
255 int gsl_matrix_get_row(gsl_vector * v, const gsl_matrix * m, const size_t i);
256 int gsl_matrix_get_col(gsl_vector * v, const gsl_matrix * m, const size_t j);
257 int gsl_matrix_set_row(gsl_matrix * m, const size_t i, const gsl_vector * v);
258 int gsl_matrix_set_col(gsl_matrix * m, const size_t j, const gsl_vector * v);
260 /* inline functions if you are using GCC */
265 gsl_matrix_get(const gsl_matrix * m, const size_t i, const size_t j)
270 GSL_ERROR_VAL("first index out of range", GSL_EINVAL, 0) ;
272 else if (j >= m->size2)
274 GSL_ERROR_VAL("second index out of range", GSL_EINVAL, 0) ;
277 return m->data[i * m->tda + j] ;
282 gsl_matrix_set(gsl_matrix * m, const size_t i, const size_t j, const double x)
287 GSL_ERROR_VOID("first index out of range", GSL_EINVAL) ;
289 else if (j >= m->size2)
291 GSL_ERROR_VOID("second index out of range", GSL_EINVAL) ;
294 m->data[i * m->tda + j] = x ;
299 gsl_matrix_ptr(gsl_matrix * m, const size_t i, const size_t j)
304 GSL_ERROR_NULL("first index out of range", GSL_EINVAL) ;
306 else if (j >= m->size2)
308 GSL_ERROR_NULL("second index out of range", GSL_EINVAL) ;
311 return (double *) (m->data + (i * m->tda + j)) ;
316 gsl_matrix_const_ptr(const gsl_matrix * m, const size_t i, const size_t j)
321 GSL_ERROR_NULL("first index out of range", GSL_EINVAL) ;
323 else if (j >= m->size2)
325 GSL_ERROR_NULL("second index out of range", GSL_EINVAL) ;
328 return (const double *) (m->data + (i * m->tda + j)) ;
335 #endif /* __GSL_MATRIX_DOUBLE_H__ */