Skip to content

Commit

Permalink
Upload documentation for current main
Browse files Browse the repository at this point in the history
  • Loading branch information
adamreichold committed Mar 23, 2024
1 parent 6c0b74d commit c30f8d8
Show file tree
Hide file tree
Showing 69 changed files with 942 additions and 234 deletions.
2 changes: 1 addition & 1 deletion numpy/all.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions numpy/array/struct.PyArray.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions numpy/borrow/struct.PyReadonlyArray.html
Original file line number Diff line number Diff line change
Expand Up @@ -284,13 +284,13 @@ <h5 id="example-10"><a href="#example-10">Example</a></h5>
</div></details><details class="toggle method-toggle" open><summary><section id="method.dtype" class="method"><a class="src rightside" href="../../src/numpy/untyped_array.rs.html#114-116">source</a><h4 class="code-header">pub fn <a href="#method.dtype" class="fn">dtype</a>(&amp;self) -&gt; &amp;<a class="struct" href="../struct.PyArrayDescr.html" title="struct numpy::PyArrayDescr">PyArrayDescr</a></h4></section></summary><div class="docblock"><p>Returns the <code>dtype</code> of the array.</p>
<p>See also <a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.dtype.html"><code>ndarray.dtype</code></a> and <a href="https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_DTYPE"><code>PyArray_DTYPE</code></a>.</p>
<h5 id="example-11"><a href="#example-11">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>numpy::{dtype, PyArray};
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>numpy::{dtype_bound, PyArray};
<span class="kw">use </span>pyo3::Python;

Python::with_gil(|py| {
<span class="kw">let </span>array = PyArray::from_vec(py, <span class="macro">vec!</span>[<span class="number">1_i32</span>, <span class="number">2</span>, <span class="number">3</span>]);

<span class="macro">assert!</span>(array.dtype().is_equiv_to(dtype::&lt;i32&gt;(py)));
<span class="macro">assert!</span>(array.dtype().is_equiv_to(dtype_bound::&lt;i32&gt;(py).as_gil_ref()));
});</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_contiguous" class="method"><a class="src rightside" href="../../src/numpy/untyped_array.rs.html#140-142">source</a><h4 class="code-header">pub fn <a href="#method.is_contiguous" class="fn">is_contiguous</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the internal data of the array is contiguous,
indepedently of whether C-style/row-major or Fortran-style/column-major.</p>
Expand Down
4 changes: 2 additions & 2 deletions numpy/borrow/struct.PyReadwriteArray.html
Original file line number Diff line number Diff line change
Expand Up @@ -316,13 +316,13 @@ <h5 id="example-11"><a href="#example-11">Example</a></h5>
</div></details><details class="toggle method-toggle" open><summary><section id="method.dtype" class="method"><a class="src rightside" href="../../src/numpy/untyped_array.rs.html#114-116">source</a><h4 class="code-header">pub fn <a href="#method.dtype" class="fn">dtype</a>(&amp;self) -&gt; &amp;<a class="struct" href="../struct.PyArrayDescr.html" title="struct numpy::PyArrayDescr">PyArrayDescr</a></h4></section></summary><div class="docblock"><p>Returns the <code>dtype</code> of the array.</p>
<p>See also <a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.dtype.html"><code>ndarray.dtype</code></a> and <a href="https://numpy.org/doc/stable/reference/c-api/array.html#c.PyArray_DTYPE"><code>PyArray_DTYPE</code></a>.</p>
<h5 id="example-12"><a href="#example-12">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>numpy::{dtype, PyArray};
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>numpy::{dtype_bound, PyArray};
<span class="kw">use </span>pyo3::Python;

Python::with_gil(|py| {
<span class="kw">let </span>array = PyArray::from_vec(py, <span class="macro">vec!</span>[<span class="number">1_i32</span>, <span class="number">2</span>, <span class="number">3</span>]);

<span class="macro">assert!</span>(array.dtype().is_equiv_to(dtype::&lt;i32&gt;(py)));
<span class="macro">assert!</span>(array.dtype().is_equiv_to(dtype_bound::&lt;i32&gt;(py).as_gil_ref()));
});</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_contiguous" class="method"><a class="src rightside" href="../../src/numpy/untyped_array.rs.html#140-142">source</a><h4 class="code-header">pub fn <a href="#method.is_contiguous" class="fn">is_contiguous</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the internal data of the array is contiguous,
indepedently of whether C-style/row-major or Fortran-style/column-major.</p>
Expand Down
2 changes: 1 addition & 1 deletion numpy/datetime/struct.Datetime.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion numpy/datetime/struct.Timedelta.html

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions numpy/dtype/fn.dtype_bound.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../numpy/fn.dtype_bound.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../numpy/fn.dtype_bound.html">../../numpy/fn.dtype_bound.html</a>...</p>
<script>location.replace("../../numpy/fn.dtype_bound.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions numpy/dtype/trait.PyArrayDescrMethods.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../numpy/trait.PyArrayDescrMethods.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../numpy/trait.PyArrayDescrMethods.html">../../numpy/trait.PyArrayDescrMethods.html</a>...</p>
<script>location.replace("../../numpy/trait.PyArrayDescrMethods.html" + location.search + location.hash);</script>
</body>
</html>
4 changes: 2 additions & 2 deletions numpy/enum.BorrowError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion numpy/fn.dtype.html
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="Returns the type descriptor (“dtype”) for a registered type."><title>dtype in numpy - 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 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">&#9776;</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><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="../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>Function <a href="index.html">numpy</a>::<wbr><a class="fn" href="#">dtype</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/dtype.rs.html#71-73">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn dtype&lt;'py, T: <a class="trait" href="trait.Element.html" title="trait numpy::Element">Element</a>&gt;(py: Python&lt;'py&gt;) -&gt; &amp;'py <a class="struct" href="struct.PyArrayDescr.html" title="struct numpy::PyArrayDescr">PyArrayDescr</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns the type descriptor (“dtype”) for a registered type.</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>Function <a href="index.html">numpy</a>::<wbr><a class="fn" href="#">dtype</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/dtype.rs.html#76-78">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn dtype&lt;'py, T: <a class="trait" href="trait.Element.html" title="trait numpy::Element">Element</a>&gt;(py: Python&lt;'py&gt;) -&gt; &amp;'py <a class="struct" href="struct.PyArrayDescr.html" title="struct numpy::PyArrayDescr">PyArrayDescr</a></code></pre><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 0.21.0: This will be replaced by <code>dtype_bound</code> in the future.</span></div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns the type descriptor (“dtype”) for a registered type.</p>
</div></details></section></div></main></body></html>
3 changes: 3 additions & 0 deletions numpy/fn.dtype_bound.html
Original file line number Diff line number Diff line change
@@ -0,0 +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="Returns the type descriptor (“dtype”) for a registered type."><title>dtype_bound in numpy - 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 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">&#9776;</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><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="../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>Function <a href="index.html">numpy</a>::<wbr><a class="fn" href="#">dtype_bound</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/dtype.rs.html#81-83">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn dtype_bound&lt;'py, T: <a class="trait" href="trait.Element.html" title="trait numpy::Element">Element</a>&gt;(py: Python&lt;'py&gt;) -&gt; Bound&lt;'py, <a class="struct" href="struct.PyArrayDescr.html" title="struct numpy::PyArrayDescr">PyArrayDescr</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Returns the type descriptor (“dtype”) for a registered type.</p>
</div></details></section></div></main></body></html>
Loading

0 comments on commit c30f8d8

Please sign in to comment.