feat: add conditional return types for axis-dependent reduction methods - #22
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds PHPStan conditional return type annotations to reduction and norm methods whose return type depends on whether
$axisis null.Motivation and Context
When calling methods like
$arr->sum()with$axis = null, the return is always a scalar (Complex|float|int), but the union return typeComplex|float|int|NDArrayforces static analysis tools like PHPStan to require type narrowing before using the result. Conditional return types allow tools to infer the correct type based on the$axisargument value, eliminating unnecessary boilerplate assertions.What's Changed
@return ($axis is null ? <scalar> : NDArray)PHPDoc annotations tosum,mean,min,max,argmin,argmax,product,var,stdinHasReductionstrait@return ($axis is null ? float : NDArray)PHPDoc annotation tonorminHasLinearAlgebratraitBreaking Changes
None.