Deep::Layer Class Reference

A deepity layer virtual class. More...

#include <Layer.h>

Inheritance diagram for Deep::Layer:

Public Member Functions
virtual	~Layer ()=default
virtual float *	GetBeliefs () noexcept=0
	Should return belief state z.
virtual const float *	GetErrors () const noexcept=0
	Should return errors e.
virtual size_t	GetInputSize () const noexcept=0
	Should return input size.
virtual size_t	GetOutputSize () const noexcept=0
	Should return output size.
virtual size_t	GetBatchSize () const noexcept=0
	Should return batch size.
virtual float	CalculateState () noexcept=0
	Calculates the internal state of the layer.
virtual void	UpdateState () noexcept=0
	Updates the states after calculation.
virtual void	UpdateWeights () noexcept=0
	Updates the weights after state updates.
virtual void	Flush () noexcept
	Flushes remaining batches.
virtual std::map< std::string, TensorDescriptor >	GetStateDict () const
	Returns a dictionary of this.

Protected Attributes
size_t	size
	Size of input.
size_t	nextSize
	Size of output.

Detailed Description

A deepity layer virtual class.

Constructor & Destructor Documentation

~Layer()

virtual Deep::Layer::~Layer ( )

virtualdefault

Member Function Documentation

CalculateState()

virtual float Deep::Layer::CalculateState ( )

pure virtualnoexcept

Calculates the internal state of the layer.

Returns

energy used

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

Flush()

virtual void Deep::Layer::Flush ( )

inlinevirtualnoexcept

Flushes remaining batches.

Reimplemented in Deep::ConvPCLayer, Deep::DiscriminativePCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

GetBatchSize()

virtual size_t Deep::Layer::GetBatchSize ( ) const

pure virtualnoexcept

Should return batch size.

Returns

? = 0

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

GetBeliefs()

virtual float * Deep::Layer::GetBeliefs ( )

pure virtualnoexcept

Should return belief state z.

Returns

? = 0

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

GetErrors()

virtual const float * Deep::Layer::GetErrors ( ) const

pure virtualnoexcept

Should return errors e.

Returns

? = 0

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

GetInputSize()

virtual size_t Deep::Layer::GetInputSize ( ) const

pure virtualnoexcept

Should return input size.

Returns

? = 0

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

GetOutputSize()

virtual size_t Deep::Layer::GetOutputSize ( ) const

pure virtualnoexcept

Should return output size.

Returns

? = 0

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

GetStateDict()

virtual std::map< std::string, TensorDescriptor > Deep::Layer::GetStateDict ( ) const

inlinevirtual

Returns a dictionary of this.

Reimplemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, and Deep::FullPCLayer.

UpdateState()

virtual void Deep::Layer::UpdateState ( )

pure virtualnoexcept

Updates the states after calculation.

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

UpdateWeights()

virtual void Deep::Layer::UpdateWeights ( )

pure virtualnoexcept

Updates the weights after state updates.

Implemented in Deep::ConvPCLayer, Deep::DirectKPPCLayer, Deep::DiscriminativePCLayer, Deep::FullPCLayer, Deep::GaussSeidelPCLayer, Deep::RBLayer, Deep::SimpleConvPCLayer, and Deep::SimplePCLayer.

Member Data Documentation

nextSize

size_t Deep::Layer::nextSize

protected

Size of output.

size

size_t Deep::Layer::size

protected

Size of input.

---

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

• include/deepity/layers/Layer.h