add state argument and dimension constraints to specialmatrices…#1165
add state argument and dimension constraints to specialmatrices…#1165srinjoy933 wants to merge 6 commits intofortran-lang:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1165 +/- ##
==========================================
- Coverage 68.66% 68.64% -0.02%
==========================================
Files 408 408
Lines 13619 13619
Branches 1537 1537
==========================================
- Hits 9351 9349 -2
- Misses 4268 4270 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Updates the stdlib_specialmatrices specification to match the existing tridiagonal constructor overloads and operator requirements, addressing the documentation gaps described in issue #1164.
Changes:
- Documented the optional
stateargument intridiagonalconstructors. - Documented the dimension (
n) matching requirement for+/-operators in addition to type/kind matching.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
loiseaujc
left a comment
loiseaujc
left a comment
There was a problem hiding this comment.
Basic PR simply rewording some things, but valid anyway. Already applied the suggestions from Copilot. LGTM.
jvdp1
left a comment
jvdp1
left a comment
There was a problem hiding this comment.
thank you @srinjoy933 . Overall LGTM. Could you check the name of the variable in the code, please?
doc/specs/stdlib_specialmatrices.md
Outdated
| - To construct a tridiagonal matrix from already allocated arrays `dl` (lower diagonal, size `n-1`), `dv` (main diagonal, size `n`) and `du` (upper diagonal, size `n-1`): | ||
|
|
||
| `A = ` [[stdlib_specialmatrices(module):tridiagonal(interface)]] `(dl, dv, du)` | ||
| `A = ` [[stdlib_specialmatrices(module):tridiagonal(interface)]] `(dl, dv, du [, state])` |
There was a problem hiding this comment.
If I am correct, the variable state is callde err in the code. I suggest to keep err to keep the code and the specs aligned.
|
hey @jvdp1 I have made the changes that you have suggested .Please suggest me if any more changes are required |
jvdp1
left a comment
jvdp1
left a comment
There was a problem hiding this comment.
thank you @srinjoy933 for correcting the specs. This PR is now ready to be merged IMO.
|
@srinjoy933 could you resolve the conflict, please? Once done, this PR will be ready to be merge IMO. |
|
hey @jvdp1 i have resolved that conflict issue ,now it is ready to be merged. |
solve #1164