NeuronContainer.h

//-------------------------------------------------------------------------------------------------------
// Copyright (C) Taylor Woll and panann contributors. All rights reserved.
// Licensed under the MIT license. See LICENSE.txt file in the project root for
// full license information.
//-------------------------------------------------------------------------------------------------------
 
#ifndef NEURONCONTAINER_H__
#define NEURONCONTAINER_H__
 
#include <vector>
 
#include "ActivationFunction.h"
 
namespace panann {
 
class NeuronContainer {
 protected:
  struct Neuron {
    size_t input_connection_start_index;
    size_t input_connection_count;
    size_t output_connection_start_index;
    size_t output_connection_count;
    double field;
    double value;
    double error;
    ActivationFunctionType activation_function_type;
  };
 
 public:
  NeuronContainer() = default;
  NeuronContainer(const NeuronContainer&) = delete;
  NeuronContainer& operator=(const NeuronContainer&) = delete;
  virtual ~NeuronContainer() = default;
 
  void SetInputNeuronCount(size_t input_neuron_count);
 
  size_t GetInputNeuronCount() const;
 
  void SetOutputNeuronCount(size_t output_neuron_count);
 
  size_t GetOutputNeuronCount() const;
 
  size_t GetNeuronCount() const;
 
  const Neuron& GetNeuron(size_t neuron_index) const;
 
 protected:
  size_t GetHiddenNeuronStartIndex() const;
 
  size_t GetInputNeuronStartIndex() const;
 
  size_t GetOutputNeuronStartIndex() const;
 
  size_t GetBiasNeuronStartIndex() const;
 
  size_t GetHiddenNeuronCount() const;
 
  size_t GetBiasNeuronCount() const;
 
  size_t AddHiddenNeurons(size_t count);
 
  void AddBiasNeurons(size_t count);
 
  void AllocateNeurons();
 
  bool AreNeuronsAllocated() const;
 
  void SetNeuronActivationFunction(size_t neuron_index,
                                   ActivationFunctionType type);
 
  Neuron& GetNeuron(size_t neuron_index);
 
  Neuron& GetInputNeuron(size_t input_neuron_index);
 
  Neuron& GetOutputNeuron(size_t output_neuron_index);
 
  Neuron& GetBiasNeuron(size_t bias_neuron_index);
 
  Neuron& GetHiddenNeuron(size_t hidden_neuron_index);
 
  const Neuron& GetOutputNeuron(size_t output_neuron_index) const;
 
 private:
  std::vector<Neuron> neurons_;
  size_t input_neuron_count_ = 0;
  size_t output_neuron_count_ = 0;
  size_t hidden_neuron_count_ = 0;
 
  // There is always a bias neuron which will be hooked-up to output layer
  // neurons.
  size_t bias_neuron_count_ = 1;
  bool is_allocated_ = false;
};
 
}  // namespace panann
 
#endif  // NEURONCONTAINER_H__