automatic commit
[folded-ctf.git] / loss_machine.h
1 /*
2  *  folded-ctf is an implementation of the folded hierarchy of
3  *  classifiers for object detection, developed by Francois Fleuret
4  *  and Donald Geman.
5  *
6  *  Copyright (c) 2008 Idiap Research Institute, http://www.idiap.ch/
7  *  Written by Francois Fleuret <francois.fleuret@idiap.ch>
8  *
9  *  This file is part of folded-ctf.
10  *
11  *  folded-ctf is free software: you can redistribute it and/or modify
12  *  it under the terms of the GNU General Public License as published
13  *  by the Free Software Foundation, either version 3 of the License,
14  *  or (at your option) any later version.
15  *
16  *  folded-ctf is distributed in the hope that it will be useful, but
17  *  WITHOUT ANY WARRANTY; without even the implied warranty of
18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  *  General Public License for more details.
20  *
21  *  You should have received a copy of the GNU General Public License
22  *  along with folded-ctf.  If not, see <http://www.gnu.org/licenses/>.
23  *
24  */
25
26 /*
27
28   A LossMachine provides all the methods necessary to do boosting with
29   a certain loss. Note that only the LOSS_EXPONENTIAL has been really
30   tested. Using the others may result in unexpected effects.
31
32  */
33
34 #ifndef LOSS_MACHINE_H
35 #define LOSS_MACHINE_H
36
37 #include "misc.h"
38 #include "sample_set.h"
39
40 class LossMachine {
41   int _loss_type;
42
43 public:
44   LossMachine(int loss_type);
45
46   void get_loss_derivatives(SampleSet *samples,
47                             scalar_t *responses,
48                             scalar_t *derivatives);
49
50   scalar_t loss(SampleSet *samples, scalar_t *responses);
51
52   scalar_t optimal_weight(SampleSet *sample_set,
53                           scalar_t *weak_learner_responses,
54                           scalar_t *current_responses);
55
56   /* This method returns in sample_nb_occurences[k] the number of time
57      the example k was sampled, and in sample_responses[k] the
58      consistent response so that the overall loss remains the same. If
59      allow_duplicates is set to 1, all samples will have an identical
60      response (i.e. weight), but some may have more than one
61      occurence. On the contrary, if allow_duplicates is 0, samples
62      will all have only one occurence (or zero) but the responses may
63      vary to account for the multiple sampling. */
64
65   void subsample(int nb, scalar_t *labels, scalar_t *responses,
66                  int nb_to_sample, int *sample_nb_occurences, scalar_t *sample_responses,
67                  int allow_duplicates);
68 };
69
70 #endif