https://github.com/karmakrafts/kstd-streams

Highly optimized, constexpr-ready collection streams for C++17/20.
https://github.com/karmakrafts/kstd-streams

cplusplus cplusplus-17 cplusplus-20 cpp cpp-library cpp-programming cpp20 cpp20-library cross-platform cross-platform-library functional-programming header-only header-only-library library streams streams-api

Last synced: about 4 hours ago
JSON representation

Highly optimized, constexpr-ready collection streams for C++17/20.

• Host: GitHub
• URL: https://github.com/karmakrafts/kstd-streams
• Owner: karmakrafts
• License: apache-2.0
• Created: 2023-03-26T21:51:40.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-07T22:57:46.000Z (9 months ago)
• Last Synced: 2024-02-07T23:39:22.678Z (9 months ago)
• Topics: cplusplus, cplusplus-17, cplusplus-20, cpp, cpp-library, cpp-programming, cpp20, cpp20-library, cross-platform, cross-platform-library, functional-programming, header-only, header-only-library, library, streams, streams-api
• Language: C++
• Homepage:
• Size: 209 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  kstd-streams

Are you looking for map, filter, reduce and more on any standard container?  

Do you want it to be a constexpr-ready zero-cost abstraction?  

**Look no further!**

kstd-streams is a highly optimized, constexpr-ready collection stream library for C++20.  

### Cloning kstd-streams

If you clone this repository for whatever purpose, don't forget to initialize the submodules using the following command:

```shell

git submodule update --init

```

### Using kstd-streams

In order to use the stream API, simply make sure you include the kstd-streams header:

```cpp

#include 

```

### Why streams are amazing

As an example, let's use computing the sum of all elements within a `std::vector`.  

Simple enough, right? If you've got some experience with programming in C++, your solution

would most likely look somewhat like this:

```cpp

std::vector elements(...);

auto sum = 0;

for(const auto element : elements) {

    sum += element;

}

```

That is quite a lot of code for such a simple operation, but that's what you get with a language as verbose as C++..  

Now let's take a look at the kstd-streams equivalent to that code:

```cpp

std::vector elements(...);

const auto sum = kstd::streams::stream(elements).sum();

```

As long as the stream value type (`int` in our case) provides an implementation for `operator+` you can use the sum operation

to sum up all the elements operated upon by the stream.

We effectively reduced the amount of code required by three quarters! Of course, you can do a lot more with streams than just 

calculating the sum of a set of elements.