mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
25 lines
6.7 KiB
HTML
25 lines
6.7 KiB
HTML
<!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="An iterator that generalizes .zip() and allows running multiple iterators in lockstep."><title>multizip in itertools - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="itertools" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../itertools/index.html">itertools</a><span class="version">0.12.1</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../itertools/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="index.html">itertools</a>::<wbr><a class="fn" href="#">multizip</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/itertools/ziptuple.rs.html#40-45">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn multizip<T, U>(t: U) -> <a class="struct" href="structs/struct.Zip.html" title="struct itertools::structs::Zip">Zip</a><T><div class="where">where
|
||
<a class="struct" href="structs/struct.Zip.html" title="struct itertools::structs::Zip">Zip</a><T>: <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><U> + <a class="trait" href="https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An iterator that generalizes <em>.zip()</em> and allows running multiple iterators in lockstep.</p>
|
||
<p>The iterator <code>Zip<(I, J, ..., M)></code> is formed from a tuple of iterators (or values that
|
||
implement <a href="https://doc.rust-lang.org/1.78.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator"><code>IntoIterator</code></a>) and yields elements
|
||
until any of the subiterators yields <code>None</code>.</p>
|
||
<p>The iterator element type is a tuple like like <code>(A, B, ..., E)</code> where <code>A</code> to <code>E</code> are the
|
||
element types of the subiterator.</p>
|
||
<p><strong>Note:</strong> The result of this macro is a value of a named type (<code>Zip<(I, J, ..)></code> of each component iterator <code>I, J, ...</code>) if each component iterator is
|
||
nameable.</p>
|
||
<p>Prefer <a href="macro.izip.html" title="macro itertools::izip"><code>izip!()</code></a> over <code>multizip</code> for the performance benefits of using the
|
||
standard library <code>.zip()</code>. Prefer <code>multizip</code> if a nameable type is needed.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>itertools::multizip;
|
||
|
||
<span class="comment">// iterate over three sequences side-by-side
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>results = [<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>];
|
||
<span class="kw">let </span>inputs = [<span class="number">3</span>, <span class="number">7</span>, <span class="number">9</span>, <span class="number">6</span>];
|
||
|
||
<span class="kw">for </span>(r, index, input) <span class="kw">in </span>multizip((<span class="kw-2">&mut </span>results, <span class="number">0</span>..<span class="number">10</span>, <span class="kw-2">&</span>inputs)) {
|
||
<span class="kw-2">*</span>r = index * <span class="number">10 </span>+ input;
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(results, [<span class="number">0 </span>+ <span class="number">3</span>, <span class="number">10 </span>+ <span class="number">7</span>, <span class="number">29</span>, <span class="number">36</span>]);</code></pre></div>
|
||
</div></details></section></div></main></body></html> |