1
0
Fork 0
cl-sites/guile.html_node/SRFI_002d4-Extensions.html
2024-12-17 12:49:28 +01:00

163 lines
20 KiB
HTML

<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual documents Guile version 3.0.10.
Copyright (C) 1996-1997, 2000-2005, 2009-2023 Free Software Foundation,
Inc.
Copyright (C) 2021 Maxime Devos
Copyright (C) 2024 Tomas Volf
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, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License." -->
<title>SRFI-4 Extensions (Guile Reference Manual)</title>
<meta name="description" content="SRFI-4 Extensions (Guile Reference Manual)">
<meta name="keywords" content="SRFI-4 Extensions (Guile Reference Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content=".texi2any-real">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="SRFI_002d4.html" rel="up" title="SRFI-4">
<link href="SRFI_002d4-and-Bytevectors.html" rel="prev" title="SRFI-4 and Bytevectors">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css">
</head>
<body lang="en">
<div class="subsubsection-level-extent" id="SRFI_002d4-Extensions">
<div class="nav-panel">
<p>
Previous: <a href="SRFI_002d4-and-Bytevectors.html" accesskey="p" rel="prev">SRFI-4 - Relation to bytevectors</a>, Up: <a href="SRFI_002d4.html" accesskey="u" rel="up">SRFI-4 - Homogeneous numeric vector datatypes</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsubsection" id="SRFI_002d4-_002d-Guile-extensions"><span>7.5.5.4 SRFI-4 - Guile extensions<a class="copiable-link" href="#SRFI_002d4-_002d-Guile-extensions"> &para;</a></span></h4>
<p>Guile defines some useful extensions to SRFI-4, which are not available in the
default Guile environment. They may be imported by loading the extensions
module:
</p>
<div class="example">
<pre class="example-preformatted">(use-modules (srfi srfi-4 gnu))
</pre></div>
<dl class="first-deffn">
<dt class="deffn" id="index-srfi_002d4_002dvector_002dtype_002dsize"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">srfi-4-vector-type-size</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-srfi_002d4_002dvector_002dtype_002dsize"> &para;</a></span></dt>
<dd><p>Return the size, in bytes, of each element of SRFI-4 vector
<var class="var">obj</var>. For example, <code class="code">(srfi-4-vector-type-size #u32())</code> returns
<code class="code">4</code>.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-any_002d_003eu8vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;u8vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003eu8vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003es8vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;s8vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003es8vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003eu16vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;u16vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003eu16vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003es16vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;s16vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003es16vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003eu32vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;u32vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003eu32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003es32vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;s32vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003es32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003eu64vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;u64vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003eu64vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003es64vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;s64vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003es64vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003ef32vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;f32vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003ef32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003ef64vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;f64vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003ef64vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003ec32vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;c32vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003ec32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-any_002d_003ec64vector"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">any-&gt;c64vector</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-any_002d_003ec64vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fu8vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_u8vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fu8vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fs8vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_s8vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fs8vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fu16vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_u16vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fu16vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fs16vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_s16vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fs16vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fu32vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_u32vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fu32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fs32vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_s32vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fs32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fu64vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_u64vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fu64vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fs64vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_s64vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fs64vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005ff32vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_f32vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005ff32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005ff64vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_f64vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005ff64vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fc32vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_c32vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fc32vector"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-scm_005fany_005fto_005fc64vector"><span class="category-def">C Function: </span><span><strong class="def-name">scm_any_to_c64vector</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fany_005fto_005fc64vector"> &para;</a></span></dt>
<dd><p>Return a (maybe newly allocated) uniform numeric vector of the indicated
type, initialized with the elements of <var class="var">obj</var>, which must be a list,
a vector, or a uniform vector. When <var class="var">obj</var> is already a suitable
uniform numeric vector, it is returned unchanged.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-u8vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u8vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-u8vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s8vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s8vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-s8vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-u16vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u16vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-u16vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s16vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s16vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-s16vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-u32vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u32vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-u32vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s32vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s32vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-s32vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-u64vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u64vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-u64vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s64vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s64vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-s64vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-f32vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">f32vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-f32vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-f64vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">f64vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-f64vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-c32vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">c32vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-c32vector_002dcopy_0021"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-c64vector_002dcopy_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">c64vector-copy!</strong> <var class="def-var-arguments">dst at src [start [end]]</var><a class="copiable-link" href="#index-c64vector_002dcopy_0021"> &para;</a></span></dt>
<dd><p>Copy a block of elements from <var class="var">src</var> to <var class="var">dst</var>, both of which must
be vectors of the indicated type, starting in <var class="var">dst</var> at <var class="var">at</var> and
starting in <var class="var">src</var> at <var class="var">start</var> and ending at <var class="var">end</var>. It is an
error for <var class="var">dst</var> to have a length less than <var class="var">at</var> + (<var class="var">end</var> -
<var class="var">start</var>). <var class="var">at</var> and <var class="var">start</var> default to 0 and <var class="var">end</var>
defaults to the length of <var class="var">src</var>.
</p>
<p>If source and destination overlap, copying takes place as if the
source is first copied into a temporary vector and then into the
destination.
</p>
<p>See also <a class="ref" href="Vector-Accessors.html#x_002dvector_002dcopy_0021"><code class="code">vector-copy!</code></a>.
</p></dd></dl>
<dl class="first-deffn">
<dt class="deffn" id="index-u8vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u8vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-u8vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s8vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s8vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-s8vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-u16vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u16vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-u16vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s16vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s16vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-s16vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-u32vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u32vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-u32vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s32vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s32vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-s32vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-u64vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">u64vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-u64vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-s64vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">s64vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-s64vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-f32vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">f32vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-f32vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-f64vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">f64vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-f64vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-c32vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">c32vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-c32vector_002dcopy"> &para;</a></span></dt>
<dt class="deffnx def-cmd-deffn" id="index-c64vector_002dcopy"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">c64vector-copy</strong> <var class="def-var-arguments">src [start [end]]</var><a class="copiable-link" href="#index-c64vector_002dcopy"> &para;</a></span></dt>
<dd><p>Returns a freshly allocated vector of the indicated type, which must be
the same as that of <var class="var">src</var>, containing the elements of <var class="var">src</var>
between <var class="var">start</var> and <var class="var">end</var>. <var class="var">start</var> defaults to 0 and
<var class="var">end</var> defaults to the length of <var class="var">src</var>.
</p>
<p>See also <a class="ref" href="Vector-Accessors.html#x_002dvector_002dcopy"><code class="code">vector-copy</code></a>.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Previous: <a href="SRFI_002d4-and-Bytevectors.html">SRFI-4 - Relation to bytevectors</a>, Up: <a href="SRFI_002d4.html">SRFI-4 - Homogeneous numeric vector datatypes</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>