File: CompInfo.h

package info (click to toggle)
spectra 1.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,788 kB
  • sloc: cpp: 23,044; ansic: 175; fortran: 131; makefile: 90
file content (36 lines) | stat: -rw-r--r-- 1,213 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// Copyright (C) 2016-2025 Yixuan Qiu <yixuan.qiu@cos.name>
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

#ifndef SPECTRA_COMP_INFO_H
#define SPECTRA_COMP_INFO_H

namespace Spectra {

///
/// \ingroup Enumerations
///
/// The enumeration to report the status of computation.
///
enum class CompInfo
{
    Successful,  ///< Computation was successful.

    NotComputed,  ///< Used in eigen solvers, indicating that computation
                  ///< has not been conducted. Users should call
                  ///< the `compute()` member function of solvers.

    NotConverging,  ///< Used in eigen solvers, indicating that some eigenvalues
                    ///< did not converge. The `compute()`
                    ///< function returns the number of converged eigenvalues.

    NumericalIssue  ///< Used in various matrix factorization classes, for example in
                    ///< Cholesky decomposition it indicates that the
                    ///< matrix is not positive definite.
};

}  // namespace Spectra

#endif  // SPECTRA_COMP_INFO_H