Giter Club home page Giter Club logo

rvolesti's Introduction

Volume computation and sampling

About

The volesti package provides R with functions for volume estimation and sampling. In particular, it provides an R interface for the C++ library volesti.

volesti computes approximations of volume of polytopes given as a set of points or linear inequalities or as a Minkowski sum of segments (zonotopes). There are algorithms for volume approximation as well as algorithms for sampling, rounding and rotating polytopes. Last but not least, volesti provides implementations of geometric algorithms to compute the score of a portfolio given asset returns and to detect financial crises in stock markets.

The latest stable version is available from CRAN.

CRAN status CRAN check CRAN downloads CRAN/METACRAN

The latest development version is available in this repository.

R-CMD-ubuntu R-CMD-macOS R-CMD-windows

Download and install

To use the development version you need to follow these steps:

  • Clone the Rvolesti repository.

  • Build and install the package by running (from an R terminal):

Rcpp::compileAttributes()
devtools::build()
install.packages("volesti")

or from a bash terminal:

Rscript -e 'Rcpp::compileAttributes()'
R CMD INSTALL --no-multiarch --with-keep.source .

The following packages should be installed: Rcpp, RcppEigen, BH, devtools.

Optionally the user can run tests and examples by running (from an R terminal):

devtools::test()
devtools::run_examples()

Documentation

The user can generate or update the documentation:

Rcpp::compileAttributes() # updates the Rcpp layer from C++ to R
roxygen2::roxygenize(roclets="rd") # updates the docs based on roxygen comments

and generate a pdf with the docs:

pack = "volesti"
path = find.package(pack)
system(paste(shQuote(file.path(R.home("bin"), "R")), "CMD", "Rd2pdf", shQuote(path)))

The documentation contains examples for all available functions. More examples are available in man/examples directory.

Credits

Copyright (c) 2012-2024 Vissarion Fisikopoulos

Copyright (c) 2018-2024 Apostolos Chalkis

You may redistribute or modify the software under the GNU Lesser General Public License as published by Free Software Foundation, either version 3 of the License, or (at your option) any later version. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

rvolesti's People

Contributors

soumya624 avatar vfisikop avatar vissarion avatar tolischal avatar farehesoheil avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.