PetaVision  Alpha
Public Member Functions | Protected Member Functions | Protected Attributes
PV::WeightsPairInterface Class Referenceabstract
Inheritance diagram for PV::WeightsPairInterface:
PV::BaseObject PV::CheckpointerDataInterface PV::Observer PV::ImpliedWeightsPair PV::WeightsPair PV::CloneWeightsPair PV::CopyWeightsPair PV::TransposeWeightsPair

Public Member Functions

 WeightsPairInterface (char const *name, HyPerCol *hc)
 
ConnectionData const * getConnectionData ()
 
bool getDataStructuresAllocatedFlag () const
 
std::string const & getDescription () const
 
char const * getDescription_c () const
 
bool getInitialValuesSetFlag () const
 
bool getInitInfoCommunicatedFlag () const
 
MPIBlock const * getMPIBlock ()
 
char const * getName () const
 
std::string const & getObjectType () const
 
Weights * getPostWeights ()
 
Weights * getPreWeights ()
 
void ioParams (enum ParamsIOFlag ioFlag, bool printHeader, bool printFooter)
 
bool isUsingGPU () const
 
char const * lookupKeyword () const
 
void needPost ()
 
void needPre ()
 
void readParams ()
 
virtual Response::Status registerData (Checkpointer *checkpointer)
 
virtual Response::Status respond (std::shared_ptr< BaseMessage const > message) override
 
void writeParams ()
 

Protected Member Functions

virtual Response::Status allocateDataStructures () override
 
virtual void allocatePostWeights ()
 
virtual void allocatePreWeights ()
 
virtual Response::Status cleanup ()
 
virtual Response::Status communicateInitInfo (std::shared_ptr< CommunicateInitInfoMessage const > message) override
 
virtual Response::Status copyInitialStateToGPU ()
 
virtual void createPostWeights (std::string const &weightsName)=0
 
virtual void createPreWeights (std::string const &weightsName)=0
 
int initialize (char const *name, HyPerCol *hc)
 
virtual Response::Status initializeState ()
 
virtual int ioParamsFillGroup (enum ParamsIOFlag ioFlag)
 
virtual Response::Status prepareCheckpointWrite ()
 
virtual Response::Status processCheckpointRead ()
 
virtual Response::Status readStateFromCheckpoint (Checkpointer *checkpointer) override
 
Response::Status respondAllocateData (std::shared_ptr< AllocateDataMessage const > message)
 
Response::Status respondCleanup (std::shared_ptr< CleanupMessage const > message)
 
Response::Status respondCommunicateInitInfo (std::shared_ptr< CommunicateInitInfoMessage const > message)
 
Response::Status respondCopyInitialStateToGPU (std::shared_ptr< CopyInitialStateToGPUMessage const > message)
 
Response::Status respondInitializeState (std::shared_ptr< InitializeStateMessage const > message)
 
Response::Status respondPrepareCheckpointWrite (std::shared_ptr< PrepareCheckpointWriteMessage const > message)
 
Response::Status respondProcessCheckpointRead (std::shared_ptr< ProcessCheckpointReadMessage const > message)
 
Response::Status respondReadStateFromCheckpoint (std::shared_ptr< ReadStateFromCheckpointMessage< Checkpointer > const > message)
 
Response::Status respondRegisterData (std::shared_ptr< RegisterDataMessage< Checkpointer > const > message)
 
Response::Status respondSetCudaDevice (std::shared_ptr< SetCudaDeviceMessage const > message)
 
virtual Response::Status setCudaDevice (std::shared_ptr< SetCudaDeviceMessage const > message)
 
void setDataStructuresAllocatedFlag ()
 
void setDescription ()
 
void setInitialValuesSetFlag ()
 
void setInitInfoCommunicatedFlag ()
 
int setName (char const *name)
 
virtual void setObjectType () override
 
int setParent (HyPerCol *hc)
 

Protected Attributes

std::string description
 
ConnectionData * mConnectionData = nullptr
 
PVCuda::CudaDevice * mCudaDevice = nullptr
 
bool mDataStructuresAllocatedFlag = false
 
bool mInitialValuesSetFlag = false
 
bool mInitInfoCommunicatedFlag = false
 
std::string mObjectType
 
PatchSize * mPatchSize = nullptr
 
Weights * mPostWeights = nullptr
 
