https://github.com/konrad1991/ast2ast

Translates an R function into a to a C++ function which is callable from within R. The typical use case intended by 'ast2ast' are functions describing ode-systems.
https://github.com/konrad1991/ast2ast

abstract-syntax-tree c c-plus-plus expression-template matrix r rcpp transpiler vector

Last synced: 7 days ago
JSON representation

Translates an R function into a to a C++ function which is callable from within R. The typical use case intended by 'ast2ast' are functions describing ode-systems.

• Host: GitHub
• URL: https://github.com/konrad1991/ast2ast
• Owner: Konrad1991
• License: gpl-2.0
• Created: 2021-03-11T12:19:26.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-20T13:08:38.000Z (27 days ago)
• Last Synced: 2025-01-02T01:09:20.268Z (14 days ago)
• Topics: abstract-syntax-tree, c, c-plus-plus, expression-template, matrix, r, rcpp, transpiler, vector
• Language: C++
• Homepage: https://konrad1991.github.io/ast2ast/
• Size: 95.8 MB
• Stars: 34
• Watchers: 3
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: Readme.md
  • Changelog: NEWS
  • License: License

Awesome Lists containing this project

README

        

[![](http://cranlogs.r-pkg.org/badges/last-month/ast2ast?color=green)](https://cran.r-project.org/package=ast2ast)

[![](https://www.r-pkg.org/badges/version/ast2ast?color=green)](https://cran.r-project.org/package=ast2ast)

[![License: GPL2](https://img.shields.io/badge/license-GPL2-blue.svg)](https://cran.r-project.org/web/licenses/GPL-2)

# R package ast2ast

## News

* see more on: https://konrad1991.github.io/ast2ast/ 

* 11-04-2023: version 0.3.1 is now on CRAN

* I gave a talk at the *useR! 2022* conference about *ast2ast*. The record can be watched using the following link: https://m.youtube.com/watch?v=5NDPOLunQTA&list=PL77T87Q0eoJjvKVFHuJZ5_BGVbPPpB8LL&index=8,

## Overview

Translates an R function into a C++ function. An external pointer to the C++ function or an R function is returned to the user. To install the Github version of the package use *devtools::install_github("Konrad1991/ast2ast", build_vignettes = TRUE)*. The package is also on CRAN and can be installed via *install.packages("ast2ast")*. 

The motivation to write the package was that it is often cumbersome using R functions in applications which have to call the R function very often (> 100 calls) (e.g. ODE solving, Optimization). One possiblity is to write the function in a faster programming language e.g. C. However, learning languages such as C is difficult and time consuming. Therefore *ast2ast* is a decent alternative as the function can be written in R.

As an example solving a simple ODE-System. The translated code is considerable faster then R code and almost as fast as C++. Code for the example can be found in the vignettes.

![Benchmark](https://github.com/Konrad1991/ast2ast/blob/master/vignettes/benchmark.png)

## Documentation:

Documentation for the function [translate](https://konrad1991.github.io/ast2ast/translate.html).

If you want a detailed documentation please read this vignette: https://konrad1991.github.io/ast2ast/DetailedDocumentation.html

In case you are interested on using ast2ast in your R package please refer to: https://konrad1991.github.io/ast2ast/InformationForPackageAuthors.html

## Contribution

Contribution would be warmly appreciated (See Code of Conduct).