| <!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 `NeuQuant` struct in crate `color_quant`."><meta name="keywords" content="rust, rustlang, rust-lang, NeuQuant"><title>NeuQuant in color_quant - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc struct"><!--[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><a class="sidebar-logo" href="../color_quant/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../color_quant/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">NeuQuant</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.color_map_rgb">color_map_rgb</a></li><li><a href="#method.color_map_rgba">color_map_rgba</a></li><li><a href="#method.index_of">index_of</a></li><li><a href="#method.init">init</a></li><li><a href="#method.lookup">lookup</a></li><li><a href="#method.map_pixel">map_pixel</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-NeuQuant">RefUnwindSafe</a></li><li><a href="#impl-Send-for-NeuQuant">Send</a></li><li><a href="#impl-Sync-for-NeuQuant">Sync</a></li><li><a href="#impl-Unpin-for-NeuQuant">Unpin</a></li><li><a href="#impl-UnwindSafe-for-NeuQuant">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-NeuQuant">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-NeuQuant">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-NeuQuant">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-NeuQuant">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-NeuQuant">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-NeuQuant">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-NeuQuant">TryInto<U></a></li></ul></section><h2><a href="index.html">In color_quant</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="index.html">color_quant</a>::<wbr><a class="struct" href="#">NeuQuant</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/color_quant/lib.rs.html#103-111">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct NeuQuant { /* private fields */ }</code></pre></div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-NeuQuant" class="impl has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#113-480">source</a><a href="#impl-NeuQuant" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.NeuQuant.html" title="struct color_quant::NeuQuant">NeuQuant</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#121-134">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(samplefac: i32, colors: usize, pixels: &[u8]) -> Self</h4></section></summary><div class="docblock"><p>Creates a new neuronal network and trains it with the supplied data.</p> |
| <p>Pixels are assumed to be in RGBA format. |
| <code>colors</code> should be $>=64$. <code>samplefac</code> determines the faction of |
| the sample that will be used to train the network. Its value must be in the |
| range $[1, 30]$. A value of $1$ thus produces the best result but is also |
| slowest. $10$ is a good compromise between speed and quality.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.init" class="method has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#139-167">source</a><h4 class="code-header">pub fn <a href="#method.init" class="fnname">init</a>(&mut self, pixels: &[u8])</h4></section></summary><div class="docblock"><p>Initializes the neuronal network and trains it with the supplied data.</p> |
| <p>This method gets called by <code>Self::new</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.map_pixel" class="method has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#171-179">source</a><h4 class="code-header">pub fn <a href="#method.map_pixel" class="fnname">map_pixel</a>(&self, pixel: &mut [u8])</h4></section></summary><div class="docblock"><p>Maps the rgba-pixel in-place to the best-matching color in the color map.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index_of" class="method has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#185-189">source</a><h4 class="code-header">pub fn <a href="#method.index_of" class="fnname">index_of</a>(&self, pixel: &[u8]) -> usize</h4></section></summary><div class="docblock"><p>Finds the best-matching index in the color map.</p> |
| <p><code>pixel</code> is assumed to be in RGBA format.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lookup" class="method has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#192-196">source</a><h4 class="code-header">pub fn <a href="#method.lookup" class="fnname">lookup</a>(&self, idx: usize) -> Option<[u8; 4]></h4></section></summary><div class="docblock"><p>Lookup pixel values for color at <code>idx</code> in the colormap.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.color_map_rgba" class="method has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#199-208">source</a><h4 class="code-header">pub fn <a href="#method.color_map_rgba" class="fnname">color_map_rgba</a>(&self) -> Vec<u8></h4></section></summary><div class="docblock"><p>Returns the RGBA color map calculated from the sample.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.color_map_rgb" class="method has-srclink"><a class="srclink rightside" href="../src/color_quant/lib.rs.html#211-219">source</a><h4 class="code-header">pub fn <a href="#method.color_map_rgb" class="fnname">color_map_rgb</a>(&self) -> Vec<u8></h4></section></summary><div class="docblock"><p>Returns the RGBA color map calculated from the sample.</p> |
| </div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-NeuQuant" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.NeuQuant.html" title="struct color_quant::NeuQuant">NeuQuant</a></h3></section><section id="impl-Send-for-NeuQuant" class="impl has-srclink"><a href="#impl-Send-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.NeuQuant.html" title="struct color_quant::NeuQuant">NeuQuant</a></h3></section><section id="impl-Sync-for-NeuQuant" class="impl has-srclink"><a href="#impl-Sync-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.NeuQuant.html" title="struct color_quant::NeuQuant">NeuQuant</a></h3></section><section id="impl-Unpin-for-NeuQuant" class="impl has-srclink"><a href="#impl-Unpin-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.NeuQuant.html" title="struct color_quant::NeuQuant">NeuQuant</a></h3></section><section id="impl-UnwindSafe-for-NeuQuant" class="impl has-srclink"><a href="#impl-UnwindSafe-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.NeuQuant.html" title="struct color_quant::NeuQuant">NeuQuant</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-NeuQuant" class="impl has-srclink"><a href="#impl-Any-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-NeuQuant" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-NeuQuant" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-NeuQuant" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-NeuQuant" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-NeuQuant" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-NeuQuant" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="color_quant" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
