<html><!-- Created using the cpp_pretty_printer from the dlib C++ library. See http://dlib.net for updates. --><head><title>dlib C++ Library - sparse_kernel_abstract.h</title></head><body bgcolor='white'><pre>
<font color='#009900'>// Copyright (C) 2009 Davis E. King (davis@dlib.net)
</font><font color='#009900'>// License: Boost Software License See LICENSE.txt for the full license.
</font><font color='#0000FF'>#undef</font> DLIB_SVm_SPARSE_KERNEL_ABSTRACT_
<font color='#0000FF'>#ifdef</font> DLIB_SVm_SPARSE_KERNEL_ABSTRACT_
<font color='#0000FF'>#include</font> <font color='#5555FF'><</font>cmath<font color='#5555FF'>></font>
<font color='#0000FF'>#include</font> <font color='#5555FF'><</font>limits<font color='#5555FF'>></font>
<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='../algs.h.html'>../algs.h</a>"
<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='../serialize.h.html'>../serialize.h</a>"
<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='kernel_abstract.h.html'>kernel_abstract.h</a>"
<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='sparse_vector_abstract.h.html'>sparse_vector_abstract.h</a>"
<font color='#0000FF'>namespace</font> dlib
<b>{</b>
<font color='#009900'>// ----------------------------------------------------------------------------------------
</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'>struct</font> <b><a name='sparse_radial_basis_kernel'></a>sparse_radial_basis_kernel</b>
<b>{</b>
<font color='#009900'>/*!
REQUIREMENTS ON T
Must be a sparse vector as defined in dlib/svm/sparse_vector_abstract.h
WHAT THIS OBJECT REPRESENTS
This object represents a radial basis function kernel
that works with sparse vectors.
THREAD SAFETY
This kernel is threadsafe.
!*/</font>
<font color='#0000FF'>typedef</font> <font color='#0000FF'>typename</font> T::value_type::second_type scalar_type;
<font color='#0000FF'>typedef</font> T sample_type;
<font color='#0000FF'>typedef</font> default_memory_manager mem_manager_type;
<font color='#0000FF'>const</font> scalar_type gamma;
<b><a name='sparse_radial_basis_kernel'></a>sparse_radial_basis_kernel</b><font face='Lucida Console'>(</font>
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == 0.1
!*/</font>
<b><a name='sparse_radial_basis_kernel'></a>sparse_radial_basis_kernel</b><font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_radial_basis_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == k.gamma
!*/</font>
<b><a name='sparse_radial_basis_kernel'></a>sparse_radial_basis_kernel</b><font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> scalar_type g
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == g
!*/</font>
scalar_type <b><a name='operator'></a>operator</b><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> a,
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> b
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
requires
- a is a sparse vector
- b is a sparse vector
ensures
- returns exp(-gamma * distance_squared(a,b))
!*/</font>
sparse_radial_basis_kernel<font color='#5555FF'>&</font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_radial_basis_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma = k.gamma
- returns *this
!*/</font>
<font color='#0000FF'><u>bool</u></font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_radial_basis_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
ensures
- if (k and *this are identical) then
- returns true
- else
- returns false
!*/</font>
<b>}</b>;
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='serialize'></a>serialize</b> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_radial_basis_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::ostream<font color='#5555FF'>&</font> out
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides serialization support for sparse_radial_basis_kernel
!*/</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='deserialize'></a>deserialize</b> <font face='Lucida Console'>(</font>
sparse_radial_basis_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::istream<font color='#5555FF'>&</font> in
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides deserialization support for sparse_radial_basis_kernel
!*/</font>
<font color='#009900'>// ----------------------------------------------------------------------------------------
</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'>struct</font> <b><a name='sparse_sigmoid_kernel'></a>sparse_sigmoid_kernel</b>
<b>{</b>
<font color='#009900'>/*!
REQUIREMENTS ON T
Must be a sparse vector as defined in dlib/svm/sparse_vector_abstract.h
WHAT THIS OBJECT REPRESENTS
This object represents a sigmoid kernel
that works with sparse vectors.
THREAD SAFETY
This kernel is threadsafe.
!*/</font>
<font color='#0000FF'>typedef</font> <font color='#0000FF'>typename</font> T::value_type::second_type scalar_type;
<font color='#0000FF'>typedef</font> T sample_type;
<font color='#0000FF'>typedef</font> default_memory_manager mem_manager_type;
<font color='#0000FF'>const</font> scalar_type gamma;
<font color='#0000FF'>const</font> scalar_type coef;
<b><a name='sparse_sigmoid_kernel'></a>sparse_sigmoid_kernel</b><font face='Lucida Console'>(</font>
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == 0.1
- #coef == -1.0
!*/</font>
<b><a name='sparse_sigmoid_kernel'></a>sparse_sigmoid_kernel</b><font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_sigmoid_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == k.gamma
- #coef == k.coef
!*/</font>
<b><a name='sparse_sigmoid_kernel'></a>sparse_sigmoid_kernel</b><font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> scalar_type g,
<font color='#0000FF'>const</font> scalar_type c
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == g
- #coef == c
!*/</font>
scalar_type <b><a name='operator'></a>operator</b><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> a,
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> b
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
requires
- a is a sparse vector
- b is a sparse vector
ensures
- returns tanh(gamma * dot(a,b) + coef)
!*/</font>
sparse_sigmoid_kernel<font color='#5555FF'>&</font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_sigmoid_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma = k.gamma
- #coef = k.coef
- returns *this
!*/</font>
<font color='#0000FF'><u>bool</u></font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_sigmoid_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
ensures
- if (k and *this are identical) then
- returns true
- else
- returns false
!*/</font>
<b>}</b>;
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='serialize'></a>serialize</b> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_sigmoid_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::ostream<font color='#5555FF'>&</font> out
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides serialization support for sparse_sigmoid_kernel
!*/</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='deserialize'></a>deserialize</b> <font face='Lucida Console'>(</font>
sparse_sigmoid_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::istream<font color='#5555FF'>&</font> in
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides deserialization support for sparse_sigmoid_kernel
!*/</font>
<font color='#009900'>// ----------------------------------------------------------------------------------------
</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'>struct</font> <b><a name='sparse_polynomial_kernel'></a>sparse_polynomial_kernel</b>
<b>{</b>
<font color='#009900'>/*!
REQUIREMENTS ON T
Must be a sparse vector as defined in dlib/svm/sparse_vector_abstract.h
WHAT THIS OBJECT REPRESENTS
This object represents a polynomial kernel
that works with sparse vectors.
THREAD SAFETY
This kernel is threadsafe.
!*/</font>
<font color='#0000FF'>typedef</font> <font color='#0000FF'>typename</font> T::value_type::second_type scalar_type;
<font color='#0000FF'>typedef</font> T sample_type;
<font color='#0000FF'>typedef</font> default_memory_manager mem_manager_type;
<font color='#0000FF'>const</font> scalar_type gamma;
<font color='#0000FF'>const</font> scalar_type coef;
<font color='#0000FF'>const</font> scalar_type degree;
<b><a name='sparse_polynomial_kernel'></a>sparse_polynomial_kernel</b><font face='Lucida Console'>(</font>
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == 1
- #coef == 0
- #degree == 1
!*/</font>
<b><a name='sparse_polynomial_kernel'></a>sparse_polynomial_kernel</b><font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_polynomial_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == k.gamma
- #coef == k.coef
- #degree == k.degree
!*/</font>
<b><a name='sparse_polynomial_kernel'></a>sparse_polynomial_kernel</b><font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> scalar_type g,
<font color='#0000FF'>const</font> scalar_type c,
<font color='#0000FF'>const</font> scalar_type d
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma == g
- #coef == c
- #degree == d
!*/</font>
scalar_type <b><a name='operator'></a>operator</b><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> a,
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> b
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
requires
- a is a sparse vector
- b is a sparse vector
ensures
- returns pow(gamma * dot(a,b) + coef, degree)
!*/</font>
sparse_polynomial_kernel<font color='#5555FF'>&</font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_polynomial_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
ensures
- #gamma = k.gamma
- #coef = k.coef
- #degree = k.degree
- returns *this
!*/</font>
<font color='#0000FF'><u>bool</u></font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_polynomial_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
ensures
- if (k and *this are identical) then
- returns true
- else
- returns false
!*/</font>
<b>}</b>;
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='serialize'></a>serialize</b> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_polynomial_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::ostream<font color='#5555FF'>&</font> out
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides serialization support for sparse_polynomial_kernel
!*/</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='deserialize'></a>deserialize</b> <font face='Lucida Console'>(</font>
sparse_polynomial_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::istream<font color='#5555FF'>&</font> in
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides deserialization support for sparse_polynomial_kernel
!*/</font>
<font color='#009900'>// ----------------------------------------------------------------------------------------
</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'>struct</font> <b><a name='sparse_linear_kernel'></a>sparse_linear_kernel</b>
<b>{</b>
<font color='#009900'>/*!
REQUIREMENTS ON T
Must be a sparse vector as defined in dlib/svm/sparse_vector_abstract.h
WHAT THIS OBJECT REPRESENTS
This object represents a linear function kernel
that works with sparse vectors.
THREAD SAFETY
This kernel is threadsafe.
!*/</font>
<font color='#0000FF'>typedef</font> <font color='#0000FF'>typename</font> T::value_type::second_type scalar_type;
<font color='#0000FF'>typedef</font> T sample_type;
<font color='#0000FF'>typedef</font> default_memory_manager mem_manager_type;
scalar_type <b><a name='operator'></a>operator</b><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> a,
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> b
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
requires
- a is a sparse vector
- b is a sparse vector
ensures
- returns dot(a,b)
!*/</font>
<font color='#0000FF'><u>bool</u></font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_linear_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
ensures
- returns true
!*/</font>
<b>}</b>;
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='serialize'></a>serialize</b> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_linear_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::ostream<font color='#5555FF'>&</font> out
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides serialization support for sparse_linear_kernel
!*/</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='deserialize'></a>deserialize</b> <font face='Lucida Console'>(</font>
sparse_linear_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::istream<font color='#5555FF'>&</font> in
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides deserialization support for sparse_linear_kernel
!*/</font>
<font color='#009900'>// ----------------------------------------------------------------------------------------
</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'>struct</font> <b><a name='sparse_histogram_intersection_kernel'></a>sparse_histogram_intersection_kernel</b>
<b>{</b>
<font color='#009900'>/*!
REQUIREMENTS ON T
Must be a sparse vector as defined in dlib/svm/sparse_vector_abstract.h
WHAT THIS OBJECT REPRESENTS
This object represents a histogram intersection kernel
that works with sparse vectors.
THREAD SAFETY
This kernel is threadsafe.
!*/</font>
<font color='#0000FF'>typedef</font> <font color='#0000FF'>typename</font> T::value_type::second_type scalar_type;
<font color='#0000FF'>typedef</font> T sample_type;
<font color='#0000FF'>typedef</font> default_memory_manager mem_manager_type;
scalar_type <b><a name='operator'></a>operator</b><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> a,
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> b
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
requires
- a is a sparse vector
- b is a sparse vector
- all the values in a and b are >= 0
ensures
- Let A(i) denote the value of the ith dimension of the a vector.
- Let B(i) denote the value of the ith dimension of the b vector.
- returns sum over all i: std::min(A(i), B(i))
!*/</font>
<font color='#0000FF'><u>bool</u></font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_histogram_intersection_kernel<font color='#5555FF'>&</font> k
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>;
<font color='#009900'>/*!
ensures
- returns true
!*/</font>
<b>}</b>;
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='serialize'></a>serialize</b> <font face='Lucida Console'>(</font>
<font color='#0000FF'>const</font> sparse_histogram_intersection_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::ostream<font color='#5555FF'>&</font> out
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides serialization support for sparse_histogram_intersection_kernel
!*/</font>
<font color='#0000FF'>template</font> <font color='#5555FF'><</font>
<font color='#0000FF'>typename</font> T
<font color='#5555FF'>></font>
<font color='#0000FF'><u>void</u></font> <b><a name='deserialize'></a>deserialize</b> <font face='Lucida Console'>(</font>
sparse_histogram_intersection_kernel<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font color='#5555FF'>&</font> item,
std::istream<font color='#5555FF'>&</font> in
<font face='Lucida Console'>)</font>;
<font color='#009900'>/*!
provides deserialization support for sparse_histogram_intersection_kernel
!*/</font>
<font color='#009900'>// ----------------------------------------------------------------------------------------
</font>
<b>}</b>
<font color='#0000FF'>#endif</font> <font color='#009900'>// DLIB_SVm_SPARSE_KERNEL_ABSTRACT_
</font>
</pre></body></html>