Skip to content

Commit

Permalink
Merge pull request #3714 from JuliaReach/schillic/volume
Browse files Browse the repository at this point in the history
Revise documentation of `volume`
  • Loading branch information
schillic authored Jan 30, 2025
2 parents aa51758 + 323c2ce commit 9726124
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions src/API/Unary/volume.jl
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

0 comments on commit 9726124

Please sign in to comment.