Skip to content

Commit

Permalink
Make groupsOf... family of functions fully tail recursive.
Browse files Browse the repository at this point in the history
This commit makes the `groupsOf...` family of functions fully tail recursive by forcing them to use the tail recursive version of List.take (normally List.take is only tail recursive for lists larger than 1000, but since the `groupsOf...` functions are themselves recursive  this can result in potential call stack overflow from the successive accumulation of (up to) 1000-long non-recursive List.take calls during the recursion).

This is an alternative to PR elmcraft#46 which would instead just add a note to the documentation warning users about the potential overflow.
  • Loading branch information
jmbromley authored Feb 29, 2024
1 parent 650ca86 commit 5b8d756
Showing 1 changed file with 41 additions and 2 deletions.
43 changes: 41 additions & 2 deletions src/List/Extra.elm
Original file line number Diff line number Diff line change
Expand Up @@ -2011,7 +2011,7 @@ groupsOfWithStep size step list =
else
let
thisGroup =
List.take size xs
takeTailRec size xs
in
if size == List.length thisGroup then
let
Expand All @@ -2026,6 +2026,45 @@ groupsOfWithStep size step list =
go list []


{- List.take starts out non-tail-recursive and switches to a tail-recursive
implementation after the first 1000 iterations. For functions which are themselves
recursive and use List.take on each call (e.g. List.Extra.groupsOf), this can result
in potential call stack overflow from the successive accumulation of up to 1000-long
non-recursive List.take calls. Here we provide an always tail recursive version of
List.take to avoid this problem. The code is taken directly from the implementation
of elm/core and carries the following copywrite:
Copyright 2014-present Evan Czaplicki
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-}
takeTailRec : Int -> List a -> List a
takeTailRec n list =
List.reverse (takeReverse n list [])


takeReverse : Int -> List a -> List a -> List a
takeReverse n list kept =
if n <= 0 then
kept

else
case list of
[] ->
kept

x :: xs ->
takeReverse (n - 1) xs (x :: kept)


{-| `groupsOfVarying ns` takes `n` elements from a list for each `n` in `ns`, splitting the list into variably sized segments
groupsOfVarying [ 2, 3, 1 ] [ "a", "b", "c", "d", "e", "f" ]
Expand Down Expand Up @@ -2105,7 +2144,7 @@ greedyGroupsOfWithStep size step list =
else
go
(List.drop step xs)
(List.take size xs :: acc)
(takeTailRec size xs :: acc)
in
go list []

Expand Down

0 comments on commit 5b8d756

Please sign in to comment.