Skip to content

Provide a Stem overload which does not allocate memory - #4

Open
alex-davidson wants to merge 5 commits into
Sorrien:masterfrom
alex-davidson:performance/spans
Open

Provide a Stem overload which does not allocate memory#4
alex-davidson wants to merge 5 commits into
Sorrien:masterfrom
alex-davidson:performance/spans

Conversation

@alex-davidson

Copy link
Copy Markdown

This refactor eliminates heap allocations from the stemming process. By accepting an output buffer from the caller we even avoid allocating a string for the result. The existing Stem method is retained to reduce likely breakage in consuming code.

Notes:

  • This adds a reference to System.Memory, since .NET Standard 2.0 does not include span types.
  • Possibly-breaking API changes mean that this is a 'major' update if SemVer is used.
  • dotMemory seems to indicate that StemInternal is still allocating strings occasionally, but this might just be first-time initialisation of the constants (~3.6KB).

Alex Davidson added 5 commits February 23, 2024 17:26
Expose these arrays as ReadOnlySpan to avoid possibility of mutation.

Note that this does mean that we take a dependency on System.Memory as
.NET Standard 2.0 does not include this type. It may be preferable to
build the library as `net48` and `netstandard2.1` to avoid this.
Make test-only methods 'internal' to conceal implementation details.
Since we never lengthen the word, we can use the same stack-based
buffer for the entire process and avoid any further allocations.

We implement our own ToLowerInvariant on a character-by-character basis
because .NET's own implementation (at least under .NET Framework)
allocates strings internally.
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