Kaspersky Neuromorphic Platform  1.0.0
API Reference
Loading...
Searching...
No Matches
knp::core Namespace Reference

Core library namespace. More...

Namespaces

namespace  messaging
 Messaging namespace.
 
namespace  tags
 Namespace for known tags.
 

Detailed Description

Core library namespace.

Typedef Documentation

◆ AllPopulations

List of population types based on neuron types specified in knp::neuron_traits::AllNeurons.

AllPopulations takes the value of Population<NeuronType_1>, Population<NeuronType_2>, ..., Population<NeuronType_n>, where NeuronType_[1..n] is the neuron type specified in knp::neuron_traits::AllNeurons.
For example, if knp::neuron_traits::AllNeurons contains BLIFATNeuron and IzhikevichNeuron types, then AllPopulations = Population<BLIFATNeuron>, Population<IzhikevichNeuron>.

Definition at line 248 of file population.h.

◆ AllPopulationsVariant

using knp::core::AllPopulationsVariant = boost::mp11::mp_rename<AllPopulations, std::variant>

Population variant that contains any population type specified in AllPopulations.

AllPopulationVariants takes the value of std::variant<PopulationType_1,..., PopulationType_n>, where PopulationType_[1..n] is the population type specified in AllPopulations.
For example, if AllPopulations contains BLIFATNeuron and IzhikevichNeuron types, then AllPopulationVariants = std::variant<BLIFATNeuron, IzhikevichNeuron>.
AllPopulationVariants retains the same order of message types as defined in AllPopulations.

See also
ALL_NEURONS.

Definition at line 259 of file population.h.

◆ AllProjections

List of projection types based on synapse types specified in knp::synapse_traits::AllSynapses.

AllProjections takes the value of Projection<SynapseType_1>, Projection<SynapseType_2>, ..., Projection<SynapseType_n>, where SynapseType_[1..n] is the synapse type specified in knp::synapse_traits::AllSynapses.
For example, if knp::synapse_traits::AllSynapses contains DeltaSynapse and AdditiveSTDPSynapse types, then AllProjections = Population<DeltaSynapse>, Population<AdditiveSTDPSynapse>.

Definition at line 427 of file projection.h.

◆ AllProjectionsVariant

using knp::core::AllProjectionsVariant = boost::mp11::mp_rename<AllProjections, std::variant>

Projection variant that contains any projection type specified in AllProjections.

AllProjectionVariants takes the value of std::variant<ProjectionType_1,..., ProjectionType_n>, where ProjectionType_[1..n] is the projection type specified in AllProjections.
For example, if AllProjections contains DeltaSynapse and AdditiveSTDPSynapse types, then AllProjectionVariants = std::variant<DeltaSynapse, AdditiveSTDPSynapse>.
AllProjectionVariants retains the same order of message types as defined in AllProjections.

See also
ALL_SYNAPSES.

Definition at line 438 of file projection.h.

◆ Step

using knp::core::Step = uint64_t

Type used to store a step number in the form of a 64-bit unsigned integer.

Definition at line 68 of file core.h.

Enumeration Type Documentation

◆ DeviceType

enum class knp::core::DeviceType
strong

The DeviceType class defines IDs of supported device types.

Enumerator
CPU 

CPU device.

GPU 

GPU device.

AltAI1_NPU 

NPU device.

Definition at line 37 of file device.h.

◆ SynapseElementAccess

Enumeration used to access connection.

Enumerator
synapse_data 

Getting synapse parameters.

source_neuron_id 

Getting source neuron index.

target_neuron_id 

Getting target neuron index.

Definition at line 49 of file projection.h.

Function Documentation

◆ operator<<()

inline ::std::ostream & knp::core::operator<< ( std::ostream & s,
const UID & uid )

Send UID to an output stream.

Parameters
soutput stream.
uidUID to send to the output stream.
Returns
modified stream.

Definition at line 186 of file uid.h.

◆ operator>>()

inline ::std::istream & knp::core::operator>> ( std::istream & s,
UID & uid )

Get UID from an input stream.

Parameters
sinput stream.
uidUID to get from the input stream.
Returns
modified stream.

Definition at line 198 of file uid.h.