Weights * mPreWeights = nullptr
 
bool mUsingGPUFlag = false
 
char * name = nullptr
 
HyPerCol * parent = nullptr
 

Detailed Description

Definition at line 18 of file WeightsPairInterface.hpp.

Member Function Documentation

virtual void PV::WeightsPairInterface::createPostWeights ( std::string const &  weightsName)
protectedpure virtual

A pure virtual method for creating the postsynaptic weights, called by needPost() if mPostWeights is null and the communicate stage has been completed.

Implementations can assume that mPostWeights is null on entry, and should set that member variable.

Implemented in PV::WeightsPair, PV::CloneWeightsPair, PV::CopyWeightsPair, PV::TransposeWeightsPair, and PV::ImpliedWeightsPair.

virtual void PV::WeightsPairInterface::createPreWeights ( std::string const &  weightsName)
protectedpure virtual

A pure virtual method for creating the presynaptic weights, called by needPre() if mPreWeights is null and the communicate stage has been completed.

Implementations can assume that mPreWeights is null on entry, and should set that member variable.

Implemented in PV::WeightsPair, PV::CloneWeightsPair, PV::CopyWeightsPair, PV::TransposeWeightsPair, and PV::ImpliedWeightsPair.

bool PV::BaseObject::getDataStructuresAllocatedFlag ( ) const
inlineinherited

Get-method for mDataStructuresAllocatedFlag, which is false on initialization and then becomes true once setDataStructuresAllocatedFlag() is called.

Definition at line 102 of file BaseObject.hpp.

bool PV::BaseObject::getInitialValuesSetFlag ( ) const
inlineinherited

Get-method for mInitialValuesSetFlag, which is false on initialization and then becomes true once setInitialValuesSetFlag() is called.

Definition at line 108 of file BaseObject.hpp.

bool PV::BaseObject::getInitInfoCommunicatedFlag ( ) const
inlineinherited

Get-method for mInitInfoCommunicatedFlag, which is false on initialization and then becomes true once setInitInfoCommunicatedFlag() is called.

Definition at line 95 of file BaseObject.hpp.

void PV::BaseObject::ioParams ( enum ParamsIOFlag  ioFlag,
bool  printHeader,
bool  printFooter 
)
inherited

Method for reading or writing the params from group in the parent HyPerCol's parameters. The group from params is selected using the name of the connection.

If ioFlag is set to write, the printHeader and printFooter flags control whether a header and footer for the parameter group is produces. These flags are set to true for layers, connections, and probes; and set to false for weight initializers and normalizers. If ioFlag is set to read, the printHeader and printFooter flags are ignored.

Note that ioParams is not virtual. To add parameters in a derived class, override ioParamFillGroup.

Definition at line 74 of file BaseObject.cpp.

virtual int PV::BaseObject::ioParamsFillGroup ( enum ParamsIOFlag  ioFlag)
inlineprotectedvirtualinherited

The virtual method for reading parameters from the parent HyPerCol's parameters, and writing to the output params file.

Derived classes with additional parameters typically override ioParamsFillGroup to call the base class's ioParamsFillGroup method and then call ioParam_[parametername] for each of their parameters. The ioParam_[parametername] methods should call the parent HyPerCol's ioParamValue() and related methods, to ensure that all parameters that get read also get written to the outputParams-generated file.

