/usr/include/dlib/svm/kernel_abstract.h is in libdlib-dev 18.18-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 | // Copyright (C) 2007 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_SVm_KERNEL_ABSTRACT_
#ifdef DLIB_SVm_KERNEL_ABSTRACT_
#include <cmath>
#include <limits>
#include <sstream>
#include "../matrix/matrix_abstract.h"
#include "../algs.h"
#include "../serialize.h"
namespace dlib
{
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
/*!A Kernel_Function_Objects */
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
/*!
WHAT IS A KERNEL FUNCTION OBJECT?
In the context of the dlib library documentation a kernel function object
is an object with an interface with the following properties:
- a public typedef named sample_type
- a public typedef named scalar_type which should be a float, double, or
long double type.
- an overloaded operator() that operates on two items of sample_type
and returns a scalar_type.
(e.g. scalar_type val = kernel_function(sample1,sample2);
would be a valid expression)
- a public typedef named mem_manager_type that is an implementation of
dlib/memory_manager/memory_manager_kernel_abstract.h or
dlib/memory_manager_global/memory_manager_global_kernel_abstract.h or
dlib/memory_manager_stateless/memory_manager_stateless_kernel_abstract.h
- an overloaded == operator that tells you if two kernels are
identical or not.
THREAD SAFETY
For a kernel function to be threadsafe it means that it must be safe to
evaluate an expression like val = kernel_function(sample1,sample2)
simultaneously from multiple threads, even when the threads operate on the same
object instances (i.e. kernel_function, sample1, and sample2). The most common
way to make this safe is to ensure that the kernel function does not mutate any
data, either in itself or in its arguments.
For examples of kernel functions see the following objects
(e.g. the radial_basis_kernel).
!*/
template <
typename T
>
struct radial_basis_kernel
{
/*!
REQUIREMENTS ON T
T must be a dlib::matrix object
WHAT THIS OBJECT REPRESENTS
This object represents a radial basis function kernel
THREAD SAFETY
This kernel is threadsafe.
!*/
typedef typename T::type scalar_type;
typedef T sample_type;
typedef typename T::mem_manager_type mem_manager_type;
const scalar_type gamma;
radial_basis_kernel(
);
/*!
ensures
- #gamma == 0.1
!*/
radial_basis_kernel(
const radial_basis_kernel& k
);
/*!
ensures
- #gamma == k.gamma
!*/
radial_basis_kernel(
const scalar_type g
);
/*!
ensures
- #gamma == g
!*/
scalar_type operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- a.nc() == 1
- b.nc() == 1
- a.nr() == b.nr()
ensures
- returns exp(-gamma * ||a-b||^2)
!*/
radial_basis_kernel& operator= (
const radial_basis_kernel& k
);
/*!
ensures
- #gamma = k.gamma
- returns *this
!*/
bool operator== (
const radial_basis_kernel& k
) const;
/*!
ensures
- if (k and *this are identical) then
- returns true
- else
- returns false
!*/
};
template <
typename T
>
void serialize (
const radial_basis_kernel<T>& item,
std::ostream& out
);
/*!
provides serialization support for radial_basis_kernel
!*/
template <
typename T
>
void deserialize (
radial_basis_kernel<T>& item,
std::istream& in
);
/*!
provides deserialization support for radial_basis_kernel
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
struct sigmoid_kernel
{
/*!
REQUIREMENTS ON T
T must be a dlib::matrix object
WHAT THIS OBJECT REPRESENTS
This object represents a sigmoid kernel
THREAD SAFETY
This kernel is threadsafe.
!*/
typedef typename T::type scalar_type;
typedef T sample_type;
typedef typename T::mem_manager_type mem_manager_type;
const scalar_type gamma;
const scalar_type coef;
sigmoid_kernel(
);
/*!
ensures
- #gamma == 0.1
- #coef == -1.0
!*/
sigmoid_kernel(
const sigmoid_kernel& k
);
/*!
ensures
- #gamma == k.gamma
- #coef == k.coef
!*/
sigmoid_kernel(
const scalar_type g,
const scalar_type c
);
/*!
ensures
- #gamma == g
- #coef == c
!*/
scalar_type operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- a.nc() == 1
- b.nc() == 1
- a.nr() == b.nr()
ensures
- returns tanh(gamma*trans(a)*b + coef)
!*/
sigmoid_kernel& operator= (
const sigmoid_kernel& k
);
/*!
ensures
- #gamma = k.gamma
- #coef = k.coef
- returns *this
!*/
bool operator== (
const sigmoid_kernel& k
) const;
/*!
ensures
- if (k and *this are identical) then
- returns true
- else
- returns false
!*/
};
template <
typename T
>
void serialize (
const sigmoid_kernel<T>& item,
std::ostream& out
);
/*!
provides serialization support for sigmoid_kernel
!*/
template <
typename T
>
void deserialize (
sigmoid_kernel<T>& item,
std::istream& in
);
/*!
provides deserialization support for sigmoid_kernel
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
struct polynomial_kernel
{
/*!
REQUIREMENTS ON T
T must be a dlib::matrix object
WHAT THIS OBJECT REPRESENTS
This object represents a polynomial kernel
THREAD SAFETY
This kernel is threadsafe.
!*/
typedef typename T::type scalar_type;
typedef T sample_type;
typedef typename T::mem_manager_type mem_manager_type;
const scalar_type gamma;
const scalar_type coef;
const scalar_type degree;
polynomial_kernel(
);
/*!
ensures
- #gamma == 1
- #coef == 0
- #degree == 1
!*/
polynomial_kernel(
const polynomial_kernel& k
);
/*!
ensures
- #gamma == k.gamma
- #coef == k.coef
- #degree == k.degree
!*/
polynomial_kernel(
const scalar_type g,
const scalar_type c,
const scalar_type d
);
/*!
ensures
- #gamma == g
- #coef == c
- #degree == d
!*/
scalar_type operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- a.nc() == 1
- b.nc() == 1
- a.nr() == b.nr()
ensures
- returns pow(gamma*trans(a)*b + coef, degree)
!*/
polynomial_kernel& operator= (
const polynomial_kernel& k
);
/*!
ensures
- #gamma = k.gamma
- #coef = k.coef
- #degree = k.degree
- returns *this
!*/
bool operator== (
const polynomial_kernel& k
) const;
/*!
ensures
- if (k and *this are identical) then
- returns true
- else
- returns false
!*/
};
template <
typename T
>
void serialize (
const polynomial_kernel<T>& item,
std::ostream& out
);
/*!
provides serialization support for polynomial_kernel
!*/
template <
typename T
>
void deserialize (
polynomial_kernel<T>& item,
std::istream& in
);
/*!
provides deserialization support for polynomial_kernel
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
struct linear_kernel
{
/*!
REQUIREMENTS ON T
T must be a dlib::matrix object
WHAT THIS OBJECT REPRESENTS
This object represents a linear function kernel
THREAD SAFETY
This kernel is threadsafe.
!*/
typedef typename T::type scalar_type;
typedef T sample_type;
typedef typename T::mem_manager_type mem_manager_type;
scalar_type operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- a.nc() == 1
- b.nc() == 1
- a.nr() == b.nr()
ensures
- returns trans(a)*b
!*/
bool operator== (
const linear_kernel& k
) const;
/*!
ensures
- returns true
!*/
};
template <
typename T
>
void serialize (
const linear_kernel<T>& item,
std::ostream& out
);
/*!
provides serialization support for linear_kernel
!*/
template <
typename T
>
void deserialize (
linear_kernel<T>& item,
std::istream& in
);
/*!
provides deserialization support for linear_kernel
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
struct histogram_intersection_kernel
{
/*!
REQUIREMENTS ON T
T must be a dlib::matrix object
WHAT THIS OBJECT REPRESENTS
This object represents a histogram intersection kernel kernel
THREAD SAFETY
This kernel is threadsafe.
!*/
typedef typename T::type scalar_type;
typedef T sample_type;
typedef typename T::mem_manager_type mem_manager_type;
scalar_type operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- is_vector(a)
- is_vector(b)
- a.size() == b.size()
- min(a) >= 0
- min(b) >= 0
ensures
- returns sum over all i: std::min(a(i), b(i))
!*/
bool operator== (
const histogram_intersection_kernel& k
) const;
/*!
ensures
- returns true
!*/
};
template <
typename T
>
void serialize (
const histogram_intersection_kernel<T>& item,
std::ostream& out
);
/*!
provides serialization support for histogram_intersection_kernel
!*/
template <
typename T
>
void deserialize (
histogram_intersection_kernel<T>& item,
std::istream& in
);
/*!
provides deserialization support for histogram_intersection_kernel
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
struct offset_kernel
{
/*!
REQUIREMENTS ON T
T must be a kernel object (e.g. radial_basis_kernel, polynomial_kernel, etc.)
WHAT THIS OBJECT REPRESENTS
This object represents a kernel with a fixed value offset
added to it.
THREAD SAFETY
This kernel is threadsafe.
!*/
typedef typename T::scalar_type scalar_type;
typedef typename T::sample_type sample_type;
typedef typename T::mem_manager_type mem_manager_type;
const T kernel;
const scalar_type offset;
offset_kernel(
);
/*!
ensures
- #offset == 0.01
!*/
offset_kernel(
const offset_kernel& k
);
/*!
ensures
- #offset == k.offset
- #kernel == k.kernel
!*/
offset_kernel(
const T& k,
const scalar_type& off
);
/*!
ensures
- #kernel == k
- #offset == off
!*/
scalar_type operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
ensures
- returns kernel(a,b) + offset
!*/
offset_kernel& operator= (
const offset_kernel& k
);
/*!
ensures
- #offset == k.offset
- #kernel == k.kernel
!*/
bool operator== (
const offset_kernel& k
) const;
/*!
ensures
- if (k and *this are identical) then
- returns true
- else
- returns false
!*/
};
template <
typename T
>
void serialize (
const offset_kernel<T>& item,
std::ostream& out
);
/*!
provides serialization support for offset_kernel
!*/
template <
typename T
>
void deserialize (
offset_kernel<T>& item,
std::istream& in
);
/*!
provides deserialization support for offset_kernel
!*/
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename kernel_type
>
struct kernel_derivative
{
/*!
REQUIREMENTS ON kernel_type
kernel_type must be one of the following kernel types:
- radial_basis_kernel
- polynomial_kernel
- sigmoid_kernel
- linear_kernel
- offset_kernel
WHAT THIS OBJECT REPRESENTS
This is a function object that computes the derivative of a kernel
function object.
THREAD SAFETY
It is always safe to use distinct instances of this object in different
threads. However, when a single instance is shared between threads then
the following rules apply:
Instances of this object are allowed to have a mutable cache which is
used by const member functions. Therefore, it is not safe to use one
instance of this object from multiple threads (unless protected by a
mutex).
!*/
typedef typename kernel_type::scalar_type scalar_type;
typedef typename kernel_type::sample_type sample_type;
typedef typename kernel_type::mem_manager_type mem_manager_type;
kernel_derivative(
const kernel_type& k_
);
/*!
ensures
- this object will return derivatives of the kernel object k_
- #k == k_
!*/
const sample_type operator() (
const sample_type& x,
const sample_type& y
) const;
/*!
ensures
- returns the derivative of k with respect to y.
!*/
const kernel_type& k;
};
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_SVm_KERNEL_ABSTRACT_
|