Skip to content

Commit

Permalink
deploy: e62b14d
Browse files Browse the repository at this point in the history
  • Loading branch information
@juntyr
juntyr committed Feb 6, 2025
1 parent 61c642d commit acfc9f9
Show file tree
Hide file tree
Showing 14 changed files with 107 additions and 107 deletions.
10 changes: 5 additions & 5 deletions numcodecs_fixed_offset_scale/enum.FixedOffsetScaleCodecError.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion numcodecs_fixed_offset_scale/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</script>

</head><body class="rustdoc mod crate"><!--[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="../numcodecs_fixed_offset_scale/index.html">numcodecs_<wbr>fixed_<wbr>offset_<wbr>scale</a><span class="version">0.2.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>numcodecs_fixed_offset_scale</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/numcodecs_fixed_offset_scale/lib.rs.html#1-237">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="https://github.com/juntyr/numcodecs-rs/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/juntyr/numcodecs-rs/ci.yml?branch=main" alt="CI Status" /></a> <a href="https://github.com/juntyr/numcodecs-rs"><img src="https://img.shields.io/badge/MSRV-1.82.0-blue" alt="MSRV" /></a> <a href="https://crates.io/crates/numcodecs-fixed-offset-scale"><img src="https://img.shields.io/crates/v/numcodecs-fixed-offset-scale" alt="Latest Version" /></a> <a href="https://docs.rs/numcodecs-fixed-offset-scale/"><img src="https://img.shields.io/docsrs/numcodecs-fixed-offset-scale" alt="Rust Doc Crate" /></a> <a href="https://juntyr.github.io/numcodecs-rs/numcodecs_fixed_offset_scale"><img src="https://img.shields.io/badge/docs-main-blue" alt="Rust Doc Main" /></a></p>
<p><code>$\frac{x - o}{s}$</code> codec implementation for the <a href="../numcodecs/index.html" title="mod numcodecs"><code>numcodecs</code></a> API.</p>
<p><code>$\frac{x - o}{s}$</code> codec implementation for the <a href="https://juntyr.github.io/numcodecs-rs/numcodecs/index.html" title="mod numcodecs"><code>numcodecs</code></a> API.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.FixedOffsetScaleCodec.html" title="struct numcodecs_fixed_offset_scale::FixedOffsetScaleCodec">Fixed<wbr>Offset<wbr>Scale<wbr>Codec</a></dt><dd>Fixed offset-scale codec which calculates <code>$c = \frac{x - o}{s}$</code> on
encoding and <code>$d = (c \cdot s) + o$</code> on decoding.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.FixedOffsetScaleCodecError.html" title="enum numcodecs_fixed_offset_scale::FixedOffsetScaleCodecError">Fixed<wbr>Offset<wbr>Scale<wbr>Codec<wbr>Error</a></dt><dd>Errors that may occur when applying the <a href="struct.FixedOffsetScaleCodec.html" title="struct numcodecs_fixed_offset_scale::FixedOffsetScaleCodec"><code>FixedOffsetScaleCodec</code></a>.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.scale.html" title="fn numcodecs_fixed_offset_scale::scale">scale</a></dt><dd>Compute <code>$\frac{x - o}{s}$</code> over the elements of the input <code>data</code> array.</dd><dt><a class="fn" href="fn.unscale.html" title="fn numcodecs_fixed_offset_scale::unscale">unscale</a></dt><dd>Compute <code>$(x \cdot s) + o$</code> over the elements of the input <code>data</code> array.</dd><dt><a class="fn" href="fn.unscale_into.html" title="fn numcodecs_fixed_offset_scale::unscale_into">unscale_<wbr>into</a></dt><dd>Compute <code>$(x \cdot s) + o$</code> over the elements of the input <code>data</code> array and
write them into the <code>out</code>put array.</dd></dl></section></div></main></body></html>
20 changes: 10 additions & 10 deletions numcodecs_fixed_offset_scale/struct.FixedOffsetScaleCodec.html
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions numcodecs_zfp/enum.ZfpCodecError.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion numcodecs_zfp/fn.decompress.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
});
</script>

