mentat/num_cpus/index.html
2018-08-22 17:04:13 +00:00

162 lines
No EOL
6.8 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `num_cpus` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, num_cpus">
<title>num_cpus - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Crate num_cpus</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'num_cpus', ty: 'mod', relpath: '../'};</script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>num_cpus</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/num_cpus/lib.rs.html#1-414' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A crate with utilities to determine the number of CPUs available on the
current system.</p>
<p>Sometimes the CPU will exaggerate the number of CPUs it contains, because it can use
<a href="https://en.wikipedia.org/wiki/Simultaneous_multithreading">processor tricks</a> to deliver increased performance when there are more threads. This
crate provides methods to get both the logical and physical numbers of cores.</p>
<p>This information can be used as a guide to how many tasks can be run in parallel.
There are many properties of the system architecture that will affect parallelism,
for example memory access speeds (for all the caches and RAM) and the physical
architecture of the processor, so the number of CPUs should be used as a rough guide
only.</p>
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
<p>Fetch the number of logical CPUs.</p>
<pre class="rust rust-example-rendered">
<span class="kw">let</span> <span class="ident">cpus</span> <span class="op">=</span> <span class="ident">num_cpus</span>::<span class="ident">get</span>();</pre>
<p>See <a href="https://docs.rs/rayon/0.8.2/rayon/struct.ThreadPool.html"><code>rayon::Threadpool</code></a> for an example of where the number of CPUs could be
used when setting up parallel jobs (Where the threadpool example uses a fixed
number 8, it could use the number of CPUs).</p>
</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.get.html"
title='fn num_cpus::get'>get</a></td>
<td class='docblock-short'>
<p>Returns the number of available CPUs of the current system.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_physical.html"
title='fn num_cpus::get_physical'>get_physical</a></td>
<td class='docblock-short'>
<p>Returns the number of physical cores of the current system.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "num_cpus";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>