
<!-- README.md is generated from README.Rmd. Please edit that file -->

# Fast Generators and Iterators for Permutations, Combinations, Integer Partitions and Compositions

[![check](https://github.com/randy3k/arrangements/actions/workflows/check.yaml/badge.svg)](https://github.com/randy3k/arrangements/actions/workflows/check.yaml)
[![codecov](https://app.codecov.io/gh/randy3k/arrangements/branch/master/graph/badge.svg)](https://app.codecov.io/gh/randy3k/arrangements)
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/arrangements)](https://cran.r-project.org/package=arrangements)
[![](https://cranlogs.r-pkg.org/badges/grand-total/arrangements)](https://cran.r-project.org/package=arrangements)

Github: <https://github.com/randy3k/arrangements>

Documentation: <https://randy3k.github.io/arrangements/>

Fast generators and iterators for permutations, combinations, integer
partitions and compositions. The arrangements are in lexicographical
order and generated iteratively in a memory efficient manner. It has
been demonstrated that ‘arrangements’ outperforms most existing packages
of similar kind. Benchmarks could be found at
<https://randy3k.github.io/arrangements/articles/benchmark.html>.

## Installation

You can install the released version of arrangements from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("arrangements")
```

Install the latest development version using

``` r
devtools::install_github("randy3k/arrangements")
```
