File: parcellfun_005fset_005fnproc.html

package info (click to toggle)
octave-parallel 4.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,648 kB
  • sloc: ansic: 24,011; cpp: 6,848; sh: 4,476; makefile: 297; perl: 170; xml: 22
file content (92 lines) | stat: -rw-r--r-- 3,800 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- General documentation for the parallel package for Octave.

Copyright (C) 2016-2023 Olaf Till <i7tiol@t-online.de>

You can redistribute this documentation and/or modify it under the terms
of the GNU General Public License as published by the Free Software
Foundation; either version 3 of the License, or (at your option) any
later version.

This documentation is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.

You should have received a copy of the GNU General Public License along
with this documentation; if not, see <http://www.gnu.org/licenses/>. -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>parcellfun_set_nproc (parallel_doc)</title>

<meta name="description" content="parcellfun_set_nproc (parallel_doc)">
<meta name="keywords" content="parcellfun_set_nproc (parallel_doc)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Function-index.html" rel="index" title="Function index">
<link href="Local-execution.html" rel="up" title="Local execution">
<link href="Cluster-execution.html" rel="next" title="Cluster execution">
<link href="pararrayfun.html" rel="prev" title="pararrayfun">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<span id="parcellfun_005fset_005fnproc"></span><div class="header">
<p>
Previous: <a href="pararrayfun.html" accesskey="p" rel="prev">pararrayfun</a>, Up: <a href="Local-execution.html" accesskey="u" rel="up">Local execution</a> &nbsp; [<a href="Function-index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Function-parcellfun_005fset_005fnproc"></span><h3 class="section">2.3 Function parcellfun_set_nproc</h3>
<span id="index-parcellfun_005fset_005fnproc-1"></span>

<span id="XREFparcellfun_005fset_005fnproc"></span><dl>
<dt id="index-parcellfun_005fset_005fnproc">Loadable Function: <em><var>nproc</var> =</em> <strong>parcellfun_set_nproc</strong> <em>(<var>nproc_arg</var>)</em></dt>
<dd><p>Set current number of background processes for parcellfun.
</p>
<p>The number of used background processes is determined by the first argument
to <code>parcellfun</code>. If necessary, <code>parcellfun</code> will spawn new
background processes, but it will never remove any of them, even if it
does not use all of them.
<code>parcellfun_set_nproc</code> can be used to set the number of currently spawned
processes to <var>nproc_arg</var>. This may be used to remove all background
processes between calls to <code>parcellfun</code> by specifying an <var>nproc_arg</var>
of zero.
</p>
<p>The real number of spawned processes will be limited to the available
processor cores and is returned.
</p>

<p><strong>See also:</strong> <a href="parcellfun.html#XREFparcellfun">parcellfun</a>.
</p></dd></dl>







</body>
</html>