Skip to content

Feature descriptions for catch22 v1.0 - #6

Merged
benfulcher merged 1 commit into
mainfrom
docs/v1.0-feature-descriptions
Oct 20, 2026
Merged

benfulcher merged 1 commit into
mainfrom
docs/v1.0-feature-descriptions

Conversation

@benfulcher

Copy link
Copy Markdown
Contributor

Updates the feature-description pages (information-about-catch22/feature-descriptions/) for catch22 v1.0. Merge this when catch22 v1.0 is released, not before: until then, these pages would describe behaviour that no released version has.

What changes:

  • Each feature is described as computed by v1.0, with its v1.0 long and short names, the hctsa code that reproduces it, and the value it takes when it can't be estimated (masking, on by default in v1.0).
  • Where v1.0 changes a feature, an info hint says what earlier versions did, including the old long or short name if it was renamed. The v0.6.0 corrections (periodicity, ami_timescale, stretch_high, stretch_decreasing) are noted separately as "Before v0.6.0".
  • The feature overview table now uses the v1.0 long names (centroid_freq is now median_freq). It gains a second table (name before v1.0, hctsa code, masked value, change from v0.6.0), a section on masking, the catch24 names and hctsa code, and a summary of the changes in v1.0.
  • Old-vs-new claims were checked against the C diff (v0.6.0..v1.0-candidate), the hctsa operations the features are frozen to, and the regenerated test outputs.

Pages outside this folder (the language-specific pages, the API reference and the citing page) still use v0.x names and behaviour, so they need their own update for v1.0.

🤖 Generated with Claude Code

Describe each feature as computed by catch22 v1.0: its v1.0 long and short
names, the hctsa code that reproduces it, and the value it takes when masked.
Where v1.0 changes a feature, a note says what earlier versions did (and
which notes refer to the v0.6.0 corrections). The overview table gains the
pre-v1.0 names, hctsa code, masked values, a masking section and a summary
of the changes in v1.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@benfulcher
benfulcher marked this pull request as ready for review October 20, 2026 00:04
@benfulcher
benfulcher merged commit 46724e8 into main Oct 20, 2026
4 checks passed
@benfulcher
benfulcher deleted the docs/v1.0-feature-descriptions branch October 20, 2026 00:04
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