Skip to content

Updated tutorial to reference gen_cube and CRAN v1.2.0 #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Updated tutorial to reference gen_cube and CRAN v1.2.0 #352

wants to merge 2 commits into from

Conversation

keithwind
Copy link

This PR updates the tutorial to reference the correct function name (gen_cube) instead of the outdated GenCube.
Additionally, it adds a note specifying that the tutorial is based on CRAN version 1.1.2.

vfisikop
vfisikop reviewed Apr 9, 2025
View reviewed changes
docker/Dockerfile.dev Outdated
@@ -0,0 +1,4 @@
FROM ubuntu:24.04
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this needed?

README.md Outdated
@@ -2,6 +2,9 @@

**VolEsti** is a `C++` library for volume approximation and sampling of convex bodies (*e.g.* polytopes) with an `R` interface. For a limited `Python` interface we refer to package [dingo](https://github.com/GeomScale/dingo). **VolEsti** is part of the [GeomScale](https://geomscale.github.io) project.

**Note:** This tutorial is based on package version **1.1.2** from CRAN.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is not the right place for this note.

docs/tutorials/general.md Outdated
@@ -4,6 +4,9 @@

`volesti` is a `C++` package (with an `R` interface) for computing estimations of volume of polytopes given by a set of points or linear inequalities or Minkowski sum of segments (zonotopes). There are two algorithms for volume estimation and algorithms for sampling, rounding and rotating polytopes.

**Note:** This tutorial is based on package version **1.1.2** from CRAN.
Please ensure you have the latest version installed for compatibility.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove the second sentence "Please ensure...".

docs/tutorials/general.md
@@ -22,7 +25,7 @@ help("sample_points")
Let’s try our first volesti command to estimate the volume of a 3-dimensional cube $\{-1\leq x_i \leq 1,x_i \in \mathbb R\ |\ i=1,2,3\}$

```r
P <- GenCube(3,'H')
P <- gen_cube(3,'H')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, did you test that the rest of the tutorial works fine with 1.1.2?

@keithwind
Copy link
Author

Hi @vfisikop
I have updated the tutorial to match version 1.2.0 as suggested by you. Currently there are two issues :
1.I have mentioned 1.2.0 in the tutorial but the latest version on CRAN is 1.1.2 so I suggest updating the package on CRAN.
2.In the last section of the tutorial, a file is used that no longer exists. As a temporary fix, I have uploaded that file as a gist (I downloaded the file from WayBack Machine). I suggest adding that file to the repository so that it can be linked from there.

@keithwind keithwind changed the title Updated tutorial to reference gen_cube and CRAN v1.1.2 Updated tutorial to reference gen_cube and CRAN v1.2.0 Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vfisikop vfisikop vfisikop left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@keithwind @vfisikop