rpms.h

Go to the documentation of this file.

/*

Copyright (c) 2003, Cornell University
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

   - Redistributions of source code must retain the above copyright notice,
       this list of conditions and the following disclaimer.
   - Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
   - Neither the name of Cornell University nor the names of its
       contributors may be used to endorse or promote products derived from
       this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.

*/

// -*- C++ -*-
#ifndef _RPMS_H
#define _RPMS_H

#include "consumer.h"
#include <math.h>

namespace CLUS
{

class RPMSConsumer: public DataConsumer
{

protected:
    double mse;
    double mae;
    double ym;
    double y2m;
    int nrData;
    ofstream* out;
    string filename;
    int nrinputs;

    /// the inputspace+realvalue.
    /// input is the output from a machine
    Vector<double>* realinput;     
public:
    RPMSConsumer(int NrInputs, char* FileName=NULL, Vector<double>* Input=NULL,
                 Vector<double>* RealInput=NULL):
            DataConsumer(Input), out(NULL),
            filename(FileName),nrinputs(NrInputs),realinput(RealInput)
    {}
    
    inline void SetRealInput(Vector<double>* RealInput)
    {
        // the realinput must be set after input is seted
        realinput=RealInput;
        ExitIf( (nrinputs+input->dim()!=realinput->dim()) && (nrinputs!=realinput->dim()),
                "Wrong dimensions in RPMSConsumer");
    }
    
    inline void SetFileName(char* FileName)
    {
        filename=FileName;
    }
    
    virtual bool Tick(void)
    {
        // print the reasult
        for(int i=0; i<nrinputs; i++)
            (*out) << (*realinput)[i] << " ";
            
        (*out) << "     ";
        
        for(int i=0; i<input->dim(); i++)
            (*out) << (*input)[i] << " ";
            
        (*out) << endl;
        if (realinput->dim()>nrinputs)
        {
            // we can compute rpms
            for(int i=0; i<input->dim(); i++)
            {
                mse+=pow2((*input)[i]-(*realinput)[i+nrinputs]);
                mae+=fabs((*input)[i]-(*realinput)[i+nrinputs]);
                ym+=(*realinput)[i+nrinputs];
                y2m+=pow2( (*realinput)[i+nrinputs] );
            }
            nrData+=input->dim();
        }
        return true;
    }
    
    virtual void Start(void)
    {
        mse=0.0;
        mae=0.0;
        ym=0;
        y2m=0;
        nrData=0;
        out = new ofstream(filename.c_str());
#ifdef HAS_FORM

        out->form("# %10d %4d\n",0,input->dim());
#else

        char str[100];
        sprintf(str,"# %10d %4d\n",0,input->dim());
        (*out) << str;
#endif

    }
    
    virtual void Stop(void)
    {
        if (nrData!=0)
        {
            mse=mse/nrData;
            mae=mae/nrData;
            ym=ym/nrData;
            y2m=y2m/nrData;
        }
        out->seekp(0);
#ifdef HAS_FORM

        out->form("# %10d %4d\n",nrData/input->dim(),nrinputs+input->dim());
#else

        char str[100];
        sprintf(str,"# %10d %4d\n",nrData/input->dim(),nrinputs+input->dim());
        (*out) << str;
#endif

        delete out;
    }
    
    double GetRMSE(void)
    {
        return sqrt(mse);
    }
    
    double GetMSE(void)
    {
        return mse;
    }
    
    double GetNRMSE(void)
    {
        return GetRMSE()/sqrt(y2m-pow2(ym));
    }
    
    double GetMAE(void)
    {
        return mae;
    }
};
}

#endif // _RPMS_H

---