[all] Deprecate unused verbose data #3871

alxbilger · 2023-05-16T13:38:32Z

By submitting this pull request, I acknowledge that
I have read, understand, and agree SOFA Developer Certificate of Origin (DCO).

Reviewers will merge this pull-request only if

it builds with SUCCESS for all platforms on the CI.
it does not generate new warnings.
it does not generate new unit test failures.
it does not generate new scene test failures.
it does not break API compatibility.
it is more than 1 week old (or has fast-merge label).

alxbilger · 2023-05-16T13:43:10Z

[ci-build][with-all-tests]

damienmarchal · 2023-05-22T07:46:17Z

Hello @alxbilger,

Thanks for the PR, removing that "verbose" looks fine to.
As a deprecation worklfow I recommand:

deprecate the data field (as done in the PR)
updates all call points that are using d_verbose: either replace them with msg_info or remove the message depending on the situation ?
in the parse method () (or init() method), detect that the verbose argument is used and print a deprecation indicating to the user that the field is either removed or replace by "printLog".

alxbilger · 2023-05-22T08:10:04Z

Hello @alxbilger,

Thanks for the PR, removing that "verbose" looks fine to. As a deprecation worklfow I recommand:

deprecate the data field (as done in the PR)

updates all call points that are using d_verbose: either replace them with msg_info or remove the message depending on the situation ?

I agree but in the case of this PR, the Data d_verbose was really not used at all. So no need to do anything.

in the parse method () (or init() method), detect that the verbose argument is used and print a deprecation indicating to the user that the field is either removed or replace by "printLog".

Yes, I will do it.

damienmarchal · 2023-05-22T08:12:14Z

Ok, i was actually not sure if it was not updated... or not used at all :)
So maybe we can move faster on that one by already DeprecatedAndRemove d_verbose ?

alxbilger · 2023-05-22T08:32:53Z

@damienmarchal I am not so sure. It is not excluded that this variable is actually used in a CUDA-based template specialization of the linear solvers (in a private plugin).

hugtalbot · 2023-05-22T13:11:32Z

anyway the variable to be used should be the inherited f_printLog right @damienmarchal @alxbilger ?

alxbilger · 2023-05-22T13:14:18Z

@hugtalbot it depends. In some other libraries, there are different levels of verbosity. We have only one. Adding an extra Data d_verbose could be a way to simulate a second level of verbosity. But it is not clean :). I think for now we just stick to f_printLog

alxbilger · 2023-05-22T13:26:43Z

@hugtalbot you flagged this PR to issue: bug (major). Is it done on purpose?

hugtalbot · 2023-05-31T08:14:06Z

my bad, all good 👍
I deeply courbette myself

* [all] Deprecate unused verbose data * Add warning in parse method

