Quantum 3xplorer (Q3)
An AI-native quantum simulation engine
Loading...
Searching...
No Matches
q3::WannierDiagnosticError Class Reference

#include <diagnostic_error.hpp>

+ Inheritance diagram for q3::WannierDiagnosticError:

Public Member Functions

 WannierDiagnosticError (WannierDiagnostic diagnostic, const std::string &message, std::vector< Real > spreads_bohr_squared={})
 
WannierDiagnostic diagnostic () const
 
std::vector< std::string > diagnostic_lines () const override
 diagnostic: <code>, and the spreads on a line of their own when there are any.
 
const std::vector< Real > & spreads_bohr_squared () const
 
std::string spreads_text () const
 The spreads as "a, b, c" with six decimals each, the form the prose names them in.
 

Detailed Description

Definition at line 27 of file diagnostic_error.hpp.

Constructor & Destructor Documentation

◆ WannierDiagnosticError()

q3::WannierDiagnosticError::WannierDiagnosticError ( WannierDiagnostic  diagnostic,
const std::string &  message,
std::vector< Real >  spreads_bohr_squared = {} 
)
inline

Definition at line 29 of file diagnostic_error.hpp.

Member Function Documentation

◆ diagnostic()

WannierDiagnostic q3::WannierDiagnosticError::diagnostic ( ) const
inline

Definition at line 36 of file diagnostic_error.hpp.

◆ diagnostic_lines()

std::vector< std::string > q3::WannierDiagnosticError::diagnostic_lines ( ) const
inlineoverridevirtual

diagnostic: <code>, and the spreads on a line of their own when there are any.

Implements q3::DiagnosticError.

Definition at line 55 of file diagnostic_error.hpp.

References spreads_text(), and q3::wannier_diagnostic_name().

◆ spreads_bohr_squared()

const std::vector< Real > & q3::WannierDiagnosticError::spreads_bohr_squared ( ) const
inline

For disentanglement_unconverged: the last gauge-invariant spreads the iteration reached, oldest first, in bohr squared – the numbers the retry ladder loosens its tolerance from. Empty for every other code.

Definition at line 45 of file diagnostic_error.hpp.

◆ spreads_text()

std::string q3::WannierDiagnosticError::spreads_text ( ) const
inline

The spreads as "a, b, c" with six decimals each, the form the prose names them in.

Definition at line 50 of file diagnostic_error.hpp.

References q3::ConvergenceWindow::history_text().

Referenced by diagnostic_lines().


The documentation for this class was generated from the following file: