Skip to main content

Crate sc_neurocore_engine

Crate sc_neurocore_engine 

Source

Modules§

analysis
attention
Stochastic Attention
bitstream
Bitstream Operations
brunel
Fused Brunel balanced network simulation in fixed-point Q8.8 arithmetic.
connectome
Biologically plausible connectivity generators.
conv
SC 2D convolutional layer using probability-domain multiplication.
cordiv
CORDIV: stochastic computing divider.
cortical_column
5-population cortical column (Douglas & Martin 2004). L4 (thalamic) → L2/3 exc ↔ L2/3 inh → L5 (output) → L6 (feedback → L4).
cortical_inject
Per-row-parallel CSR sparse matrix-vector add for the Potjans CorticalColumn block-CSR injection path.
dna
High-performance DNA strand displacement pipeline.
ei_network
Fused E-I balanced LIF network simulation in f64 arithmetic.
encoder
Stochastic Encoders
evo
Accelerates evolutionary substrate hot paths:
fault
Hardware fault injection for robustness testing.
fusion
Multi-modal fusion layer using stochastic multiplexing.
grad
graph
Stochastic Graph Layer
ir
SC Compute Graph IR
layer
Dense Stochastic Layer
lgssm
Rust implementation of the Kalman filter forward pass for a linear Gaussian state-space model.
network_runner
High-performance network simulation backend.
neuron
Neuron Models
neurons
optimizer
Accelerates SC-Optimizer hot paths:
partition
Kernighan-Lin local refinement for the chiplet hierarchical partitioner. Mirrors HierarchicalPartitioner._refine step-for-step so the Rust output is bit-identical to the Python reference (the algorithm is fully deterministic given a CSR adjacency, a list of per-edge |scc| weights, vertex weights, an initial part_map and (kl_iterations, correlation_penalty, n_parts)).
phi
Barrett & Seth 2011 geometric Phi under Gaussian assumption. Phi* = MI(past; future) - max_partition sum MI(past_k; future_k)
photonic
High-performance photonic network-on-chip primitives.
ping
Step-by-step parity with PINGCircuit.step in src/sc_neurocore/network/gamma_oscillation.py.
predictive_coding
Predictive coding via XOR + popcount in packed bitstream domain.
pyo3_neurons
PyO3 wrappers for all neuron models.
quantum
High-performance quantum annealing primitives.
rall_dendrite
Compartmental dendritic tree with Rall’s 3/2 power rule. Distal → proximal propagation with inter-compartment coupling.
recorder
Spike recording and statistics.
recurrent
SC recurrent/reservoir layer (echo state network).
rk4_neurons
Explicit RK4 ports for the priority neuron integrator paths.
scpn
simd
SIMD Popcount Dispatch
sobol
Sobol quasi-random bitstream generator.
synapses
Stochastic STDP Synapse
wilson_cowan
Batch parity with WilsonCowanUnit.step in src/sc_neurocore/neurons/models/wilson_cowan.py (Wilson & Cowan 1972, Biophys. J. 12:1–24).
wong_wang
Batch parity with WongWangUnit.step in src/sc_neurocore/neurons/models/wong_wang.py (Wong & Wang 2006, J. Neurosci. 26:1314–1328).

Structs§

BitstreamEncoder
DenseLayer
FixedPointLif
Lfsr16
PyAdExNeuron
PyBitStreamTensor
PyBitstreamAverager
PyBrunelNetwork
PyCorticalColumn
PyDifferentiableDenseLayer
PyExpIFNeuron
PyIzhikevich
PyKuramotoSolver
PyLapicqueNeuron
PyNetworkRunner
PyRallDendrite
PySCPNMetrics
PyScGraph
PyScGraphBuilder
PyStochasticAttention
PyStochasticGraphLayer
PySurrogateLif
StdpSynapse

Functions§

__pyfunction_batch_encode 🔒
__pyfunction_batch_encode_numpy 🔒
__pyfunction_batch_lif_run 🔒
__pyfunction_batch_lif_run_multi 🔒
__pyfunction_batch_lif_run_varying 🔒
__pyfunction_ir_emit_sv 🔒
__pyfunction_ir_parse 🔒
__pyfunction_ir_print 🔒
__pyfunction_ir_verify 🔒
__pyfunction_pack_bitstream 🔒
__pyfunction_pack_bitstream_numpy 🔒
__pyfunction_popcount 🔒
__pyfunction_popcount_numpy 🔒
__pyfunction_py_adaptive_length 🔒
__pyfunction_py_adaptive_spike_distance 🔒
__pyfunction_py_amplitude_cutoff 🔒
__pyfunction_py_approximate_entropy 🔒
__pyfunction_py_autocorrelation_time 🔒
__pyfunction_py_batch_simulate 🔒
__pyfunction_py_bayesian_decode 🔒
__pyfunction_py_bin_spike_train 🔒
__pyfunction_py_burst_detection 🔒
__pyfunction_py_cell_assembly_detection 🔒
__pyfunction_py_change_point_detection 🔒
__pyfunction_py_coincidence_index 🔒
__pyfunction_py_compound_poisson_process 🔒
__pyfunction_py_conditional_granger_causality 🔒
__pyfunction_py_conditional_intensity 🔒
__pyfunction_py_cordiv 🔒
__pyfunction_py_covariance_matrix 🔒
__pyfunction_py_cross_correlation 🔒
__pyfunction_py_cubic_higher_order 🔒
__pyfunction_py_cv2 🔒
__pyfunction_py_cv_isi 🔒
__pyfunction_py_d_prime 🔒
__pyfunction_py_demixed_pca 🔒
__pyfunction_py_directed_transfer_function 🔒
__pyfunction_py_dna_check_cross_hybridization 🔒
__pyfunction_py_dna_design_orthogonal_set 🔒
__pyfunction_py_dna_design_sequence 🔒
__pyfunction_py_dna_detect_hairpins 🔒
__pyfunction_py_dna_simulate_kinetics 🔒
__pyfunction_py_drift_metric 🔒
__pyfunction_py_earth_movers_distance 🔒
__pyfunction_py_event_synchronization 🔒
__pyfunction_py_evo_batch_crossover 🔒
__pyfunction_py_evo_batch_fitness 🔒
__pyfunction_py_evo_batch_mutate 🔒
__pyfunction_py_evo_diversity 🔒
__pyfunction_py_evo_novelty 🔒
__pyfunction_py_evo_tournament 🔒
__pyfunction_py_factor_analysis 🔒
__pyfunction_py_fano_factor 🔒
__pyfunction_py_firing_rate 🔒
__pyfunction_py_first_spike_latency 🔒
__pyfunction_py_functional_connectivity 🔒
__pyfunction_py_gamma_process 🔒
__pyfunction_py_gaussian_attention 🔒
__pyfunction_py_gpfa 🔒
__pyfunction_py_gpfa_transform 🔒
__pyfunction_py_homogeneous_poisson 🔒
__pyfunction_py_hunter_milton_similarity 🔒
__pyfunction_py_hurst_exponent 🔒
__pyfunction_py_infonce_loss 🔒
__pyfunction_py_inject_bitflip_u8 🔒
__pyfunction_py_inject_dropout_u8 🔒
__pyfunction_py_inject_gaussian_u8 🔒
__pyfunction_py_inject_stuck_at_0_u8 🔒
__pyfunction_py_inject_stuck_at_1_u8 🔒
__pyfunction_py_instantaneous_rate 🔒
__pyfunction_py_isi 🔒
__pyfunction_py_isi_distance 🔒
__pyfunction_py_isi_hazard_function 🔒
__pyfunction_py_isi_profile 🔒
__pyfunction_py_isi_survivor_function 🔒
__pyfunction_py_isi_violation_rate 🔒
__pyfunction_py_isolation_distance 🔒
__pyfunction_py_joint_psth 🔒
__pyfunction_py_kl_refine 🔒
__pyfunction_py_kozachenko_leonenko_mi 🔒
__pyfunction_py_l_ratio 🔒
__pyfunction_py_lempel_ziv_complexity 🔒
__pyfunction_py_lgssm_kalman_filter 🔒
__pyfunction_py_linear_discriminant_decode 🔒
__pyfunction_py_local_variation 🔒
__pyfunction_py_maximum_likelihood_decode 🔒
__pyfunction_py_multi_neuron_victor_purpura 🔒
__pyfunction_py_mutual_information 🔒
__pyfunction_py_naive_bayes_decode 🔒
__pyfunction_py_nn_hit_rate 🔒
__pyfunction_py_noise_correlation 🔒
__pyfunction_py_noise_entropy 🔒
__pyfunction_py_opt_extract_pareto 🔒
__pyfunction_py_opt_sa_search 🔒
__pyfunction_py_pairwise_correlation 🔒
__pyfunction_py_pairwise_granger_causality 🔒
__pyfunction_py_parallel_csr_multi_spmv_add 🔒
__pyfunction_py_parallel_csr_spmv_add 🔒
__pyfunction_py_partial_directed_coherence 🔒
__pyfunction_py_permutation_entropy 🔒
__pyfunction_py_ph_analyze_crosstalk 🔒
__pyfunction_py_ph_analyze_crosstalk_bank 🔒
__pyfunction_py_ph_analyze_crosstalk_pairs 🔒
__pyfunction_py_ph_analyze_power_budget 🔒
__pyfunction_py_ph_cascade_mzi 🔒
__pyfunction_py_ph_mzi_transfer_matrix 🔒
__pyfunction_py_ph_route_waveguides 🔒
__pyfunction_py_phase_locking_value 🔒
__pyfunction_py_phi_star 🔒
__pyfunction_py_ping_step 🔒
__pyfunction_py_place_field_detection 🔒
__pyfunction_py_population_vector_decode 🔒
__pyfunction_py_power_spectrum 🔒
__pyfunction_py_predict_xor_ema 🔒
__pyfunction_py_predict_xor_lfsr 🔒
__pyfunction_py_prediction_error 🔒
__pyfunction_py_presence_ratio 🔒
__pyfunction_py_psth 🔒
__pyfunction_py_qa_batch_ising_energy 🔒
__pyfunction_py_qa_gauge_transform 🔒
__pyfunction_py_qa_generate_gauges 🔒
__pyfunction_py_qa_greedy_partition 🔒
__pyfunction_py_qa_ising_energy 🔒
__pyfunction_py_qa_simulated_annealing 🔒
__pyfunction_py_recover_xor_ema 🔒
__pyfunction_py_recover_xor_lfsr 🔒
__pyfunction_py_renewal_density 🔒
__pyfunction_py_response_onset 🔒
__pyfunction_py_sample_entropy 🔒
__pyfunction_py_scaled_dot_product_attention 🔒
__pyfunction_py_schreiber_similarity 🔒
__pyfunction_py_signal_correlation 🔒
__pyfunction_py_silhouette_score 🔒
__pyfunction_py_simulate_ei_network 🔒
__pyfunction_py_sinusoidal_position_encode 🔒
__pyfunction_py_snr 🔒
__pyfunction_py_spade_detect 🔒
__pyfunction_py_spatial_information 🔒
__pyfunction_py_spectral_granger_causality 🔒
__pyfunction_py_spike_count 🔒
__pyfunction_py_spike_count_covariance 🔒
__pyfunction_py_spike_directionality 🔒
__pyfunction_py_spike_distance 🔒
__pyfunction_py_spike_distance_matrix 🔒
__pyfunction_py_spike_field_coherence 🔒
__pyfunction_py_spike_phase_histogram 🔒
__pyfunction_py_spike_profile 🔒
__pyfunction_py_spike_sync 🔒
__pyfunction_py_spike_sync_profile 🔒
__pyfunction_py_spike_time_tiling_coefficient 🔒
__pyfunction_py_spike_times 🔒
__pyfunction_py_spike_train_coherence 🔒
__pyfunction_py_spike_train_entropy 🔒
__pyfunction_py_spike_train_order 🔒
__pyfunction_py_spike_train_pca 🔒
__pyfunction_py_spike_triggered_average 🔒
__pyfunction_py_spike_triggered_covariance 🔒
__pyfunction_py_stimulus_specific_information 🔒
__pyfunction_py_surrogate_bin_shuffling 🔒
__pyfunction_py_surrogate_dither 🔒
__pyfunction_py_surrogate_isi_shuffle 🔒
__pyfunction_py_surrogate_joint_isi 🔒
__pyfunction_py_surrogate_spike_train_shifting 🔒
__pyfunction_py_synfire_chain_detection 🔒
__pyfunction_py_tokenise_spikes 🔒
__pyfunction_py_transfer_entropy 🔒
__pyfunction_py_tuning_curve 🔒
__pyfunction_py_unitary_events 🔒
__pyfunction_py_van_rossum_distance 🔒
__pyfunction_py_victor_purpura_distance 🔒
__pyfunction_py_waveform_amplitude 🔒
__pyfunction_py_waveform_halfwidth 🔒
__pyfunction_py_waveform_pt_ratio 🔒
__pyfunction_py_waveform_recovery_slope 🔒
__pyfunction_py_waveform_repolarization_slope 🔒
__pyfunction_py_waveform_width 🔒
__pyfunction_py_wilson_cowan_simulate 🔒
__pyfunction_py_wong_wang_simulate 🔒
__pyfunction_set_num_threads 🔒
__pyfunction_simd_tier 🔒
__pyfunction_unpack_bitstream 🔒
__pyfunction_unpack_bitstream_numpy 🔒
batch_encode 🔒
Bernoulli-encode a numpy float64 array into packed bitstream words.
batch_encode_numpy 🔒
Bernoulli-encode a numpy float64 array into a 2-D numpy uint64 array.
batch_lif_run 🔒
Run a LIF neuron for N steps with constant inputs.
batch_lif_run_multi 🔒
Run N independent LIF neurons in parallel, each with its own constant input.
batch_lif_run_varying 🔒
Run a LIF neuron for N steps with per-step current and optional noise arrays.
extract_matrix_f64 🔒
ir_emit_sv 🔒
Emit SystemVerilog from an IR graph.
ir_parse 🔒
Parse an IR graph from text format.
ir_print 🔒
Print an IR graph to its stable text format.
ir_verify 🔒
Verify an IR graph. Returns None on success, or a list of error strings.
pack_bitstream 🔒
pack_bitstream_numpy 🔒
Pack a 1-D numpy uint8 array into packed u64 words, returning a numpy array. Zero-copy input, single-allocation output.
parse_sc_type 🔒
Parse a Python type string into ScType.
parse_surrogate 🔒
popcount 🔒
popcount_numpy 🔒
Popcount on a numpy uint64 array — zero-copy input.
py_adaptive_length 🔒
py_adaptive_spike_distance 🔒
py_amplitude_cutoff 🔒
py_approximate_entropy 🔒
py_autocorrelation_time 🔒
py_batch_simulate 🔒
Run a named neuron model for n_steps with a current trace, returning voltage trace + spike indices. Entire simulation in Rust.
py_bayesian_decode 🔒
py_bin_spike_train 🔒
py_burst_detection 🔒
py_cell_assembly_detection 🔒
py_change_point_detection 🔒
py_coincidence_index 🔒
py_compound_poisson_process 🔒
py_conditional_granger_causality 🔒
py_conditional_intensity 🔒
py_cordiv 🔒
py_covariance_matrix 🔒
py_cross_correlation 🔒
py_cubic_higher_order 🔒
py_cv2 🔒
py_cv_isi 🔒
py_d_prime 🔒
py_demixed_pca 🔒
py_directed_transfer_function 🔒
py_dna_check_cross_hybridization 🔒
py_dna_design_orthogonal_set 🔒
py_dna_design_sequence 🔒
py_dna_detect_hairpins 🔒
py_dna_simulate_kinetics 🔒
py_drift_metric 🔒
py_earth_movers_distance 🔒
py_event_synchronization 🔒
py_evo_batch_crossover 🔒
Batch uniform crossover (Rust-accelerated).
py_evo_batch_fitness 🔒
Batch fitness evaluation (Rust-accelerated).
py_evo_batch_mutate 🔒
Batch-mutate population weights (Rust-accelerated).
py_evo_diversity 🔒
Population diversity (mean pairwise L2 distance).
py_evo_novelty 🔒
Novelty scores against archive.
py_evo_tournament 🔒
Tournament selection.
py_factor_analysis 🔒
py_fano_factor 🔒
py_firing_rate 🔒
py_first_spike_latency 🔒
py_functional_connectivity 🔒
py_gamma_process 🔒
py_gaussian_attention 🔒
py_gpfa 🔒
py_gpfa_transform 🔒
py_homogeneous_poisson 🔒
py_hunter_milton_similarity 🔒
py_hurst_exponent 🔒
py_infonce_loss 🔒
py_inject_bitflip_u8 🔒
py_inject_dropout_u8 🔒
py_inject_gaussian_u8 🔒
py_inject_stuck_at_0_u8 🔒
py_inject_stuck_at_1_u8 🔒
py_instantaneous_rate 🔒
py_isi 🔒
py_isi_distance 🔒
py_isi_hazard_function 🔒
py_isi_profile 🔒
py_isi_survivor_function 🔒
py_isi_violation_rate 🔒
py_isolation_distance 🔒
py_joint_psth 🔒
py_kl_refine 🔒
py_kozachenko_leonenko_mi 🔒
py_l_ratio 🔒
py_lempel_ziv_complexity 🔒
py_lgssm_kalman_filter 🔒
Forward Kalman filter for a Linear Gaussian State-Space Model.
py_linear_discriminant_decode 🔒
py_local_variation 🔒
py_maximum_likelihood_decode 🔒
py_multi_neuron_victor_purpura 🔒
py_mutual_information 🔒
py_naive_bayes_decode 🔒
py_nn_hit_rate 🔒
py_noise_correlation 🔒
py_noise_entropy 🔒
py_opt_extract_pareto 🔒
Extract Pareto frontier from (luts, power, score) arrays.
py_opt_sa_search 🔒
Run SA design-space search (Rust-accelerated).
py_pairwise_correlation 🔒
py_pairwise_granger_causality 🔒
py_parallel_csr_multi_spmv_add 🔒
py_parallel_csr_spmv_add 🔒
py_partial_directed_coherence 🔒
py_permutation_entropy 🔒
py_ph_analyze_crosstalk 🔒
Analyze WDM crosstalk (Rust-accelerated).
py_ph_analyze_crosstalk_bank 🔒
Geometric crosstalk analysis for a uniform bank of parallel waveguides.
py_ph_analyze_crosstalk_pairs 🔒
Per-pair geometric crosstalk for arbitrary waveguide geometry. pairs_a[i], pairs_b[i], gaps_nm[i], lengths_um[i] describe pair i. Evaluated in parallel via Rayon — the O(N²) analysis path.
py_ph_analyze_power_budget 🔒
Analyze optical power budget (Rust-accelerated).
py_ph_cascade_mzi 🔒
Cascade multiple MZI stages via matrix multiplication.
py_ph_mzi_transfer_matrix 🔒
Compute MZI 2×2 transfer matrix for a given phase.
py_ph_route_waveguides 🔒
Route waveguides on a mesh topology (Rust-accelerated).
py_phase_locking_value 🔒
py_phi_star 🔒
py_ping_step 🔒
py_place_field_detection 🔒
py_population_vector_decode 🔒
py_power_spectrum 🔒
py_predict_xor_ema 🔒
py_predict_xor_lfsr 🔒
py_prediction_error 🔒
py_presence_ratio 🔒
py_psth 🔒
py_qa_batch_ising_energy 🔒
Batch compute Ising energies for many configurations.
py_qa_gauge_transform 🔒
Apply gauge transform to Ising biases and couplings.
py_qa_generate_gauges 🔒
Generate random gauge vectors.
py_qa_greedy_partition 🔒
Greedy graph partitioning for problem decomposition.
py_qa_ising_energy 🔒
Compute Ising energy for a spin configuration.
py_qa_simulated_annealing 🔒
Run simulated annealing on an Ising model (Rust-accelerated).
py_recover_xor_ema 🔒
py_recover_xor_lfsr 🔒
py_renewal_density 🔒
py_response_onset 🔒
py_sample_entropy 🔒
py_scaled_dot_product_attention 🔒
py_schreiber_similarity 🔒
py_signal_correlation 🔒
py_silhouette_score 🔒
py_simulate_ei_network 🔒
py_sinusoidal_position_encode 🔒
py_snr 🔒
py_spade_detect 🔒
py_spatial_information 🔒
py_spectral_granger_causality 🔒
py_spike_count 🔒
py_spike_count_covariance 🔒
py_spike_directionality 🔒
py_spike_distance 🔒
py_spike_distance_matrix 🔒
py_spike_field_coherence 🔒
py_spike_phase_histogram 🔒
py_spike_profile 🔒
py_spike_sync 🔒
py_spike_sync_profile 🔒
py_spike_time_tiling_coefficient 🔒
py_spike_times 🔒
py_spike_train_coherence 🔒
py_spike_train_entropy 🔒
py_spike_train_order 🔒
py_spike_train_pca 🔒
py_spike_triggered_average 🔒
py_spike_triggered_covariance 🔒
py_stimulus_specific_information 🔒
py_surrogate_bin_shuffling 🔒
py_surrogate_dither 🔒
py_surrogate_isi_shuffle 🔒
py_surrogate_joint_isi 🔒
py_surrogate_spike_train_shifting 🔒
py_synfire_chain_detection 🔒
py_tokenise_spikes 🔒
py_transfer_entropy 🔒
py_tuning_curve 🔒
py_unitary_events 🔒
py_van_rossum_distance 🔒
py_victor_purpura_distance 🔒
py_waveform_amplitude 🔒
py_waveform_halfwidth 🔒
py_waveform_pt_ratio 🔒
py_waveform_recovery_slope 🔒
py_waveform_repolarization_slope 🔒
py_waveform_width 🔒
py_wilson_cowan_simulate 🔒
Simulate a single Wilson-Cowan E/I unit for ext_input.len() steps and return per-step e, i traces plus final scalars.
py_wong_wang_simulate 🔒
Simulate a single Wong-Wang unit for stim1.len() steps and return the per-step state traces + firing-rate traces.
reshape_flat_to_rows 🔒
sc_neurocore_engine 🔒
SC-NeuroCore ─ High-Performance Rust Engine
set_num_threads 🔒
Set the number of threads in the global rayon thread pool.
simd_tier 🔒
Returns the highest SIMD tier available on this CPU.
unpack_bitstream 🔒
unpack_bitstream_numpy 🔒
Unpack a numpy uint64 array back to a numpy uint8 array.