* Rename file DefaultContactManager into CollisionResponse * Update Compat layer with the new class name * udpate CMakeLists with new class name * udpate CMakeLists with new class name keeping compat file * update class name in the code * propagate the change of C++ class name * add compatibility file * update all scenes with new component name CollisionResponse * Apply suggestions from code review Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * [LinearAlgebra] Change access specifier for the method set (#3834) * Change access specifier for the method set. Needed in SofaCUDASolver plugin. Regardless the resons of this modification, The fact that this method is at the begining of the class declaration without any access specifier befoe is not usual * Changed attributs/methods orders and remove repeated identifiers --------- Co-authored-by: Paul Baksic <paul.baksic@unistra.fr> * [Spring] Remove unused dependencies (#3848) * [StateContainer] Fix bug in dynamic data registration (#3783) * [Sofa.Type] Replace the use of Matrix::s_identity (deprecated) by Matrix::Identity() * [Sofa.Component.StateContainer] Fix missing registration of dynamic properties. Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> --------- Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> * [SceneChecking] Add check when setting contactStiffness uselessly (#3843) * [SceneChecking] Add check when setting contactStiffness uselessly * Separate contribution in a separate function * [test] Fix unit test on RestShapeSpringsForceField (#3864) * [plugins] Remove fetching of SofaPython (#3855) * [Constraint.Lagrangian] Activate the export of lambda forces by default (#3857) * [all] Change variable name supportOnlySymmetricMatrix in MParams (#3861) * [all] Change variable name supportOnlySymmetricMatrix in MechanicalParams * propagate the supportOnlySymmetricMatrix API change * Add deprecation --------- Co-authored-by: Alex Bilger <alexbilger0@gmail.com> * [Constraint.Lagrangian] Add messages when no compliance is given (#3858) * [Constraint.Lagrangian] Add messages when no compliance is given * minor esthetic msg update * [all] include base class inl file (#3865) * [test] Fix failing unit test (#3876) Introduced in #3858 * [LinearAlgebra] Pull Insimo's CompressedRowSparseMatrix into the main branch (#3515) * WIP * CRS: integration from issofa * rename all bloc to blocks * use MessagingAPI (and rename again bloc to block * add matrix_bloc_traits for Vec * fix compilation with CRS debug macros * revert some useless changes * add insimo as contributors * fix compilation test by bringing back operators and MatrixExpr * fix stuff about add() * add compress() after clearing (fix some tests?) * fix debug compilation * clarify add() functions (indices, etc) * apply insimo code and clean ups * rename CRS for CRSGeneric * apply insimo code for CRSMechanical (previous CRS) and clean ups * add transitional header * fix confusion about mul() * bring back some changes from original version * bring back BM:add with mat3 and various fixes * fix gcc * remove conversion warnings * fix tests and stuff * Use struct instead of class (+public) Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * remove diag/debug/trace api in crs * remove now-useless CRS trace logger utility header * remove some override warnings * remove more warnings * fix rebase * refresh scene with MechanicalMatrixMapper * change traits to try to match previous behavior * fix missing include * add explicit instanction for float type * apply suggestion by using directly the correct type * remove the touch trait --------- Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * [SofaCUDA] Deprecated CudaTexture.h (#3869) It is not used, and its content is deprecated in Cuda 12 * [examples] Fix unstable scene constantMomentum.scn (#3886) * [SofaCUDA] Replace deprecated vector types (#3902) * [Config] Fix cross-compilation for embedded external libs (#3870) [Config] Fix cross-compilation by turning off cmake_find_root_path for embedded external libs * [all] Deprecate unused verbose data (#3871) * [all] Deprecate unused verbose data * Add warning in parse method * [contact] Add missing call to super init (#3884) * [SolidMechanics] Use accessors & make geometrical data required in BFF (#3887) [SolidMechanics] Use accessors & make geometrical data required in BeamFEMFF * [SofaCUDA] No longer use deprecated texture references in HexaTLED (#3868) * [SofaCUDA] Remove non-working scene * Introduce example * nodesPerElement * DhC0, DhC1 and DhC2 * detJ * Disp * hourglass control * preferredDirection * Di1, Di2, Dv1, Dv2 * force coordinates * Fi * x, x0 * Ignore added scene on CI --------- Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> Co-authored-by: Paul Baksic <30337881+bakpaul@users.noreply.github.com> Co-authored-by: Paul Baksic <paul.baksic@unistra.fr> Co-authored-by: Damien Marchal <damien.marchal@univ-lille1.fr> Co-authored-by: Alex Bilger <alexbilger0@gmail.com> Co-authored-by: Frederick Roy <fredroy@users.noreply.github.com> Co-authored-by: Olivier Roussel <olivier.roussel@inria.fr>

…work#3891) * Rename file DefaultContactManager into CollisionResponse * Update Compat layer with the new class name * udpate CMakeLists with new class name * udpate CMakeLists with new class name keeping compat file * update class name in the code * propagate the change of C++ class name * add compatibility file * update all scenes with new component name CollisionResponse * Apply suggestions from code review Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * [LinearAlgebra] Change access specifier for the method set (sofa-framework#3834) * Change access specifier for the method set. Needed in SofaCUDASolver plugin. Regardless the resons of this modification, The fact that this method is at the begining of the class declaration without any access specifier befoe is not usual * Changed attributs/methods orders and remove repeated identifiers --------- Co-authored-by: Paul Baksic <paul.baksic@unistra.fr> * [Spring] Remove unused dependencies (sofa-framework#3848) * [StateContainer] Fix bug in dynamic data registration (sofa-framework#3783) * [Sofa.Type] Replace the use of Matrix::s_identity (deprecated) by Matrix::Identity() * [Sofa.Component.StateContainer] Fix missing registration of dynamic properties. Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> --------- Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> * [SceneChecking] Add check when setting contactStiffness uselessly (sofa-framework#3843) * [SceneChecking] Add check when setting contactStiffness uselessly * Separate contribution in a separate function * [test] Fix unit test on RestShapeSpringsForceField (sofa-framework#3864) * [plugins] Remove fetching of SofaPython (sofa-framework#3855) * [Constraint.Lagrangian] Activate the export of lambda forces by default (sofa-framework#3857) * [all] Change variable name supportOnlySymmetricMatrix in MParams (sofa-framework#3861) * [all] Change variable name supportOnlySymmetricMatrix in MechanicalParams * propagate the supportOnlySymmetricMatrix API change * Add deprecation --------- Co-authored-by: Alex Bilger <alexbilger0@gmail.com> * [Constraint.Lagrangian] Add messages when no compliance is given (sofa-framework#3858) * [Constraint.Lagrangian] Add messages when no compliance is given * minor esthetic msg update * [all] include base class inl file (sofa-framework#3865) * [test] Fix failing unit test (sofa-framework#3876) Introduced in sofa-framework#3858 * [LinearAlgebra] Pull Insimo's CompressedRowSparseMatrix into the main branch (sofa-framework#3515) * WIP * CRS: integration from issofa * rename all bloc to blocks * use MessagingAPI (and rename again bloc to block * add matrix_bloc_traits for Vec * fix compilation with CRS debug macros * revert some useless changes * add insimo as contributors * fix compilation test by bringing back operators and MatrixExpr * fix stuff about add() * add compress() after clearing (fix some tests?) * fix debug compilation * clarify add() functions (indices, etc) * apply insimo code and clean ups * rename CRS for CRSGeneric * apply insimo code for CRSMechanical (previous CRS) and clean ups * add transitional header * fix confusion about mul() * bring back some changes from original version * bring back BM:add with mat3 and various fixes * fix gcc * remove conversion warnings * fix tests and stuff * Use struct instead of class (+public) Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * remove diag/debug/trace api in crs * remove now-useless CRS trace logger utility header * remove some override warnings * remove more warnings * fix rebase * refresh scene with MechanicalMatrixMapper * change traits to try to match previous behavior * fix missing include * add explicit instanction for float type * apply suggestion by using directly the correct type * remove the touch trait --------- Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * [SofaCUDA] Deprecated CudaTexture.h (sofa-framework#3869) It is not used, and its content is deprecated in Cuda 12 * [examples] Fix unstable scene constantMomentum.scn (sofa-framework#3886) * [SofaCUDA] Replace deprecated vector types (sofa-framework#3902) * [Config] Fix cross-compilation for embedded external libs (sofa-framework#3870) [Config] Fix cross-compilation by turning off cmake_find_root_path for embedded external libs * [all] Deprecate unused verbose data (sofa-framework#3871) * [all] Deprecate unused verbose data * Add warning in parse method * [contact] Add missing call to super init (sofa-framework#3884) * [SolidMechanics] Use accessors & make geometrical data required in BFF (sofa-framework#3887) [SolidMechanics] Use accessors & make geometrical data required in BeamFEMFF * [SofaCUDA] No longer use deprecated texture references in HexaTLED (sofa-framework#3868) * [SofaCUDA] Remove non-working scene * Introduce example * nodesPerElement * DhC0, DhC1 and DhC2 * detJ * Disp * hourglass control * preferredDirection * Di1, Di2, Dv1, Dv2 * force coordinates * Fi * x, x0 * Ignore added scene on CI --------- Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> Co-authored-by: Paul Baksic <30337881+bakpaul@users.noreply.github.com> Co-authored-by: Paul Baksic <paul.baksic@unistra.fr> Co-authored-by: Damien Marchal <damien.marchal@univ-lille1.fr> Co-authored-by: Alex Bilger <alexbilger0@gmail.com> Co-authored-by: Frederick Roy <fredroy@users.noreply.github.com> Co-authored-by: Olivier Roussel <olivier.roussel@inria.fr>

* [all] Deprecate unused verbose data * Add warning in parse method

…work#3891) * Rename file DefaultContactManager into CollisionResponse * Update Compat layer with the new class name * udpate CMakeLists with new class name * udpate CMakeLists with new class name keeping compat file * update class name in the code * propagate the change of C++ class name * add compatibility file * update all scenes with new component name CollisionResponse * Apply suggestions from code review Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * [LinearAlgebra] Change access specifier for the method set (sofa-framework#3834) * Change access specifier for the method set. Needed in SofaCUDASolver plugin. Regardless the resons of this modification, The fact that this method is at the begining of the class declaration without any access specifier befoe is not usual * Changed attributs/methods orders and remove repeated identifiers --------- Co-authored-by: Paul Baksic <paul.baksic@unistra.fr> * [Spring] Remove unused dependencies (sofa-framework#3848) * [StateContainer] Fix bug in dynamic data registration (sofa-framework#3783) * [Sofa.Type] Replace the use of Matrix::s_identity (deprecated) by Matrix::Identity() * [Sofa.Component.StateContainer] Fix missing registration of dynamic properties. Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> --------- Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> * [SceneChecking] Add check when setting contactStiffness uselessly (sofa-framework#3843) * [SceneChecking] Add check when setting contactStiffness uselessly * Separate contribution in a separate function * [test] Fix unit test on RestShapeSpringsForceField (sofa-framework#3864) * [plugins] Remove fetching of SofaPython (sofa-framework#3855) * [Constraint.Lagrangian] Activate the export of lambda forces by default (sofa-framework#3857) * [all] Change variable name supportOnlySymmetricMatrix in MParams (sofa-framework#3861) * [all] Change variable name supportOnlySymmetricMatrix in MechanicalParams * propagate the supportOnlySymmetricMatrix API change * Add deprecation --------- Co-authored-by: Alex Bilger <alexbilger0@gmail.com> * [Constraint.Lagrangian] Add messages when no compliance is given (sofa-framework#3858) * [Constraint.Lagrangian] Add messages when no compliance is given * minor esthetic msg update * [all] include base class inl file (sofa-framework#3865) * [test] Fix failing unit test (sofa-framework#3876) Introduced in sofa-framework#3858 * [LinearAlgebra] Pull Insimo's CompressedRowSparseMatrix into the main branch (sofa-framework#3515) * WIP * CRS: integration from issofa * rename all bloc to blocks * use MessagingAPI (and rename again bloc to block * add matrix_bloc_traits for Vec * fix compilation with CRS debug macros * revert some useless changes * add insimo as contributors * fix compilation test by bringing back operators and MatrixExpr * fix stuff about add() * add compress() after clearing (fix some tests?) * fix debug compilation * clarify add() functions (indices, etc) * apply insimo code and clean ups * rename CRS for CRSGeneric * apply insimo code for CRSMechanical (previous CRS) and clean ups * add transitional header * fix confusion about mul() * bring back some changes from original version * bring back BM:add with mat3 and various fixes * fix gcc * remove conversion warnings * fix tests and stuff * Use struct instead of class (+public) Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * remove diag/debug/trace api in crs * remove now-useless CRS trace logger utility header * remove some override warnings * remove more warnings * fix rebase * refresh scene with MechanicalMatrixMapper * change traits to try to match previous behavior * fix missing include * add explicit instanction for float type * apply suggestion by using directly the correct type * remove the touch trait --------- Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> * [SofaCUDA] Deprecated CudaTexture.h (sofa-framework#3869) It is not used, and its content is deprecated in Cuda 12 * [examples] Fix unstable scene constantMomentum.scn (sofa-framework#3886) * [SofaCUDA] Replace deprecated vector types (sofa-framework#3902) * [Config] Fix cross-compilation for embedded external libs (sofa-framework#3870) [Config] Fix cross-compilation by turning off cmake_find_root_path for embedded external libs * [all] Deprecate unused verbose data (sofa-framework#3871) * [all] Deprecate unused verbose data * Add warning in parse method * [contact] Add missing call to super init (sofa-framework#3884) * [SolidMechanics] Use accessors & make geometrical data required in BFF (sofa-framework#3887) [SolidMechanics] Use accessors & make geometrical data required in BeamFEMFF * [SofaCUDA] No longer use deprecated texture references in HexaTLED (sofa-framework#3868) * [SofaCUDA] Remove non-working scene * Introduce example * nodesPerElement * DhC0, DhC1 and DhC2 * detJ * Disp * hourglass control * preferredDirection * Di1, Di2, Dv1, Dv2 * force coordinates * Fi * x, x0 * Ignore added scene on CI --------- Signed-off-by: Damien Marchal <damien.marchal@univ-lille1.fr> Co-authored-by: Alex Bilger <alxbilger@users.noreply.github.com> Co-authored-by: Paul Baksic <30337881+bakpaul@users.noreply.github.com> Co-authored-by: Paul Baksic <paul.baksic@unistra.fr> Co-authored-by: Damien Marchal <damien.marchal@univ-lille1.fr> Co-authored-by: Alex Bilger <alexbilger0@gmail.com> Co-authored-by: Frederick Roy <fredroy@users.noreply.github.com> Co-authored-by: Olivier Roussel <olivier.roussel@inria.fr>

alxbilger added pr: status to review To notify reviewers to review this pull-request pr: clean Cleaning the code labels May 16, 2023

alxbilger added 2 commits May 22, 2023 10:33

[all] Deprecate unused verbose data

9c8e346

Add warning in parse method

85425d7

alxbilger force-pushed the deprecateverbosedata branch from 146d1bb to 85425d7 Compare May 22, 2023 08:33

hugtalbot approved these changes May 22, 2023

View reviewed changes

hugtalbot added the issue: bug (major) Critical bug affecting everyone: not working, performances or accuracy degraded label May 22, 2023

hugtalbot removed the issue: bug (major) Critical bug affecting everyone: not working, performances or accuracy degraded label May 31, 2023

hugtalbot added pr: status ready Approved a pull-request, ready to be squashed and removed pr: status to review To notify reviewers to review this pull-request labels May 31, 2023

alxbilger merged commit 571b1d6 into sofa-framework:master May 31, 2023

hugtalbot pushed a commit to hugtalbot/sofa that referenced this pull request Jun 1, 2023

[all] Deprecate unused verbose data (sofa-framework#3871)

e547cd3

* [all] Deprecate unused verbose data * Add warning in parse method

hugtalbot added this to the v23.12 milestone Jun 4, 2023

alxbilger added a commit to alxbilger/sofa that referenced this pull request Oct 27, 2023

[all] Deprecate unused verbose data (sofa-framework#3871)

64d3998

* [all] Deprecate unused verbose data * Add warning in parse method

alxbilger added a commit to alxbilger/sofa that referenced this pull request Oct 27, 2023

[all] Deprecate unused verbose data (sofa-framework#3871)

73db635

* [all] Deprecate unused verbose data * Add warning in parse method

alxbilger added a commit to alxbilger/sofa that referenced this pull request Oct 27, 2023

[all] Deprecate unused verbose data (sofa-framework#3871)

5ba216c

* [all] Deprecate unused verbose data * Add warning in parse method

hugtalbot changed the title ~~[all] Deprecate unused verbose data~~ [all] Deprecate unused verbose data Feb 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[all] Deprecate unused verbose data #3871

[all] Deprecate unused verbose data #3871

Uh oh!

alxbilger commented May 16, 2023

Uh oh!

alxbilger commented May 16, 2023

Uh oh!

damienmarchal commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

damienmarchal commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

hugtalbot commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

hugtalbot commented May 31, 2023 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[all] Deprecate unused verbose data #3871

[all] Deprecate unused verbose data #3871

Uh oh!

Conversation

alxbilger commented May 16, 2023

Uh oh!

alxbilger commented May 16, 2023

Uh oh!

damienmarchal commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

damienmarchal commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

hugtalbot commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

alxbilger commented May 22, 2023

Uh oh!

hugtalbot commented May 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hugtalbot commented May 31, 2023 •

edited

Loading