From: annikoff@ya.ru
To: ruby-core@ruby-lang.org
Subject: [ruby-core:99330] [Ruby master Feature#17016] Enumerable#scan_left
Date: Sat, 25 Jul 2020 10:12:25 +0000 (UTC) [thread overview]
Message-ID: <redmine.journal-86725.20200725101225.15511@ruby-lang.org> (raw)
In-Reply-To: redmine.issue-17016.20200707174828.15511@ruby-lang.org
Issue #17016 has been updated by y.annikov (Yakov Annikov).
y.annikov (Yakov Annikov) wrote in #note-22:
> I've created a PR with the implementation of `scan` and `lazy.scan` methods https://github.com/ruby/ruby/pull/3358
> Feel free to reject it but any comments are appreciated. I got a lot of fun writing this code and looking at Ruby source code.
I renamed it to `reflect` for a while though I like `scan` more.
Here are examples of the behaviour of `reflect` method that I've implemented:
``` ruby
# reflect
(0...0).reflect(:+) => []
(5..10).reflect(:+) => [5, 10, 16, 23, 31, 40, 50]
(5..10).reflect { |sum, n| sum + n } => [5, 10, 16, 23, 31, 40, 50]
(5..10).reflect(1, :*) => [1, 5, 30, 210, 1680, 15120, 151200]
(5..10).reflect(1) { |product, n| product * n } => [1, 5, 30, 210, 1680, 15120, 151200]
[1, 2, 3].reflect => no block given (ArgumentError)
```
``` ruby
# lazy.reflect
(0..Float::INFINITY).lazy.reflect(:+).first(4) => [0, 0, 1, 3]
(0..Float::INFINITY).lazy.reflect(:+).first(4) => [1, 1, 2, 4]
enum = (5..10).lazy.reflect(:+) => #<Enumerator::Lazy: #<Enumerator::Lazy: 5..10>:reflect(:+)>
7.times.map { enum.next } => [5, 10, 16, 23, 31, 40, 50]
enum = (5..10).lazy.reflect(1, :*) => #<Enumerator::Lazy: #<Enumerator::Lazy: 5..10>:reflect(1, :*)>
7.times.map { enum.next } => [1, 5, 30, 210, 1680, 15120, 151200]
[1, 2, 3].lazy.reflect => no block given (ArgumentError)
```
----------------------------------------
Feature #17016: Enumerable#scan_left
https://bugs.ruby-lang.org/issues/17016#change-86725
* 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!
---Files--------------------------------
scan_left_example.rb (2.93 KB)
--
https://bugs.ruby-lang.org/
next prev parent reply other threads:[~2020-07-25 10:12 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
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 ` annikoff [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.ruby-lang.org/en/community/mailing-lists/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=redmine.journal-86725.20200725101225.15511@ruby-lang.org \
--to=ruby-core@ruby-lang.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).