File: Measurer.h

package info (click to toggle)
torch 2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 5,488 kB
  • ctags: 3,217
  • sloc: cpp: 14,272; makefile: 201
file content (95 lines) | stat: -rw-r--r-- 2,571 bytes parent folder | download
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
// Copyright (C) 2002 Ronan Collobert (collober@iro.umontreal.ca)
//                
//
// This file is part of Torch. Release II.
// [The Ultimate Machine Learning Library]
//
// Torch is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Torch is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Torch; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#ifndef MEASURER_INC
#define MEASURER_INC

#include "Object.h"

namespace Torch {

class Machine;
class DataSet;

/** Used to measure what you want during training/testing.
    Usually, trainers call measurers.
    The #DataSet# associated to the measurer allow us
    to know when the measurer should be called.
    (if the #DataSet# is the train dataset, the
    measurer will be called during the train phase...)

    @author Ronan Collobert (collober@iro.umontreal.ca)
*/
class Measurer : public Object
{
  public:

    /** The measurer put here what it measures.
        As it could be everything, you should
        know what's inside before using it.
    */
    void *measure;

    /// The measurer save measures in this file.
    FILE *file;

    // -- internal --
    bool file_is_opened;

    /// The associated #DataSet#.
    DataSet *data;

    //-----

    /** Measurer with the associated #DataSet# #data_#,
        and put results in the file #file_#.
    */
    Measurer(DataSet *data_, FILE *file_);

    /** Open the file #filename# for writing measures.        
        #data_# is the associated #DataSet#.
    */
    Measurer(DataSet *data_, const char *filename);

    /** Measure something for the current example.
        (This example has been selected in #data#
         by the trainer)
    */
    virtual void measureEx();

    /** Measure something after the current iteration.
        (After the call of #measureEx()# for each
        example of #data#)
    */
    virtual void measureIter();

    /// Measure something at the end of the training/testing phase.
    virtual void measureEnd();

    //-----

    virtual void reset();
    virtual ~Measurer();
};


}

#endif