Implement the Array API

[gabejohnson]

I've started by copying the code from https://github.com/purescript/purescript-arrays/blob/master/src/Data/Array.purs and modifying it to use this list implementation.

I've chosen to simplify the FFI JS files by using Fn<n>, runFn<n> and mkFn<n> instead of manually currying. There is less potential for errors using this strategy and the possibility of future compiler optimizations.

updateAtIndices, modifyAtIndices, sort, sortBy , sortWith, group, group', and, groupBy have yet to be implemented (I also didn't write an Ord instance).

I implemented Traversable as a placeholder until it's available "natively".

There's certainly room for improvement in organization and documentation.

Note: The doc comments are barely changed from those in -arrays and I'm unsure what the licensing implications are.

[gabejohnson]

You might also notice the Show instance results in

show $ fromFoldable [1, 2, 3] == "<1,2,3>"

This is a placeholder until a proper representation is chosen.

[paldepind]

This looks really great.

I've chosen to simplify the foreign FFI JS files by using Fn<n>, runFn<n> and mkFn<n> instead of manually currying. There is less potential for errors using this strategy and the possibility of future compiler optimizations.

That definitely looks like a better approach than what I was doing before.

I implemented Traversable as a placeholder until it's available "natively".

If List implemented Traversable based on Fanasy Land would that be useable in PureScript?

Do you think having this as a purescript folder here is fine or should I set up a repository specifically to it?

[paldepind]

This is a placeholder until a proper representation is chosen.

I think

show $ fromFoldable [1, 2, 3] == "fromFoldable [1, 2, 3]"

would be an appropriate representation.

In JavaScript I'm thinking that

list(1, 2, 3).toString() === "list(1, 2, 3)"

[gabejohnson]

If List implemented Traversable based on Fanasy Land would that be useable in PureScript?

No it wouldn't. You're welcome to improve the efficiency of the current implementation of course 😄

[gabejohnson]

Do you think having this as a purescript folder here is fine or should I set up a repository specifically to it?

Idk. That's probably a better question for the #purescript Slack

[paldepind]

List exports a length so this could be exports.length = L.length.

[paldepind]

What about adding an equalsBy to List itself?

[gabejohnson]

Do you see general utility for equalsBy?

[gabejohnson]

@paldepind I've make some changes/additions.

[gabejohnson]

@paldepind I didn't want to presume anything about the documentation style or how you might want to include examples and algorithmic complexity.

If you want to merge this as-is and tackle the docs yourself that would be great. Otherwise, I'd like some guidance concerning style/examples when you have time.

[paldepind]

@gabejohnson

What do you think about the name purescript-rrb-list as suggested in hdgarrood/purescript-sequences#31?

If you think that name is fine then I suggest the following: I create a new GitHub repository in Funkia with that name, you create an identical PR for that repo, I merge it and publish it to Pursuit. Then PS users can actually start trying the library and additional improvements can be based off of that 😄

Btw, I highly appreciate the work you've done in this PR!

[gabejohnson]

Honestly I don't like -rrb-list because I care about the performance characteristics, not the implementation (which I don't assume the user is going to glean from seeing rrb).

Maybe -fast-list?

[gabejohnson]

That said, I don't want to hold things up. I know there's a market for a data structure like this.

[gabejohnson]

purescript-funkia-list is another possibility. It was mentioned in Slack that calling it anything else might mislead people to think it's implemented in PS.

[paldepind]

purescript-funkia-list is a fine name as well. But, I'm not sure that the Funkia name means anything to people. I think the fact that it is a JavaScript library should be added to the top of the readme. Similarly to how purescript-array does not indicate that it is JavaScript arrays but it is mentioned in the docs.

I prefer purescript-rrb-list because I think it is the name that best describes what it is 😄

I've created a repo for the PS bindings here: https://github.com/funkia/purescript-rrb-list

[gabejohnson]

How would you like the package namespaced? RRB.List or Funkia.List?

[paldepind]

Would the Data prefix be appropriate? Data.RRBList for instance?

[gabejohnson]

There's a trend moving away from the Data/Control namespacing scheme (see https://github.com/purescript/purescript-effect/blob/master/src/Effect.purs).

The prefix seems unnecessary and arbitrary to me. I think RRBList is fine.

[paldepind]

Oh, well, that is a trend I can get behind 😄

I think RRBList is fine.

I agree 😄

[paldepind]

Superceeded by funkia/purescript-rrb-list#1.