ConditionalStatsCollector.h

Go to the documentation of this file.

// -*- C++ -*-

// ConditionalStatsCollector.h
//
// Copyright (C) 2003 Pascal Vincent 
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. 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.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS 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.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org

/* *******************************************************      
   * $Id: ConditionalStatsCollector.h,v 1.6 2004/07/21 16:30:53 chrish42 Exp $ 
   ******************************************************* */

// Authors: Pascal Vincent

#ifndef ConditionalStatsCollector_INC
#define ConditionalStatsCollector_INC

#include <plearn/base/Object.h>
#include "TMat.h"
#include <plearn/base/RealMapping.h>

namespace PLearn {
using namespace std;

class ConditionalStatsCollector: public Object
{
public:
  typedef Object inherited;

protected:
  // *********************
  // * protected options *
  // *********************

  // ### declare protected option fields (such as learnt parameters) here
  // ...
    
public:

  // ************************
  // * options *
  // ************************

    int condvar; 

    TVec<RealMapping> ranges; 

    TVec< TMat<double> > counts;

    TVec< TMat<double> > sums; 

    TVec< TMat<double> > sums_condvar; 

    TVec< TMat<double> > sumsquares;

    TVec< TMat<double> > sumsquares_condvar;

    TVec< TMat<double> > minima; 

    TVec< TMat<double> > minima_condvar; 

    TVec< TMat<double> > maxima; 

    TVec< TMat<double> > maxima_condvar; 

  // ****************
  // * Methods
  // ****************

public:

  // Default constructor, make sure the implementation in the .cc
  // initializes all fields to reasonable default values.
  ConditionalStatsCollector();

  void setBinMappingsAndCondvar(const TVec<RealMapping>& the_ranges, int the_condvar);

  void forget();

  void update(const Vec& v, real weight = 1.0);

protected:
    int findrange(int varindex, real val) const;

  // ******************
  // * Object methods *
  // ******************

private: 
  // (PLEASE IMPLEMENT IN .cc)
  void build_();

protected: 
  // (PLEASE IMPLEMENT IN .cc)
  static void declareOptions(OptionList& ol);

public:
  // Declares other standard object methods
  //  If your class is not instantiatable (it has pure virtual methods)
  // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 
  PLEARN_DECLARE_OBJECT(ConditionalStatsCollector);

  // simply calls inherited::build() then build_() 
  virtual void build();

  // (PLEASE IMPLEMENT IN .cc)
  virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);

};

// Declares a few other classes and functions related to this class
  DECLARE_OBJECT_PTR(ConditionalStatsCollector);
  
} // end of namespace PLearn

#endif

---