<!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="Elements that can be used as direct operands in arithmetic with arrays."><meta name="keywords" content="rust, rustlang, rust-lang, ScalarOperand"><title>ScalarOperand in ndarray - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../ndarray/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Trait ScalarOperand</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><div class="sidebar-links"><a href="#impl-ScalarOperand-for-Complex%3Cf32%3E">Complex<f32></a><a href="#impl-ScalarOperand-for-Complex%3Cf64%3E">Complex<f64></a><a href="#impl-ScalarOperand-for-bool">bool</a><a href="#impl-ScalarOperand-for-f32">f32</a><a href="#impl-ScalarOperand-for-f64">f64</a><a href="#impl-ScalarOperand-for-i16">i16</a><a href="#impl-ScalarOperand-for-i32">i32</a><a href="#impl-ScalarOperand-for-i64">i64</a><a href="#impl-ScalarOperand-for-i8">i8</a><a href="#impl-ScalarOperand-for-isize">isize</a><a href="#impl-ScalarOperand-for-u16">u16</a><a href="#impl-ScalarOperand-for-u32">u32</a><a href="#impl-ScalarOperand-for-u64">u64</a><a href="#impl-ScalarOperand-for-u8">u8</a><a href="#impl-ScalarOperand-for-usize">usize</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">ndarray</a></h2><div id="sidebar-vars" data-name="ScalarOperand" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">ndarray</a>::<wbr><a class="trait" href="#">ScalarOperand</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/ndarray/impl_ops.rs.html#32" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait ScalarOperand: 'static + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> { }</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Elements that can be used as direct operands in arithmetic with arrays.</p>
<p>For example, <code>f64</code> is a <code>ScalarOperand</code> which means that for an array <code>a</code>,
arithmetic like <code>a + 1.0</code>, and, <code>a * 2.</code>, and <code>a += 3.</code> are allowed.</p>
<p>In the description below, let <code>A</code> be an array or array view,
let <code>B</code> be an array with owned data,
and let <code>C</code> be an array with mutable data.</p>
<p><code>ScalarOperand</code> determines for which scalars <code>K</code> operations <code>&A @ K</code>, and <code>B @ K</code>,
and <code>C @= K</code> are defined, as <em><strong>right hand side operands</strong></em>, for applicable
arithmetic operators (denoted <code>@</code>).</p>
<p><em><strong>Left hand side</strong></em> scalar operands are not related to this trait
(they need one <code>impl</code> per concrete scalar type); but they are still
implemented for the same types, allowing operations
<code>K @ &A</code>, and <code>K @ B</code> for primitive numeric types <code>K</code>.</p>
<p>This trait <em><strong>does not</strong></em> limit which elements can be stored in an array in general.
Non-<code>ScalarOperand</code> types can still participate in arithmetic as array elements in
in array-array operations.</p>
</div></details><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><div id="impl-ScalarOperand-for-bool" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a></h3><a href="#impl-ScalarOperand-for-bool" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#33" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-i8" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.i8.html">i8</a></h3><a href="#impl-ScalarOperand-for-i8" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#34" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-u8" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.u8.html">u8</a></h3><a href="#impl-ScalarOperand-for-u8" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#35" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-i16" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.i16.html">i16</a></h3><a href="#impl-ScalarOperand-for-i16" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#36" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-u16" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.u16.html">u16</a></h3><a href="#impl-ScalarOperand-for-u16" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#37" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-i32" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.i32.html">i32</a></h3><a href="#impl-ScalarOperand-for-i32" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#38" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-u32" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.u32.html">u32</a></h3><a href="#impl-ScalarOperand-for-u32" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#39" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-i64" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.i64.html">i64</a></h3><a href="#impl-ScalarOperand-for-i64" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#40" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-u64" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.u64.html">u64</a></h3><a href="#impl-ScalarOperand-for-u64" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#41" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-isize" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.isize.html">isize</a></h3><a href="#impl-ScalarOperand-for-isize" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#42" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-usize" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.usize.html">usize</a></h3><a href="#impl-ScalarOperand-for-usize" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#43" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-f32" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.f32.html">f32</a></h3><a href="#impl-ScalarOperand-for-f32" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#44" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-f64" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.f64.html">f64</a></h3><a href="#impl-ScalarOperand-for-f64" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#45" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-Complex%3Cf32%3E" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="struct" href="../num_complex/struct.Complex.html" title="struct num_complex::Complex">Complex</a><<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.f32.html">f32</a>></h3><a href="#impl-ScalarOperand-for-Complex%3Cf32%3E" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#46" title="goto source code">[src]</a></div><div id="impl-ScalarOperand-for-Complex%3Cf64%3E" class="impl has-srclink"><h3 class="code-header in-band">impl <a class="trait" href="trait.ScalarOperand.html" title="trait ndarray::ScalarOperand">ScalarOperand</a> for <a class="struct" href="../num_complex/struct.Complex.html" title="struct num_complex::Complex">Complex</a><<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.f64.html">f64</a>></h3><a href="#impl-ScalarOperand-for-Complex%3Cf64%3E" class="anchor"></a><a class="srclink" href="../src/ndarray/impl_ops.rs.html#47" title="goto source code">[src]</a></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/ndarray/trait.ScalarOperand.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="ndarray" data-search-index-js="../search-index.js" data-search-js="../search.js"></div><script src="../main.js"></script></body></html>