geopm::NNFactory Class Reference

Class to generate objects related to feed-forward neural nets, i.e. TensorOneD, TensorTwoD, DenseLayer, and LocalNeuralNet objects. More...

#include <NNFactory.hpp>

Inheritance diagram for geopm::NNFactory:

Public Member Functions
virtual	~NNFactory ()=default
virtual std::shared_ptr< LocalNeuralNet >	createLocalNeuralNet (const std::vector< std::shared_ptr< DenseLayer > > &layers) const =0
	Create a LocalNeuralNet.
virtual std::shared_ptr< DenseLayer >	createDenseLayer (const TensorTwoD &weights, const TensorOneD &biases) const =0
	Create a Dense Layer.
virtual TensorTwoD	createTensorTwoD (const std::vector< std::vector< double > > &vals) const =0
	Create a TensorTwoD object.
virtual TensorOneD	createTensorOneD (const std::vector< double > &vals) const =0
	Create a TensorOneD object.

Static Public Member Functions
static std::unique_ptr< NNFactory >	make_unique ()
	Returns a unique pointer to a concrete object constructed using the underlying implementation.
static std::shared_ptr< NNFactory >	make_shared ()
	Returns a shared pointer to a concrete object constructed using the underlying implementation.

Detailed Description

Class to generate objects related to feed-forward neural nets, i.e. TensorOneD, TensorTwoD, DenseLayer, and LocalNeuralNet objects.

Constructor & Destructor Documentation

~NNFactory()

virtual geopm::NNFactory::~NNFactory ( )

virtualdefault

Member Function Documentation

createDenseLayer()

virtual std::shared_ptr< DenseLayer > geopm::NNFactory::createDenseLayer ( const TensorTwoD &  weights, const TensorOneD &  biases  ) const

pure virtual

Create a Dense Layer.

Parameters

[in]	weights	TensorTwoD instance (matrix)
[in]	biases	TensorOneD instance (vector)

Returns

Returns a shared pointer to the DenseLayer instance

Implemented in geopm::NNFactoryImp.

createLocalNeuralNet()

virtual std::shared_ptr< LocalNeuralNet > geopm::NNFactory::createLocalNeuralNet ( const std::vector< std::shared_ptr< DenseLayer > > &  layers ) const

pure virtual

Create a LocalNeuralNet.

Parameters

[in]

layers

A shared pointer to a vector of DenseLayers

Returns

Returns a shared pointer to a LocalNeuralNet instance

Implemented in geopm::NNFactoryImp.

createTensorOneD()

virtual TensorOneD geopm::NNFactory::createTensorOneD ( const std::vector< double > &  vals ) const

pure virtual

Create a TensorOneD object.

Parameters

[in]

vals

Vector of doubles to fill TensorOneD object

Returns

Returns a TensorOneD instance

Implemented in geopm::NNFactoryImp.

createTensorTwoD()

virtual TensorTwoD geopm::NNFactory::createTensorTwoD ( const std::vector< std::vector< double > > &  vals ) const

pure virtual

Create a TensorTwoD object.

Parameters

[in]

vals

Matrix doubles to fill TensorTwoD object

Returns

Returns a TensorTwoD instance

Implemented in geopm::NNFactoryImp.

make_shared()

std::shared_ptr< NNFactory > geopm::NNFactory::make_shared ( )

static

Returns a shared pointer to a concrete object constructed using the underlying implementation.

make_unique()

std::unique_ptr< NNFactory > geopm::NNFactory::make_unique ( )

static

Returns a unique pointer to a concrete object constructed using the underlying implementation.

---

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

• NNFactory.hpp
• NNFactory.cpp