</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="../numcodecs_zfp/index.html">numcodecs_<wbr>zfp</a><span class="version">0.3.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">decompress</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#errors" title="Errors">Errors</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate numcodecs_<wbr>zfp</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">numcodecs_zfp</a></div><h1>Function <span class="fn">decompress</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/numcodecs_zfp/lib.rs.html#272-281">Source</a> </span></div><pre class="rust item-decl"><code>pub fn decompress(encoded: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="type" href="../numcodecs/array/type.AnyArray.html" title="type numcodecs::array::AnyArray">AnyArray</a>, <a class="enum" href="enum.ZfpCodecError.html" title="enum numcodecs_zfp::ZfpCodecError">ZfpCodecError</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decompress the <code>encoded</code> data into an array using ZFP.</p>
</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="../numcodecs_zfp/index.html">numcodecs_<wbr>zfp</a><span class="version">0.3.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">decompress</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#errors" title="Errors">Errors</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate numcodecs_<wbr>zfp</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">numcodecs_zfp</a></div><h1>Function <span class="fn">decompress</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/numcodecs_zfp/lib.rs.html#272-281">Source</a> </span></div><pre class="rust item-decl"><code>pub fn decompress(encoded: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="type" href="https://juntyr.github.io/numcodecs-rs/numcodecs/array/type.AnyArray.html" title="type numcodecs::array::AnyArray">AnyArray</a>, <a class="enum" href="enum.ZfpCodecError.html" title="enum numcodecs_zfp::ZfpCodecError">ZfpCodecError</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decompress the <code>encoded</code> data into an array using ZFP.</p>
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h2>
<p>Errors with</p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion numcodecs_zfp/fn.decompress_into.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

</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="../numcodecs_zfp/index.html">numcodecs_<wbr>zfp</a><span class="version">0.3.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">decompress_<wbr>into</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#errors" title="Errors">Errors</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate numcodecs_<wbr>zfp</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">numcodecs_zfp</a></div><h1>Function <span class="fn">decompress_into</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/numcodecs_zfp/lib.rs.html#294-302">Source</a> </span></div><pre class="rust item-decl"><code>pub fn decompress_into(
encoded: &amp;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],
decoded: <a class="type" href="../numcodecs/array/type.AnyArrayViewMut.html" title="type numcodecs::array::AnyArrayViewMut">AnyArrayViewMut</a>&lt;'_&gt;,
decoded: <a class="type" href="https://juntyr.github.io/numcodecs-rs/numcodecs/array/type.AnyArrayViewMut.html" title="type numcodecs::array::AnyArrayViewMut">AnyArrayViewMut</a>&lt;'_&gt;,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="enum.ZfpCodecError.html" title="enum numcodecs_zfp::ZfpCodecError">ZfpCodecError</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decompress the <code>encoded</code> data into a <code>decoded</code> array using ZFP.</p>
<h2 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h2>
<p>Errors with</p>
Expand Down
2 changes: 1 addition & 1 deletion numcodecs_zfp/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@
</script>

</head><body class="rustdoc mod crate"><!--[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="../numcodecs_zfp/index.html">numcodecs_<wbr>zfp</a><span class="version">0.3.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>numcodecs_zfp</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/numcodecs_zfp/lib.rs.html#1-302">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="https://github.com/juntyr/numcodecs-rs/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/juntyr/numcodecs-rs/ci.yml?branch=main" alt="CI Status" /></a> <a href="https://github.com/juntyr/numcodecs-rs"><img src="https://img.shields.io/badge/MSRV-1.82.0-blue" alt="MSRV" /></a> <a href="https://crates.io/crates/numcodecs-zfp"><img src="https://img.shields.io/crates/v/numcodecs-zfp" alt="Latest Version" /></a> <a href="https://docs.rs/numcodecs-zfp/"><img src="https://img.shields.io/docsrs/numcodecs-zfp" alt="Rust Doc Crate" /></a> <a href="https://juntyr.github.io/numcodecs-rs/numcodecs_zfp"><img src="https://img.shields.io/badge/docs-main-blue" alt="Rust Doc Main" /></a></p>
<p>ZFP codec implementation for the <a href="../numcodecs/index.html" title="mod numcodecs"><code>numcodecs</code></a> API.</p>
<p>ZFP codec implementation for the <a href="https://juntyr.github.io/numcodecs-rs/numcodecs/index.html" title="mod numcodecs"><code>numcodecs</code></a> API.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ZfpCodec.html" title="struct numcodecs_zfp::ZfpCodec">ZfpCodec</a></dt><dd>Codec providing compression using ZFP</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ZfpCodecError.html" title="enum numcodecs_zfp::ZfpCodecError">ZfpCodec<wbr>Error</a></dt><dd>Errors that may occur when applying the <a href="struct.ZfpCodec.html" title="struct numcodecs_zfp::ZfpCodec"><code>ZfpCodec</code></a>.</dd><dt><a class="enum" href="enum.ZfpCompressionMode.html" title="enum numcodecs_zfp::ZfpCompressionMode">ZfpCompression<wbr>Mode</a></dt><dd>ZFP compression mode</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.compress.html" title="fn numcodecs_zfp::compress">compress</a></dt><dd>Compress the <code>data</code> array using ZFP with the provided <code>mode</code>.</dd><dt><a class="fn" href="fn.decompress.html" title="fn numcodecs_zfp::decompress">decompress</a></dt><dd>Decompress the <code>encoded</code> data into an array using ZFP.</dd><dt><a class="fn" href="fn.decompress_into.html" title="fn numcodecs_zfp::decompress_into">decompress_<wbr>into</a></dt><dd>Decompress the <code>encoded</code> data into a <code>decoded</code> array using ZFP.</dd></dl></section></div></main></body></html>
Loading

0 comments on commit acfc9f9

Please sign in to comment.