File: Reading-and-writing-multisets.html

package info (click to toggle)
gsl-ref-html 2.3-1
links: PTS
area: non-free
in suites: bookworm, bullseye, buster, forky, sid, trixie
size: 6,876 kB
ctags: 4,574
sloc: makefile: 35
file content (134 lines) | stat: -rw-r--r-- 6,940 bytes
<!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: Reading and writing multisets</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Reading and writing multisets">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Reading and writing multisets">
<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="Multisets.html#Multisets" rel="up" title="Multisets">
<link href="Multiset-Examples.html#Multiset-Examples" rel="next" title="Multiset Examples">
<link href="Multiset-functions.html#Multiset-functions" rel="previous" title="Multiset functions">
<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="Reading-and-writing-multisets"></a>
<div class="header">
<p>
Next: <a href="Multiset-Examples.html#Multiset-Examples" accesskey="n" rel="next">Multiset Examples</a>, Previous: <a href="Multiset-functions.html#Multiset-functions" accesskey="p" rel="previous">Multiset functions</a>, Up: <a href="Multisets.html#Multisets" accesskey="u" rel="up">Multisets</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Reading-and-writing-multisets-1"></a>
<h3 class="section">11.6 Reading and writing multisets</h3>

<p>The library provides functions for reading and writing multisets to a
file as binary data or formatted text.
</p>
<dl>
<dt><a name="index-gsl_005fmultiset_005ffwrite"></a>Function: <em>int</em> <strong>gsl_multiset_fwrite</strong> <em>(FILE * <var>stream</var>, const gsl_multiset * <var>c</var>)</em></dt>
<dd><p>This function writes the elements of the multiset <var>c</var> to the
stream <var>stream</var> in binary format.  The function returns
<code>GSL_EFAILED</code> if there was a problem writing to the file.  Since the
data is written in the native binary format it may not be portable
between different architectures.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmultiset_005ffread"></a>Function: <em>int</em> <strong>gsl_multiset_fread</strong> <em>(FILE * <var>stream</var>, gsl_multiset * <var>c</var>)</em></dt>
<dd><p>This function reads elements from the open stream <var>stream</var> into the
multiset <var>c</var> in binary format.  The multiset <var>c</var> must be
preallocated with correct values of <em>n</em> and <em>k</em> since the
function uses the size of <var>c</var> to determine how many bytes to read.
The function returns <code>GSL_EFAILED</code> if there was a problem reading
from the file.  The data is assumed to have been written in the native
binary format on the same architecture.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmultiset_005ffprintf"></a>Function: <em>int</em> <strong>gsl_multiset_fprintf</strong> <em>(FILE * <var>stream</var>, const gsl_multiset * <var>c</var>, const char * <var>format</var>)</em></dt>
<dd><p>This function writes the elements of the multiset <var>c</var>
line-by-line to the stream <var>stream</var> using the format specifier
<var>format</var>, which should be suitable for a type of <var>size_t</var>.
In ISO C99 the type modifier <code>z</code> represents <code>size_t</code>, so
<code>&quot;%zu\n&quot;</code> is a suitable format.<a name="DOCF11" href="#FOOT11"><sup>11</sup></a>  The function returns
<code>GSL_EFAILED</code> if there was a problem writing to the file.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fmultiset_005ffscanf"></a>Function: <em>int</em> <strong>gsl_multiset_fscanf</strong> <em>(FILE * <var>stream</var>, gsl_multiset * <var>c</var>)</em></dt>
<dd><p>This function reads formatted data from the stream <var>stream</var> into the
multiset <var>c</var>.  The multiset <var>c</var> must be preallocated with
correct values of <em>n</em> and <em>k</em> since the function uses the size of <var>c</var> to
determine how many numbers to read.  The function returns
<code>GSL_EFAILED</code> if there was a problem reading from the file.
</p></dd></dl>


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

<h3><a name="FOOT11" href="#DOCF11">(11)</a></h3>
<p>In versions of the
GNU C library prior to the ISO C99 standard,
the type modifier <code>Z</code> was used instead.</p>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Multiset-Examples.html#Multiset-Examples" accesskey="n" rel="next">Multiset Examples</a>, Previous: <a href="Multiset-functions.html#Multiset-functions" accesskey="p" rel="previous">Multiset functions</a>, Up: <a href="Multisets.html#Multisets" accesskey="u" rel="up">Multisets</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>