ISpikingNeuron.cs

Go to the documentation of this file.

namespace SpikingNeuronNetwork.Lib.Interfaces
{
    using System.Collections.Generic;
    using Training;
    
    public interface ISpikingNeuron
    {
        int NeuronIndex { get; set; }

        SpikingNeuronNetwork NeuronNetwork { get; set; }
        
        bool Verbose { get; set; }

        NeuronState State { get; }
        
        SimulationMethod Method { get; set; }

        double PostSpikeState { get; }

        double InitialState { get; }

        bool IsStandAloneNeuron { get; }

        double RemainingTimeToSpike { get; }

        double NextSpikeTime { get; }

        int NumInputs { get; }

        Dictionary<Synapse, double> Weights { get; }

        string ToString();

        ISpikingNeuron Clone();

        void ResetState();

        List<Spike> RunThetaNeuron(List<Spike> inputSpikes, int maxNumOutputSpikes);
 
        IEnumerable<Spike> ProcessSpike(Spike spike, out SpikeStats spikeStats);

        List<double> CalculatePostSpikeDerivativesNumerical(NeuronFiringHistory neuronFiringHistory);

        List<double> CalculatePostSpikeDerivatives(NeuronFiringHistory neuronFiringHistory);

        Dictionary<Synapse, NeuronDerivativeParameters> CalculateOutputSpikeTimeDerivativesNumerical(NeuronFiringHistory neuronFiringHistory);

        Dictionary<Synapse, NeuronDerivativeParameters> CalculateOutputSpikeTimeDerivatives(NeuronFiringHistory neuronFiringHistory);
    }
}