OptionBase.h

Go to the documentation of this file.

// -*- C++ -*-4 1999/10/29 20:41:34 dugas

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio and University of Montreal
// Copyright (C) 2002 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: OptionBase.h,v 1.8 2004/07/21 16:30:50 chrish42 Exp $
   * This file is part of the PLearn library.
   ******************************************************* */


#ifndef OptionBase_INC
#define OptionBase_INC

#include <plearn/io/pl_io.h>
#include "PP.h"
#include <plearn/io/PStream.h>        
#include <plearn/io/PStream_util.h>   
#include <vector>

namespace PLearn {
using namespace std;

// Predeclaration of Object
class Object;

class OptionBase: public PPointable
{
public:
  typedef unsigned int flag_t; // bit field

  static const flag_t buildoption;       

  static const flag_t learntoption;

  static const flag_t tuningoption;

  static const flag_t nosave; 

protected:
  string optionname_;  // the name of the option
  flag_t flags_; 
  string optiontype_;  // the datatype of the option ("int" ...)
  string defaultval_;  // string representation of the default value (will be printed by optionHelp())
  string description_; // A description of this option

public:

  OptionBase(const string& optionname, flag_t flags,
             const string& optiontype, const string& defaultval, 
             const string& description)
    :optionname_(optionname), flags_(flags), 
    optiontype_(optiontype), defaultval_(defaultval),
    description_(description) {}

  virtual void read(Object* o, PStream& in) const = 0;

  virtual bool shouldBeSkipped() const; 

  virtual void read_and_discard(PStream& in) const = 0;
  virtual void write(const Object* o, PStream& out) const = 0;

  // writes the option into a string instead of a stream
  // (calls write on a string stream) 
  string writeIntoString(const Object* o) const;
  
  virtual Object* getAsObject(Object* o) const = 0;
  virtual const Object* getAsObject(const Object* o) const = 0;
  virtual Object *getIndexedObject(Object *o, int i) const = 0;
  virtual const Object *getIndexedObject(const Object *o, int i) const = 0;    
  
  virtual string optionHolderClassName(const Object* o) const = 0;

  inline const string& optionname() const { return optionname_; }
  inline bool isOptionNamed(string name) const { return name == optionname(); }
  
  inline const string& optiontype() const { return optiontype_; }
  inline const string& defaultval() const { return defaultval_; }
  inline const string& description() const { return description_; }
  inline flag_t flags() const { return flags_; }

  inline void setDefaultVal(const string& newdefaultval)
  { defaultval_ = newdefaultval; }
};

typedef vector< PP<OptionBase> > OptionList;



} // end of namespace PLearn

#endif 

---