https://github.com/imfi-jz/haxe-functional
Tools for writing Haxe code in the functional programming paradigm.
https://github.com/imfi-jz/haxe-functional
functional-programming haxe library
Last synced: about 2 months ago
JSON representation
Tools for writing Haxe code in the functional programming paradigm.
- Host: GitHub
- URL: https://github.com/imfi-jz/haxe-functional
- Owner: imfi-jz
- License: gpl-3.0
- Created: 2023-04-15T18:23:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-15T19:53:26.000Z (about 2 years ago)
- Last Synced: 2023-04-30T10:24:50.933Z (about 2 years ago)
- Topics: functional-programming, haxe, library
- Language: Haxe
- Homepage: https://discord.gg/2KedGjpQMR
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Haxe Functional
'Haxe Functional' (work in progress name) is a small library with a set of functions that help and extend the capabilities of writing [Haxe](https://haxe.org/) code in the functional programming paradigm. It provides functions for common functional collection operations like `filter`, `reduce`, `map` and more, and works on any collection (`Iterable`, `Array`, etc.) or map.
## Usage
Clone the repository or download it as a zip and use the source code (under /src) as a library source in your project's hxml file (see section Disclaimer).
The functions can be used on a collection by assigning the collection to a variable of type `Multitude` like so:
```haxe
final functionalArray:Multitude = [1, 2, 3];
final twosOnly = functionalArray.filter((num) -> num == 2);
final functionalArray2:Multitude = 0...10;
final oddsOnly = functionalArray2.reject((num) -> num % 2 == 0);
```
The `Multitude` type will respect the collection's order and provides functions to convert it back to `Array` or get its `Iterator` or `KeyValueIterator`.
The library also works on `Maps` (key value pairs) by assigning a map to a variable of type `Pairs`, like so:
```haxe
final functionalMap:Pairs = ["M" => "Monday", "T" => "Tuesday"];
final mondaysOnly = functionalMap.filter((key, value) -> key == "M");
```
Here is a list of all functions that available to functional collections (Multitude and Pairs):
- `each` - executes a function for each item in the collection.
- `filter` - retain only the items that meet a condition.
- `find` - returns the first item that meets a condition.
- `reject` - removes all items that meet a condition.
- `map` - transforms each item in the collection to a given type.
- `reduce` - reduces the collection to a single value.
- `first` - returns the first item in the collection.
- `any` - returns whether any item is present in the collection.
Function currying is also possible via the `abstract` `Curry` type. I forgot how exaclty this works (it's been a while since writing this code lol).
## Compilation
This library was written for Haxe version 4. It should work with all compilation targets (with possibly a few exceptions).
The library can be compiled with a few different options.
By default all functional functions are inlined, resulting in potentially much less stack frames at runtime. This can be disabled with the following flag:
```hxml
-D no_functional_inline
```
To increase performance, operations like filter, map, etc. can be executed on the instance itself instead of returning a new collection each time. This is agains the concept of functional programming and should only be used if you are 100% sure the side effects of mutating your collections do not matter. To enable direct mutation on your collections (`Multitude` and `Pairs`) add the following flag:
```hxml
-D functional_mutable
```
## Disclaimer
I am providing this library as is, and am currently not making it an actual haxelib, as I am not 100% sure if every functional concept is implemented correctly. However, I still think this may be a useful tool to some.
Most of the functions are to some degree documented.
Do not expect regular updates for this library. If you decide to use this library I will try to provide support if you have questions. Suggestions are also welcome.