| <!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="Trait for vector metrics."><meta name="keywords" content="rust, rustlang, rust-lang, VectorMetric"><title>VectorMetric in rusty_machine::linalg::norm - 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 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><a class="sidebar-logo" href="../../../rusty_machine/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="../../../rusty_machine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">VectorMetric</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.metric">metric</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::linalg::norm</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">Trait <a href="../../index.html">rusty_machine</a>::<wbr><a href="../index.html">linalg</a>::<wbr><a href="index.html">norm</a>::<wbr><a class="trait" href="#">VectorMetric</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/rulinalg/norm/mod.rs.html#44">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 trait"><code>pub trait VectorMetric<T> { |
| fn <a href="#tymethod.metric" class="fnname">metric</a>(&self, v1: &<a class="struct" href="../struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><T>, v2: &<a class="struct" href="../struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><T>) -> T; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for vector metrics.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.metric" class="method has-srclink"><a class="srclink rightside" href="../../../src/rulinalg/norm/mod.rs.html#46">source</a><h4 class="code-header">fn <a href="#tymethod.metric" class="fnname">metric</a>(&self, v1: &<a class="struct" href="../struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><T>, v2: &<a class="struct" href="../struct.Vector.html" title="struct rusty_machine::linalg::Vector">Vector</a><T>) -> T</h4></section></summary><div class="docblock"><p>Computes the metric distance between two vectors.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-VectorMetric%3CT%3E-for-U" class="impl has-srclink"><a class="srclink rightside" href="../../../src/rulinalg/norm/mod.rs.html#68">source</a><a href="#impl-VectorMetric%3CT%3E-for-U" class="anchor"></a><h3 class="code-header">impl<U, T> <a class="trait" href="trait.VectorMetric.html" title="trait rusty_machine::linalg::norm::VectorMetric">VectorMetric</a><T> for U<span class="where fmt-newline">where<br> U: <a class="trait" href="trait.VectorNorm.html" title="trait rusty_machine::linalg::norm::VectorNorm">VectorNorm</a><T>,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><T, Output = T>,</span></h3></section><div class="docblock"><p>The induced vector metric</p> |
| <p>Given a norm <code>N</code>, the induced vector metric <code>M</code> computes |
| the metric distance, <code>d</code>, between two vectors <code>v1</code> and <code>v2</code> |
| as follows:</p> |
| <p><code>d = M(v1, v2) = N(v1 - v2)</code></p> |
| </div></div><script src="../../../implementors/rulinalg/norm/trait.VectorMetric.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rusty_machine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
