|
PLearn 0.1
|
The first sentence should be a BRIEF DESCRIPTION of what the class does. More...
#include <PentaTest.h>


Public Member Functions | |
| PentaTest () | |
| Default constructor. | |
| virtual string | classname () const |
| virtual OptionList & | getOptionList () const |
| virtual OptionMap & | getOptionMap () const |
| virtual RemoteMethodMap & | getRemoteMethodMap () const |
| virtual PentaTest * | deepCopy (CopiesMap &copies) const |
| virtual void | build () |
| Post-constructor. | |
| virtual void | makeDeepCopyFromShallowCopy (CopiesMap &copies) |
| Transforms a shallow copy into a deep copy. | |
| virtual void | perform () |
| The method performing the test. | |
Static Public Member Functions | |
| static string | _classname_ () |
| 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 the class options. | |
Private Types | |
| typedef PTest | inherited |
Private Member Functions | |
| void | build_ () |
| This does the actual building. | |
The first sentence should be a BRIEF DESCRIPTION of what the class does.
Place the rest of the class programmer documentation here. Doxygen supports Javadoc-style comments. See http://www.doxygen.org/manual.html
Definition at line 61 of file PentaTest.h.
typedef PTest PLearn::PentaTest::inherited [private] |
Reimplemented from PLearn::PTest.
Definition at line 63 of file PentaTest.h.
| PLearn::PentaTest::PentaTest | ( | ) |
Default constructor.
Definition at line 61 of file PentaTest.cc.
{
// ...
// ### You may (or not) want to call build_() to finish building the object
// ### (doing so assumes the parent classes' build_() have been called too
// ### in the parent classes' constructors, something that you must ensure)
}
| string PLearn::PentaTest::_classname_ | ( | ) | [static] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| OptionList & PLearn::PentaTest::_getOptionList_ | ( | ) | [static] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| RemoteMethodMap & PLearn::PentaTest::_getRemoteMethodMap_ | ( | ) | [static] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| Object * PLearn::PentaTest::_new_instance_for_typemap_ | ( | ) | [static] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| StaticInitializer PentaTest::_static_initializer_ & PLearn::PentaTest::_static_initialize_ | ( | ) | [static] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| void PLearn::PentaTest::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::PTest.
Definition at line 74 of file PentaTest.cc.
{
inherited::build();
build_();
}
| void PLearn::PentaTest::build_ | ( | ) | [private] |
This does the actual building.
Reimplemented from PLearn::PTest.
Definition at line 120 of file PentaTest.cc.
{
// ### 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::PentaTest::classname | ( | ) | const [virtual] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| void PLearn::PentaTest::declareOptions | ( | OptionList & | ol | ) | [static, protected] |
Declares the class options.
Reimplemented from PLearn::PTest.
Definition at line 100 of file PentaTest.cc.
{
// ### 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", &PentaTest::myoption, OptionBase::buildoption,
// "Help text describing this option");
// ...
// Now call the parent class' declareOptions
inherited::declareOptions(ol);
}
| static const PPath& PLearn::PentaTest::declaringFile | ( | ) | [inline, static] |
Reimplemented from PLearn::PTest.
Definition at line 88 of file PentaTest.h.
:
//##### Protected Options ###############################################
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| OptionList & PLearn::PentaTest::getOptionList | ( | ) | const [virtual] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| OptionMap & PLearn::PentaTest::getOptionMap | ( | ) | const [virtual] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| RemoteMethodMap & PLearn::PentaTest::getRemoteMethodMap | ( | ) | const [virtual] |
Reimplemented from PLearn::PTest.
Definition at line 56 of file PentaTest.cc.
| void PLearn::PentaTest::makeDeepCopyFromShallowCopy | ( | CopiesMap & | copies | ) | [virtual] |
Transforms a shallow copy into a deep copy.
Reimplemented from PLearn::PTest.
Definition at line 83 of file PentaTest.cc.
References PLERROR.
{
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("PentaTest::makeDeepCopyFromShallowCopy not fully (correctly) implemented yet!");
}
| void PLearn::PentaTest::perform | ( | ) | [virtual] |
The method performing the test.
A typical test consists in some output (to pout and / or perr), and updates of this object's options.
Reimplemented from PLearn::PTest.
Definition at line 134 of file PentaTest.cc.
References a, b, c, PLearn::choleskySolve(), PLearn::endl(), i, PLearn::PLearnError::message(), n, PLearn::PentadiagonalSolveInPlace(), and x.
{
try {
const int n = 10;
Mat A(n,n);
Vec a(n),b(n),c(n),y(n);
for (int i=0; i<n; ++i) {
A(i,i) = 50+1.5*i;
a[i] = 50+1.5*i;
if (i+1<n) {
A(i,i+1) = 4+2*i;
A(i+1,i) = 4+2*i;
b[i] = 4+2*i;
}
if (i+2<n) {
A(i,i+2) = i;
A(i+2,i) = i;
c[i] = i;
}
y[i] = 2*i+1;
}
cout << "A matrix is" << endl;
cout << A << endl;
cout << "y vector is " << endl;
cout << y << endl;
cout << "Solution found by Cholesky" << endl;
Vec x = choleskySolve(A, y);
cout << x << endl;
cout << "Solution found by Pentadiagonal solver" << endl;
PentadiagonalSolveInPlace(y, a, b, c);
cout << y << endl;
}
catch (PLearnError e) {
cout << "PLearnError: " << e.message() << endl;
}
}

Reimplemented from PLearn::PTest.
Definition at line 88 of file PentaTest.h.
1.7.4