Struct friedrich::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.

Methods

impl HyperTan

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

Constructs a new Hyperbolic Tangent Kernel.

Trait Implementations

impl Kernel for HyperTan

const NB_PARAMETERS: usize

numbers of parameters (such as bandwith and amplitude) of the kernel

fn kernel<S1: Storage<f64, U1, Dynamic>, S2: Storage<f64, U1, Dynamic>>(
    &self,
    x1: &Matrix<f64, U1, Dynamic, S1>,
    x2: &Matrix<f64, U1, Dynamic, S2>
) -> f64

Takes two equal length slices (row vector) and returns a scalar.

fn gradient<S1: Storage<f64, U1, Dynamic>, S2: Storage<f64, U1, Dynamic>>(
    &self,
    x1: &Matrix<f64, U1, Dynamic, S1>,
    x2: &Matrix<f64, U1, Dynamic, S2>
) -> Vec<f64>

Takes two equal length slices (row vector) and returns a vector containing the value of the gradient for each parameter in an arbitrary order.

fn get_parameters(&self) -> Vec<f64>

Returns a vector containing all the parameters of the kernel in the same order as the outputs of the gradient function

fn set_parameters(&mut self, parameters: &[f64])

Sets all the parameters of the kernel by reading them from a slice where they are in the same order as the outputs of the gradient function

fn heuristic_fit<SM: Storage<f64, Dynamic, Dynamic>, SV: Storage<f64, Dynamic, U1>>(
    &mut self,
    _training_inputs: &Matrix<f64, Dynamic, Dynamic, SM>,
    _training_outputs: &Matrix<f64, Dynamic, U1, SV>
)

Optional, function that fits the kernel parameters on the training data using fast heuristics. This is used as a starting point for gradient descent.

impl Clone for HyperTan

fn clone(&self) -> HyperTan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for HyperTan

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 Debug for HyperTan

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

Formats the value using the given formatter.