File: Vector-allocation.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 (83 lines) | stat: -rw-r--r-- 4,295 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
<html lang="en">
<head>
<title>Vector allocation - 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="Vectors.html" title="Vectors">
<link rel="next" href="Accessing-vector-elements.html" title="Accessing vector 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="Vector-allocation"></a>
Next:&nbsp;<a rel="next" accesskey="n" href="Accessing-vector-elements.html">Accessing vector elements</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Vectors.html">Vectors</a>
<hr>
</div>

<h4 class="subsection">8.3.1 Vector allocation</h4>

<p>The functions for allocating memory to a vector follow the style of
<code>malloc</code> and <code>free</code>.  In addition they also perform their own
error checking.  If there is insufficient memory available to allocate a
vector then the functions call the GSL error handler (with an error
number of <code>GSL_ENOMEM</code>) in addition to returning a null
pointer.  Thus if you use the library error handler to abort your program
then it isn't necessary to check every <code>alloc</code>.

<div class="defun">
&mdash; Function: gsl_vector * <b>gsl_vector_alloc</b> (<var>size_t n</var>)<var><a name="index-gsl_005fvector_005falloc-854"></a></var><br>
<blockquote><p>This function creates a vector of length <var>n</var>, returning a pointer to
a newly initialized vector struct. A new block is allocated for the
elements of the vector, and stored in the <var>block</var> component of the
vector struct.  The block is &ldquo;owned&rdquo; by the vector, and will be
deallocated when the vector is deallocated. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: gsl_vector * <b>gsl_vector_calloc</b> (<var>size_t n</var>)<var><a name="index-gsl_005fvector_005fcalloc-855"></a></var><br>
<blockquote><p>This function allocates memory for a vector of length <var>n</var> and
initializes all the elements of the vector to zero. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: void <b>gsl_vector_free</b> (<var>gsl_vector * v</var>)<var><a name="index-gsl_005fvector_005ffree-856"></a></var><br>
<blockquote><p>This function frees a previously allocated vector <var>v</var>.  If the
vector was created using <code>gsl_vector_alloc</code> then the block
underlying the vector will also be deallocated.  If the vector has
been created from another object then the memory is still owned by
that object and will not be deallocated.  The vector <var>v</var> must be a
valid vector object (a null pointer is not allowed). 
</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>