File size: 6,590 Bytes
9375c9a |
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 |
// Copyright (C) 2010 Davis E. King ([email protected])
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_MR_FUNCTION_ObJECTS_ABSTRACT_Hh_
#ifdef DLIB_MR_FUNCTION_ObJECTS_ABSTRACT_Hh_
#include "../matrix.h"
#include <cmath>
#include "../svm/sparse_vector_abstract.h"
namespace dlib
{
// ----------------------------------------------------------------------------------------
struct squared_euclidean_distance
{
/*!
WHAT THIS OBJECT REPRESENTS
This is a simple function object that computes squared euclidean distance
between two dlib::matrix objects.
THREAD SAFETY
This object has no mutable members. Therefore, it is safe to call
operator() on a single instance of this object simultaneously from multiple
threads.
!*/
squared_euclidean_distance (
);
/*!
ensures
- #lower == 0
- #upper == std::numeric_limits<double>::infinity()
!*/
squared_euclidean_distance (
const double l,
const double u
);
/*!
ensures
- #lower == l
- #upper == u
!*/
const double lower;
const double upper;
template <typename sample_type>
double operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- sample_type should be a kind of dlib::matrix
ensures
- let LEN = length_squared(a-b)
- if (lower <= LEN <= upper) then
- returns LEN
- else
- returns std::numeric_limits<double>::infinity()
!*/
};
// ----------------------------------------------------------------------------------------
struct cosine_distance
{
/*!
WHAT THIS OBJECT REPRESENTS
This is a simple function object that computes the cosine of the angle
between two vectors and returns 1 - this quantity. Moreover, this object
works for both sparse and dense vectors.
THREAD SAFETY
This object has no mutable members. Therefore, it is safe to call
operator() on a single instance of this object simultaneously from multiple
threads.
!*/
template <typename sample_type>
double operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- sample_type is a dense vector (e.g. a dlib::matrix) or a sparse
vector as defined at the top of dlib/svm/sparse_vector_abstract.h
ensures
- let theta = the angle between a and b.
- returns 1 - cos(theta)
(e.g. this function returns 0 when a and b have an angle of 0 between
each other, 1 if they have a 90 degree angle, and a maximum of 2 if the
vectors have a 180 degree angle between each other).
- zero length vectors are considered to have angles of 0 between all other
vectors.
!*/
};
// ----------------------------------------------------------------------------------------
struct negative_dot_product_distance
{
/*!
WHAT THIS OBJECT REPRESENTS
This is a simple function object that computes the dot product between two
vectors and returns the negation of this value. Moreover, this object
works for both sparse and dense vectors.
THREAD SAFETY
This object has no mutable members. Therefore, it is safe to call
operator() on a single instance of this object simultaneously from multiple
threads.
!*/
template <typename sample_type>
double operator() (
const sample_type& a,
const sample_type& b
) const;
/*!
requires
- sample_type is a dense vector (e.g. a dlib::matrix) or a sparse
vector as defined at the top of dlib/svm/sparse_vector_abstract.h
ensures
- returns -dot(a,b)
!*/
};
// ----------------------------------------------------------------------------------------
struct use_weights_of_one
{
/*!
WHAT THIS OBJECT REPRESENTS
This is a simple function object that takes a single argument
and always returns 1
THREAD SAFETY
This object has no mutable members. Therefore, it is safe to call
operator() on a single instance of this object simultaneously from multiple
threads.
!*/
template <typename edge_type>
double operator() (
const edge_type&
) const;
/*!
ensures
- returns 1
!*/
};
// ----------------------------------------------------------------------------------------
struct use_gaussian_weights
{
/*!
WHAT THIS OBJECT REPRESENTS
This is a simple function object that takes a single argument
which should be an object similar to dlib::sample_pair.
THREAD SAFETY
This object has no mutable members. Therefore, it is safe to call
operator() on a single instance of this object simultaneously from multiple
threads.
!*/
use_gaussian_weights (
);
/*!
ensures
- #gamma == 0.1
!*/
use_gaussian_weights (
double g
);
/*!
ensures
- #gamma == g
!*/
double gamma;
template <typename edge_type>
double operator() (
const edge_type& e
) const;
/*!
requires
- e.distance() must be a valid expression that returns a number
(e.g. edge_type might be dlib::sample_pair)
ensures
- returns std::exp(-gamma*e.distance());
!*/
};
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_MR_FUNCTION_ObJECTS_ABSTRACT_Hh_
|