Reimplemented in PV::HyPerLayer, PV::InputLayer, PV::BaseProbe, PV::PoolingDelivery, PV::ColumnEnergyProbe, PV::MomentumUpdater, PV::ColProbe, PV::BinningLayer, PV::LIF, PV::AdaptiveTimeScaleProbe, PV::PatchSize, PV::ANNLayer, PV::NormalizeMultiply, PV::HyPerDeliveryFacade, PV::InitWeights, PV::TransposePoolingDelivery, PV::ConnectionData, PV::AbstractNormProbe, PV::BaseConnection, PV::BaseDelivery, PV::PostsynapticPerspectiveGPUDelivery, PV::PresynapticPerspectiveStochasticDelivery, PV::CloneWeightsPair, PV::WeightsPair, PV::HyPerDelivery, PV::ArborList, PV::PostsynapticPerspectiveConvolveDelivery, PV::PresynapticPerspectiveConvolveDelivery, PV::HebbianUpdater, PV::PostsynapticPerspectiveStochasticDelivery, PV::PresynapticPerspectiveGPUDelivery, PV::NormalizeBase, PV::CopyWeightsPair, PV::DependentPatchSize, PV::Retina, PV::InitGauss2DWeights, PV::RescaleDelivery, PV::OriginalConnNameParam, PV::L2NormProbe, PV::FeedbackConnectionData, PV::SharedWeights, PV::StrengthParam, PV::DependentArborList, PV::BaseWeightUpdater, PV::DependentSharedWeights, PV::SingleArbor, PV::FirmThresholdCostFnProbe, PV::TransposeWeightsPair, PV::InitVFromFile, PV::InitUniformWeights, PV::QuotientColProbe, PV::GaussianRandomV, PV::UniformRandomV, PV::RequireAllZeroActivityProbe, PV::RescaleLayer, PV::InputRegionLayer, PV::PointProbe, PV::ConstantV, PV::CloneVLayer, PV::BackgroundLayer, PV::GapLayer, PV::SigmoidLayer, PV::L0NormProbe, PV::HyPerLCALayer, PV::KernelProbe, PV::ISTALayer, PV::StatsProbe, PV::InitCocircWeights, PV::InitUniformRandomWeights, PV::FilenameParsingGroundTruthLayer, PV::MaskLayer, PV::PoolingIndexLayer, PV::InitGaussianRandomWeights, PV::LeakyIntegrator, PV::MomentumLCALayer, PV::InitOneToOneWeights, PV::ANNErrorLayer, PV::InitSpreadOverArborsWeights, PV::SegmentLayer, PV::PointLIFProbe, PV::Segmentify, PV::NormalizeContrastZeroMean, PV::NormalizeL2, PV::NormalizeMax, PV::NormalizeSum, PV::NormalizeGroup, PV::BaseInitV, PV::LogTimeScaleProbe, PV::KneeTimeScaleProbe, and PV::DropoutLayer.

Definition at line 139 of file BaseObject.hpp.

bool PV::BaseObject::isUsingGPU ( ) const
inlineinherited

Returns true if the object requires the GPU; false otherwise. HyPerCol will not initialize the GPU unless one of the objects in its hierarchy returns true

Definition at line 116 of file BaseObject.hpp.

char const * PV::BaseObject::lookupKeyword ( ) const
inherited

Look up the keyword of the params group with the same name as the object.

Definition at line 42 of file BaseObject.cpp.

void PV::WeightsPairInterface::needPost ( )

Objects that need the postsynaptic weights should call this function, but should make sure that the WeightsPairInterface object has completed its communicate stage first.

Internally, this method calls the virtual createPostWeights() method.

Definition at line 116 of file WeightsPairInterface.cpp.

void PV::WeightsPairInterface::needPre ( )

Objects that need the presynaptic weights should call this function, but should make sure that the WeightsPairInterface object has completed its communicate stage first.

Internally, this method calls the virtual createPreWeights() method.

Definition at line 106 of file WeightsPairInterface.cpp.

void PV::BaseObject::readParams ( )
inlineinherited

A method that reads the parameters for the group whose name matches the name of the object. It, along with writeParams(), is a wrapper around ioParams, so that readParams and writeParams automatically run through the same parameters in the same order.

Definition at line 62 of file BaseObject.hpp.

void PV::BaseObject::setDataStructuresAllocatedFlag ( )
inlineprotectedinherited

This method sets mDataStructuresAllocatedFlag to true.

Definition at line 175 of file BaseObject.hpp.

void PV::BaseObject::setInitialValuesSetFlag ( )
inlineprotectedinherited

This method sets the flag returned by getInitialValuesSetFlag to true.

Definition at line 180 of file BaseObject.hpp.

void PV::BaseObject::setInitInfoCommunicatedFlag ( )
inlineprotectedinherited

This method sets mInitInfoCommunicatedFlag to true.

Definition at line 170 of file BaseObject.hpp.

void PV::BaseObject::writeParams ( )
inlineinherited

A method that writes the parameters for the group whose name matches the name of the object. It, along with readParams(), is a wrapper around ioParams, so that readParams and writeParams automatically run through the same parameters in the same order.

Definition at line 69 of file BaseObject.hpp.

The documentation for this class was generated from the following files: