File: Accessing-vector-elements.html

package info (click to toggle)
gsl-ref-html 2.3-1
  • links: PTS
  • area: non-free
  • in suites: bullseye, buster, sid
  • size: 6,876 kB
  • ctags: 4,574
  • sloc: makefile: 35
file content (160 lines) | stat: -rw-r--r-- 8,802 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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!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, 2014, 2015, 2016 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 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 the freedom to copy and modify this
GNU Manual." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Accessing vector elements</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Accessing vector elements">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Accessing vector 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="Vectors.html#Vectors" rel="up" title="Vectors">
<link href="Initializing-vector-elements.html#Initializing-vector-elements" rel="next" title="Initializing vector elements">
<link href="Vector-allocation.html#Vector-allocation" rel="previous" title="Vector 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-vector-elements"></a>
<div class="header">
<p>
Next: <a href="Initializing-vector-elements.html#Initializing-vector-elements" accesskey="n" rel="next">Initializing vector elements</a>, Previous: <a href="Vector-allocation.html#Vector-allocation" accesskey="p" rel="previous">Vector allocation</a>, Up: <a href="Vectors.html#Vectors" accesskey="u" rel="up">Vectors</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Accessing-vector-elements-1"></a>
<h4 class="subsection">8.3.2 Accessing vector elements</h4>
<a name="index-vectors_002c-range_002dchecking"></a>
<a name="index-range_002dchecking-for-vectors"></a>
<a name="index-bounds-checking_002c-extension-to-GCC"></a>
<a name="index-gcc-extensions_002c-range_002dchecking"></a>
<a name="index-Fortran-range-checking_002c-equivalent-in-gcc"></a>

<p>Unlike <small>FORTRAN</small> compilers, C compilers do not usually provide
support for range checking of vectors and matrices.<a name="DOCF8" href="#FOOT8"><sup>8</sup></a>  The functions <code>gsl_vector_get</code> and
<code>gsl_vector_set</code> can perform portable range checking for you and
report an error if you attempt to access elements outside the allowed
range.
</p>
<p>The functions for accessing the elements of a vector or matrix are
defined in <samp>gsl_vector.h</samp> and declared <code>extern inline</code> to
eliminate function-call overhead.  You must compile your program with
the preprocessor macro <code>HAVE_INLINE</code> defined to use these
functions.
</p>
<a name="index-GSL_005fRANGE_005fCHECK_005fOFF"></a>
<p>If necessary you can turn off range checking completely without
modifying any source files by recompiling your program with the
preprocessor definition <code>GSL_RANGE_CHECK_OFF</code>.  Provided your
compiler supports inline functions the effect of turning off range
checking is to replace calls to <code>gsl_vector_get(v,i)</code> by
<code>v-&gt;data[i*v-&gt;stride]</code> and calls to <code>gsl_vector_set(v,i,x)</code> by
<code>v-&gt;data[i*v-&gt;stride]=x</code>.  Thus there should be no performance
penalty for using the range checking functions when range checking is
turned off.
</p>
<a name="index-GSL_005fC99_005fINLINE-2"></a>
<p>If you use a C99 compiler which requires inline functions in header
files to be declared <code>inline</code> instead of <code>extern inline</code>,
define the macro <code>GSL_C99_INLINE</code> (see <a href="Inline-functions.html#Inline-functions">Inline functions</a>).
With GCC this is selected automatically when compiling in C99 mode
(<code>-std=c99</code>).
</p>
<a name="index-gsl_005fcheck_005frange"></a>
<p>If inline functions are not used, calls to the functions
<code>gsl_vector_get</code> and <code>gsl_vector_set</code> will link to the
compiled versions of these functions in the library itself.  The range
checking in these functions is controlled by the global integer
variable <code>gsl_check_range</code>.  It is enabled by default&mdash;to
disable it, set <code>gsl_check_range</code> to zero.  Due to function-call
overhead, there is less benefit in disabling range checking here than
for inline functions.
</p>
<dl>
<dt><a name="index-gsl_005fvector_005fget"></a>Function: <em>double</em> <strong>gsl_vector_get</strong> <em>(const gsl_vector * <var>v</var>, const size_t <var>i</var>)</em></dt>
<dd><p>This function returns the <var>i</var>-th element of a vector <var>v</var>.  If
<var>i</var> lies outside the allowed range of 0 to <em><var>n</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_005fvector_005fset"></a>Function: <em>void</em> <strong>gsl_vector_set</strong> <em>(gsl_vector * <var>v</var>, const size_t <var>i</var>, double <var>x</var>)</em></dt>
<dd><p>This function sets the value of the <var>i</var>-th element of a vector
<var>v</var> to <var>x</var>.  If <var>i</var> lies outside the allowed range of 0 to
<em><var>n</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_005fvector_005fptr"></a>Function: <em>double *</em> <strong>gsl_vector_ptr</strong> <em>(gsl_vector * <var>v</var>, size_t <var>i</var>)</em></dt>
<dt><a name="index-gsl_005fvector_005fconst_005fptr"></a>Function: <em>const double *</em> <strong>gsl_vector_const_ptr</strong> <em>(const gsl_vector * <var>v</var>, size_t <var>i</var>)</em></dt>
<dd><p>These functions return a pointer to the <var>i</var>-th element of a vector
<var>v</var>.  If <var>i</var> lies outside the allowed range of 0 to <em><var>n</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>

<div class="footnote">
<hr>
<h4 class="footnotes-heading">Footnotes</h4>

<h3><a name="FOOT8" href="#DOCF8">(8)</a></h3>
<p>Range
checking is available in the GNU C Compiler bounds-checking extension,
but it is not part of the default installation of GCC. Memory accesses
can also be checked with Valgrind or the <code>gcc -fmudflap</code>
memory protection option.</p>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Initializing-vector-elements.html#Initializing-vector-elements" accesskey="n" rel="next">Initializing vector elements</a>, Previous: <a href="Vector-allocation.html#Vector-allocation" accesskey="p" rel="previous">Vector allocation</a>, Up: <a href="Vectors.html#Vectors" accesskey="u" rel="up">Vectors</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>