Skip to content
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

Revise documentation of volume #3714

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Revise documentation of volume #3714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions src/API/Unary/volume.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
"""
volume(X::LazySet)

Compute the volume of a set.
Compute the volume, or Lebesgue measure, of a set.

### Input

- `X` -- set

### Output

A real number representing the volume of `X`.
A real number representing the Lebesgue measure of `X`.

### Notes

The [Lebesgue measure](https://en.wikipedia.org/wiki/Lebesgue_measure) has the
following common special cases:

- In 1D, it coincides with the *length*.
- In 2D, it coincides with the *area* (see also [`area`](@ref)).
- In 3D, it coincides with the *volume*.

In higher dimensions, it is also known as the *hypervolume* or simply *volume*.
"""
function volume(::LazySet) end
Loading