Skip to content

Commit

Permalink
Minor edits to CHANGELOG for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
rmjarvis committed Mar 12, 2024
1 parent 4a6ca39 commit f4c975f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The new three-point binning scheme is called ``bin_type="LogSAS"``. This is now
binning for all three-point correlation classes. Furthermore, the default algorithm is
``algo="multipole"``, which first computes the multipole version of the correlation function
using the Porth et al algorithm. Then it converts back to regular configuration space
the the LogSAS binning.
wth the LogSAS binning.

The old versions are still available in case there are use cases for which they are superior
in some way. I do use them in the test suite still for comparison purposes. To use the
Expand All @@ -29,21 +29,21 @@ my old implementation. Now, you can indicate whether or not you want the three
to keep their ordering in the triangle with the parameter ``ordered`` in the `Corr3.process`
function. If ``ordered=False``, then points from the (2 or 3) catalogs are allowed to take
any position in the triangle. If ``ordered=True`` (the default), then points from the first
catalog will only for point P1 in the triangle, points from the second catalog will only be at P2,
and points from the third will only be at P3. This seems to be a more intuitive way to control
this than the old ``CrossCorrelation`` classes.
catalog will only be used for point P1 in the triangle, points from the second catalog will only
be at P2, and points from the third will only be at P3. This is a significantly more intuitive
way to control this than the old CrossCorrelation classes.

Another big change in this release is the addition of more fields for the two-point correlations.
TreeCorr now implements correlations of spin-1 vector fields, as well as complex-valued
fields with spin=0, 3, or 4. (TreeCorr had already implemented spin-2 of course.)
Another big change in this release is the addition of more kinds of fields for the two-point
correlations. TreeCorr now implements correlations of spin-1 vector fields, as well as
complex-valued fields with spin 0, 3, or 4. (TreeCorr had already implemented spin-2 of course.)
The letters for each of these are V, Z, T, and Q respectively. I only did the pairings of each of
these with itself, counts (N), and real scalar fields (K). However, it would not be too hard
to add more if someone has a use case for a pairing of two complex fields with different spins.

A complete list of all new features and changes is given below.
`Relevant PRs and Issues,
<https://github.com/rmjarvis/TreeCorr/issues?q=milestone%3A%22Version+5.0%22+is%3Aclosed>`_
whose issue numbers are listed below for the relevant items.
are listed below by number for the relevant items.


Dependency Change
Expand Down

0 comments on commit f4c975f

Please sign in to comment.