SimpleSIMD 4.6.0

SimpleSIMD

What is SIMD?

Single Instruction, Multiple Data (SIMD) units refer to hardware components that perform the same operation on multiple data operands concurrently. The concurrency is performed on a single thread, while utilizing the full size of the processor register to perform several operations at one.
This approach could be combined with standard multithreading for massive performence boosts in numeric computations.

Goals And Purpose

• Single API to unify SIMD for All supported types
• Gain performence boost for mathematical computations using a simple API
• Simplifies SIMD usage, and to make it easy to integrate it into an already existing solutions
• Helps generalize several methemathical functions for supported types
• Performs less allocations compared to standard LINQ implementations

Available Functions

<details> <summary><h4>Comparison</h4></summary>

• Equal

• Greater

• GreaterOrEqual

• Less

• LessOrEqual </details> <details> <summary><h4>Elementwise</h4></summary>

• Negate

• Abs

• Add

• Divide

• Multiply

• Subtract

• And

• AndNot

• Or

• Xor

• Not

• Select

• Ternary (Conditional Select)

• Concat

• Sqrt </details> <details> <summary><h4>Reduction</h4></summary>

• Aggregate

• Sum

• Average

• Max

• Min

• Dot </details> <details> <summary><h4>General</h4></summary>

• All

• Any

• Contains

• IndexOf

• Fill

• Foreach </details>

Auto-Generated Functions

For any of the Elementwise functions, an auto-generated overload is created, which doesn't accept Span<T> result, and instead returns T[] as the result.

For any of the functions with the Value Delagate pattern, an auto-generated overload is created, which accepts regular delegates. Note that using this overload results in performence losses. Check Value Delegates section for more info.

Performance Benefits

A simple benchmark to demonstrate performance gains of using SIMD.
Benchmarked method was a Sum over an int[].

<details> <summary>Benchmark Details</summary>

BenchmarkDotNet=v0.13.2, OS=Windows 11 (10.0.22621.819)
Intel Core i7-10510U CPU 1.80GHz, 1 CPU, 8 logical and 4 physical cores
.NET SDK=7.0.100
  [Host]     : .NET 7.0.0 (7.0.22.51805), X64 RyuJIT AVX2
  DefaultJob : .NET 7.0.0 (7.0.22.51805), X64 RyuJIT AVX2

</details>

Value Delegates

This library uses the value delegate pattern. This pattern is used as a replacement for regular delegates.
Calling functions using this patten may feel unusual since it requires creation of structs to pass as arguments instead of delegates, but it is very beneficial performance-wise. The performance difference makes using this pattern worthwhile in performance critical places.
Since the focus of this library is pure performance, we use this pattern wherever possible.

Usage:

using System;
using System.Numerics;
using SimpleSimd;

namespace MyProgram
{
    class Program
    {
        static void Main()
        {
            // Creating the data
            // Can be int[], Span<int>, ReadOnlySpan<int>
            int[] Data = GetData();
            
            // We need to create 2 structs which will serve as a replacement for delegates
            SimdOps.Sum(Data, new VecSelector(), new Selector());
        }
    }             
    
    // A struct which is used as Vector<int> selector
    // Inheritence from IFunc<Vector<T>, Vector<T>> is according to Sum() signature
    struct VecSelector : IFunc<Vector<int>, Vector<int>>
    {
        public Vector<int> Invoke(Vector<int> param) => DoSomething(param);
    }

    // A struct which is used as int selector
    // Inheritence from IFunc<T, T> is according to Sum() signature
    struct Selector : IFunc<int, int>
    {
        public int Invoke(int param) => DoSomething(param);
    }   
}

benchmark:

Both of the benchmarked methods have the exactly same code, both of them are accelerated using SIMD,
the only difference is the argument types.

// Delegate, baseline
public static T Sum<T>(ReadOnlySpan<T> span, Func<Vector<T>, Vector<T>> vSelector, Func<T, T> selector) 
            where T : struct, INumber<T>;

// ValueDelegate
public static T Sum<T, F1, F2>(ReadOnlySpan<T> span, F1 vSelector, F2 selector)
            where T  : struct, INumber<T>
            where F1 : struct, IFunc<Vector<T>, Vector<T>>
            where F2 : struct, IFunc<T, T>;

<details> <summary>Benchmark Details</summary>

BenchmarkDotNet=v0.13.2, OS=Windows 11 (10.0.22621.819)
Intel Core i7-10510U CPU 1.80GHz, 1 CPU, 8 logical and 4 physical cores
.NET SDK=7.0.100
  [Host]     : .NET 7.0.0 (7.0.22.51805), X64 RyuJIT AVX2
  DefaultJob : .NET 7.0.0 (7.0.22.51805), X64 RyuJIT AVX2

</details>

Limitations

• Methods are not lazily evaluated as IEnumerable
• Old hardware might not support SIMD
• Supported collection types:
  • T[]
  • Span<T>
  • ReadOnlySpan<T>
• Supports only Primitive Numeric Types as array elements. Supported types are:
  • byte, sbyte
  • short, ushort
  • int, uint
  • long, ulong
  • nint, nuint
  • float
  • double

Contributing

All ideas and suggestions are welcome. Feel free to open an issue if you have an idea or a suggestion that might improve this project. If you encounter a bug or have a feature request, please open a relevent issue.

License

This project is licensed under MIT license. For more info see the License File