-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Upload documentation for current main
- Loading branch information
1 parent
9642ec8
commit 4c1f8df
Showing
26 changed files
with
506 additions
and
460 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| <!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="Safe interface for NumPy’s N-dimensional arrays"><title>numpy::array - Rust</title><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"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="numpy" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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 mod"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../numpy/index.html">numpy</a><span class="version">0.20.0</span></h2></div><h2 class="location"><a href="#">Module array</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate numpy</a></h2></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="../../numpy/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>Module <a href="../index.html">numpy</a>::<wbr><a class="mod" href="#">array</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/numpy/array.rs.html#1-2296">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Safe interface for NumPy’s <a href="https://numpy.org/doc/stable/reference/arrays.ndarray.html">N-dimensional arrays</a></p> | ||
| <main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../numpy/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>Module <a href="../index.html">numpy</a>::<wbr><a class="mod" href="#">array</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/numpy/array.rs.html#1-2314">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Safe interface for NumPy’s <a href="https://numpy.org/doc/stable/reference/arrays.ndarray.html">N-dimensional arrays</a></p> | ||
| </div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.PyArray.html" title="struct numpy::array::PyArray">PyArray</a></div><div class="desc docblock-short">A safe, statically-typed wrapper for NumPy’s <a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html"><code>ndarray</code></a> class.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.PyArray0Methods.html" title="trait numpy::array::PyArray0Methods">PyArray0Methods</a></div><div class="desc docblock-short">Implementation of functionality for <a href="type.PyArray0.html" title="type numpy::array::PyArray0"><code>PyArray0<T></code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.PyArrayMethods.html" title="trait numpy::array::PyArrayMethods">PyArrayMethods</a></div><div class="desc docblock-short">Implementation of functionality for <a href="struct.PyArray.html" title="struct numpy::array::PyArray"><code>PyArray<T, D></code></a>.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.get_array_module.html" title="fn numpy::array::get_array_module">get_array_module</a></div><div class="desc docblock-short">Returns a handle to NumPy’s multiarray module.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.PyArray0.html" title="type numpy::array::PyArray0">PyArray0</a></div><div class="desc docblock-short">Zero-dimensional array.</div></li><li><div class="item-name"><a class="type" href="type.PyArray1.html" title="type numpy::array::PyArray1">PyArray1</a></div><div class="desc docblock-short">One-dimensional array.</div></li><li><div class="item-name"><a class="type" href="type.PyArray2.html" title="type numpy::array::PyArray2">PyArray2</a></div><div class="desc docblock-short">Two-dimensional array.</div></li><li><div class="item-name"><a class="type" href="type.PyArray3.html" title="type numpy::array::PyArray3">PyArray3</a></div><div class="desc docblock-short">Three-dimensional array.</div></li><li><div class="item-name"><a class="type" href="type.PyArray4.html" title="type numpy::array::PyArray4">PyArray4</a></div><div class="desc docblock-short">Four-dimensional array.</div></li><li><div class="item-name"><a class="type" href="type.PyArray5.html" title="type numpy::array::PyArray5">PyArray5</a></div><div class="desc docblock-short">Five-dimensional array.</div></li><li><div class="item-name"><a class="type" href="type.PyArray6.html" title="type numpy::array::PyArray6">PyArray6</a></div><div class="desc docblock-short">Six-dimensional array.</div></li><li><div class="item-name"><a class="type" href="type.PyArrayDyn.html" title="type numpy::array::PyArrayDyn">PyArrayDyn</a></div><div class="desc docblock-short">Dynamic-dimensional array.</div></li></ul></section></div></main></body></html> |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| <!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="Implementation of functionality for `PyArray0<T>`."><title>PyArray0Methods in numpy::array - Rust</title><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"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="numpy" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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 trait"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../numpy/index.html">numpy</a><span class="version">0.20.0</span></h2></div><h2 class="location"><a href="#">PyArray0Methods</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.item">item</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-PyArray0Methods%3C'py,+T%3E-for-Bound%3C'py,+PyArray%3CT,+Dim%3C%5Busize;+0%5D%3E%3E%3E">Bound<'py, PyArray0<T>></a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In numpy::array</a></h2></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="../../numpy/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>Trait <a href="../index.html">numpy</a>::<wbr><a href="index.html">array</a>::<wbr><a class="trait" href="#">PyArray0Methods</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/numpy/array.rs.html#1924-1934">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait PyArray0Methods<'py, T>: <a class="trait" href="trait.PyArrayMethods.html" title="trait numpy::array::PyArrayMethods">PyArrayMethods</a><'py, T, <a class="type" href="https://docs.rs/ndarray/0.15/ndarray/aliases/type.Ix0.html" title="type ndarray::aliases::Ix0">Ix0</a>> { | ||
| <main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../numpy/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>Trait <a href="../index.html">numpy</a>::<wbr><a href="index.html">array</a>::<wbr><a class="trait" href="#">PyArray0Methods</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/numpy/array.rs.html#1942-1952">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait PyArray0Methods<'py, T>: <a class="trait" href="trait.PyArrayMethods.html" title="trait numpy::array::PyArrayMethods">PyArrayMethods</a><'py, T, <a class="type" href="https://docs.rs/ndarray/0.15/ndarray/aliases/type.Ix0.html" title="type ndarray::aliases::Ix0">Ix0</a>> { | ||
| // Provided method | ||
| fn <a href="#method.item" class="fn">item</a>(&self) -> T | ||
| <span class="where">where T: <a class="trait" href="../trait.Element.html" title="trait numpy::Element">Element</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a></span> { ... } | ||
| }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implementation of functionality for <a href="type.PyArray0.html" title="type numpy::array::PyArray0"><code>PyArray0<T></code></a>.</p> | ||
| </div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.item" class="method"><a class="src rightside" href="../../src/numpy/array.rs.html#1928-1933">source</a><h4 class="code-header">fn <a href="#method.item" class="fn">item</a>(&self) -> T<div class="where">where | ||
| </div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.item" class="method"><a class="src rightside" href="../../src/numpy/array.rs.html#1946-1951">source</a><h4 class="code-header">fn <a href="#method.item" class="fn">item</a>(&self) -> T<div class="where">where | ||
| T: <a class="trait" href="../trait.Element.html" title="trait numpy::Element">Element</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,</div></h4></section></summary><div class="docblock"><p>Get the single element of a zero-dimensional array.</p> | ||
| <p>See <a href="../fn.inner.html" title="fn numpy::inner"><code>inner</code></a> for an example.</p> | ||
| </div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-PyArray0Methods%3C'py,+T%3E-for-Bound%3C'py,+PyArray%3CT,+Dim%3C%5Busize;+0%5D%3E%3E%3E" class="impl"><a class="src rightside" href="../../src/numpy/array.rs.html#2266">source</a><a href="#impl-PyArray0Methods%3C'py,+T%3E-for-Bound%3C'py,+PyArray%3CT,+Dim%3C%5Busize;+0%5D%3E%3E%3E" class="anchor">§</a><h3 class="code-header">impl<'py, T> <a class="trait" href="trait.PyArray0Methods.html" title="trait numpy::array::PyArray0Methods">PyArray0Methods</a><'py, T> for Bound<'py, <a class="type" href="type.PyArray0.html" title="type numpy::array::PyArray0">PyArray0</a><T>></h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/numpy/array/trait.PyArray0Methods.js" data-ignore-extern-crates="pyo3" async></script></section></div></main></body></html> | ||
| </div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-PyArray0Methods%3C'py,+T%3E-for-Bound%3C'py,+PyArray%3CT,+Dim%3C%5Busize;+0%5D%3E%3E%3E" class="impl"><a class="src rightside" href="../../src/numpy/array.rs.html#2284">source</a><a href="#impl-PyArray0Methods%3C'py,+T%3E-for-Bound%3C'py,+PyArray%3CT,+Dim%3C%5Busize;+0%5D%3E%3E%3E" class="anchor">§</a><h3 class="code-header">impl<'py, T> <a class="trait" href="trait.PyArray0Methods.html" title="trait numpy::array::PyArray0Methods">PyArray0Methods</a><'py, T> for Bound<'py, <a class="type" href="type.PyArray0.html" title="type numpy::array::PyArray0">PyArray0</a><T>></h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/numpy/array/trait.PyArray0Methods.js" data-ignore-extern-crates="pyo3" async></script></section></div></main></body></html> |
Oops, something went wrong.