PLearn 0.1
|
Base class for option definitions. More...
#include <OptionBase.h>
Public Types | |
typedef unsigned int | flag_t |
The flags in the following list are bitwise-ORed to obtain the option flags. | |
typedef unsigned int | OptionLevel |
OptionLevel: How advanced (complicated, seldom used) is this option? Used to hide options from help text as needed, to ease readability for a basic, normal, advanced or experimental level of use. | |
typedef map< string, OptionLevel > | StrToLevelMap |
typedef map< OptionLevel, string > | LevelToStrMap |
typedef map< string, flag_t > | StrToFlagMap |
typedef map< flag_t, string > | FlagToStrMap |
Public Member Functions | |
OptionBase (const string &optionname, flag_t flags, const string &optiontype, const string &defaultval, const string &description, const OptionLevel &level) | |
Most of these parameters only serve to provide the user with an informative help text. | |
virtual void | read (Object *o, PStream &in) const =0 |
Read the option into the specified object from the input stream. | |
virtual void | write (const Object *o, PStream &out) const =0 |
Write the option from the specified object to the output stream. | |
string | writeIntoString (const Object *o) const |
Writes the option into a string instead of a stream (calls write on a string stream); return the string. | |
virtual void | readIntoIndex (Object *o, PStream &in, const string &index) |
Read into index "i" of the object's option; the index is a string for generality (i.e. | |
virtual void | writeAtIndex (const Object *o, PStream &out, const string &index) const |
Write from index "i" of the object's option; the index is a string for generality (i.e. | |
virtual Object * | getAsObject (Object *o) const =0 |
Return as an Object* the option within the specified object; it's an error to call this function if the option does not refer to an Object&, Object* or PP<Object>. | |
virtual const Object * | getAsObject (const Object *o) const =0 |
Return as an Object* the option within the specified object; it's an error to call this function if the option does not refer to an Object&, Object* or PP<Object>. | |
virtual Object * | getIndexedObject (Object *o, int i) const =0 |
Return as an Object* the i-th item option, which must be either a TVec or an Array. | |
virtual const Object * | getIndexedObject (const Object *o, int i) const =0 |
Return as an Object* the i-th item option, which must be either a TVec or an Array. | |
virtual void * | getAsVoidPtr (Object *o) const =0 |
Return the option contained in the specified object as a raw void*. | |
virtual const void * | getAsVoidPtr (const Object *o) const =0 |
Return the option contained in the specified object as a raw void*. | |
virtual bool | shouldBeSkipped () const |
Should this option be skipped upon reading it? (i.e. | |
virtual string | optionHolderClassName (const Object *o) const =0 |
Returns the name of the class in to which this option belongs. | |
const string & | optionname () const |
The name of the option (field) | |
bool | isOptionNamed (string name) const |
Test the option name. | |
void | setOptionName (const string &name) |
Set option name. | |
const string & | optiontype () const |
Option type accessor. | |
const string & | defaultval () const |
Default value accessor. | |
const OptionLevel & | level () const |
Option level accessor. | |
string | levelString () const |
Option level as a string. | |
void | setDefaultVal (const string &newdefaultval) |
Change the string representation of the default value. | |
const string & | description () const |
Description accessor. | |
flag_t | flags () const |
Flags accessor. | |
vector< string > | flagStrings () const |
Human-readable accessor of flags. | |
virtual bool | isAccessibleAsObject () const =0 |
Return true if the option can be obtained as an Object* (i.e. | |
virtual int | indexableSize (const Object *o) const =0 |
Return the size of the indexable option, IF it is indexable. | |
virtual int | diff (const string &refer, const string &other, PLearnDiff *diffs) const =0 |
Comparison between two option values. | |
Static Public Member Functions | |
static const OptionLevel & | getCurrentOptionLevel () |
get the current option level for help text | |
static void | setCurrentOptionLevel (const OptionLevel &l) |
set the current option level for help text | |
static const StrToLevelMap & | getStrToLevelMap () |
Get map (name->level) of all option levels. | |
static const LevelToStrMap & | getLevelToStrMap () |
Get map (level->) of all option levels. | |
static OptionLevel | optionLevelFromString (const string &s) |
convert string to OptionLevel | |
static string | optionLevelToString (const OptionLevel &l) |
convert OptionLevel to string | |
static const flag_t & | getCurrentFlags () |
get the current option level for help text | |
static void | setCurrentFlags (const flag_t &f) |
set the current option level for help text | |
static const StrToFlagMap & | getStrToFlagMap () |
Get map (name->flag) of all possible flags. | |
static const FlagToStrMap & | getFlagToStrMap () |
Get map (flag->name) of all possible flags. | |
Static Public Attributes | |
static const flag_t | buildoption = 1 |
'buildoption': an option typically specified before calling the initial build (semantically similar to a constructor parameter), for instance the number of hidden units in a neural net. | |
static const flag_t | learntoption = 1 << 1 |
'learntoption': an option whose proper value is computed by the class after construction (not to be set by the user before build) and potentially complex operations such as learning over a training set. | |
static const flag_t | tuningoption = 1 << 2 |
'tuningoption': an option typically set after the initial build, to tune the object | |
static const flag_t | nosave = 1 << 3 |
'nosave': when set, this flag requests the option not to be saved in the object serialisation; mostly used when we must have several options that map to the same physical data field, for script backward compatibility. | |
static const flag_t | nonparentable = 1 << 4 |
When this flag is set, the option does not lead to a parenting relationship in the "ParentableObject" sense. | |
static const flag_t | nontraversable = 1 << 5 |
When this flag is set, the option is not traversed by the ObjectGraphIterator class (and ipso facto by related functions, such as memfun_broadcast. | |
static const flag_t | remotetransmit = 1 << 6 |
When this flag is set, the option is transmitted between servers and clients, even if the nosave flag is also set. | |
static const OptionLevel | basic_level = 200 |
mandatory options | |
static const OptionLevel | advanced_level = 400 |
useful but seldom used | |
static const OptionLevel | expert_level = 800 |
more than advanced, not experimental | |
static const OptionLevel | experimental_level = 9999 |
only a few people understand those | |
static const OptionLevel | deprecated_level = 99999999 |
should not be used anymore | |
static const OptionLevel | default_level = OptionBase::basic_level |
default for options w/o explicit level | |
Protected Attributes | |
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. | |
OptionLevel | level_ |
Option level (low=basic, high=advanced) | |
Static Protected Attributes | |
static OptionLevel | current_option_level_ = OptionBase::default_level |
static StrToLevelMap | str_to_level |
init. | |
static LevelToStrMap | level_to_str |
init. | |
static flag_t | current_flags_ |
to toggle display of options by option flags | |
static StrToFlagMap | str_to_flag |
init. | |
static FlagToStrMap | flag_to_str |
init. |
Base class for option definitions.
Definition at line 68 of file OptionBase.h.
typedef unsigned int PLearn::OptionBase::flag_t |
The flags in the following list are bitwise-ORed to obtain the option flags.
Definition at line 80 of file OptionBase.h.
typedef map<flag_t, string> PLearn::OptionBase::FlagToStrMap |
Definition at line 149 of file OptionBase.h.
typedef map<OptionLevel, string> PLearn::OptionBase::LevelToStrMap |
Definition at line 147 of file OptionBase.h.
typedef unsigned int PLearn::OptionBase::OptionLevel |
OptionLevel: How advanced (complicated, seldom used) is this option? Used to hide options from help text as needed, to ease readability for a basic, normal, advanced or experimental level of use.
Definition at line 138 of file OptionBase.h.
typedef map<string, flag_t> PLearn::OptionBase::StrToFlagMap |
Definition at line 148 of file OptionBase.h.
typedef map<string, OptionLevel> PLearn::OptionBase::StrToLevelMap |
Definition at line 146 of file OptionBase.h.
PLearn::OptionBase::OptionBase | ( | const string & | optionname, |
flag_t | flags, | ||
const string & | optiontype, | ||
const string & | defaultval, | ||
const string & | description, | ||
const OptionLevel & | level | ||
) |
Most of these parameters only serve to provide the user with an informative help text.
(only optionname and flags are really important)
Definition at line 75 of file OptionBase.cc.
References PLERROR.
: optionname_(optionname), flags_(flags), optiontype_(optiontype), defaultval_(defaultval), description_(description), level_(level) { /* if(defaultval_ != "") PLERROR("DEFAULT VAL: '%s'", defaultval_.c_str()); */ if (optionname.size() > 0 && optionname[0] == '_' ) PLERROR("OptionBase::OptionBase: options should not start with an underscore: '%s'", optionname.c_str()); }
const string& PLearn::OptionBase::defaultval | ( | ) | const [inline] |
Default value accessor.
Definition at line 261 of file OptionBase.h.
References defaultval_.
{ return defaultval_; }
const string& PLearn::OptionBase::description | ( | ) | const [inline] |
Description accessor.
Definition at line 273 of file OptionBase.h.
References description_.
{ return description_; }
virtual int PLearn::OptionBase::diff | ( | const string & | refer, |
const string & | other, | ||
PLearnDiff * | diffs | ||
) | const [pure virtual] |
Comparison between two option values.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
flag_t PLearn::OptionBase::flags | ( | ) | const [inline] |
Flags accessor.
Definition at line 276 of file OptionBase.h.
References flags_.
Referenced by flagStrings(), and shouldBeSkipped().
{ return flags_; }
vector< string > PLearn::OptionBase::flagStrings | ( | ) | const |
Human-readable accessor of flags.
Definition at line 149 of file OptionBase.cc.
References flags(), getFlagToStrMap(), optionname(), optiontype(), and PLERROR.
{ flag_t curflags = flags(); vector<string> fs; const FlagToStrMap& flag_map= getFlagToStrMap(); for (FlagToStrMap::const_iterator it = flag_map.begin(), end = flag_map.end() ; it != end ; ++it) { // As we process each option, turn it off in temporary copy of flags to // detect unprocessed flags if (curflags & it->first) { fs.push_back(it->second); curflags &= ~it->first; } } if (curflags) PLERROR("OptionBase::flagStrings: unprocessed flags in option '%s' (%s);\n" "cannot interpret remaining bits %d", optionname().c_str(), optiontype().c_str(), curflags); return fs; }
Return as an Object* the option within the specified object; it's an error to call this function if the option does not refer to an Object&, Object* or PP<Object>.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
Return as an Object* the option within the specified object; it's an error to call this function if the option does not refer to an Object&, Object* or PP<Object>.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
virtual void* PLearn::OptionBase::getAsVoidPtr | ( | Object * | o | ) | const [pure virtual] |
Return the option contained in the specified object as a raw void*.
Can be used with the optiontype() accessor to cast to an appropriate type. Should be used sparingly and only when absolutely necessary.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
virtual const void* PLearn::OptionBase::getAsVoidPtr | ( | const Object * | o | ) | const [pure virtual] |
Return the option contained in the specified object as a raw void*.
Can be used with the optiontype() accessor to cast to an appropriate type. Should be used sparingly and only when absolutely necessary.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
static const flag_t& PLearn::OptionBase::getCurrentFlags | ( | ) | [inline, static] |
get the current option level for help text
Definition at line 318 of file OptionBase.h.
References current_flags_.
Referenced by PLearn::HTMLHelpCommand::helpOnClass(), and PLearn::Plide::toggleOptionFlag().
{ return current_flags_; }
static const OptionLevel& PLearn::OptionBase::getCurrentOptionLevel | ( | ) | [inline, static] |
get the current option level for help text
Definition at line 305 of file OptionBase.h.
References current_option_level_.
Referenced by PLearn::HTMLHelpCommand::flagsAndLevelHeading(), PLearn::HTMLHelpCommand::helpClasses(), PLearn::HelpSystem::helpClassOptions(), PLearn::HelpSystem::helpClassOptionsHTML(), PLearn::HTMLHelpCommand::helpOnClass(), PLearn::HelpSystem::helpOnOption(), PLearn::HTMLUtils::highlight_known_classes(), PLearn::HTMLHelpCommand::highlight_known_classes(), and PLearn::HTMLUtils::make_http_hyperlinks().
{ return current_option_level_; }
const OptionBase::FlagToStrMap & PLearn::OptionBase::getFlagToStrMap | ( | ) | [static] |
Get map (flag->name) of all possible flags.
Definition at line 135 of file OptionBase.cc.
References buildoption, flag_to_str, learntoption, nonparentable, nontraversable, nosave, remotetransmit, and tuningoption.
Referenced by flagStrings(), and getStrToFlagMap().
{ if (flag_to_str.size() == 0) { flag_to_str[buildoption ] = "buildoption"; flag_to_str[learntoption ] = "learntoption"; flag_to_str[tuningoption ] = "tuningoption"; flag_to_str[nosave ] = "nosave"; flag_to_str[nonparentable ] = "nonparentable"; flag_to_str[nontraversable] = "nontraversable"; flag_to_str[remotetransmit] = "remotetransmit"; } return flag_to_str; }
virtual const Object* PLearn::OptionBase::getIndexedObject | ( | const Object * | o, |
int | i | ||
) | const [pure virtual] |
Return as an Object* the i-th item option, which must be either a TVec or an Array.
It's an error to call this function if the indexed item does not refer to an Object* or PP<Object>.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
Return as an Object* the i-th item option, which must be either a TVec or an Array.
It's an error to call this function if the indexed item does not refer to an Object* or PP<Object>.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
const OptionBase::LevelToStrMap & PLearn::OptionBase::getLevelToStrMap | ( | ) | [static] |
Get map (level->) of all option levels.
Definition at line 199 of file OptionBase.cc.
References getStrToLevelMap(), level_to_str, and str_to_level.
Referenced by PLearn::HTMLHelpCommand::flagsAndLevelHeading(), and optionLevelToString().
{ if(level_to_str.size() == 0) { getStrToLevelMap();//make sure it is filled for(StrToLevelMap::iterator it= str_to_level.begin(); it != str_to_level.end(); ++it) level_to_str[it->second]= it->first; } return level_to_str; }
const OptionBase::StrToFlagMap & PLearn::OptionBase::getStrToFlagMap | ( | ) | [static] |
Get map (name->flag) of all possible flags.
Definition at line 122 of file OptionBase.cc.
References flag_to_str, getFlagToStrMap(), and str_to_flag.
{ if(str_to_flag.size() == 0) { getFlagToStrMap();//make sure it is filled for(FlagToStrMap::iterator it= flag_to_str.begin(); it != flag_to_str.end(); ++it) str_to_flag[it->second]= it->first; } return str_to_flag; }
const OptionBase::StrToLevelMap & PLearn::OptionBase::getStrToLevelMap | ( | ) | [static] |
Get map (name->level) of all option levels.
Definition at line 177 of file OptionBase.cc.
References advanced_level, basic_level, deprecated_level, experimental_level, expert_level, and str_to_level.
Referenced by getLevelToStrMap(), and optionLevelFromString().
{ if(str_to_level.size() == 0) { str_to_level["basic"]= basic_level; str_to_level["advanced"]= advanced_level; str_to_level["expert"]= expert_level; str_to_level["experimental"]= experimental_level; str_to_level["deprecated"]= deprecated_level; } return str_to_level; }
Return the size of the indexable option, IF it is indexable.
If not indexable, return 0. If indexable, this returns one more than the maximum permissible index in getIndexedObject()
or readIntoIndex()
or writeAtIndex()
.
o | The object containing the object |
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
virtual bool PLearn::OptionBase::isAccessibleAsObject | ( | ) | const [pure virtual] |
Return true if the option can be obtained as an Object*
(i.e.
getAsObject()
succeeds) or can be indexed as an Object*
(i.e. getIndexedObject()
succeeds)
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
bool PLearn::OptionBase::isOptionNamed | ( | string | name | ) | const [inline] |
Test the option name.
One cannot use a 'const string&' because it is used by STL.
Definition at line 252 of file OptionBase.h.
References optionname().
{ return name == optionname(); }
const OptionLevel& PLearn::OptionBase::level | ( | ) | const [inline] |
Option level accessor.
Definition at line 264 of file OptionBase.h.
References level_.
Referenced by PLearn::diff(), and levelString().
{ return level_; }
string PLearn::OptionBase::levelString | ( | ) | const [inline] |
Option level as a string.
Definition at line 266 of file OptionBase.h.
References level(), and optionLevelToString().
{ return optionLevelToString(level()); }
virtual string PLearn::OptionBase::optionHolderClassName | ( | const Object * | o | ) | const [pure virtual] |
Returns the name of the class in to which this option belongs.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
OptionBase::OptionLevel PLearn::OptionBase::optionLevelFromString | ( | const string & | s | ) | [static] |
convert string to OptionLevel
Definition at line 190 of file OptionBase.cc.
References getStrToLevelMap(), PLearn::lowerstring(), return, str_to_level, and PLearn::toint().
Referenced by PLearn::HelpCommand::run().
{ getStrToLevelMap();//make sure it is filled StrToLevelMap::iterator it= str_to_level.find(lowerstring(s)); if(it != str_to_level.end()) return it->second; return (OptionLevel)toint(s); }
string PLearn::OptionBase::optionLevelToString | ( | const OptionLevel & | l | ) | [static] |
convert OptionLevel to string
Definition at line 211 of file OptionBase.cc.
References getLevelToStrMap(), level_to_str, and PLearn::tostring().
Referenced by PLearn::HelpSystem::helpClassOptions(), and levelString().
{ getLevelToStrMap();//make sure it is filled LevelToStrMap::iterator it= level_to_str.find(l); if(it != level_to_str.end()) return it->second; return tostring(l); }
const string& PLearn::OptionBase::optionname | ( | ) | const [inline] |
The name of the option (field)
Definition at line 248 of file OptionBase.h.
References optionname_.
Referenced by PLearn::diff(), flagStrings(), isOptionNamed(), readIntoIndex(), and writeAtIndex().
{ return optionname_; }
const string& PLearn::OptionBase::optiontype | ( | ) | const [inline] |
Option type accessor.
Definition at line 258 of file OptionBase.h.
References optiontype_.
Referenced by flagStrings(), readIntoIndex(), and writeAtIndex().
{ return optiontype_; }
Read the option into the specified object from the input stream.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
Read into index "i" of the object's option; the index is a string for generality (i.e.
applies to both vectors and maps)
Reimplemented in PLearn::TVecOption< ObjectType, VecElementType >, and PLearn::TVecStaticOption< VecElementType >.
Definition at line 108 of file OptionBase.cc.
References optionname(), optiontype(), and PLERROR.
{ PLERROR("OptionBase::readIntoIndex: indexed reads are not supported for option '%s' " "of type '%s'", optionname().c_str(), optiontype().c_str()); }
static void PLearn::OptionBase::setCurrentFlags | ( | const flag_t & | f | ) | [inline, static] |
set the current option level for help text
Definition at line 320 of file OptionBase.h.
References current_flags_.
Referenced by PLearn::Plide::toggleOptionFlag().
{ current_flags_= f; }
static void PLearn::OptionBase::setCurrentOptionLevel | ( | const OptionLevel & | l | ) | [inline, static] |
set the current option level for help text
Definition at line 307 of file OptionBase.h.
References current_option_level_.
Referenced by PLearn::HelpCommand::run(), PLearn::PLearnServer::setOptionLevel(), and PLearn::Plide::setOptionLevel().
{ current_option_level_= l; }
void PLearn::OptionBase::setDefaultVal | ( | const string & | newdefaultval | ) | [inline] |
Change the string representation of the default value.
Definition at line 269 of file OptionBase.h.
References defaultval_.
{ defaultval_ = newdefaultval; }
void PLearn::OptionBase::setOptionName | ( | const string & | name | ) | [inline] |
Set option name.
Definition at line 255 of file OptionBase.h.
References optionname_.
Referenced by PLearn::diff().
{ optionname_ = name; }
bool PLearn::OptionBase::shouldBeSkipped | ( | ) | const [virtual] |
Should this option be skipped upon reading it? (i.e.
don't read it in any variable)
Definition at line 92 of file OptionBase.cc.
References buildoption, flags(), learntoption, and tuningoption.
{ return (flags() & (buildoption | learntoption | tuningoption)) == 0; }
Write the option from the specified object to the output stream.
Implemented in PLearn::Option< T, Enclosing >, PLearn::StaticOption< OptionType >, PLearn::Option< size_t, self >, PLearn::Option< ObjectType, TVec< VecElementType > >, PLearn::Option< DeallocatorType, self >, and PLearn::StaticOption< TVec< VecElementType > >.
Referenced by writeIntoString().
void PLearn::OptionBase::writeAtIndex | ( | const Object * | o, |
PStream & | out, | ||
const string & | index | ||
) | const [virtual] |
Write from index "i" of the object's option; the index is a string for generality (i.e.
applies to both vectors and maps)
Reimplemented in PLearn::TVecOption< ObjectType, VecElementType >, and PLearn::TVecStaticOption< VecElementType >.
Definition at line 115 of file OptionBase.cc.
References optionname(), optiontype(), and PLERROR.
{ PLERROR("OptionBase::writeAtIndex: indexed writes are not supported for option '%s' " "of type '%s'", optionname().c_str(), optiontype().c_str()); }
string PLearn::OptionBase::writeIntoString | ( | const Object * | o | ) | const |
Writes the option into a string instead of a stream (calls write on a string stream); return the string.
Definition at line 98 of file OptionBase.cc.
References PLearn::PStream::flush(), PLearn::openString(), PLearn::PStream::plearn_ascii, and write().
{ string s; PStream out = openString(s, PStream::plearn_ascii, "w"); write(o, out); out.flush(); // May not be necessary ? return s; }
const OptionBase::OptionLevel PLearn::OptionBase::advanced_level = 400 [static] |
useful but seldom used
Definition at line 140 of file OptionBase.h.
Referenced by PLearn::BootstrapVMatrix::declareOptions(), PLearn::RBMModule::declareOptions(), PLearn::FractionSplitter::declareOptions(), PLearn::KFoldSplitter::declareOptions(), PLearn::RBMDiagonalMatrixConnection::declareOptions(), PLearn::OnlineLearningModule::declareOptions(), PLearn::NNet::declareOptions(), PLearn::RBMMatrixConnection::declareOptions(), and getStrToLevelMap().
const OptionBase::OptionLevel PLearn::OptionBase::basic_level = 200 [static] |
mandatory options
Definition at line 139 of file OptionBase.h.
Referenced by PLearn::BaggingLearner::declareOptions(), and getStrToLevelMap().
const OptionBase::flag_t PLearn::OptionBase::buildoption = 1 [static] |
'buildoption': an option typically specified before calling the initial build (semantically similar to a constructor parameter), for instance the number of hidden units in a neural net.
Definition at line 87 of file OptionBase.h.
Referenced by PLearn::YMDDatedVMatrix::declareOptions(), PLearn::WPLS::declareOptions(), PLearn::WordNetSenseDictionary::declareOptions(), PLearn::WordNetFeatureSet::declareOptions(), PLearn::WeightedQuadraticPolynomialKernel::declareOptions(), PLearn::WeightedDistance::declareOptions(), PLearn::WeightedCostFunction::declareOptions(), PLearn::VVMatrix::declareOptions(), PLearn::VVec::declareOptions(), PLearn::VPLProcessor::declareOptions(), PLearn::VPLPreprocessedLearner2::declareOptions(), PLearn::VPLPreprocessedLearner::declareOptions(), PLearn::VPLCombinedLearner::declareOptions(), PLearn::VMatrixFromDistribution::declareOptions(), PLearn::VMatrix::declareOptions(), PLearn::PreprocessingVMatrix::declareOptions(), PLearn::VMatLanguage::declareOptions(), PLearn::VMatKernel::declareOptions(), PLearn::ViewSplitterVMatrix::declareOptions(), PLearn::VecStatsCollector::declareOptions(), PLearn::VecExtendedVMatrix::declareOptions(), PLearn::VecElementVariable::declareOptions(), PLearn::VecDictionary::declareOptions(), PLearn::VBoundDBN2::declareOptions(), PLearn::VarUtilsTest::declareOptions(), PLearn::VariablesTest::declareOptions(), PLearn::VariableSelectionWithDirectedGradientDescent::declareOptions(), PLearn::VariableDeletionVMatrix::declareOptions(), PLearn::ValueSelectRowsVMatrix::declareOptions(), PLearn::UniformVMatrix::declareOptions(), PLearn::UniformizeVMatrix::declareOptions(), PLearn::UniformizeLearner::declareOptions(), PLearn::UniformDistribution::declareOptions(), PLearn::UnfrozenDeepBeliefNet::declareOptions(), PLearn::UnfoldedSumOfVariable::declareOptions(), PLearn::UnfoldedFuncVariable::declareOptions(), PLearn::UnequalConstantVariable::declareOptions(), PLearn::UndirectedSoftmaxModule::declareOptions(), PLearn::UnconditionalDistribution::declareOptions(), PLearn::UnaryVariable::declareOptions(), PLearn::UnaryHardSlopeVariable::declareOptions(), PLearn::UCISpecification::declareOptions(), PLearn::UCIDataVMatrix::declareOptions(), PLearn::TruncatedRealFunction::declareOptions(), PLearn::TreeDBNModule::declareOptions(), PLearn::TransformOutputLearner::declareOptions(), PLearn::TransformationLearner::declareOptions(), PLearn::TrainValidTestSplitter::declareOptions(), PLearn::TrainTestSplitter::declareOptions(), PLearn::Train::declareOptions(), PLearn::TorchLearner::declareOptions(), PLearn::TopDownAsymetricDeepNetwork::declareOptions(), PLearn::ToBagSplitter::declareOptions(), PLearn::ToBagClassifier::declareOptions(), PLearn::TMatTest::declareOptions(), PLearn::TimesConstantVariable::declareOptions(), PLearn::ThresholdedKernel::declareOptions(), PLearn::ThresholdBpropVariable::declareOptions(), PLearn::TextStreamVMatrix::declareOptions(), PLearn::TextSenseSequenceVMatrix::declareOptions(), PLearn::TextFilesVMatrix::declareOptions(), PLearn::TestMethod::declareOptions(), PLearn::TestLearner::declareOptions(), PLearn::TestInTrainSplitter::declareOptions(), PLearn::TestingLearner::declareOptions(), PLearn::TestImputations::declareOptions(), PLearn::TemporalHorizonVMatrix::declareOptions(), PLearn::Template::declareOptions(), PLearn::TargetEncodingLearner::declareOptions(), PLearn::TanhModule::declareOptions(), PLearn::TangentLearner::declareOptions(), PLearn::SymbolNode::declareOptions(), PLearn::SVMClassificationTorch::declareOptions(), PLearn::SurfaceTemplateLearner::declareOptions(), PLearn::SurfaceMesh::declareOptions(), PLearn::SupervisedDBN::declareOptions(), PLearn::Supersampling2DModule::declareOptions(), PLearn::SumVarianceOfLinearTransformedCategoricals::declareOptions(), PLearn::SumOverBagsVariable::declareOptions(), PLearn::SumOfVariable::declareOptions(), PLearn::SummationKernel::declareOptions(), PLearn::SubVMatrix::declareOptions(), PLearn::SubsamplingDBN::declareOptions(), PLearn::Subsampling2DModule::declareOptions(), PLearn::SubsampleVariable::declareOptions(), PLearn::SubMatVariable::declareOptions(), PLearn::SubMatTransposeVariable::declareOptions(), PLearn::SubInputVMatrix::declareOptions(), PLearn::StructuralLearner::declareOptions(), PLearn::StochasticBinarizeVMatrix::declareOptions(), PLearn::StepwiseSelectionOracle::declareOptions(), PLearn::QuantilesStatsIterator::declareOptions(), PLearn::LiftStatsIterator::declareOptions(), PLearn::StatsCollector::declareOptions(), PLearn::StatefulLearner::declareOptions(), PLearn::StackedSVDNet::declareOptions(), PLearn::StackedSplitter::declareOptions(), PLearn::StackedModulesModule::declareOptions(), PLearn::StackedModulesLearner::declareOptions(), PLearn::StackedLearner::declareOptions(), PLearn::StackedFocusedAutoassociatorsNet::declareOptions(), PLearn::StackedAutoassociatorsNet::declareOptions(), PLearn::StabilisationLearner::declareOptions(), PLearn::SquaredErrorCostFunction::declareOptions(), PLearn::SplitWiseValidationVMatrix::declareOptions(), PLearn::SplitModule::declareOptions(), PLearn::SpiralDistribution::declareOptions(), PLearn::SpectralClustering::declareOptions(), PLearn::SparseIncrementalAffineTransformVariable::declareOptions(), PLearn::SourceVMatrixSplitter::declareOptions(), PLearn::SourceVMatrix::declareOptions(), PLearn::SourceVariable::declareOptions(), PLearn::SourceKernel::declareOptions(), PLearn::SortRowsVMatrix::declareOptions(), PLearn::SoftSlopeVariable::declareOptions(), PLearn::SoftSlopeIntegralVariable::declareOptions(), PLearn::SoftHistogramBinner::declareOptions(), PLearn::SigmoidPrimitiveKernel::declareOptions(), PLearn::SigmoidalKernel::declareOptions(), PLearn::ShuntingNNetLayerModule::declareOptions(), PLearn::ShuffleColumnsVMatrix::declareOptions(), PLearn::ShiftAndRescaleVMatrix::declareOptions(), PLearn::ShiftAndRescaleFeatureRealFunction::declareOptions(), PLearn::ShellScript::declareOptions(), PLearn::SetOption::declareOptions(), PLearn::SequentialValidation::declareOptions(), PLearn::SequentialSplitter::declareOptions(), PLearn::SequentialModelSelector::declareOptions(), PLearn::SequentialLearner::declareOptions(), PLearn::SeparateInputVMatrix::declareOptions(), PLearn::SemiSupervisedProbClassCostVariable::declareOptions(), PLearn::SemiSupervisedDBN::declareOptions(), PLearn::SelectSetsSplitter::declareOptions(), PLearn::SelectRowsVMatrix::declareOptions(), PLearn::SelectRowsMultiInstanceVMatrix::declareOptions(), PLearn::SelectRowsFileIndexVMatrix::declareOptions(), PLearn::SelectInputSubsetLearner::declareOptions(), PLearn::SelectedOutputCostFunction::declareOptions(), PLearn::SelectColumnsVMatrix::declareOptions(), PLearn::SecondIterationWrapper::declareOptions(), PLearn::ScoreLayerVariable::declareOptions(), PLearn::ScaleGradientModule::declareOptions(), PLearn::ScaledGeneralizedDistanceRBFKernel::declareOptions(), PLearn::ScaledGaussianKernel::declareOptions(), PLearn::ScaledConditionalCDFSmoother::declareOptions(), PLearn::SaltPepperNoiseVariable::declareOptions(), PLearn::RunObject::declareOptions(), PLearn::RPPath::declareOptions(), PLearn::RowsSubVMatrix::declareOptions(), PLearn::RowOfVariable::declareOptions(), PLearn::RowBufferedVMatrixTest::declareOptions(), PLearn::RowAtPositionVariable::declareOptions(), PLearn::ReshapeVariable::declareOptions(), PLearn::ReplicateSamplesVMatrix::declareOptions(), PLearn::RepeatVMatrix::declareOptions(), PLearn::RepeatSplitter::declareOptions(), PLearn::ReorderByMissingVMatrix::declareOptions(), PLearn::RemoveRowsVMatrix::declareOptions(), PLearn::RemoveDuplicateVMatrix::declareOptions(), PLearn::RemapLastColumnVMatrix::declareOptions(), PLearn::ReIndexedTargetVMatrix::declareOptions(), PLearn::ReIndexedTargetVariable::declareOptions(), PLearn::RegularGridVMatrix::declareOptions(), PLearn::RegressorFromDistribution::declareOptions(), PLearn::RegressionTreeRegisters::declareOptions(), PLearn::RegressionTreeQueue::declareOptions(), PLearn::RegressionTreeNode::declareOptions(), PLearn::RegressionTreeMulticlassLeaveProb::declareOptions(), PLearn::RegressionTreeMulticlassLeaveFast::declareOptions(), PLearn::RegressionTreeMulticlassLeave::declareOptions(), PLearn::RegressionTreeLeave::declareOptions(), PLearn::RegressionTree::declareOptions(), PLearn::Redirect::declareOptions(), PLearn::ReconstructionWeightsKernel::declareOptions(), PLearn::RealValueIndicatorFunction::declareOptions(), PLearn::RealRangeIndicatorFunction::declareOptions(), PLearn::RealMapping::declareOptions(), PLearn::RealFunctionsProcessedVMatrix::declareOptions(), PLearn::RealFunctionProduct::declareOptions(), PLearn::RealFunctionOfInputFeature::declareOptions(), PLearn::RealFunctionFromKernel::declareOptions(), PLearn::RealFunction::declareOptions(), PLearn::RBMWoodsLayer::declareOptions(), PLearn::RBMTrainer::declareOptions(), PLearn::RBMSparse1DMatrixConnection::declareOptions(), PLearn::RBMRateLayer::declareOptions(), PLearn::RBMParameters::declareOptions(), PLearn::RBMMultitaskClassificationModule::declareOptions(), PLearn::RBMModule::declareOptions(), PLearn::RBMMixedLayer::declareOptions(), PLearn::RBMMixedConnection::declareOptions(), PLearn::RBMMatrixTransposeConnection::declareOptions(), PLearn::RBMMatrixConnection::declareOptions(), PLearn::RBMLocalMultinomialLayer::declareOptions(), PLearn::RBMLLParameters::declareOptions(), PLearn::RBMLayer::declareOptions(), PLearn::RBMLateralBinomialLayer::declareOptions(), PLearn::RBMJointLLParameters::declareOptions(), PLearn::RBMJointGenericParameters::declareOptions(), PLearn::RBMDistribution::declareOptions(), PLearn::RBMDiagonalMatrixConnection::declareOptions(), PLearn::RBMConv2DLLParameters::declareOptions(), PLearn::RBMConv2DConnection::declareOptions(), PLearn::RBMConnection::declareOptions(), PLearn::RBMClassificationModule::declareOptions(), PLearn::RationalQuadraticARDKernel::declareOptions(), PLearn::RankingFromKernel::declareOptions(), PLearn::RankedVMatrix::declareOptions(), PLearn::RangeVMatrix::declareOptions(), PLearn::RandomSamplesVMatrix::declareOptions(), PLearn::RandomSamplesFromVMatrix::declareOptions(), PLearn::RandomNeighborsDifferencesVMatrix::declareOptions(), PLearn::RandomGaussMix::declareOptions(), PLearn::RandomForcedValuesVariable::declareOptions(), PLearn::QuadraticUtilityCostFunction::declareOptions(), PLearn::PythonTableVMatrix::declareOptions(), PLearn::PythonProcessedVMatrix::declareOptions(), PLearn::PythonProcessedLearner::declareOptions(), PLearn::PythonFeatureSet::declareOptions(), PLearn::PythonCodeSnippet::declareOptions(), PLearn::PyPLearnScript::declareOptions(), PLearn::PvGradNNet::declareOptions(), PLearn::PutSubVMatrix::declareOptions(), PLearn::PTimer::declareOptions(), PLearn::PTest::declareOptions(), PLearn::PseudolikelihoodRBM::declareOptions(), PLearn::PruningLinearRegressor::declareOptions(), PLearn::ProcessSymbolicSequenceVMatrix::declareOptions(), PLearn::ProcessInputCostModule::declareOptions(), PLearn::ProcessingVMatrix::declareOptions(), PLearn::ProcessDatasetVMatrix::declareOptions(), PLearn::ProbabilityPairsVariable::declareOptions(), PLearn::ProbabilityPairsInverseVariable::declareOptions(), PLearn::PricingTransactionPairProfitFunction::declareOptions(), PLearn::Preprocessing::declareOptions(), PLearn::PrecomputedVMatrix::declareOptions(), PLearn::PrecomputedProcessedLearner::declareOptions(), PLearn::PrecomputedKernel::declareOptions(), PLearn::PRandom::declareOptions(), PLearn::PowVariable::declareOptions(), PLearn::PowDistanceKernel::declareOptions(), PLearn::PotentialsVariable::declareOptions(), PLearn::PolynomialKernel::declareOptions(), PLearn::PlusConstantVariable::declareOptions(), PLearn::PLS::declareOptions(), PLearn::PLMathTest::declareOptions(), PLearn::PLearnerOutputVMatrix::declareOptions(), PLearn::PLearnerDiagonalKernel::declareOptions(), PLearn::PLearner::declareOptions(), PLearn::PLearnDiff::declareOptions(), PLearn::PTester::declareOptions(), PLearn::PDistributionVariable::declareOptions(), PLearn::PDistribution::declareOptions(), PLearn::PConditionalDistribution::declareOptions(), PLearn::PCA::declareOptions(), PLearn::ParzenWindow::declareOptions(), PLearn::PartSupervisedDBN::declareOptions(), PLearn::PartsDistanceKernel::declareOptions(), PLearn::PairsVMatrix::declareOptions(), PLearn::OracleObjectGenerator::declareOptions(), PLearn::Optimizer::declareOptions(), PLearn::OptimizeOptionOracle::declareOptions(), PLearn::OnlineLearningModule::declareOptions(), PLearn::OnlineGramNaturalGradientOptimizer::declareOptions(), PLearn::OneHotVMatrix::declareOptions(), PLearn::OneHotVariable::declareOptions(), PLearn::OneHotSquaredLoss::declareOptions(), PLearn::OnBagsModule::declareOptions(), PLearn::ObservationWindow::declareOptions(), PLearn::Z::declareOptions(), PLearn::X::declareOptions(), PLearn::ObjectGenerator::declareOptions(), PLearn::NxProfileLearner::declareOptions(), PLearn::NormalizedDotProductKernel::declareOptions(), PLearn::NormalizationLearner::declareOptions(), PLearn::NonLocalManifoldParzenKernel::declareOptions(), PLearn::NonLocalManifoldParzen::declareOptions(), PLearn::NoBpropVariable::declareOptions(), PLearn::NnlmWordRepresentationLayer::declareOptions(), PLearn::NnlmOutputLayer::declareOptions(), PLearn::NnlmOnlineLearner::declareOptions(), PLearn::NNet::declareOptions(), PLearn::NLLNeighborhoodWeightsVariable::declareOptions(), PLearn::NGramDistribution::declareOptions(), PLearn::NeuralProbabilisticLanguageModel::declareOptions(), PLearn::NeuralNet::declareOptions(), PLearn::NetworkModule::declareOptions(), PLearn::NetworkConnection::declareOptions(), PLearn::NetflixVMatrix::declareOptions(), PLearn::NeighborhoodSmoothnessNNet::declareOptions(), PLearn::NeighborhoodImputationVMatrix::declareOptions(), PLearn::NeighborhoodConditionalMean::declareOptions(), PLearn::NeighborhoodBoxVolumeDensityEstimator::declareOptions(), PLearn::NegLogProbCostFunction::declareOptions(), PLearn::NegKernel::declareOptions(), PLearn::NegCrossEntropySigmoidVariable::declareOptions(), PLearn::NearestNeighborPredictionCost::declareOptions(), PLearn::NatGradSMPNNet::declareOptions(), PLearn::NatGradNNet::declareOptions(), PLearn::NatGradEstimator::declareOptions(), PLearn::NaryVariable::declareOptions(), PLearn::MultiToUniInstanceSelectRandomVMatrix::declareOptions(), PLearn::MultiTaskSeparationSplitter::declareOptions(), PLearn::MultiTargetOneHotVMatrix::declareOptions(), PLearn::MultiSampleVariable::declareOptions(), PLearn::MultiMaxVariable::declareOptions(), PLearn::MultiInstanceVMatrix::declareOptions(), PLearn::MultiInstanceNNet::declareOptions(), PLearn::MultiClassAdaBoost::declareOptions(), PLearn::MovingAverageVMatrix::declareOptions(), PLearn::MovingAverage::declareOptions(), PLearn::MoleculeTemplateLearner::declareOptions(), PLearn::MoleculeTemplate::declareOptions(), PLearn::ModuleTester::declareOptions(), PLearn::ModuleStackModule::declareOptions(), PLearn::ModulesLearner::declareOptions(), PLearn::ModuleLearner::declareOptions(), PLearn::mNNet::declareOptions(), PLearn::MixUnlabeledNeighbourVMatrix::declareOptions(), PLearn::MixtureVMatrix::declareOptions(), PLearn::MixtureDistribution::declareOptions(), PLearn::MissingInstructionVMatrix::declareOptions(), PLearn::MissingIndicatorVMatrix::declareOptions(), PLearn::MeshVertex::declareOptions(), PLearn::MeshMatch::declareOptions(), PLearn::MeshGraph::declareOptions(), PLearn::MeshFace::declareOptions(), PLearn::MeshEdge::declareOptions(), PLearn::MergeDond2Files::declareOptions(), PLearn::MemoryVMatrixNoSave::declareOptions(), PLearn::MemoryVMatrix::declareOptions(), PLearn::MemoryStressTest::declareOptions(), PLearn::MemoryCachedKernel::declareOptions(), PLearn::MeanMedianModeImputationVMatrix::declareOptions(), PLearn::MeanImputationVMatrix::declareOptions(), PLearn::MaxSubsamplingTest::declareOptions(), PLearn::MaxSubsampling2DModule::declareOptions(), PLearn::MatRowVariable::declareOptions(), PLearn::MatrixSumOfVariable::declareOptions(), PLearn::MatrixOneHotSquaredLoss::declareOptions(), PLearn::MatrixModule::declareOptions(), PLearn::MatrixElementsVariable::declareOptions(), PLearn::Matern1ARDKernel::declareOptions(), PLearn::MarginPerceptronCostVariable::declareOptions(), PLearn::ManualBinner::declareOptions(), PLearn::ManifoldParzenKernel::declareOptions(), PLearn::ManifoldParzen2::declareOptions(), PLearn::ManifoldParzen::declareOptions(), PLearn::ManifoldKNNDistribution::declareOptions(), PLearn::LogOfGaussianDensityKernel::declareOptions(), PLearn::LogAddVariable::declareOptions(), PLearn::LocalNeighborsDifferencesVMatrix::declareOptions(), PLearn::LocalMedBoost::declareOptions(), PLearn::LocallyWeightedDistribution::declareOptions(), PLearn::LocallyPrecomputedVMatrix::declareOptions(), PLearn::LocallyMagnifiedDistribution::declareOptions(), PLearn::LocalizedFeaturesLayerVariable::declareOptions(), PLearn::LocalGaussianClassifier::declareOptions(), PLearn::LLEKernel::declareOptions(), PLearn::LLE::declareOptions(), PLearn::LLC::declareOptions(), PLearn::LinearRegressor::declareOptions(), PLearn::LinearInductiveTransferClassifier::declareOptions(), PLearn::LinearFilterModule::declareOptions(), PLearn::LinearCombinationOfScalarVariables::declareOptions(), PLearn::LinearCombinationModule::declareOptions(), PLearn::LiftStatsCollector::declareOptions(), PLearn::LiftBinaryCostFunction::declareOptions(), PLearn::LIBSVMSparseVMatrix::declareOptions(), PLearn::LemmatizeVMatrix::declareOptions(), PLearn::LearnerProcessedVMatrix::declareOptions(), PLearn::Learner::declareOptions(), PLearn::LayerCostModule::declareOptions(), PLearn::LaplacianKernel::declareOptions(), PLearn::KroneckerBaseKernel::declareOptions(), PLearn::KPCATangentLearner::declareOptions(), PLearn::KNNVMatrix::declareOptions(), PLearn::KNNRegressor::declareOptions(), PLearn::KNNImputationVMatrix::declareOptions(), PLearn::KNNClassifier::declareOptions(), PLearn::KMeansClustering::declareOptions(), PLearn::KLp0p1RBMModule::declareOptions(), PLearn::KFoldSplitter::declareOptions(), PLearn::KFoldLogisticClassifier::declareOptions(), PLearn::KernelVMatrix::declareOptions(), PLearn::KernelRidgeRegressor::declareOptions(), PLearn::KernelProjection::declareOptions(), PLearn::KernelPCA::declareOptions(), PLearn::KernelDensityEstimator::declareOptions(), PLearn::Kernel::declareOptions(), PLearn::JoinVMatrix::declareOptions(), PLearn::IsomapTangentLearner::declareOptions(), PLearn::Isomap::declareOptions(), PLearn::IsMissingVariable::declareOptions(), PLearn::IsAboveThresholdVariable::declareOptions(), PLearn::InterleaveVMatrix::declareOptions(), PLearn::InfiniteMNISTVMatrix::declareOptions(), PLearn::InferenceRBM::declareOptions(), PLearn::IndexedVMatrixTest::declareOptions(), PLearn::IndexedVMatrix::declareOptions(), PLearn::IndexAtPositionVariable::declareOptions(), PLearn::IncrementalNNet::declareOptions(), PLearn::ImputationVMatrix::declareOptions(), PLearn::IIDNoiseKernel::declareOptions(), PLearn::ICP::declareOptions(), PLearn::HyperSetOption::declareOptions(), PLearn::HyperRetrain::declareOptions(), PLearn::HyperOptimize::declareOptions(), PLearn::HyperLearner::declareOptions(), PLearn::HyperCommand::declareOptions(), PLearn::HTMLHelpGenerator::declareOptions(), PLearn::HTMLHelpConfig::declareOptions(), PLearn::HorizonStatefulLearner::declareOptions(), PLearn::HistogramDistribution::declareOptions(), PLearn::HintonDeepBeliefNet::declareOptions(), PLearn::HeterogenuousAffineTransformWeightPenalty::declareOptions(), PLearn::HeterogenuousAffineTransformVariable::declareOptions(), PLearn::HeapTest::declareOptions(), PLearn::HashMapFeatureSet::declareOptions(), PLearn::GraphicalBiText::declareOptions(), PLearn::Grapher::declareOptions(), PLearn::GramVMatrix::declareOptions(), PLearn::GradNNetLayerModule::declareOptions(), PLearn::GradientOptimizer::declareOptions(), PLearn::GeodesicDistanceKernel::declareOptions(), PLearn::GenericNearestNeighbors::declareOptions(), PLearn::GenerateDecisionPlot::declareOptions(), PLearn::GeneralizedOneHotVMatrix::declareOptions(), PLearn::GeneralizedDistanceRBFKernel::declareOptions(), PLearn::GaussPartSupervisedDBN::declareOptions(), PLearn::GaussMix::declareOptions(), PLearn::GaussianProcessRegressor::declareOptions(), PLearn::GaussianProcessNLLVariable::declareOptions(), PLearn::GaussianKernel::declareOptions(), PLearn::GaussianizeVMatrix::declareOptions(), PLearn::GaussianDistribution::declareOptions(), PLearn::GaussianDensityKernel::declareOptions(), PLearn::GaussianDBNRegression::declareOptions(), PLearn::GaussianDBNClassification::declareOptions(), PLearn::GaussianContinuumDistribution::declareOptions(), PLearn::GaussianContinuum::declareOptions(), PLearn::Function::declareOptions(), PLearn::FractionSplitter::declareOptions(), PLearn::ForwardVMatrix::declareOptions(), PLearn::ForwardModule::declareOptions(), PLearn::FNetLayerVariable::declareOptions(), PLearn::FixDond2BinaryVariables::declareOptions(), PLearn::FinancePreprocVMatrix::declareOptions(), PLearn::FilterSplitter::declareOptions(), PLearn::FilteredVMatrix::declareOptions(), PLearn::FileVMatrix::declareOptions(), PLearn::FileDictionary::declareOptions(), PLearn::FeatureSetSequentialCRF::declareOptions(), PLearn::FeatureSetNNet::declareOptions(), PLearn::FeatureSetNaiveBayesClassifier::declareOptions(), PLearn::ExtractNNetParamsVMatrix::declareOptions(), PLearn::ExtendedVMatrix::declareOptions(), PLearn::ExtendedVariable::declareOptions(), PLearn::ExplicitSplitter::declareOptions(), PLearn::ExplicitListOracle::declareOptions(), PLearn::Experimentation::declareOptions(), PLearn::Experiment::declareOptions(), PLearn::ExhaustiveNearestNeighbors::declareOptions(), PLearn::EqualConstantVariable::declareOptions(), PLearn::EpanechnikovKernel::declareOptions(), PLearn::EntropyContrastLearner::declareOptions(), PLearn::EntropyContrast::declareOptions(), PLearn::EncodedVMatrix::declareOptions(), PLearn::EmbeddedSequentialLearner::declareOptions(), PLearn::EmbeddedLearner::declareOptions(), PLearn::ElementAtPositionVariable::declareOptions(), PLearn::EarlyStoppingOracle::declareOptions(), PLearn::DynamicallyLinkedRBMsModel::declareOptions(), PLearn::DuplicateScalarVariable::declareOptions(), PLearn::DuplicateRowVariable::declareOptions(), PLearn::DuplicateColumnVariable::declareOptions(), PLearn::DTWKernel::declareOptions(), PLearn::DivisiveNormalizationKernel::declareOptions(), PLearn::DiverseComponentAnalysis::declareOptions(), PLearn::Distribution::declareOptions(), PLearn::DistRepNNet::declareOptions(), PLearn::DistanceKernel::declareOptions(), PLearn::DisregardRowsVMatrix::declareOptions(), PLearn::DiskVMatrix::declareOptions(), PLearn::DiscriminativeRBM::declareOptions(), PLearn::DiscriminativeDeepBeliefNet::declareOptions(), PLearn::DictionaryVMatrix::declareOptions(), PLearn::Dictionary::declareOptions(), PLearn::DichotomizeVMatrix::declareOptions(), PLearn::DichotomizeDond2DiscreteVariables::declareOptions(), PLearn::DenoisingRecurrentNet::declareOptions(), PLearn::DeepReconstructorNet::declareOptions(), PLearn::DeepNonLocalManifoldParzen::declareOptions(), PLearn::DeepNNet::declareOptions(), PLearn::DeepFeatureExtractorNNet::declareOptions(), PLearn::DeepBeliefNet::declareOptions(), PLearn::DBSplitter::declareOptions(), PLearn::DatedJoinVMatrix::declareOptions(), PLearn::CutBelowThresholdVariable::declareOptions(), PLearn::CutAboveThresholdVariable::declareOptions(), PLearn::CumVMatrix::declareOptions(), PLearn::CubicSpline::declareOptions(), PLearn::CrossReferenceVMatrix::declareOptions(), PLearn::CovariancePreservationImputationVMatrix::declareOptions(), PLearn::Cov2CorrVariable::declareOptions(), PLearn::CostModule::declareOptions(), PLearn::Correspondence::declareOptions(), PLearn::CorrelationProfiler::declareOptions(), PLearn::CorrelationKernel::declareOptions(), PLearn::Convolution2DModule::declareOptions(), PLearn::ConvexBasisKernel::declareOptions(), PLearn::Variable::declareOptions(), PLearn::ConstrainedSourceVariable::declareOptions(), PLearn::ConstantVMatrix::declareOptions(), PLearn::ConstantRegressor::declareOptions(), PLearn::ConstantRealFunction::declareOptions(), PLearn::ConjRosenbrock::declareOptions(), PLearn::ConjGradientOptimizer::declareOptions(), PLearn::ConditionalStatsCollector::declareOptions(), PLearn::ConditionalMeanImputationVMatrix::declareOptions(), PLearn::ConditionalGaussianDistribution::declareOptions(), PLearn::ConditionalDictionary::declareOptions(), PLearn::ConditionalDensityNet::declareOptions(), PLearn::ConditionalCDFSmoother::declareOptions(), PLearn::ConcatSetsSplitter::declareOptions(), PLearn::ConcatRowsVMatrix::declareOptions(), PLearn::ConcatRowsSubVMatrix::declareOptions(), PLearn::ConcatOfVariable::declareOptions(), PLearn::ConcatDisjointFeatureSet::declareOptions(), PLearn::ConcatColumnsVMatrix::declareOptions(), PLearn::ComputeDond2Target::declareOptions(), PLearn::CompareLearner::declareOptions(), PLearn::CompactVMatrixPolynomialKernel::declareOptions(), PLearn::CompactVMatrixGaussianKernel::declareOptions(), PLearn::CompactFileVMatrix::declareOptions(), PLearn::CombiningCostsModule::declareOptions(), PLearn::ClassSubsetVMatrix::declareOptions(), PLearn::ClassSeparationSplitter::declareOptions(), PLearn::ClassMarginCostFunction::declareOptions(), PLearn::ClassifierFromDensity::declareOptions(), PLearn::ClassifierFromConditionalPDistribution::declareOptions(), PLearn::ClassErrorCostModule::declareOptions(), PLearn::ClassErrorCostFunction::declareOptions(), PLearn::ChemicalICP::declareOptions(), PLearn::CheckDond2FileSequence::declareOptions(), PLearn::ChainedLearners::declareOptions(), PLearn::CCCostVariable::declareOptions(), PLearn::CartesianProductOracle::declareOptions(), PLearn::Calendar::declareOptions(), PLearn::CachedFeatureSet::declareOptions(), PLearn::BootstrapVMatrix::declareOptions(), PLearn::BootstrapSplitter::declareOptions(), PLearn::BinSplitter::declareOptions(), PLearn::BinaryVariable::declareOptions(), PLearn::BinaryStump::declareOptions(), PLearn::BinaryOpVMatrix::declareOptions(), PLearn::BinaryNumbersVMatrix::declareOptions(), PLearn::BinaryKernelDiscrimination::declareOptions(), PLearn::BinaryClassificationLossVariable::declareOptions(), PLearn::BinaryBallTree::declareOptions(), PLearn::BinarizeModule::declareOptions(), PLearn::BetaKernel::declareOptions(), PLearn::BestAveragingPLearner::declareOptions(), PLearn::BernoulliSampleVariable::declareOptions(), PLearn::BatchVMatrix::declareOptions(), PLearn::BasisSelectionRegressor::declareOptions(), PLearn::BaseRegressorWrapper::declareOptions(), PLearn::BaseRegressorConfidence::declareOptions(), PLearn::BallTreeNearestNeighbors::declareOptions(), PLearn::BaggingLearner::declareOptions(), PLearn::BackConvolution2DModule::declareOptions(), PLearn::AutoVMatrixSaveSource::declareOptions(), PLearn::AutoVMatrix::declareOptions(), PLearn::AutoScaledGradientOptimizer::declareOptions(), PLearn::AutoLinearRegressor::declareOptions(), PLearn::AsciiVMatrix::declareOptions(), PLearn::ARDBaseKernel::declareOptions(), PLearn::AppendNeighborsVMatrix::declareOptions(), PLearn::AnalyzeFieldStats::declareOptions(), PLearn::AnalyzeDond2DiscreteVariables::declareOptions(), PLearn::AffineTransformWeightPenalty::declareOptions(), PLearn::AffineTransformVariable::declareOptions(), PLearn::AddMissingVMatrix::declareOptions(), PLearn::AddLayersNNet::declareOptions(), PLearn::AdditiveNormalizationKernel::declareOptions(), PLearn::AdditiveGaussianNoiseVariable::declareOptions(), PLearn::AddCostToLearner::declareOptions(), PLearn::AddBagInformationVMatrix::declareOptions(), PLearn::AdaptGradientOptimizer::declareOptions(), PLearn::AdaBoost::declareOptions(), getFlagToStrMap(), PLearn::HelpSystem::helpClassOptionsHTML(), PLearn::HelpSystem::helpOnOption(), PLearn::HelpSystem::listBuildOptionsWithLevels(), PLearn::PTester::perform(), PLearn::Plide::precisOnClass(), and shouldBeSkipped().
OptionBase::flag_t PLearn::OptionBase::current_flags_ [static, protected] |
(OptionBase::buildoption | OptionBase::learntoption | OptionBase::tuningoption | OptionBase::nosave | OptionBase::nonparentable | OptionBase::nontraversable | OptionBase::remotetransmit)
to toggle display of options by option flags
Definition at line 156 of file OptionBase.h.
Referenced by getCurrentFlags(), and setCurrentFlags().
OptionBase::OptionLevel PLearn::OptionBase::current_option_level_ = OptionBase::default_level [static, protected] |
Definition at line 151 of file OptionBase.h.
Referenced by getCurrentOptionLevel(), and setCurrentOptionLevel().
default for options w/o explicit level
Definition at line 144 of file OptionBase.h.
string PLearn::OptionBase::defaultval_ [protected] |
string representation of the default value (will be printed by optionHelp())
Definition at line 164 of file OptionBase.h.
Referenced by defaultval(), and setDefaultVal().
const OptionBase::OptionLevel PLearn::OptionBase::deprecated_level = 99999999 [static] |
should not be used anymore
Definition at line 143 of file OptionBase.h.
Referenced by PLearn::BootstrapVMatrix::declareOptions(), PLearn::PLearner::declareOptions(), and getStrToLevelMap().
string PLearn::OptionBase::description_ [protected] |
A description of this option.
Definition at line 165 of file OptionBase.h.
Referenced by description().
const OptionBase::OptionLevel PLearn::OptionBase::experimental_level = 9999 [static] |
only a few people understand those
Definition at line 142 of file OptionBase.h.
Referenced by getStrToLevelMap().
const OptionBase::OptionLevel PLearn::OptionBase::expert_level = 800 [static] |
more than advanced, not experimental
Definition at line 141 of file OptionBase.h.
Referenced by getStrToLevelMap().
OptionBase::FlagToStrMap PLearn::OptionBase::flag_to_str [static, protected] |
init.
Definition at line 158 of file OptionBase.h.
Referenced by getFlagToStrMap(), and getStrToFlagMap().
flag_t PLearn::OptionBase::flags_ [protected] |
Definition at line 162 of file OptionBase.h.
Referenced by flags().
const OptionBase::flag_t PLearn::OptionBase::learntoption = 1 << 1 [static] |
'learntoption': an option whose proper value is computed by the class after construction (not to be set by the user before build) and potentially complex operations such as learning over a training set.
Example: the (trained) weights of a neural net.
Definition at line 95 of file OptionBase.h.
Referenced by PLearn::WPLS::declareOptions(), PLearn::WordNetSenseDictionary::declareOptions(), PLearn::VPLProcessor::declareOptions(), PLearn::VPLPreprocessedLearner2::declareOptions(), PLearn::VPLPreprocessedLearner::declareOptions(), PLearn::VPLCombinedLearner::declareOptions(), PLearn::VMatLanguage::declareOptions(), PLearn::VMatKernel::declareOptions(), PLearn::VecStatsCollector::declareOptions(), PLearn::VecExtendedVMatrix::declareOptions(), PLearn::VariableSelectionWithDirectedGradientDescent::declareOptions(), PLearn::VariableDeletionVMatrix::declareOptions(), PLearn::UniformizeLearner::declareOptions(), PLearn::UniformDistribution::declareOptions(), PLearn::UndirectedSoftmaxModule::declareOptions(), PLearn::TransformationLearner::declareOptions(), PLearn::TorchLearner::declareOptions(), PLearn::TopDownAsymetricDeepNetwork::declareOptions(), PLearn::TMatTest::declareOptions(), PLearn::TemporalHorizonVMatrix::declareOptions(), PLearn::TargetEncodingLearner::declareOptions(), PLearn::TanhModule::declareOptions(), PLearn::TangentLearner::declareOptions(), PLearn::SymbolNode::declareOptions(), PLearn::SVMClassificationTorch::declareOptions(), PLearn::SurfaceMesh::declareOptions(), PLearn::SupervisedDBN::declareOptions(), PLearn::Supersampling2DModule::declareOptions(), PLearn::SubsamplingDBN::declareOptions(), PLearn::Subsampling2DModule::declareOptions(), PLearn::SubMatVariable::declareOptions(), PLearn::StructuralLearner::declareOptions(), PLearn::StepwiseSelectionOracle::declareOptions(), PLearn::LiftStatsIterator::declareOptions(), PLearn::SharpeRatioStatsIterator::declareOptions(), PLearn::StderrStatsIterator::declareOptions(), PLearn::StddevStatsIterator::declareOptions(), PLearn::ExpMeanStatsIterator::declareOptions(), PLearn::MeanStatsIterator::declareOptions(), PLearn::StatsIterator::declareOptions(), PLearn::StatsCollector::declareOptions(), PLearn::StackedSVDNet::declareOptions(), PLearn::StackedModulesModule::declareOptions(), PLearn::StackedModulesLearner::declareOptions(), PLearn::StackedFocusedAutoassociatorsNet::declareOptions(), PLearn::StackedAutoassociatorsNet::declareOptions(), PLearn::Splitter::declareOptions(), PLearn::SplitModule::declareOptions(), PLearn::SpectralClustering::declareOptions(), PLearn::SparseIncrementalAffineTransformVariable::declareOptions(), PLearn::ShuntingNNetLayerModule::declareOptions(), PLearn::ShiftAndRescaleVMatrix::declareOptions(), PLearn::SelectRowsVMatrix::declareOptions(), PLearn::SecondIterationWrapper::declareOptions(), PLearn::ScoreLayerVariable::declareOptions(), PLearn::RunObject::declareOptions(), PLearn::ReorderByMissingVMatrix::declareOptions(), PLearn::RegressionTreeRegisters::declareOptions(), PLearn::RegressionTreeQueue::declareOptions(), PLearn::RegressionTreeNode::declareOptions(), PLearn::RegressionTreeMulticlassLeaveProb::declareOptions(), PLearn::RegressionTreeMulticlassLeaveFast::declareOptions(), PLearn::RegressionTreeMulticlassLeave::declareOptions(), PLearn::RegressionTreeLeave::declareOptions(), PLearn::RegressionTree::declareOptions(), PLearn::RBMTrainer::declareOptions(), PLearn::RBMSparse1DMatrixConnection::declareOptions(), PLearn::RBMQLParameters::declareOptions(), PLearn::RBMMultitaskClassificationModule::declareOptions(), PLearn::RBMModule::declareOptions(), PLearn::RBMMixedLayer::declareOptions(), PLearn::RBMMixedConnection::declareOptions(), PLearn::RBMMatrixTransposeConnection::declareOptions(), PLearn::RBMMatrixConnectionNatGrad::declareOptions(), PLearn::RBMMatrixConnection::declareOptions(), PLearn::RBMLQParameters::declareOptions(), PLearn::RBMLocalMultinomialLayer::declareOptions(), PLearn::RBMLLParameters::declareOptions(), PLearn::RBMLayer::declareOptions(), PLearn::RBMLateralBinomialLayer::declareOptions(), PLearn::RBMGenericParameters::declareOptions(), PLearn::RBMDiagonalMatrixConnection::declareOptions(), PLearn::RBMConv2DLLParameters::declareOptions(), PLearn::RBMConv2DConnection::declareOptions(), PLearn::RBMConnection::declareOptions(), PLearn::RBMClassificationModule::declareOptions(), PLearn::RankLearner::declareOptions(), PLearn::PTimer::declareOptions(), PLearn::PseudolikelihoodRBM::declareOptions(), PLearn::PruningLinearRegressor::declareOptions(), PLearn::ProcessInputCostModule::declareOptions(), PLearn::PRandom::declareOptions(), PLearn::PLS::declareOptions(), PLearn::PLearnerOutputVMatrix::declareOptions(), PLearn::PLearner::declareOptions(), PLearn::PDistribution::declareOptions(), PLearn::PCA::declareOptions(), PLearn::PartSupervisedDBN::declareOptions(), PLearn::PartsDistanceKernel::declareOptions(), PLearn::OracleObjectGenerator::declareOptions(), PLearn::Optimizer::declareOptions(), PLearn::OptimizeOptionOracle::declareOptions(), PLearn::OneHotVMatrix::declareOptions(), PLearn::ObservationWindow::declareOptions(), PLearn::NormalizationLearner::declareOptions(), PLearn::NonLocalManifoldParzen::declareOptions(), PLearn::NnlmWordRepresentationLayer::declareOptions(), PLearn::NnlmOutputLayer::declareOptions(), PLearn::NNet::declareOptions(), PLearn::NGramTree::declareOptions(), PLearn::NGramDistribution::declareOptions(), PLearn::NeuralProbabilisticLanguageModel::declareOptions(), PLearn::NeuralNet::declareOptions(), PLearn::NeighborhoodSmoothnessNNet::declareOptions(), PLearn::NeighborhoodBoxVolumeDensityEstimator::declareOptions(), PLearn::NatGradSMPNNet::declareOptions(), PLearn::NatGradNNet::declareOptions(), PLearn::NatGradEstimator::declareOptions(), PLearn::MultiInstanceNNet::declareOptions(), PLearn::MultiClassAdaBoost::declareOptions(), PLearn::MoleculeTemplateLearner::declareOptions(), PLearn::ModuleStackModule::declareOptions(), PLearn::ModuleLearner::declareOptions(), PLearn::mNNet::declareOptions(), PLearn::MixtureVMatrix::declareOptions(), PLearn::MergeDond2Files::declareOptions(), PLearn::MemoryVMatrix::declareOptions(), PLearn::MeanMedianModeImputationVMatrix::declareOptions(), PLearn::MeanImputationVMatrix::declareOptions(), PLearn::MaxSubsamplingTest::declareOptions(), PLearn::MaxSubsampling2DModule::declareOptions(), PLearn::ManualBinner::declareOptions(), PLearn::ManifoldParzen2::declareOptions(), PLearn::ManifoldParzen::declareOptions(), PLearn::LogaddOnBagsModule::declareOptions(), PLearn::LocalMedBoost::declareOptions(), PLearn::LocallyPrecomputedVMatrix::declareOptions(), PLearn::LocallyMagnifiedDistribution::declareOptions(), PLearn::LocalGaussianClassifier::declareOptions(), PLearn::LLE::declareOptions(), PLearn::LLC::declareOptions(), PLearn::LinearRegressor::declareOptions(), PLearn::LinearInductiveTransferClassifier::declareOptions(), PLearn::LinearFilterModule::declareOptions(), PLearn::LiftStatsCollector::declareOptions(), PLearn::LemmatizeVMatrix::declareOptions(), PLearn::LayerCostModule::declareOptions(), PLearn::KPCATangentLearner::declareOptions(), PLearn::KMeansClustering::declareOptions(), PLearn::KLp0p1RBMModule::declareOptions(), PLearn::KFoldLogisticClassifier::declareOptions(), PLearn::KernelRidgeRegressor::declareOptions(), PLearn::KernelProjection::declareOptions(), PLearn::KernelPCA::declareOptions(), PLearn::Kernel::declareOptions(), PLearn::IsomapTangentLearner::declareOptions(), PLearn::Isomap::declareOptions(), PLearn::InferenceRBM::declareOptions(), PLearn::IndexedVMatrix::declareOptions(), PLearn::IncrementalNNet::declareOptions(), PLearn::ICP::declareOptions(), PLearn::HyperOptimize::declareOptions(), PLearn::HyperLearner::declareOptions(), PLearn::HistogramDistribution::declareOptions(), PLearn::HintonDeepBeliefNet::declareOptions(), PLearn::HashMapFeatureSet::declareOptions(), PLearn::GradNNetLayerModule::declareOptions(), PLearn::GradientOptimizer::declareOptions(), PLearn::GradientCorrector::declareOptions(), PLearn::GeodesicDistanceKernel::declareOptions(), PLearn::GenericNearestNeighbors::declareOptions(), PLearn::GeneralizedOneHotVMatrix::declareOptions(), PLearn::GaussPartSupervisedDBN::declareOptions(), PLearn::GaussMixLocalProjections::declareOptions(), PLearn::GaussMix::declareOptions(), PLearn::GaussianizeVMatrix::declareOptions(), PLearn::GaussianDistribution::declareOptions(), PLearn::GaussianDBNRegression::declareOptions(), PLearn::GaussianDBNClassification::declareOptions(), PLearn::GaussianContinuumDistribution::declareOptions(), PLearn::GaussianContinuum::declareOptions(), PLearn::FNetLayerVariable::declareOptions(), PLearn::FinancePreprocVMatrix::declareOptions(), PLearn::FileVMatrix::declareOptions(), PLearn::FeatureSetSequentialCRF::declareOptions(), PLearn::FeatureSetNNet::declareOptions(), PLearn::FeatureSetNaiveBayesClassifier::declareOptions(), PLearn::ExtendedVMatrix::declareOptions(), PLearn::ExplicitListOracle::declareOptions(), PLearn::EarlyStoppingOracle::declareOptions(), PLearn::DynamicallyLinkedRBMsModel::declareOptions(), PLearn::DivisiveNormalizationKernel::declareOptions(), PLearn::DiverseComponentAnalysis::declareOptions(), PLearn::DistRepNNet::declareOptions(), PLearn::DiscriminativeRBM::declareOptions(), PLearn::DiscriminativeDeepBeliefNet::declareOptions(), PLearn::DictionaryVMatrix::declareOptions(), PLearn::Dictionary::declareOptions(), PLearn::DichotomizeVMatrix::declareOptions(), PLearn::DenoisingRecurrentNet::declareOptions(), PLearn::DeepReconstructorNet::declareOptions(), PLearn::DeepNonLocalManifoldParzen::declareOptions(), PLearn::DeepNNet::declareOptions(), PLearn::DeepFeatureExtractorNNet::declareOptions(), PLearn::DeepBeliefNet::declareOptions(), PLearn::CubicSpline::declareOptions(), PLearn::Convolution2DModule::declareOptions(), PLearn::ConstantRegressor::declareOptions(), PLearn::ConditionalStatsCollector::declareOptions(), PLearn::ConditionalMeanImputationVMatrix::declareOptions(), PLearn::ConditionalDensityNet::declareOptions(), PLearn::ConcatRowsVMatrix::declareOptions(), PLearn::ConcatRowsSubVMatrix::declareOptions(), PLearn::ConcatColumnsVMatrix::declareOptions(), PLearn::CombiningCostsModule::declareOptions(), PLearn::ClassifierFromDensity::declareOptions(), PLearn::ChemicalICP::declareOptions(), PLearn::CartesianProductOracle::declareOptions(), PLearn::CachedFeatureSet::declareOptions(), PLearn::BootstrapVMatrix::declareOptions(), PLearn::BinaryStump::declareOptions(), PLearn::BinaryNumbersVMatrix::declareOptions(), PLearn::BestAveragingPLearner::declareOptions(), PLearn::BasisSelectionRegressor::declareOptions(), PLearn::BaseRegressorWrapper::declareOptions(), PLearn::BaseRegressorConfidence::declareOptions(), PLearn::BallTreeNearestNeighbors::declareOptions(), PLearn::BaggingLearner::declareOptions(), PLearn::BackConvolution2DModule::declareOptions(), PLearn::AutoVMatrix::declareOptions(), PLearn::AutoScaledGradientOptimizer::declareOptions(), PLearn::AutoLinearRegressor::declareOptions(), PLearn::AdditiveNormalizationKernel::declareOptions(), PLearn::AddCostToLearner::declareOptions(), PLearn::AdaBoost::declareOptions(), getFlagToStrMap(), and shouldBeSkipped().
OptionLevel PLearn::OptionBase::level_ [protected] |
Option level (low=basic, high=advanced)
Definition at line 166 of file OptionBase.h.
Referenced by level().
OptionBase::LevelToStrMap PLearn::OptionBase::level_to_str [static, protected] |
init.
Definition at line 153 of file OptionBase.h.
Referenced by getLevelToStrMap(), and optionLevelToString().
const OptionBase::flag_t PLearn::OptionBase::nonparentable = 1 << 4 [static] |
When this flag is set, the option does not lead to a parenting relationship in the "ParentableObject" sense.
In other words, the object pointed to by this option does not get its parent() backpointer set to this.
Definition at line 117 of file OptionBase.h.
Referenced by PLearn::TransparentParentable::checkParent(), getFlagToStrMap(), and PLearn::ParentableObject::updateChildrensParent().
const OptionBase::flag_t PLearn::OptionBase::nontraversable = 1 << 5 [static] |
When this flag is set, the option is not traversed by the ObjectGraphIterator class (and ipso facto by related functions, such as memfun_broadcast.
Definition at line 124 of file OptionBase.h.
Referenced by getFlagToStrMap(), and PLearn::ObjectOptionsIterator::operator++().
const OptionBase::flag_t PLearn::OptionBase::nosave = 1 << 3 [static] |
'nosave': when set, this flag requests the option not to be saved in the object serialisation; mostly used when we must have several options that map to the same physical data field, for script backward compatibility.
Definition at line 109 of file OptionBase.h.
Referenced by PLearn::VMatrix::declareOptions(), PLearn::VecStatsCollector::declareOptions(), PLearn::VecExtendedVMatrix::declareOptions(), PLearn::VariableDeletionVMatrix::declareOptions(), PLearn::UnfrozenDeepBeliefNet::declareOptions(), PLearn::UnfoldedFuncVariable::declareOptions(), PLearn::UnconditionalDistribution::declareOptions(), PLearn::UCIDataVMatrix::declareOptions(), PLearn::TorchLearner::declareOptions(), PLearn::TemporalHorizonVMatrix::declareOptions(), PLearn::SVMClassificationTorch::declareOptions(), PLearn::SurfaceTemplateLearner::declareOptions(), PLearn::SubsamplingDBN::declareOptions(), PLearn::StatsCollector::declareOptions(), PLearn::Splitter::declareOptions(), PLearn::SpectralClustering::declareOptions(), PLearn::SortRowsVMatrix::declareOptions(), PLearn::SoftmaxModule::declareOptions(), PLearn::ShiftAndRescaleVMatrix::declareOptions(), PLearn::SelectRowsVMatrix::declareOptions(), PLearn::SelectColumnsVMatrix::declareOptions(), PLearn::ReorderByMissingVMatrix::declareOptions(), PLearn::RemoveDuplicateVMatrix::declareOptions(), PLearn::RegressionTreeRegisters::declareOptions(), PLearn::RegressionTreeNode::declareOptions(), PLearn::RegressionTreeLeave::declareOptions(), PLearn::RegressionTree::declareOptions(), PLearn::RBMMixedConnection::declareOptions(), PLearn::RandomGaussMix::declareOptions(), PLearn::PTest::declareOptions(), PLearn::ProcessDatasetVMatrix::declareOptions(), PLearn::PrecomputedVMatrix::declareOptions(), PLearn::PLearnerOutputVMatrix::declareOptions(), PLearn::PLearner::declareOptions(), PLearn::PartSupervisedDBN::declareOptions(), PLearn::OneHotVMatrix::declareOptions(), PLearn::ObservationWindow::declareOptions(), PLearn::NNet::declareOptions(), PLearn::NGramDistribution::declareOptions(), PLearn::NetworkModule::declareOptions(), PLearn::MultiToUniInstanceSelectRandomVMatrix::declareOptions(), PLearn::MultiClassAdaBoost::declareOptions(), PLearn::ModuleStackModule::declareOptions(), PLearn::MixtureDistribution::declareOptions(), PLearn::MemoryVMatrixNoSave::declareOptions(), PLearn::MemoryVMatrix::declareOptions(), PLearn::MeanMedianModeImputationVMatrix::declareOptions(), PLearn::ManifoldParzen2::declareOptions(), PLearn::LocallyPrecomputedVMatrix::declareOptions(), PLearn::LLE::declareOptions(), PLearn::LinearRegressor::declareOptions(), PLearn::LayerCostModule::declareOptions(), PLearn::KernelProjection::declareOptions(), PLearn::KernelPCA::declareOptions(), PLearn::Isomap::declareOptions(), PLearn::IndexedVMatrix::declareOptions(), PLearn::HyperOptimize::declareOptions(), PLearn::HyperLearner::declareOptions(), PLearn::HintonDeepBeliefNet::declareOptions(), PLearn::GramVMatrix::declareOptions(), PLearn::GeneralizedOneHotVMatrix::declareOptions(), PLearn::GaussPartSupervisedDBN::declareOptions(), PLearn::GaussMixLocalProjections::declareOptions(), PLearn::GaussianizeVMatrix::declareOptions(), PLearn::GaussianDistribution::declareOptions(), PLearn::ForwardVMatrix::declareOptions(), PLearn::ForwardModule::declareOptions(), PLearn::FinancePreprocVMatrix::declareOptions(), PLearn::FilteredVMatrix::declareOptions(), PLearn::ExtractNNetParamsVMatrix::declareOptions(), PLearn::ExtendedVMatrix::declareOptions(), PLearn::ExhaustiveNearestNeighbors::declareOptions(), PLearn::EmbeddedLearner::declareOptions(), PLearn::DiscriminativeRBM::declareOptions(), PLearn::DeepBeliefNet::declareOptions(), PLearn::CrossEntropyCostModule::declareOptions(), PLearn::CosKernel::declareOptions(), PLearn::ConcatRowsVMatrix::declareOptions(), PLearn::ConcatRowsSubVMatrix::declareOptions(), PLearn::ConcatColumnsVMatrix::declareOptions(), PLearn::CenteredVMatrix::declareOptions(), PLearn::BootstrapVMatrix::declareOptions(), PLearn::AutoVMatrix::declareOptions(), PLearn::AdaBoost::declareOptions(), getFlagToStrMap(), PLearn::Object::getOptionsToRemoteTransmit(), and PLearn::Object::getOptionsToSave().
string PLearn::OptionBase::optionname_ [protected] |
the name of the option
Definition at line 161 of file OptionBase.h.
Referenced by optionname(), and setOptionName().
string PLearn::OptionBase::optiontype_ [protected] |
the datatype of the option ("int" ...)
Definition at line 163 of file OptionBase.h.
Referenced by optiontype().
const OptionBase::flag_t PLearn::OptionBase::remotetransmit = 1 << 6 [static] |
When this flag is set, the option is transmitted between servers and clients, even if the nosave flag is also set.
All options w/o nosave are transmitted by default.
Definition at line 131 of file OptionBase.h.
Referenced by PLearn::VecStatsCollector::declareOptions(), PLearn::Splitter::declareOptions(), PLearn::PLearner::declareOptions(), PLearn::ObservationWindow::declareOptions(), getFlagToStrMap(), and PLearn::Object::getOptionsToRemoteTransmit().
OptionBase::StrToFlagMap PLearn::OptionBase::str_to_flag [static, protected] |
OptionBase::StrToLevelMap PLearn::OptionBase::str_to_level [static, protected] |
init.
Definition at line 152 of file OptionBase.h.
Referenced by getLevelToStrMap(), getStrToLevelMap(), and optionLevelFromString().
const OptionBase::flag_t PLearn::OptionBase::tuningoption = 1 << 2 [static] |
'tuningoption': an option typically set after the initial build, to tune the object
Definition at line 101 of file OptionBase.h.
Referenced by PLearn::BinaryBallTree::declareOptions(), getFlagToStrMap(), and shouldBeSkipped().