AddCostToLearner.h

Go to the documentation of this file.

// -*- C++ -*-

// AddCostToLearner.h
//
// Copyright (C) 2004 Olivier Delalleau 
// 
// 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: AddCostToLearner.h,v 1.6 2004/07/21 20:25:38 tihocan Exp $ 
   ******************************************************* */

// Authors: Olivier Delalleau

#ifndef AddCostToLearner_INC
#define AddCostToLearner_INC

#include "PLearner.h"
#include <plearn/var/Var.h>

namespace PLearn {
using namespace std;

class AddCostToLearner: public PLearner
{

private:

  typedef PLearner inherited;

  mutable Vec combined_output;
  
protected:

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

  // Fields below are not options.

  mutable Mat bag_outputs;

  mutable int bag_size;
    
  mutable VarArray cross_entropy_prop;
  
  Var cross_entropy_var;
  
  Vec desired_target;

  real fac;

  real output_max;
  real output_min;

  Var output_var;
  
  Vec sub_learner_output;

  mutable Vec sub_input;

  Var target_var;

public:

  // ************************
  // * public build options *
  // ************************

  bool check_output_consistency;
  int combine_bag_outputs_method;
  bool compute_costs_on_bags;
  TVec<string> costs;
  bool force_output_to_target_interval;
  real from_max;
  real from_min;
  bool rescale_output;
  bool rescale_target;
  PP<PLearner> sub_learner;
  real to_max;
  real to_min;

  // ****************
  // * Constructors *
  // ****************

  AddCostToLearner();

  // ******************
  // * PLearner methods *
  // ******************

private: 

  void build_();

protected: 

  static void declareOptions(OptionList& ol);

public:

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

  virtual void build();

  virtual void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);

  // Declares other standard object methods.
  PLEARN_DECLARE_OBJECT(AddCostToLearner);


  // **************************
  // **** PLearner methods ****
  // **************************

  virtual int outputsize() const;

  virtual void forget();

  virtual void train();

  virtual void computeOutput(const Vec& input, Vec& output) const;

  virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
                                       const Vec& target, Vec& costs) const;

  virtual TVec<string> getTestCostNames() const;

  virtual TVec<string> getTrainCostNames() const;

  virtual void setExperimentDirectory(const string& the_expdir) {
    sub_learner->setExperimentDirectory(the_expdir);
  }
  virtual void setTrainingSet(VMat training_set, bool call_forget=true);
  virtual void setTrainStatsCollector(PP<VecStatsCollector> statscol) {
    sub_learner->setTrainStatsCollector(statscol);
  }

};

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

#endif

---