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.

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

Towards version 0.8 (breaking release) #171

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Conversation

daanhb
Copy link
Member

@daanhb daanhb commented Jan 29, 2025

This pull request mainly completes the work that was started to factor out functionality of maps. A new package FunctionMaps.jl was created. It was present as a submodule in DomainSets v0.7, but is removed in this PR.

The functionality of DomainSets is exactly the same as in the current version 0.7.15. What is breaking is the exports.

  • Most functions that were exported by DomainSets before are now exported either by DomainSets or by FunctionMaps. Thus, the following should work for most people:
julia> using DomainSets, FunctionMaps

I will list below exactly what the sets of exported symbols are. The total number of exports was reduced a little bit.

  • One other change is that LinearAlgebra.cross is no longer pirated to mean the cartesian product of domains. In version 0.8 DomainSets.:× is different from LinearAlgebra.:×. The latter is a synonym for LinearAlgebra.cross, the former is a synonym for DomainSets.cartesianproduct (which in turn simply calls the productdomain functions).

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 5 lines in your changes missing coverage. Please review.

Project coverage is 93.81%. Comparing base (793535e) to head (2ef0919).

Files with missing lines Patch % Lines
src/domains/complex.jl 0.00% 2 Missing ⚠️
src/deprecated.jl 0.00% 1 Missing ⚠️
src/generic/mapped.jl 0.00% 1 Missing ⚠️
src/generic/productdomain.jl 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #171      +/-   ##
==========================================
- Coverage   93.91%   93.81%   -0.11%     
==========================================
  Files          27       28       +1     
  Lines        1842     1844       +2     
==========================================
  Hits         1730     1730              
- Misses        112      114       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@daanhb
Copy link
Member Author

daanhb commented Jan 29, 2025

On exports:

  • DomainSets v0.7.15 exports 209 symbols (looking at names(DomainSets, all=false))
  • DomainSets v0.8 in current PR exports 157 symbols
  • FunctionMaps v0.1.1 exports 35 symbols

Thus, the union of DomainSets 0.8 and FunctionMaps 0.1.1 is still smaller than what DomainSets used to export in 0.7. The difference lies mainly in functions that had been deprecated and have now been removed. In addition:

  • AbstractMap: has disappeared. Use Map instead
  • StaticIdentityMap and VectorIdentityMap: unexported in favour of using the abstract IdentityMap constructor (if one is so inclined)
  • ComposedMap, TypedMap: unexported for similar reason, there should not be a reason for the general user to invoke these functions directly
  • CartToPolarMap, PolarToCartMap: unexported because these are application oriented and somewhat arbitrary. Better to focus on co-existing with CoordinateTransformations.jl instead
  • rotation_map: unexported for the same reason, but this lives on in DomainSets and not in FunctionMaps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant