Experiment.h

Go to the documentation of this file.

// -*- C++ -*-

// Experiment.h
// 
// Copyright (C) 2002 Pascal Vincent, Frederic Morin
// 
// 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: Experiment.h,v 1.8 2004/07/21 16:30:57 chrish42 Exp $ 
   ******************************************************* */

#ifndef Experiment_INC
#define Experiment_INC

#include <plearn/base/Object.h>
#include <plearn_learners/generic/Learner.h>
#include <plearn/vmat/VMat.h>
#include <plearn/vmat/Splitter.h>

namespace PLearn {
using namespace std;

class Experiment: public Object
{    
public:

  typedef Object inherited;

  // ************************
  // * public build options *
  // ************************
  
  // See declareOptions method in .cc for the role of these options.

  string expdir;  
  PP<Learner> learner;
  VMat dataset;
  PP<Splitter> splitter;
  bool save_models;
  bool save_initial_models;
  bool save_test_outputs;
  bool save_test_costs;

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

  // Default constructor
  Experiment();


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

private: 
  // (Please implement in .cc)
  void build_();

protected: 
  // (Please implement in .cc)
  static void declareOptions(OptionList& ol);

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

  PLEARN_DECLARE_OBJECT(Experiment);

  virtual void run();

};

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

#endif

---