ruby-core@ruby-lang.org archive (unofficial mirror)
 help / color / mirror / Atom feed
* [ruby-core:99078] [Ruby master Feature#17016] Enumerable#scan_left
@ 2020-07-07 17:48 finch.parker
  2020-07-08  4:00 ` [ruby-core:99083] " sawadatsuyoshi
                   ` (39 more replies)
  0 siblings, 40 replies; 41+ messages in thread
From: finch.parker @ 2020-07-07 17:48 UTC (permalink / raw)
  To: ruby-core

Issue #17016 has been reported by parker (Parker Finch).

----------------------------------------
Feature #17016: Enumerable#scan_left
https://bugs.ruby-lang.org/issues/17016

* Author: parker (Parker Finch)
* Status: Open
* Priority: Normal
----------------------------------------
## Proposal

Add a `#scan_left` method to `Enumerable`.

(The name "scan_left" is based on Scala's scanLeft and Haskell's scanl. It seems like "scan_left" would be a ruby-ish name for  this concept, but I'm curious if there are other thoughts on naming here!)

## Background

`#scan_left` is similar to `#inject`, but it accumulates the partial results that are computed. As a comparison:
```
[1, 2, 3].inject(0, &:+) => 6
[1, 2, 3].scan_left(0, &:+) => [0, 1, 3, 6]
```

Notably, the `scan_left` operation can be done lazily since it doesn't require processing the entire collection before computing a value.

I recently described `#scan_left`, and its relationship to `#inject`, more thoroughly in [this blog post](https://medium.com/building-panorama-education/scan-left-a-lazy-incremental-alternative-to-inject-f6e946f74c00).

## Reasoning
We heavily rely on the scan operation. We use an [event-sourcing](https://martinfowler.com/eaaDev/EventSourcing.html) pattern, which means that we are scanning over individual "events" and building up the corresponding state. We rely on the history of states and need to do this lazily (we stream events because they cannot fit in memory). Thus the scan operation is much more applicable than the inject operation.

We suspect that there are many applications that could leverage the scan operation. [This question](https://stackoverflow.com/questions/1475808/cumulative-array-sum-in-ruby) would be more easily answered by `#scan_left`. It is a natural fit for any application that needs to store the incrementally-computed values of an `#inject`, and a requirement for an application that needs to use `#inject` while maintaining laziness.

## Implementation
There is a Ruby implementation of this functionality [here](https://github.com/panorama-ed/scan_left/) and an implementation in C [here](https://github.com/ruby/ruby/pull/3078).

## Counterarguments
Introducing a new public method is committing to maintenance going forward and expands the size of the Ruby codebase -- it should not be done lightly. I think that providing the functionality here is worth the tradeoff, but I understand any hesitation to add yet more to Ruby!



-- 
https://bugs.ruby-lang.org/

^ permalink raw reply	[flat|nested] 41+ messages in thread

end of thread, other threads:[~2021-04-27 15:14 UTC | newest]

Thread overview: 41+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-07 17:48 [ruby-core:99078] [Ruby master Feature#17016] Enumerable#scan_left finch.parker
2020-07-08  4:00 ` [ruby-core:99083] " sawadatsuyoshi
2020-07-08 14:51 ` [ruby-core:99089] " finch.parker
2020-07-09 21:33 ` [ruby-core:99102] " eregontp
2020-07-10 20:57 ` [ruby-core:99117] " finch.parker
2020-07-11  5:46 ` [ruby-core:99121] " nobu
2020-07-11 17:47 ` [ruby-core:99129] " eregontp
2020-07-11 17:49 ` [ruby-core:99130] " eregontp
2020-07-12  8:52 ` [ruby-core:99133] " nobu
2020-07-12 11:32 ` [ruby-core:99134] " eregontp
2020-07-12 23:51 ` [ruby-core:99141] " shyouhei
2020-07-14 17:50 ` [ruby-core:99167] " finch.parker
2020-07-14 18:20 ` [ruby-core:99168] " finch.parker
2020-07-15 14:33 ` [ruby-core:99177] " eregontp
2020-07-16  5:17 ` [ruby-core:99189] " mame
2020-07-17 14:29 ` [ruby-core:99203] " finch.parker
2020-07-18  3:23 ` [ruby-core:99212] " nobu
2020-07-20  6:02 ` [ruby-core:99234] " matz
2020-07-22 17:23 ` [ruby-core:99270] " finch.parker
2020-07-22 18:12 ` [ruby-core:99274] " msiegel
2020-07-23  3:12 ` [ruby-core:99286] " nobu
2020-07-23 15:39 ` [ruby-core:99301] " finch.parker
2020-07-23 21:44 ` [ruby-core:99307] " annikoff
2020-07-24  2:30 ` [ruby-core:99310] " nobu
2020-07-25  6:20 ` [ruby-core:99327] " duerst
2020-07-25  7:49 ` [ruby-core:99328] " duerst
2020-07-25 10:12 ` [ruby-core:99330] " annikoff
2020-07-28 17:42 ` [ruby-core:99367] " msiegel
2020-07-28 23:34 ` [ruby-core:99378] " duerst
2020-07-30 19:16 ` [ruby-core:99404] " finch.parker
2020-07-31  5:47 ` [ruby-core:99410] " nobu
2020-08-10 16:47 ` [ruby-core:99545] " finch.parker
2020-08-21 14:22 ` [ruby-core:99664] " finch.parker
2020-08-29 11:41 ` [ruby-core:99769] " daniel
2020-09-03 14:57 ` [ruby-core:99880] " finch.parker
2020-11-10 14:06 ` [ruby-core:100762] " annikoff
2020-11-30 14:38 ` [ruby-core:101156] " finch.parker
2021-04-13 14:51 ` [ruby-core:103429] " finch.parker
2021-04-17  8:15 ` [ruby-core:103497] [Ruby master Feature#17016] Enumerable#accumulate mame
2021-04-27  9:05 ` [ruby-core:103614] " duerst
2021-04-27 15:14 ` [ruby-core:103615] " msiegel

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).