File: Accessing-matrix-elements.html

package info (click to toggle)
gsl-ref-html 1.16-1
  • links: PTS
  • area: non-free
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 5,816 kB
  • ctags: 4,130
  • sloc: makefile: 35
file content (119 lines) | stat: -rw-r--r-- 6,558 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections and no cover texts.  A copy of the license is
included in the section entitled "GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Accessing matrix elements</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Accessing matrix elements">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Accessing matrix elements">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="Matrices.html#Matrices" rel="up" title="Matrices">
<link href="Initializing-matrix-elements.html#Initializing-matrix-elements" rel="next" title="Initializing matrix elements">
<link href="Matrix-allocation.html#Matrix-allocation" rel="previous" title="Matrix allocation">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Accessing-matrix-elements"></a>
<div class="header">
<p>
Next: <a href="Initializing-matrix-elements.html#Initializing-matrix-elements" accesskey="n" rel="next">Initializing matrix elements</a>, Previous: <a href="Matrix-allocation.html#Matrix-allocation" accesskey="p" rel="previous">Matrix allocation</a>, Up: <a href="Matrices.html#Matrices" accesskey="u" rel="up">Matrices</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Accessing-matrix-elements-1"></a>
<h4 class="subsection">8.4.2 Accessing matrix elements</h4>
<a name="index-matrices_002c-range_002dchecking"></a>
<a name="index-range_002dchecking-for-matrices"></a>

<p>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>
<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 
</p>
<div class="example">
<pre class="example">m-&gt;data[i * m-&gt;tda + j]
</pre></div>

<p>where <var>tda</var> is the physical row-length of the matrix.
</p>
<dl>
<dt><a name="index-gsl_005fmatrix_005fget"></a>Function: <em>double</em> <strong>gsl_matrix_get</strong> <em>(const gsl_matrix * <var>m</var>, size_t <var>i</var>, size_t <var>j</var>)</em></dt>
<dd><p>This function returns the <em>(i,j)</em>-th element of a matrix
<var>m</var>.  If <var>i</var> or <var>j</var> lie outside the allowed range of 0 to
<em><var>n1</var>-1</em> and 0 to <em><var>n2</var>-1</em> 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></dd></dl>

<dl>
<dt><a name="index-gsl_005fmatrix_005fset"></a>Function: <em>void</em> <strong>gsl_matrix_set</strong> <em>(gsl_matrix * <var>m</var>, size_t <var>i</var>, size_t <var>j</var>, double <var>x</var>)</em></dt>
<dd><p>This function sets the value of the <em>(i,j)</em>-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 <em><var>n1</var>-1</em> and 0 to <em><var>n2</var>-1</em> then the error
handler is invoked.  An inline version of this function is used when <code>HAVE_INLINE</code> is defined.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmatrix_005fptr"></a>Function: <em>double *</em> <strong>gsl_matrix_ptr</strong> <em>(gsl_matrix * <var>m</var>, size_t <var>i</var>, size_t <var>j</var>)</em></dt>
<dt><a name="index-gsl_005fmatrix_005fconst_005fptr"></a>Function: <em>const double *</em> <strong>gsl_matrix_const_ptr</strong> <em>(const gsl_matrix * <var>m</var>, size_t <var>i</var>, size_t <var>j</var>)</em></dt>
<dd><p>These functions return a pointer to the <em>(i,j)</em>-th element of a
matrix <var>m</var>.  If <var>i</var> or <var>j</var> lie outside the allowed range of
0 to <em><var>n1</var>-1</em> and 0 to <em><var>n2</var>-1</em> then the error handler is invoked
and a null pointer is returned.  Inline versions of these functions are used when <code>HAVE_INLINE</code> is defined.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Initializing-matrix-elements.html#Initializing-matrix-elements" accesskey="n" rel="next">Initializing matrix elements</a>, Previous: <a href="Matrix-allocation.html#Matrix-allocation" accesskey="p" rel="previous">Matrix allocation</a>, Up: <a href="Matrices.html#Matrices" accesskey="u" rel="up">Matrices</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>