-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3714 from JuliaReach/schillic/volume
Revise documentation of `volume`
- Loading branch information
Showing
1 changed file
with
13 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |