Logging #131

shivupa · 2021-10-05T22:10:55Z

This implements a virtual Logging class which can be implemented by the user to log each iteration. This implements the proposed implementation "A" on #103.

The added tests are very simple and demonstrate an example of the derived logging class.

Closes #103

codecov-commenter · 2021-10-05T22:21:07Z

Codecov Report

Attention: Patch coverage is 96.96970% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 92.4%. Comparing base (3af5641) to head (a91f594).

❗ Current head a91f594 differs from pull request most recent head 88c3b30

Please upload reports for the commit 88c3b30 to get more accurate results.

Files	Patch %	Lines
include/Spectra/JDSymEigsBase.h	88.8%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #131     +/-   ##
========================================
- Coverage    93.2%   92.4%   -0.9%     
========================================
  Files          45      46      +1     
  Lines        2400    2253    -147     
========================================
- Hits         2239    2082    -157     
- Misses        161     171     +10

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

JensWehner · 2021-10-05T22:45:18Z

include/Spectra/DavidsonSymEigsSolver.h

@@ -39,8 +39,8 @@ class DavidsonSymEigsSolver : public JDSymEigsBase<DavidsonSymEigsSolver<OpType>
    Vector m_diagonal;

 public:
-    DavidsonSymEigsSolver(OpType& op, Index nev, Index nvec_init, Index nvec_max) :
-        JDSymEigsBase<DavidsonSymEigsSolver<OpType>, OpType>(op, nev, nvec_init, nvec_max)
+    DavidsonSymEigsSolver(OpType& op, Index nev, Index nvec_init, Index nvec_max, std::unique_ptr<LoggerBase<Scalar, Vector>> logger = nullptr) :


I do not prefer default arguments instead just have two constructors. The reason for it is that if we eve change the interface or add a second default argument it will all break down in user code.

I had it implemented this way at first, but I wanted to reduce code duplication so I went with default args. I will change it back since I agree with your assessment.

JensWehner · 2021-10-05T22:47:27Z

include/Spectra/GenEigsBase.h

+        if (logger)
+            m_logger = std::move(logger);


I prefer brackets around one line if statements, but it is a nitpick

and the rest of the codebase does not do it so. :)

I prefer it as well but I will leave it since the code base doesn't do that

JensWehner · 2021-10-05T22:49:23Z

include/Spectra/GenEigsBase.h

+            if (m_logger)
+                m_logger->iteration_log(i, nconv, m_ncv, m_ritz_val.head(m_nev), m_resid, m_ritz_conv);


I think it would be nicer to have an iteration_data structure because if we want to log more things this function signature would have to change everywhere, of course then we would maybe have to take copies.

Sure this makes sense. I will push some commits with this change. Even if we make copies, the size of the objects shouldn't be overly large so this will probably be ok.

you can also take references in the constructor. So you could have a datastructure that just returns const references as well

JensWehner · 2021-10-05T22:50:17Z

include/Spectra/JDSymEigsBase.h

@@ -51,6 +54,7 @@ class JDSymEigsBase

 private:
    CompInfo m_info = CompInfo::NotComputed;  // status of the computation
+    std::unique_ptr<LoggerBase<Scalar, Vector>> m_logger;


thing is this makes the class non copyable, what do we do about that?

We could use shared_ptr? There is no need for this to be unique_ptr

the other option would be to just have a * and have the user of the library manage the lifetime of the logger

JensWehner · 2021-10-05T22:51:23Z

include/Spectra/LoggerBase.h

+    ///
+    /// Virtual logging function
+    ///
+    virtual void iteration_log(const Index& iteration, const Index& number_of_converged, const Index& subspace_size, const Vector& current_eigenvalues, const Vector& residues, const BoolArray& current_eig_converged);


as said I think we should add a Datastructure here, maybe even an abstract baseclass so we can use this also for the other solvers. @yixuan would this be worth extending to the other solvers?

JensWehner

Thanks for implementing it, what a nice PR. I added some comments which I think can make it even more long term stable. Would be nice for the other solvers to adapt sth. similiar.

Great work!

shivupa · 2021-10-06T18:31:59Z

Thanks for the quick review and the advice!

shivupa · 2021-10-08T20:30:03Z

@JensWehner If you could take another pass I'd appreciate it!

JensWehner · 2021-10-11T18:48:26Z

include/Spectra/GenEigsBase.h


 private:
    BoolArray     m_ritz_conv; // indicator of the convergence of Ritz values
    CompInfo      m_info;      // status of the computation
+    std::shared_ptr<LoggerBase<Scalar, ComplexVector>> m_logger;


I am not sure if a shared_ptr is a good idea, because I copy would habe interesting problems then, because we would only have a shallow copy.

Yeah sorry I wanted to try to use something safer than a raw pointer, but I realize now I would have to rewrite the copy constructor. That is still an option, but I switched to raw ptrs for now.

include/Spectra/LoggerBase.h

JensWehner

Small nitpicks otherwise I like the addition, but let us see what @yixuan says.

…s. This commit can be rolled back if desired

JensWehner reviewed Oct 5, 2021

View reviewed changes

JensWehner reviewed Oct 11, 2021

View reviewed changes

include/Spectra/LoggerBase.h Outdated Show resolved Hide resolved

JensWehner reviewed Oct 11, 2021

View reviewed changes

shivupa added 16 commits May 31, 2024 18:05

GenEigs* logging

32bd493

SymEigs* logging

fe4c5d2

JDEig* logging

eb940b0

Fix types

3fe65ac

logging tests

d3622e9

remove comment

6f97d87

unique_ptr -> shared_ptr

d213e64

Separate constructors

efa471d

logging data class

07e1cbb

Use raw ptr and prune includes

b6ecbe2

initialize ptr as nullptr

90dcfcb

Minor fixes

f180bcd

Logging function pure virtual

8c993e2

Fix search space size

e3e0869

Add a logging function that gets called at the start of the iteration…

7bdec45

…s. This commit can be rolled back if desired

minor fix

88c3b30

shivupa force-pushed the logging branch from 68c31e2 to 88c3b30 Compare May 31, 2024 22:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Logging #131

Logging #131

shivupa commented Oct 5, 2021

codecov-commenter commented Oct 5, 2021 •

edited by codecov bot

Loading

JensWehner Oct 5, 2021

shivupa Oct 6, 2021

JensWehner Oct 5, 2021

JensWehner Oct 5, 2021

shivupa Oct 6, 2021

JensWehner Oct 5, 2021

shivupa Oct 6, 2021

JensWehner Oct 6, 2021

JensWehner Oct 5, 2021

shivupa Oct 6, 2021

JensWehner Oct 6, 2021

JensWehner Oct 5, 2021

JensWehner left a comment

shivupa commented Oct 6, 2021

shivupa commented Oct 8, 2021

JensWehner Oct 11, 2021

shivupa Oct 16, 2021

JensWehner left a comment

		if (m_logger)
		m_logger->iteration_log(i, nconv, m_ncv, m_ritz_val.head(m_nev), m_resid, m_ritz_conv);

Logging #131

Are you sure you want to change the base?

Logging #131

Conversation

shivupa commented Oct 5, 2021

codecov-commenter commented Oct 5, 2021 • edited by codecov bot Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JensWehner left a comment

Choose a reason for hiding this comment

shivupa commented Oct 6, 2021

shivupa commented Oct 8, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JensWehner left a comment

Choose a reason for hiding this comment

codecov-commenter commented Oct 5, 2021 •

edited by codecov bot

Loading