PLearn 0.1
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Static Protected Member Functions | Private Types | Private Member Functions
PLearn::RealFunctionProduct Class Reference

The first sentence should be a BRIEF DESCRIPTION of what the class does. More...

#include <RealFunctionProduct.h>

Inheritance diagram for PLearn::RealFunctionProduct:
Inheritance graph
[legend]
Collaboration diagram for PLearn::RealFunctionProduct:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 RealFunctionProduct ()
 Default constructor.
 RealFunctionProduct (RealFunc func1, RealFunc func2)
virtual real evaluate (const Vec &x) const
virtual string classname () const
virtual OptionListgetOptionList () const
virtual OptionMapgetOptionMap () const
virtual RemoteMethodMapgetRemoteMethodMap () const
virtual RealFunctionProductdeepCopy (CopiesMap &copies) const
virtual void build ()
 Post-constructor.
virtual void makeDeepCopyFromShallowCopy (CopiesMap &copies)
 Transforms a shallow copy into a deep copy.

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 PPathdeclaringFile ()

Public Attributes

RealFunc f1
RealFunc f2

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

static void declareOptions (OptionList &ol)
 Declares the class options.

Private Types

typedef RealFunction inherited

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

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

Todo:
Write class to-do's here if there are any.
Deprecated:
Write deprecated stuff here if there is any. Indicate what else should be used instead.

Definition at line 57 of file RealFunctionProduct.h.


Member Typedef Documentation

Reimplemented from PLearn::RealFunction.

Definition at line 59 of file RealFunctionProduct.h.


Constructor & Destructor Documentation

PLearn::RealFunctionProduct::RealFunctionProduct ( ) [inline]

Default constructor.

Definition at line 71 of file RealFunctionProduct.h.

{}
PLearn::RealFunctionProduct::RealFunctionProduct ( RealFunc  func1,
RealFunc  func2 
) [inline]

Definition at line 73 of file RealFunctionProduct.h.

        :f1(func1), f2(func2)
    {}

Member Function Documentation

string PLearn::RealFunctionProduct::_classname_ ( ) [static]

Reimplemented from PLearn::RealFunction.

Definition at line 49 of file RealFunctionProduct.cc.

OptionList & PLearn::RealFunctionProduct::_getOptionList_ ( ) [static]

Reimplemented from PLearn::RealFunction.

Definition at line 49 of file RealFunctionProduct.cc.

RemoteMethodMap & PLearn::RealFunctionProduct::_getRemoteMethodMap_ ( ) [static]

Reimplemented from PLearn::RealFunction.

Definition at line 49 of file RealFunctionProduct.cc.

bool PLearn::RealFunctionProduct::_isa_ ( const Object o) [static]

Reimplemented from PLearn::RealFunction.

Definition at line 49 of file RealFunctionProduct.cc.

Object * PLearn::RealFunctionProduct::_new_instance_for_typemap_ ( ) [static]

Reimplemented from PLearn::Object.

Definition at line 49 of file RealFunctionProduct.cc.

StaticInitializer RealFunctionProduct::_static_initializer_ & PLearn::RealFunctionProduct::_static_initialize_ ( ) [static]

Reimplemented from PLearn::RealFunction.

Definition at line 49 of file RealFunctionProduct.cc.

void PLearn::RealFunctionProduct::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::RealFunction.

Definition at line 52 of file RealFunctionProduct.cc.

void PLearn::RealFunctionProduct::build_ ( ) [private]

This does the actual building.

Reimplemented from PLearn::RealFunction.

Definition at line 93 of file RealFunctionProduct.cc.

{}
string PLearn::RealFunctionProduct::classname ( ) const [virtual]

Reimplemented from PLearn::Object.

Definition at line 49 of file RealFunctionProduct.cc.

void PLearn::RealFunctionProduct::declareOptions ( OptionList ol) [static, protected]

Declares the class options.

Reimplemented from PLearn::RealFunction.

Definition at line 65 of file RealFunctionProduct.cc.

References PLearn::OptionBase::buildoption, PLearn::declareOption(), f1, and f2.

{
    // ### 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. If you don't provide one of these three,
    // ### this option will be ignored when loading values from a script.
    // ### You can also combine flags, for example with OptionBase::nosave:
    // ### (OptionBase::buildoption | OptionBase::nosave)

    declareOption(ol, "f1", &RealFunctionProduct::f1,
                  OptionBase::buildoption,
                  "The first factor");

    declareOption(ol, "f2", &RealFunctionProduct::f2,
                  OptionBase::buildoption,
                  "The second factor");

    // Now call the parent class' declareOptions
    inherited::declareOptions(ol);
}

Here is the call graph for this function:

static const PPath& PLearn::RealFunctionProduct::declaringFile ( ) [inline, static]

Reimplemented from PLearn::RealFunction.

Definition at line 83 of file RealFunctionProduct.h.

:
    //#####  Protected Options  ###############################################
RealFunctionProduct * PLearn::RealFunctionProduct::deepCopy ( CopiesMap copies) const [virtual]

Reimplemented from PLearn::RealFunction.

Definition at line 49 of file RealFunctionProduct.cc.

real PLearn::RealFunctionProduct::evaluate ( const Vec x) const [virtual]

Implements PLearn::RealFunction.

Definition at line 87 of file RealFunctionProduct.cc.

{
    return f1->evaluate(x) * f2->evaluate(x);
}
OptionList & PLearn::RealFunctionProduct::getOptionList ( ) const [virtual]

Reimplemented from PLearn::Object.

Definition at line 49 of file RealFunctionProduct.cc.

OptionMap & PLearn::RealFunctionProduct::getOptionMap ( ) const [virtual]

Reimplemented from PLearn::Object.

Definition at line 49 of file RealFunctionProduct.cc.

RemoteMethodMap & PLearn::RealFunctionProduct::getRemoteMethodMap ( ) const [virtual]

Reimplemented from PLearn::Object.

Definition at line 49 of file RealFunctionProduct.cc.

void PLearn::RealFunctionProduct::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]

Transforms a shallow copy into a deep copy.

Reimplemented from PLearn::RealFunction.

Definition at line 58 of file RealFunctionProduct.cc.

References PLearn::deepCopyField().

Here is the call graph for this function:


Member Data Documentation

Reimplemented from PLearn::RealFunction.

Definition at line 83 of file RealFunctionProduct.h.

Definition at line 64 of file RealFunctionProduct.h.

Referenced by declareOptions().

Definition at line 65 of file RealFunctionProduct.h.

Referenced by declareOptions().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines