Skip to content

Commit

Permalink
expose the keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris committed Oct 7, 2024
1 parent c0d9faf commit 038542d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/set_distance.jl
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ The distance is calculated with the metric given to `Hausdorff` which defaults t
a proper metric in the space of sets of state space sets.
This metric only works for `StateSpaceSet`s whose elements are `SVector`s.
For developers: `set_distance` can take keywords `tree1, tree2` that are the KDTrees
of the first and second sets respectively.
"""
struct Hausdorff{M<:Metric}
metric::M
Expand All @@ -79,12 +82,15 @@ The distance is calculated with the given metric.
The `brute::Bool` argument switches the computation between a KDTree-based version,
or brute force (i.e., calculation of all distances and picking the smallest one).
Brute force performs better for datasets that are either large dimensional or
Brute force performs better for sets that are either large dimensional or
have a small amount of points. Deciding a cutting point is not trivial,
and is recommended to simply benchmark the [`set_distance`](@ref) function to
make a decision.
If `brute = false` this metric only works for `StateSpaceSet`s whose elements are `SVector`s.
For developers: `set_distance` can take a keyword `tree2` that is the KDTree
of the second set.
"""
struct StrictlyMinimumDistance{M<:Metric}
brute::Bool
Expand Down

0 comments on commit 038542d

Please sign in to comment.