NeuralAmpModeler-rs 3.0.2

An opinionated, high-performance Neural Amp Modeler (NAM) client and core implementation in Rust for Linux/PipeWire and CLAP plugins.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 Fábio Henrique de Lima Silva (fhl.bsb@gmail.com) All rights reserved.

//! Optimized Softsign activation kernels.

use crate::activation_simd_avx2;
use crate::activation_simd_avx512;
use core::arch::x86_64::*;

/// Vector approximation of `Softsign(x) = x / (1 + |x|)` using AVX2.
///
/// Uses `_mm256_rcp_ps` with a Newton-Raphson iteration for ~24-bit precision.
///
/// # Safety
/// Requires AVX2 and FMA support.
#[target_feature(enable = "avx2,fma")]
pub unsafe fn simd_softsign_avx2(x: __m256) -> __m256 {
    let one = _mm256_set1_ps(1.0);
    let two = _mm256_set1_ps(2.0);
    // abs_x = x & 0x7FFFFFFF
    let abs_x = _mm256_andnot_ps(_mm256_set1_ps(-0.0), x);
    let den = _mm256_add_ps(one, abs_x);

    // Reciprocal with double Newton-Raphson (saturates f32)
    let mut res = _mm256_rcp_ps(den);
    res = _mm256_mul_ps(res, _mm256_fnmadd_ps(den, res, two));
    res = _mm256_mul_ps(res, _mm256_fnmadd_ps(den, res, two));

    _mm256_mul_ps(x, res)
}

/// Vector approximation of `Softsign(x)` (Dual, 16 floats).
///
/// # Safety
/// Requires AVX2 and FMA support.
#[target_feature(enable = "avx2,fma")]
pub unsafe fn simd_softsign_dual_avx2(x1: __m256, x2: __m256) -> (__m256, __m256) {
    let one = _mm256_set1_ps(1.0);
    let two = _mm256_set1_ps(2.0);
    let zero_minus = _mm256_set1_ps(-0.0);

    let abs_x1 = _mm256_andnot_ps(zero_minus, x1);
    let abs_x2 = _mm256_andnot_ps(zero_minus, x2);
    let den1 = _mm256_add_ps(one, abs_x1);
    let den2 = _mm256_add_ps(one, abs_x2);

    let mut res1 = _mm256_rcp_ps(den1);
    let mut res2 = _mm256_rcp_ps(den2);

    // 1st NR iteration
    res1 = _mm256_mul_ps(res1, _mm256_fnmadd_ps(den1, res1, two));
    res2 = _mm256_mul_ps(res2, _mm256_fnmadd_ps(den2, res2, two));
    // 2nd NR iteration: saturates f32 mantissa
    res1 = _mm256_mul_ps(res1, _mm256_fnmadd_ps(den1, res1, two));
    res2 = _mm256_mul_ps(res2, _mm256_fnmadd_ps(den2, res2, two));

    (_mm256_mul_ps(x1, res1), _mm256_mul_ps(x2, res2))
}

/// Vector approximation of `Softsign(x) = x / (1 + |x|)` using AVX-512.
///
/// # Safety
/// Requires AVX-512F, AVX-512VL and AVX-512DQ support.
#[target_feature(enable = "avx512f,avx512vl,avx512dq")]
pub unsafe fn simd_softsign_avx512(x: __m512) -> __m512 {
    let one = _mm512_set1_ps(1.0);
    let two = _mm512_set1_ps(2.0);

    // _mm512_andnot_ps requires AVX-512DQ. With the feature enabled in context, the call is safe.
    let abs_x = _mm512_andnot_ps(_mm512_set1_ps(-0.0), x);
    let den = _mm512_add_ps(one, abs_x);

    // Reciprocal with double Newton-Raphson (saturates f32)
    let mut res = _mm512_rcp14_ps(den);
    res = _mm512_mul_ps(res, _mm512_fnmadd_ps(den, res, two));
    res = _mm512_mul_ps(res, _mm512_fnmadd_ps(den, res, two));

    _mm512_mul_ps(x, res)
}

/// Applies Softsign activation to a slice of f32 using AVX2 optimization.
///
/// # Safety
/// Requires AVX2 and FMA support.
#[target_feature(enable = "avx2,fma")]
pub unsafe fn softsign_slice_avx2(slice: &mut [f32]) {
    let mut i = 0;
    let len = slice.len();

    unsafe {
        activation_simd_avx2!(
            i,
            len,
            {
                let x1 = _mm256_loadu_ps(slice.as_ptr().add(i));
                let x2 = _mm256_loadu_ps(slice.as_ptr().add(i + 8));
                let (y1, y2) = simd_softsign_dual_avx2(x1, x2);
                _mm256_storeu_ps(slice.as_mut_ptr().add(i), y1);
                _mm256_storeu_ps(slice.as_mut_ptr().add(i + 8), y2);
            },
            {
                let x = _mm256_loadu_ps(slice.as_ptr().add(i));
                let y = simd_softsign_avx2(x);
                _mm256_storeu_ps(slice.as_mut_ptr().add(i), y);
            }
        );
    }

    for item in slice.iter_mut().skip(i) {
        *item /= 1.0 + item.abs();
    }
}

/// Applies Softsign activation to a slice of f32 using AVX-512 optimization.
///
/// # Safety
/// Requires AVX-512F, AVX-512VL and AVX-512DQ support.
#[target_feature(enable = "avx512f,avx512vl,avx512dq")]
pub unsafe fn softsign_slice_avx512(slice: &mut [f32]) {
    let mut i = 0;
    let len = slice.len();

    unsafe {
        activation_simd_avx512!(i, len, {
            let x = _mm512_loadu_ps(slice.as_ptr().add(i));
            let y = simd_softsign_avx512(x);
            _mm512_storeu_ps(slice.as_mut_ptr().add(i), y);
        });
    }

    for item in slice.iter_mut().skip(i) {
        *item /= 1.0 + item.abs();
    }
}

/// Scalar version of `softsign` (x / (1 + |x|)).
#[inline(always)]
pub fn softsign(x: f32) -> f32 {
    x / (1.0 + x.abs())
}