File: Accessing-matrix-elements.html

package info (click to toggle)
gsl-ref-html 1.10-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,496 kB
  • ctags: 2,955
  • sloc: makefile: 33
file content (92 lines) | stat: -rw-r--r-- 5,149 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<html lang="en">
<head>
<title>Accessing matrix elements - GNU Scientific Library -- Reference Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Scientific Library -- Reference Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Matrices.html" title="Matrices">
<link rel="prev" href="Matrix-allocation.html" title="Matrix allocation">
<link rel="next" href="Initializing-matrix-elements.html" title="Initializing matrix elements">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with the
Invariant Sections being ``GNU General Public License'' and ``Free Software
Needs Free Documentation'', the Front-Cover text being ``A GNU Manual'',
and with the Back-Cover Text being (a) (see below).  A copy of the
license is included in the section entitled ``GNU Free Documentation
License''.

(a) The Back-Cover Text is: ``You have freedom to copy and modify this
GNU Manual, like GNU software.''-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Accessing-matrix-elements"></a>
Next:&nbsp;<a rel="next" accesskey="n" href="Initializing-matrix-elements.html">Initializing matrix elements</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Matrix-allocation.html">Matrix allocation</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Matrices.html">Matrices</a>
<hr>
</div>

<h4 class="subsection">8.4.2 Accessing matrix elements</h4>

<p><a name="index-matrices_002c-range_002dchecking-914"></a><a name="index-range_002dchecking-for-matrices-915"></a>
The functions for accessing the elements of a matrix use the same range
checking system as vectors.  You can turn off range checking by recompiling
your program with the preprocessor definition
<code>GSL_RANGE_CHECK_OFF</code>.

   <p>The elements of the matrix are stored in &ldquo;C-order&rdquo;, where the second
index moves continuously through memory.  More precisely, the element
accessed by the function <code>gsl_matrix_get(m,i,j)</code> and
<code>gsl_matrix_set(m,i,j,x)</code> is

<pre class="example">     m-&gt;data[i * m-&gt;tda + j]
</pre>
   <p class="noindent">where <var>tda</var> is the physical row-length of the matrix.

<div class="defun">
&mdash; Function: double <b>gsl_matrix_get</b> (<var>const gsl_matrix * m, size_t i, size_t j</var>)<var><a name="index-gsl_005fmatrix_005fget-916"></a></var><br>
<blockquote><p>This function returns the (i,j)-th element of a matrix
<var>m</var>.  If <var>i</var> or <var>j</var> lie outside the allowed range of 0 to
<var>n1</var>-1 and 0 to <var>n2</var>-1 then the error handler is invoked and 0
is returned.  An inline version of this function is used when <code>HAVE_INLINE</code> is defined. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: void <b>gsl_matrix_set</b> (<var>gsl_matrix * m, size_t i, size_t j, double x</var>)<var><a name="index-gsl_005fmatrix_005fset-917"></a></var><br>
<blockquote><p>This function sets the value of the (i,j)-th element of a
matrix <var>m</var> to <var>x</var>.  If <var>i</var> or <var>j</var> lies outside the
allowed range of 0 to <var>n1</var>-1 and 0 to <var>n2</var>-1 then the error
handler is invoked.  An inline version of this function is used when <code>HAVE_INLINE</code> is defined. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: double * <b>gsl_matrix_ptr</b> (<var>gsl_matrix * m, size_t i, size_t j</var>)<var><a name="index-gsl_005fmatrix_005fptr-918"></a></var><br>
&mdash; Function: const double * <b>gsl_matrix_const_ptr</b> (<var>const gsl_matrix * m, size_t i, size_t j</var>)<var><a name="index-gsl_005fmatrix_005fconst_005fptr-919"></a></var><br>
<blockquote><p>These functions return a pointer to the (i,j)-th element of a
matrix <var>m</var>.  If <var>i</var> or <var>j</var> lie outside the allowed range of
0 to <var>n1</var>-1 and 0 to <var>n2</var>-1 then the error handler is invoked
and a null pointer is returned.  Inline versions of these function are used when <code>HAVE_INLINE</code> is defined. 
</p></blockquote></div>

<hr>The GNU Scientific Library - a free numerical library licensed under the GNU GPL<br>Back to the <a href="/software/gsl/">GNU Scientific Library Homepage</a></body></html>