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

#include <UnconditionalDistribution.h>

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

List of all members.

Public Member Functions

 UnconditionalDistribution ()
 Default constructor.
virtual void build ()
 Simply call inherited::build() then build_().
virtual void makeDeepCopyFromShallowCopy (CopiesMap &copies)
 Transform a shallow copy into a deep copy.
virtual string classname () const
virtual OptionListgetOptionList () const
virtual OptionMapgetOptionMap () const
virtual RemoteMethodMapgetRemoteMethodMap () const
virtual UnconditionalDistributiondeepCopy (CopiesMap &copies) const
virtual void forget ()
 Resets the distribution.
void setPredictor (const Vec &predictor, bool call_parent=true) const
 Return an error (not used in unconditional distributions).
void generatePredictor (Vec &x)
 Return an error (not used in unconditional distributions).
void generatePredictorGivenPredicted (Vec &x, const Vec &y)
 Return an error (not used in unconditional distributions).
void generateJoint (Vec &xy)
 Warns and calls generate(xy).
void generatePredicted (Vec &y)
 Warns and calls generate(y).

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

Static Public Attributes

static StaticInitializer _static_initializer_

Static Protected Member Functions

static void declareOptions (OptionList &ol)
 Declare this class' options.

Private Types

typedef PDistribution inherited

Private Member Functions

void build_ ()
 This does the actual building.

Detailed Description

Definition at line 52 of file UnconditionalDistribution.h.


Member Typedef Documentation


Constructor & Destructor Documentation

PLearn::UnconditionalDistribution::UnconditionalDistribution ( )

Default constructor.

Definition at line 52 of file UnconditionalDistribution.cc.


Member Function Documentation

string PLearn::UnconditionalDistribution::_classname_ ( ) [static]
OptionList & PLearn::UnconditionalDistribution::_getOptionList_ ( ) [static]
RemoteMethodMap & PLearn::UnconditionalDistribution::_getRemoteMethodMap_ ( ) [static]
bool PLearn::UnconditionalDistribution::_isa_ ( const Object o) [static]
Object * PLearn::UnconditionalDistribution::_new_instance_for_typemap_ ( ) [static]
StaticInitializer UnconditionalDistribution::_static_initializer_ & PLearn::UnconditionalDistribution::_static_initialize_ ( ) [static]
void PLearn::UnconditionalDistribution::build ( ) [virtual]
void PLearn::UnconditionalDistribution::build_ ( ) [private]
string PLearn::UnconditionalDistribution::classname ( ) const [virtual]
void PLearn::UnconditionalDistribution::declareOptions ( OptionList ol) [static, protected]

Declare this class' options.

Reimplemented from PLearn::PDistribution.

Reimplemented in PLearn::GaussianContinuumDistribution, PLearn::NeighborhoodBoxVolumeDensityEstimator, PLearn::GaussianDistribution, PLearn::KernelDensityEstimator, PLearn::NonLocalManifoldParzen, PLearn::RBMDistribution, PLearn::SpiralDistribution, PLearn::UniformDistribution, and PLearn::ManifoldKNNDistribution.

Definition at line 68 of file UnconditionalDistribution.cc.

References PLearn::OptionBase::buildoption, PLearn::PDistribution::n_predictor, PLearn::OptionBase::nosave, PLearn::PDistribution::outputs_def, PLearn::PDistribution::predicted_size, PLearn::PDistribution::predictor_part, PLearn::PDistribution::predictor_size, and PLearn::redeclareOption().

Referenced by PLearn::UniformDistribution::declareOptions(), PLearn::SpiralDistribution::declareOptions(), PLearn::RBMDistribution::declareOptions(), PLearn::NonLocalManifoldParzen::declareOptions(), PLearn::NeighborhoodBoxVolumeDensityEstimator::declareOptions(), PLearn::ManifoldKNNDistribution::declareOptions(), PLearn::KernelDensityEstimator::declareOptions(), PLearn::GaussianDistribution::declareOptions(), and PLearn::GaussianContinuumDistribution::declareOptions().

