Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename MultRowVector to MultVector #2709

Merged
merged 2 commits into from
Sep 12, 2018

Conversation

fingolfin
Copy link
Member

With PR #2640 merged, I am submitting the remaining MatrixObj changes as separate PRs.

This contains @ssiccha work on MultRowVector resp. MultVector from PR #1685. I think these change are fine, but perhaps we want to squash them into a single commit (and/or split them differently across commits than right now). Also, the changes are a bit more extensive, and I felt it was best to give people a chance to review them separately once again (back then, @frankluebeck briefly commented on the PR, but I think I was the only one to extensively review it.

@ssiccha feel free to approve, even though these are your own changes ;-). In fact, that means you are uniquely qualified to review this now ;-).

@fingolfin fingolfin added topic: documentation Issues and PRs related to documentation topic: tests issues or PRs related to tests topic: library release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels Aug 15, 2018
@codecov
Copy link

codecov bot commented Aug 15, 2018

Codecov Report

Merging #2709 into master will decrease coverage by <.01%.
The diff coverage is 51.31%.

@@            Coverage Diff             @@
##           master    #2709      +/-   ##
==========================================
- Coverage   76.03%   76.02%   -0.01%     
==========================================
  Files         480      480              
  Lines      240919   240940      +21     
==========================================
- Hits       183185   183184       -1     
- Misses      57734    57756      +22
Impacted Files Coverage Δ
lib/listcoef.gi 72.33% <ø> (+0.11%) ⬆️
lib/vec8bit.gi 53.56% <ø> (ø) ⬆️
lib/obsolete.gd 79.16% <ø> (ø) ⬆️
hpcgap/lib/vec8bit.gi 52.13% <ø> (ø) ⬆️
lib/vecmat.gi 68.55% <0%> (ø) ⬆️
hpcgap/lib/vecmat.gi 64.52% <0%> (ø) ⬆️
lib/matobj.gi 31.22% <0%> (-1.67%) ⬇️
lib/obsolete.gi 0% <0%> (ø) ⬆️
lib/matobjplist.gi 14.56% <0%> (+0.07%) ⬆️
lib/claspcgs.gi 42.2% <100%> (ø) ⬆️
... and 17 more

Copy link
Contributor

@ThomasBreuer ThomasBreuer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Except for the remarks in the code, this looks fine to me.

@@ -185,6 +189,11 @@ Instead of <C>PositionFirstComponent(list,obj)</C>, you may use
<C>PositionProperty(list,x->x[1]=obj)</C> as a replacement, depending on
your specific use case.

<Index Key="MultRowVector"><C>MultRowVector</C></Index>
The five argument version of the operation <C>MultRowVector</C> has been
deprecated in GAP 4.8 since it was unused and only available for coefficient
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GAP 4.8 should be replaced by GAP 4.10?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed

src/listoper.c Outdated
@@ -1571,33 +1571,50 @@ Obj FuncADD_ROW_VECTOR_2_FAST ( Obj self,

/****************************************************************************
**
*F FuncMULT_ROW_VECTOR_2( <self>, <list>, <mult> )
*F FuncMULT_VECTOR_LEFT_RIGHT_2( <self>, <list>, <mult> )
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last argument is missing.

@fingolfin
Copy link
Member Author

@ssiccha Sergio, could you please indicate whether you think it's reasonable if I squash this into a single commit?

@ssiccha
Copy link
Contributor

ssiccha commented Aug 22, 2018

@fingolfin 62344d4 should definitely be squashed into bde1e35. I would leave 1e466c6 alone since it touches a lot more files than bde1e35 and 62344d4.

@fingolfin
Copy link
Member Author

Squashed that one commit, rebased, and addressed @ThomasBreuer other remark.

@hulpke
Copy link
Contributor

hulpke commented Aug 30, 2018

Will the identifier MultRowVector be kept as a synonym for a number of releases?

@fingolfin
Copy link
Member Author

We never remove an identifier that has been made obsolete before at least all distributed packages stopped using it. Beyond that, we might remove it -- but if you have special need to keep it around, of course that'd be considered, too; and e.g. a comment noting this requirement could be added next to DeclareObsoleteSynonym( "MultRowVector", "MultVector" );. And in addition, of course you'd be able to veto the PR removing the synonym (but of course it's possible to miss such a PR; so I'd suggest we add a comment declaring the need, so that before removing it, you'd be consulted explicitly).

@fingolfin
Copy link
Member Author

@ThomasBreuer is this PR OK now, from your perspective? If so, please approve (or at least drop the "request for changes"). Thanks!

@fingolfin
Copy link
Member Author

At this point, I think it might be best to not rush this into GAP 4.10 at the last minute, but rather delay it to GAP 4.11. Setting milestone accordingly. Feel free to override me if you think it's important to get this in now, though.

@fingolfin fingolfin added this to the GAP 4.11 milestone Sep 7, 2018
- Split MultRowVector to MultRowVectorLeft / MultRowVectorRight.
- MultRowVector is declared a synonym for MultRowVectorLeft.
- MultRowVectorOp is renamed to MultRowVectorLeftOp on the C level.
- Add four argument declarations for MultRowVectorLeft( vec, mul, from, to )
  and ..Right
- Remove the five argument version of MultRowVector in MatrixObj.
  Deprecate it also in the library. This version was not used anywhere in
  the library or packages

- Add generic and plist implementations of MultRowVector where necessary
  - Implement and declare ..Left and ..Right versions in matrixobj*
  - Only do the ..Left version in listcoef.g?. The methods from listcoef.gi
    are only used for integers and FFEs in the library.
    Adding the ..Right versions would only introduce lots of unused code.
    People wanting to use the ..Right versions should use vector objs.

- Have a kernel function MULT_ROW_VECTOR_LEFT_RIGHT_2 which is called by
  MULT_ROW_VECTOR_LEFT_2 and ..RIGHT_2

- Add tests for MultRowVector
Performs the following sed commands in the directories
`lib/`, `src/`, `hpcgap/`. Then undo the changes in
the `obsolete.{gd,gi}` files.

sed -i 's/MULT_ROW_VECTOR/MULT_VECTOR/g' `find . -type f`
sed -i 's/MULT_ROWVECTOR/MULT_VECTOR/g' `find . -type f`
sed -i 's/MultRowVector/MultVector/g' `find . -type f`
git checkout -- obsolete.{gd,gi}

Also perform:
sed -i 's/MultRowVector/MultVector/g' doc/ref/vector.xml
@fingolfin fingolfin merged commit 4040d9b into gap-system:master Sep 12, 2018
@fingolfin fingolfin deleted the mh/MatrixObj-MultVector branch September 12, 2018 20:40
@fingolfin fingolfin changed the title MatrixObj: Rename MultRowVector to MultVector, and add doc, code, tests Rename MultRowVector to MultVector Aug 22, 2019
@fingolfin fingolfin added release notes: added PRs introducing changes that have since been mentioned in the release notes and removed release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels Aug 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: added PRs introducing changes that have since been mentioned in the release notes topic: documentation Issues and PRs related to documentation topic: library topic: tests issues or PRs related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants