Struct rusty_machine::learning::toolkit::kernel::HyperTan

pub struct HyperTan {
    pub alpha: f64,
    pub c: f64,
}

The Hyperbolic Tangent Kernel.

ker(x,y) = tanh(αx^Ty + c)

Fields

alpha: f64

The scaling of the inner product.

c: f64

The constant to add to the inner product.

Implementations

impl HyperTan

pub fn new(alpha: f64, c: f64) -> HyperTan

Constructs a new Hyperbolic Tangent Kernel.

Examples

use rusty_machine::learning::toolkit::kernel;
use rusty_machine::learning::toolkit::kernel::Kernel;

// Construct a kernel with alpha = 1, c = 2.
let ker = kernel::HyperTan::new(1.0, 2.0);

println!("{0}", ker.kernel(&[1.,2.,3.], &[3.,4.,5.]));

Trait Implementations

impl Clone for HyperTan

fn clone(&self) -> HyperTan

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HyperTan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HyperTan

Constructs a default Hyperbolic Tangent Kernel.

The defaults are:

• alpha = 1
• c = 0

fn default() -> HyperTan

Returns the “default value” for a type.

impl Kernel for HyperTan

fn kernel(&self, x1: &[f64], x2: &[f64]) -> f64

The kernel function.

impl Copy for HyperTan