{
    // First call the parent class' declareOptions().
    inherited::declareOptions(ol);

    // And modify some options for unconditional distributions.

    redeclareOption(ol, "outputs_def", &UnconditionalDistribution::outputs_def,
                                       OptionBase::buildoption,
        "See help for this option in PDistribution. Basically, this is the\n"
        "same, except that 'E' and 'V' are obviously not allowed.");
    // TODO Find a cool way to synchronize this help with the PDistribution
    // help?

    redeclareOption(ol, "predictor_size",
                        &UnconditionalDistribution::predictor_size,
                        OptionBase::nosave,
        "Unused in unconditional distributions.");

    redeclareOption(ol, "predicted_size",
                        &UnconditionalDistribution::predicted_size,
                        OptionBase::nosave,
        "Unused in unconditional distributions.");

    redeclareOption(ol, "predictor_part",
                        &UnconditionalDistribution::predictor_part,
                        OptionBase::nosave,
        "Unused in unconditional distributions.");

    redeclareOption(ol, "n_predictor",
                        &UnconditionalDistribution::n_predictor,
                        OptionBase::nosave,
        "Unused in unconditional distributions.");
}

Here is the call graph for this function:

Here is the caller graph for this function:

static const PPath& PLearn::UnconditionalDistribution::declaringFile ( ) [inline, static]
UnconditionalDistribution * PLearn::UnconditionalDistribution::deepCopy ( CopiesMap copies) const [virtual]
void PLearn::UnconditionalDistribution::forget ( ) [virtual]
void PLearn::UnconditionalDistribution::generateJoint ( Vec xy) [virtual]

Warns and calls generate(xy).

Reimplemented from PLearn::PDistribution.

Definition at line 167 of file UnconditionalDistribution.cc.

References PLWARNING.

{
    PLWARNING("In UnconditionalDistribution::generateJoint -\n"
              "Not implemented for unconditional distributions.\n"
              "Calling \"generate\" instead.\n");
    generate(xy);
}
void PLearn::UnconditionalDistribution::generatePredicted ( Vec y) [virtual]

Warns and calls generate(y).

Reimplemented from PLearn::PDistribution.

Definition at line 178 of file UnconditionalDistribution.cc.

References PLERROR.

{
    PLERROR("In UnconditionalDistribution::generatePredicted -\n"
            "Not implemented for unconditional distributions.\n"
            "Calling \"generate\" instead.\n");
    generate(y);
}
void PLearn::UnconditionalDistribution::generatePredictor ( Vec x) [virtual]

Return an error (not used in unconditional distributions).

Reimplemented from PLearn::PDistribution.

Definition at line 148 of file UnconditionalDistribution.cc.

References PLERROR.

{
    PLERROR("In UnconditionalDistribution::generatePredictor -\n"
            "Not implemented for unconditional distributions.\n");
}
void PLearn::UnconditionalDistribution::generatePredictorGivenPredicted ( Vec x,
const Vec y 
) [virtual]

Return an error (not used in unconditional distributions).

Reimplemented from PLearn::PDistribution.

Definition at line 157 of file UnconditionalDistribution.cc.

References PLERROR.

{
    PLERROR("In UnconditionalDistribution::generatePredictorGivenPredicted -\n"
            "Not implemented for unconditional distributions.\n");
}
OptionList & PLearn::UnconditionalDistribution::getOptionList ( ) const [virtual]
OptionMap & PLearn::UnconditionalDistribution::getOptionMap ( ) const [virtual]
RemoteMethodMap & PLearn::UnconditionalDistribution::getRemoteMethodMap ( ) const [virtual]
void PLearn::UnconditionalDistribution::makeDeepCopyFromShallowCopy ( CopiesMap copies) [virtual]
void PLearn::UnconditionalDistribution::setPredictor ( const Vec predictor,
bool  call_parent = true 
) const [virtual]

Return an error (not used in unconditional distributions).

Reimplemented from PLearn::PDistribution.

Definition at line 138 of file UnconditionalDistribution.cc.

References PLERROR.

{
    PLERROR("In UnconditionalDistribution::setPredictor -\n"
            "Not implemented for unconditional distributions.\n");
}

Member Data Documentation


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