#[non_exhaustive]pub enum Error {
Show 16 variants
SelfConnection,
NeuronCountOutOfRange,
ZeroTimeStep,
FrozenMembrane,
NeuronIdOutOfRange,
DivisorOutOfRange,
BadLayerSizes,
MissingNeuronType,
ProbabilityOutOfRange,
PlasticityEnabled,
NeuronCountMismatch,
SynapseCountMismatch,
MixedVoltageGrids,
BadCaseName,
NeuronNotAtRest,
NeuronIdMismatch,
}Expand description
Crate-level error type.
The network’s fallible functions, Synapse::new, FixedNetwork::try_from
and trace::header return Result<T> via this type; nir’s
return NirError, the bridge’s and the kernel’s
BridgeError, and trace::row a fmt::Result. Infallible accessors
return plain values. No unwrap() outside tests (v0.1 lesson); the
expects outside them, in nir’s graph assembly and in
freeze::module, each follow the check they name, and a NirImport
edited after it was built can still reach the assembly’s
(NirImport::build_network § Panics).
One variant per rule: a refusal returns the variant of the rule it
breaks, and a function’s # Errors names the variants it returns. Not
exhaustive: a new rule may add a variant in a minor release. The
variants’ order and their integer values (an as cast) are not
promised. A call that breaks two rules returns the variant of one of
them, and which one is not promised.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
SelfConnection
A synapse from a neuron to itself (Synapse::new, and
SpikingNeuralNetwork::add_synapse through it).
NeuronCountOutOfRange
A network of no neuron, or of more than 65,535: ids are u16
(SpikingNeuralNetwork::new and from_neurons).
ZeroTimeStep
A time step of zero (SpikingNeuralNetwork::new and
from_neurons).
FrozenMembrane
A neuron whose membrane cannot move at the network’s time step: a
membrane time constant of 0 or above 1,000 time steps, where
dt_over_tau truncates to 0 (SpikingNeuralNetwork::new and
from_neurons).
NeuronIdOutOfRange
A neuron id not below the network’s neuron count
(SpikingNeuralNetwork::add_synapse).
DivisorOutOfRange
A synaptic input divisor of 0 or above 32,767
(SpikingNeuralNetwork::set_synaptic_input_divisor): the step
divides by it as an i16.
BadLayerSizes
A Feedforward layer list with a layer of no neuron, or whose sizes
do not sum to the neuron count
(SpikingNeuralNetwork::build_topology).
MissingNeuronType
A Balanced ratio that leaves the network no excitatory or no
inhibitory neuron (SpikingNeuralNetwork::build_topology).
ProbabilityOutOfRange
A Random connectivity or a SmallWorld rewiring probability
outside 0 to 1, NaN included
(SpikingNeuralNetwork::build_topology).
PlasticityEnabled
A network with plasticity enabled, which a FixedNetwork does not
have (FixedNetwork::try_from).
NeuronCountMismatch
A network whose neuron count is not the FixedNetwork’s N
(FixedNetwork::try_from).
SynapseCountMismatch
A network whose synapse count is not the FixedNetwork’s S
(FixedNetwork::try_from).
MixedVoltageGrids
Neurons on more than one voltage grid: a network keeps one
(SpikingNeuralNetwork::from_neurons, and trace::header as a
guard).
BadCaseName
A trace case name that is empty or holds anything but lowercase
ASCII letters, digits and - (trace::header).
NeuronNotAtRest
A neuron that is not at rest: its membrane off its resting
potential, refractory time left, a current or a stamp, none of which
LIFNeuron::new and the with_* chain build
(SpikingNeuralNetwork::from_neurons).
NeuronIdMismatch
A neuron whose id is not its position among the neurons given
(SpikingNeuralNetwork::from_neurons).
Trait Implementations§
impl Copy for Error
impl Eq for Error
Source§impl Error for Error
impl Error for Error
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()