|
PLearn 0.1
|
#include <Binner.h>


Public Types | |
| typedef Object | inherited |
Public Member Functions | |
| Binner () | |
| virtual void | build () |
| Post-constructor. | |
| virtual void | makeDeepCopyFromShallowCopy (CopiesMap &copies) |
| Transforms a shallow copy into a deep copy. | |
| virtual int | nBins () const |
| Return the number of bins computed by this binner. | |
| virtual PP< RealMapping > | getBinning (VMat v) const |
| Returns a binning for a single column vmatrix v. | |
| virtual TVec< TVec< int > > | getBins (const Vec &v) const |
| Return a vector whose i-th element is the list of the indices in 'v' that belong to the i-th bin. | |
| virtual string | classname () const |
| virtual OptionList & | getOptionList () const |
| virtual OptionMap & | getOptionMap () const |
| virtual RemoteMethodMap & | getRemoteMethodMap () const |
| virtual Binner * | deepCopy (CopiesMap &copies) const |
Static Public Member Functions | |
| static string | _classname_ () |
| Declares name and deepCopy methods. | |
| static OptionList & | _getOptionList_ () |
| static RemoteMethodMap & | _getRemoteMethodMap_ () |
| static Object * | _new_instance_for_typemap_ () |
| static bool | _isa_ (const Object *o) |
| static void | _static_initialize_ () |
| static const PPath & | declaringFile () |
Static Public Attributes | |
| static StaticInitializer | _static_initializer_ |
Static Protected Member Functions | |
| static void | declareOptions (OptionList &ol) |
| Declares this class' options. | |
Private Member Functions | |
| void | build_ () |
| This does the actual building. | |
| typedef Object PLearn::Binner::inherited |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| string PLearn::Binner::_classname_ | ( | ) | [static] |
Declares name and deepCopy methods.
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| OptionList & PLearn::Binner::_getOptionList_ | ( | ) | [static] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| RemoteMethodMap & PLearn::Binner::_getRemoteMethodMap_ | ( | ) | [static] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| Object * PLearn::Binner::_new_instance_for_typemap_ | ( | ) | [static] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| StaticInitializer Binner::_static_initializer_ & PLearn::Binner::_static_initialize_ | ( | ) | [static] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| void PLearn::Binner::build | ( | ) | [virtual] |
Post-constructor.
The normal implementation should call simply inherited::build(), then this class's build_(). This method should be callable again at later times, after modifying some option fields to change the "architecture" of the object.
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
Definition at line 89 of file Binner.cc.
References PLearn::Object::build(), and build_().
Referenced by PLearn::ManualBinner::build().
{
inherited::build();
build_();
}


| void PLearn::Binner::build_ | ( | ) | [private] |
This does the actual building.
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
Definition at line 77 of file Binner.cc.
Referenced by build().
{
// ### This method should do the real building of the object,
// ### according to set 'options', in *any* situation.
// ### Typical situations include:
// ### - Initial building of an object from a few user-specified options
// ### - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
// ### - Updating or "re-building" of an object after a few "tuning" options have been modified.
// ### You should assume that the parent class' build_() has already been called.
}

| string PLearn::Binner::classname | ( | ) | const [virtual] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| void PLearn::Binner::declareOptions | ( | OptionList & | ol | ) | [static, protected] |
Declares this class' options.
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
Definition at line 60 of file Binner.cc.
References PLearn::Object::declareOptions().
Referenced by PLearn::ManualBinner::declareOptions().
{
// ### Declare all of this object's options here
// ### For the "flags" of each option, you should typically specify
// ### one of OptionBase::buildoption, OptionBase::learntoption or
// ### OptionBase::tuningoption. Another possible flag to be combined with
// ### is OptionBase::nosave
// ### ex:
// declareOption(ol, "myoption", &Binner::myoption, OptionBase::buildoption,
// "Help text describing this option");
// ...
// Now call the parent class' declareOptions
inherited::declareOptions(ol);
}


| static const PPath& PLearn::Binner::declaringFile | ( | ) | [inline, static] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| PP< RealMapping > PLearn::Binner::getBinning | ( | VMat | v | ) | const [virtual] |
Return a vector whose i-th element is the list of the indices in 'v' that belong to the i-th bin.
This method does not need to be written in subclasses (in general), as long as 'getBinning()' is implemented.
Reimplemented in PLearn::SoftHistogramBinner.
Definition at line 119 of file Binner.cc.
References PLearn::TVec< T >::append(), PLearn::columnmatrix(), getBinning(), i, PLearn::TVec< T >::length(), and PLWARNING.
{
PLWARNING("In Binner::getBins - This method has not been tested yet, remove this warning if it works fine");
VMat col = new MemoryVMatrix(columnmatrix(v));
PP<RealMapping> mapping = getBinning(col);
TVec< TVec<int> > bins(mapping->length());
for (int i = 0; i < v.length(); i++) {
bins[mapping->binnumber(v[i])].append(i);
}
return bins;
}

| OptionList & PLearn::Binner::getOptionList | ( | ) | const [virtual] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| OptionMap & PLearn::Binner::getOptionMap | ( | ) | const [virtual] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| RemoteMethodMap & PLearn::Binner::getRemoteMethodMap | ( | ) | const [virtual] |
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
| void PLearn::Binner::makeDeepCopyFromShallowCopy | ( | CopiesMap & | copies | ) | [virtual] |
Transforms a shallow copy into a deep copy.
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
Definition at line 96 of file Binner.cc.
References PLearn::Object::makeDeepCopyFromShallowCopy(), and PLERROR.
Referenced by PLearn::ManualBinner::makeDeepCopyFromShallowCopy().
{
inherited::makeDeepCopyFromShallowCopy(copies);
// ### Call deepCopyField on all "pointer-like" fields
// ### that you wish to be deepCopied rather than
// ### shallow-copied.
// ### ex:
// deepCopyField(trainvec, copies);
// ### Remove this line when you have fully implemented this method.
PLERROR("Binner::makeDeepCopyFromShallowCopy not fully (correctly) implemented yet!");
}


| int PLearn::Binner::nBins | ( | ) | const [virtual] |
Return the number of bins computed by this binner.
Default implementation displays an error.
Reimplemented in PLearn::SoftHistogramBinner.
Definition at line 133 of file Binner.cc.
References PLERROR.
{
PLERROR("In Binner::nBins - The nBins() method is not available for this Binner.");
return 0;
}
Reimplemented from PLearn::Object.
Reimplemented in PLearn::ManualBinner, and PLearn::SoftHistogramBinner.
1.7.4