HPCsharp.StrongNamed
3.17.1
dotnet add package HPCsharp.StrongNamed --version 3.17.1
NuGet\Install-Package HPCsharp.StrongNamed -Version 3.17.1
<PackageReference Include="HPCsharp.StrongNamed" Version="3.17.1" />
paket add HPCsharp.StrongNamed --version 3.17.1
#r "nuget: HPCsharp.StrongNamed, 3.17.1"
// Install HPCsharp.StrongNamed as a Cake Addin #addin nuget:?package=HPCsharp.StrongNamed&version=3.17.1 // Install HPCsharp.StrongNamed as a Cake Tool #tool nuget:?package=HPCsharp.StrongNamed&version=3.17.1
If you like HPCsharp, give it a star and donate to help us keep more good stuff coming.
Give us feedback and let us know where else could use additional performance.
High Performance Computing in C# (HPCsharp)
NuGet package of high performance Parallel C# generic algorithms (multi-core and SSE). Runs on Windows and Linux (.NET 5, 6 and 8, .NET Standard 2.0 and 2.1). Raises C# performance many times over standard versions. Familiar interfaces, similar to standard C# algorithms and Linq. Free, open source, on nuget.org
* | ** | SSE | Multi-Core | Array | List | Details | |
---|---|---|---|---|---|---|---|
Add | 2 | 14 | ✔️ | :heavy_check_mark: | ✔️ | Adds two arrays element-wise | |
Binary Search | 1 | 2 | ✔️ | ✔️ | Generic IComparer<T> | ||
Block Swap | 4 | 5 | ✔️ | Generic | |||
Parallel .ToArray() | 1 | 11 | ✔️ | ✔️ | ✔️ | ✔️ | List.ToArray() and Array.Copy() parallel generic |
Counting Sort | 3 | 14 | ✔️ | ✔️ | ✔️ | byte, ushort, sbyte, short arrays. Ludicrous speed! | |
Divide-and-Conquer | 2 | 4 | ✔️ | ✔️ | Generic serial and parallel abstraction | ||
Fill | 4 | 10 | ✔️ | ✔️ | ✔️ | Numeric arrays | |
Heap Sort | 1 | 2 | ✔️ | ||||
Histogram | 14 | 35 | ✔️ | ✔️ | ✔️ | Byte, N-bit components of numeric arrays | |
Insertion Sort | 1 | 2 | ✔️ | ✔️ | Generic IComparer<T> | ||
Introspective Sort | 1 | 3 | ✔️ | ||||
Max, Min | 2 | 12 | ✔️ | ✔️ | ✔️ | ✔️ | Generic IComparer<T> |
Mean Absolute Deviation | 3 | 6 | ✔️ | ✔️ | ✔️ | ✔️ | float[] and double[] |
Merge | 6 | 18 | ✔️ | ✔️ | ✔️ | Generic IComparer<T> | |
Merge In-Place | 1 | 3 | ✔️ | ✔️ | ✔️ | Generic IComparer<T> | |
Multi-way Merge | 1 | 1 | ✔️ | ||||
Merge Sort | 2 | 25 | ✔️ | ✔️ | Generic, Stable or not, whole or partial | ||
Merge Sort In-Place | 2 | 8 | ✔️ | ✔️ | Generic, Adaptive, whole or partial | ||
Priority Queue | 2 | 15 | ✔️ | ||||
Quicksort | 5 | 9 | ✔️ | ✔️ | |||
Radix Sort (LSD) | 6 | 40 | ✔️ | ✔️ | ✔️ | Numeric arrays, user defined types, Stable | |
Radix Sort (MSD) | 4 | 24 | ✔️ | ✔️ | ✔️ | Numeric arrays, user defined types, In-place | |
Sequence Equal | 2 | 19 | ✔️ | ✔️ | ✔️ | ||
Standard Deviation | 7 | 12 | ✔️ | ✔️ | ✔️ | Avoids arithmetic overflow exception | |
Sum | 7 | 214 | ✔️ | ✔️ | ✔️ | Numeric arrays. Better in many ways | |
Swap | 4 | 4 | ✔️ | Generic swap variations | |||
Zero Array Detect | 3 | 13 | ✔️ | ✔️ | Detect if byte array is all zeroes |
* Number of different algorithms
** Number of functions for this algorithm\
Examples
Usage examples are provided in the HPCsharpExamples directory, which has a VisualStudio 2022 solution. Build and run it to see performance gains on your computer or a cloud node. To get the maximum performance make sure to target x64 processor architecture for the Release build in VisualStudio, increasing performance by as much as 50%.
Book
HPCsharp has a book dedicated to Parallel Algorithm implementations within.
Benchmarking
The first time you call a function that is implemented using SIMD/SSE instructions, C# just-in-time (JIT) compiler takes the time to compile and optimize that function, which results in much slower performance. On the second use of the function and on subsequent uses, the SIMD/SSE function will run at its full performance. Keep this behavior of the C# JIT compiler in mind as you use or benchmark HPCsharp functions.
C# Standard Sort and Linq
C# implements two ways to sort arrays: .Sort and Linq.OrderBy. Sort does not support multi-core, whereas Linq.OrderBy does. The following Table shows performance of these two algorithms, for three input data distributions, in Millions of Int32's per second.
Random | Presorted | Constant | Computer | |
---|---|---|---|---|
.Sort | 11 | 70 | 32 | 1-core of 6-core i7-9750H |
.Sort | 13 | 136 | 78 | 1-core of Intel i7-12700H |
.Sort | 9 | 58 | 46 | 1-core of 32-core AMD EPYC |
Linq.OrderBy | 2.3 | 6.3 | 6.3 | 1-core of Intel i7-12700H |
Linq.AsParallel.OrderBy | 2.1 | 6.3 | 6.3 | 14-core Intel i7-12700H |
Linq.OrderBy | 2.3 | 7.7 | 8.0 | single-core on 14 core Intel Xeon |
Linq.AsParallel.OrderBy | 1.1 | 5.5 | 5.4 | single-core on 32 core AMD EPYC |
LSD Radix Sort
HPCsharp implements LSD Radix Sort, which is a linear time O(N), stable sorting algorithm. The following table shows performance for three input data distributions, in Millions of UInt32's per second.
Random | Presorted | Constant | Computer | |
---|---|---|---|---|
LSD Radix Sort (Parallel) | 655 | 652 | 692 | 48-core AWS C7i.24xlarge (Intel) |
LSD Radix Sort (Parallel) | 716 | 744 | 766 | 48-core AWS C7a.24xlarge (AMD) |
LSD Radix Sort (Parallel) | 524 | 538 | 676 | 14-core Intel i7-12700H |
LSD Radix Sort (Sequential) | 127 | 62 | 181 | 1-core of Intel i7-12700H |
Several implementations available: serial, partially parallel, and fully parallel. Serial algorithm runs on a single core. Partially parallel algorithm runs the counting/histogram phase of the algorithm in parallel, and the permutation phase serially. Fully parallel algorith runs both phases of the algorithm on multiple cores in parallel.
Radix Sort has been extended to sort user defined classes based on a UInt32 or UInt64 key within the class. Radix Sort is currently using only a single core.
In-Place MSD Radix Sort
Single-core (sequential) in-place MSD Radix Sort provides competitive performance with a truly in-place implementation, which is linear-time. It is not a stable sort, just like Array.Sort. This algorithm supports keys of various data types: unsigned and signed integers (32-bit and 64-bit), floating-point and double.
Random | Presorted | Constant | Data Type | Computer | |
---|---|---|---|---|---|
MSD Radix Sort (in-place) | 28 | 42 | 333 | int | 1-core of Intel i7-12700H |
MSD Radix Sort (in-place) | 19 | 35 | 146 | long | 1-core of Intel i7-12700H |
MSD Radix Sort (in-place) | 21 | 33 | 241 | float | 1-core of Intel i7-12700H |
MSD Radix Sort (in-place) | 16 | 28 | 120 | double | 1-core of Intel i7-12700H |
Merge Sort
Merge Sort provides a performance boost comparing with Linq.OrderBy when running on a single core, but is not competitive with Array.Sort(). On a single core on variety of machines, sorting an array of Int32's, performance in Millions of Int32's per second is:
Random | Presorted | Constant | Description | |
---|---|---|---|---|
HPC# .SortMerge | 8 | 30 | 27 | 1-core of Intel i7-12700H |
HPC# .SortMerge | 5 | 16 | 15 | 1-core of 32-core AMD EPYC |
Parallel Merge Sort uses multiple CPU cores to accelerate performance, which scales well with the number of cores and the number of memory channels. C# Array.Sort does not support parallel sorting. On variety of machines, sorting an array of Int32's, performance in Millions of Int32's per second is:
Random | Presorted | Constant | Description | |
---|---|---|---|---|
HPC# .SortMergePar | 136 | 659 | 451 | 14-core Intel i7-12700H |
HPC# .SortMergePar | 272 | 875 | 736 | 48-core AWS C7a.24xlarge (AMD) |
HPC# .SortMergePar | 293 | 893 | 760 | 32-core AMD EPYC |
HPC# .SortMergePar | 397 | 915 | 754 | 48-core Intel Xeon 8275CL |
HPCsharp's Parallel Merge Sort is not stable, just like Array.Sort. The version benchmarked above is the not-in-place one. Faster than Array.Sort and List.Sort across all distributions, and substantially faster than Linq.OrderBy and Linq.OrderBy.AsParallel, which doesn't scale well as the number of cores increases. HPCsharp's Parallel Merge Sort scales very well with the number of cores, for all distributions providing higher performance than Array.Sort() and Linq.OrderBy and Linq.OrderBy.AsParallel.
Better Sum in Many Ways
HPCsharp improves .Sum() of numeric arrays in the following ways:
- Adds support for the missing signed integer data types: sbyte and short
- Adds support for all unsigned integer data types: byte, ushort, uint, and ulong
- Simplified use: no arithmetic overflow exceptions to deal with, for all integer data types
- SIMD/SSE implementations for all integer and floating-point data types, to boost performance several times per processor core, as well as multi-core to use all the cores
- Adds support for BigInteger: single-core and multi-core
- New checked SIMD/SSE addition in C#, unsigned and signed, for much higher performance
- Extended precision ulong[] and long[] summation for a full precision to a Decimal and BigInteger result, using integer computation only: SIMD/SSE, single-core and multi-core
- Reduced error from O(eN) downto O(elgN) for float and double arrays by performing pair-wise summation
- Reduced error further down to O(e) by implementing Kahan summation for float and double arrays, with slight performance reduction, implemented in SIMD/SSE and multi-core
- GigaAdds/sec performance for all processor native data types
The table below compares performance (in GigaAdds/second) of Linq.AsParallel().Sum() and HPCsharp.SumSsePar() - both use multi-core (6 or 14 of them), with HPCsharp also using SIMD/SSE data parallel instructions on each core to gain additional performance:
sbyte | byte | short | ushort | int | uint | long | ulong | Details | |
---|---|---|---|---|---|---|---|---|---|
array.Sum() | n/a | n/a | n/a | n/a | 1.5* | n/a | 1.7* | n/a | using 6 cores |
array.Sum(v ⇒ (long)v) | 0.72 | 0.76 | 0.75 | 0.76 | 0.7 | 0.7 | using 6 cores | ||
array.Sum(v ⇒ (decimal)v) | 0.35 | 0.31 | 0.29 | using 6 cores | |||||
Parallel.ForEach((long)v) | 5.9 | 10.9 | 10.7 | using 6 cores, HPC# includes | |||||
Parallel.ForEach((long)v) | 1.0 | 0.7 | Raspberry Pi 4, 4-core ARM | ||||||
HPC# (6-core) | 33 | 33 | 17 | 17 | 8.4 | 8.4 | 3.7 | 4 | using 6 cores, 2 memory channels |
HPC# (6-core) | 26 | 26 | 13 | 3.6 | using 2 cores | ||||
HPC# (14-core) | 63 | 63 | 16 | 22 | 14 | 14 | 3.2 | 7.1 | 4 memory channels |
HPC# (32-core) | 100 | AMD EPYC 7502P w/ 8-channel DDR4 3200 |
* arithmetic overflow exception is possible
n/a not available
float | floatToDouble | double | decimal | BigInteger | |
---|---|---|---|---|---|
array.Sum() | 1.8 | 2.1 | 0.38 | 0.016** | |
array.Sum(v ⇒ (double)v) | 0.66 | ||||
HPC# | 8.3 | 7.9 | 4.2 | 0.5 | 0.075 |
HPC# pair-wise * | 8.3 | 7.9 | 4.2 | ||
HPC# Kahan | 6.7 | 5.9 | 3.6 |
** Linq doesn't implement BigInteger.Sum(), used .Aggregate() instead, which doesn't speed-up with .AsParallel()
* HPCsharp implements pair-wise floating-point parallel (multi-core) by default, since it uses divide-and-conquer algorithm for multi-core implementation.
All HPCsharp integer summations (unsigned and signed) including long[] and ulong[] arrays, do not throw overflow exceptions, while producing a perfectly accurate result. This simplifies usage, while providing high performance.
HPCsharp ulong[] array summation implements a full accuracy algorithm using integer only arithmetic to provide maximum performance. It detects and deals with arithmetic overflow internally, without using exceptions, using integer only computation. HPCsharp also uses SIMD/SSE data parallel instructions to get maximum performance out of each core, and uses multi-core to run even faster.
For more details, see several blogs on various aspects:
- Better C# .Sum() in Many Ways
- Better C# .Sum() in More Ways
- Faster Checked Addition in C#
- Faster Checked Addition in C# (Part 2)
- Checked SIMD/SSE Addition in C#
- Video of Checked SIMD/SSE/multi-core Addition in C#
Standard Deviation
Accelerated and safer implementation of standard deviation for integer type arrays, float and double arrays. Accelerated by using multi-core and SSE data parallel instructions. Avoids arithmetic overflow exceptions for integer data types, using the same methods as HPCsharp's .Sum(). The following benchmarks ran on 6-core i7-9750H processor:
intToLong | longToDecimal | ulongToDecimal | float | floatToDouble | double | |
---|---|---|---|---|---|---|
Linq | 0.33 | 0.21 | 0.2 | 0.48 | 0.47 | 0.48 |
HPC# | 3.3 | 1.9 | 2.0 | 4.0 | 3.8 | 2.0 |
The above benchmarks of Linq code were implemented in the following way:
intArray.Average(v => (long)v); // intToLong
or
longArray.Average(v => (decimal)v); // longToDecimal
to ensure that no arithmetic overflow exception is possible, to make a fair comparison to HPCsharp implementations.
The following benchmarks ran on 14-core Xeon W-2175 processor:
intToLong | longToDecimal | ulongToDecimal | float | floatToDouble | double | |
---|---|---|---|---|---|---|
Linq | 0.44 | 0.29 | 0.26 | 0.6 | 0.5 | 0.5 |
HPC# | 4.9 | 2.2 | 3.6 | 6.5 | 5.9 | 3.7 |
https://duvanenko.tech.blog/2020/03/22/parallel-standard-deviation/
Mean Absolute Deviation
Another useful measure of variability within a dataset is Mean Absolute Deviation. It is related to standard deviation, using absolute value of the difference between the average value of the data set and-Conquer each data value, eliminating warping of the data.
https://duvanenko.tech.blog/2020/03/22/how-standard-deviation-measures-warped-data/
Divide-and-Conquer
Provides parallel and serial generic functions, which support multi-core and single-core divide-and-conquer algorithm. Two versions are provided: single data type and two types.
For more details, see blog:
Merge
O(N) linear-time generic merge algorithms for arrays and list containers. Merges two pre-sorted arrays or lists, of any data type that defines IComparer<T>. Two not-in-place algorithms: comparison at the heads, and divide-and-conquer. Parallel Merge algorithm, using divide-and-conquer, merges two presorted collections using multiple cores. Used by Parallel Merge Sort. See example solution for working code samples.
Insertion Sort
Insertion Sort, which is O(N<sup>2</sup>), and useful for fast in-place sorting of very small collections, due to its cache-friendliness. Generic implemenation for Array and List containers. Used by Parallel Merge Sort and MSD Radix Sort for the base case.
Add
Two algorithms for adding two arrays together:
- c[] = a[] + b[]
- a[] += b[]
The second algorithm is about 70% faster than the first. So far, both algorithms are implemented for int[] only, but other data types can be easily added. Both algorithms are implemented in scalar, data-parallel SIMD/SSE on a single core, and multi-core. Both run up to the memory bandwidth limit.
Binary Search
Generic implementation of the binary search algorithm, for Array and List containers. Used by the scalar and parallel divide-and-conquer Merge algorithms.
Min and Max
Collection | vs Linq | Parallel vs Linq | |
---|---|---|---|
SequenceEqual | Array, List | 4X faster | up to 11X faster |
Min | Array | 14-26X faster | 4-7X faster |
Max | Array | 1.5X faster |
.Min() is implemented using SIMD/SSE instructions to run at 4 GigaInts/sec on a single core, and over 5 GigaInts/sec on quad-core.
Block Swap
Three scalar algorithms for in-place swapping two neighboring sub-regions of an array, which do not have to be of equal size:
- Reversal
- Gries and Mills
- Juggle Bentley
See an article for more details (http://www.drdobbs.com/parallel/benchmarking-block-swapping-algorithms/232900395)
Also, several generic version of two element swap.
Zero Array Detect
Detects whether a byte array is zero in every byte. Runs at 17 GBytes/sec on a quad-core laptop, with two memory channels, using a single core. Provides short-circuit, early exit when a non-zero value is detected while scanning the array. Provides scalar, SSE, scalar-unrolled, SSE-unrolled, scalar unrolled multi-core, and SSE unrolled multi-core implementations. Unrolled refers to the loop being unrolled a few times to gain additional performance.
On dual memory channel CPUs, SSE-unrolled is the fastest, using a single core, saturating system memory bandwidth. For systems with more memory channels, SSE unrolled multi-core will most likely have the highest performance.
Parallel Copy
Converting a List to an Array is a common operation:
var listSource = new List<int> { 5, 7, 16, 3 };
int[] arrayDestination1 = listSource.ToArray(); // C# standard conversion
int[] arrayDestination2 = listSource.ToArrayPar(); // HPCsharp parallel/multi-core/faster conversion
The following table shows performance (in Billion Int32's per second) for copy functions:
ToArray() | AsParallel().ToArray() | Array.Copy() | ToArrayPar() | Memory Channels | Description |
---|---|---|---|---|---|
6-core i7 | 0.6 | 0.1 | 2.6 | 2 | Returns a new Array |
14-core Xeon | 0.6 | 0.6 | 1.2 | 4 | Returns a new Array |
var listSource = new List<int> { 5, 7, 16, 3 };
int[] arrayDestination = new int[4];
listSource.CopyTo(arrayDestination); // C# standard List to Array copy
listSource.CopyToPar(arrayDestination); // HPCsharp parallel/multi-core/faster copy
The following table shows performance (in GigaInt32/sec) for copy functions:
CopyTo() | CopyToPar() | Paged-in | Memory Channels | Description | |
---|---|---|---|---|---|
6-core i7 | 0.4 | 1.3 | No | 2 | Copies to a new Array |
6-core i7 | 2.4 | 2.9 | Yes | 2 | Copies to an existing Array |
var arraySource = new int[4] { 5, 7, 16, 3 };
int[] arrayDestination = new int[4];
arraySource.CopyTo(arrayDestination); // C# standard List to Array copy
arraySource.CopyToPar(arrayDestination); // HPCsharp parallel/multi-core/faster copy
HPCsharp provides parallel (multi-core) versions of List.ToArray() and List.CopyTo() functions, with exactly the same interfaces. Parallel Array.ToArray() and Array.CopyTo() are also available. These parallel functions are 3 times faster when the destination is a new array - i.e. allocated but never touched - a common use case shown in the first source code case above. When a destination array has been used before and has been paged into system memory, these parallel functions are 10-20% faster. These parallel copy functions provide a generic interface, handling any data type.
For more details, seee blog https://duvanenko.tech.blog/2019/08/19/faster-copying-in-c/
Naming Conventions
HPCsharp follows a few simple naming conventions:
- SSE functions append "Sse" to the function name
- multi-core functions append "Par" to the function name
- if the function name clashes with C# Linq name, then "Hpc" is appended to the function name
Blogs and Videos
For details on the motivation see blog: https://duvanenko.tech.blog/2018/03/03/high-performance-c/
For more performance discussion see blog: https://duvanenko.tech.blog/2018/05/23/faster-sorting-in-c/
HPCsharp presentation at the Indianapolis .NET Consortium, March 2019 on https://youtu.be/IRNW4VGevvQ
HPCsharp lighning talk at the Indianapolis .NET Consortium, October 2019 on - https://www.youtube.com/watch?v=hNqE1Ghwbv4
Website for Feature Votes
Visit us at https://foostate.com/ and let us know what other high performance algorithms are important to you, and you'd like to see in this NuGet package.
Encouragement
If you like it, then help us keep more good stuff like this coming. Let us know other algorithms that could use acceleration.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- System.Numerics.Vectors (>= 4.5.0)
- System.Runtime.Numerics (>= 4.3.0)
-
.NETStandard 2.1
- System.Numerics.Vectors (>= 4.5.0)
- System.Runtime.Numerics (>= 4.3.0)
-
net6.0
- System.Numerics.Vectors (>= 4.5.0)
- System.Runtime.Numerics (>= 4.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
3.17.1 | 109 | 10/24/2024 |
Serial Merge Sort - added a parameter to select whether it is stable or not. Switched to using VS2022 and cleaned up warnings.