Amesos2::Status Class Reference

Holds internal status data about the owning Amesos2 solver. More...

#include <Amesos2_Status.hpp>

Public Member Functions
	~Status ()
	Default destructor.
int	getNumPreOrder () const
	Returns the number of pre-orderings performed by the owning solver.
int	getNumSymbolicFact () const
	Returns the number of symbolic factorizations performed by the owning solver.
int	getNumNumericFact () const
	Returns the number of numeric factorizations performed by the owning solver.
int	getNumSolve () const
	Returns the number of solves performed by the owning solver.
bool	preOrderingDone () const
	If true , then pre-ordering has been performed.
bool	symbolicFactorizationDone () const
	If true , then symbolic factorization has been performed.
bool	numericFactorizationDone () const
	If true , then numeric factorization has been performed.
size_t	getNnzLU () const
	Get the number of non-zero entries in the and factors.

Private Attributes
int	numPreOrder_
	Number of pre-ordering phases.
int	numSymbolicFact_
	Number of symbolic factorization phases.
int	numNumericFact_
	Number of numeric factorization phases.
int	numSolve_
	Number of solves.
EPhase	last_phase_
	The last phase of computation that was performed by the owning solver object.
size_t	lu_nnz_
	The number of non-zeros in the factors.

Friends
template<template< class, class > class ConcreteSolver, class Matrix, class Vector>
class	SolverCore

Detailed Description

Holds internal status data about the owning Amesos2 solver.

Provides convenient access to status data for both solvers and outside users.

See also

Solver::getStatus()

Member Function Documentation

getNumPreOrder()

int Amesos2::Status::getNumPreOrder ( ) const

inline

Returns the number of pre-orderings performed by the owning solver.

References numPreOrder_.

getNumSymbolicFact()

int Amesos2::Status::getNumSymbolicFact ( ) const

inline

Returns the number of symbolic factorizations performed by the owning solver.

References numSymbolicFact_.

getNumNumericFact()

int Amesos2::Status::getNumNumericFact ( ) const

inline

Returns the number of numeric factorizations performed by the owning solver.

References numNumericFact_.

getNumSolve()

int Amesos2::Status::getNumSolve ( ) const

inline

Returns the number of solves performed by the owning solver.

References numSolve_.

preOrderingDone()

bool Amesos2::Status::preOrderingDone ( ) const

inline

If true , then pre-ordering has been performed.

References last_phase_.

symbolicFactorizationDone()

bool Amesos2::Status::symbolicFactorizationDone ( ) const

inline

If true , then symbolic factorization has been performed.

References last_phase_.

numericFactorizationDone()

bool Amesos2::Status::numericFactorizationDone ( ) const

inline

If true , then numeric factorization has been performed.

References last_phase_.

getNnzLU()

size_t Amesos2::Status::getNnzLU ( ) const

inline

Get the number of non-zero entries in the and factors.

Returns 0 if numeric factorization has not yet been performed, or if the solver does not support getting statistics about the factors.

References lu_nnz_.

Member Data Documentation

numPreOrder_

int Amesos2::Status::numPreOrder_

private

Number of pre-ordering phases.

Referenced by getNumPreOrder().

numSymbolicFact_

int Amesos2::Status::numSymbolicFact_

private

Number of symbolic factorization phases.

Referenced by getNumSymbolicFact().

numNumericFact_

int Amesos2::Status::numNumericFact_

private

Number of numeric factorization phases.

Referenced by getNumNumericFact().

numSolve_

int Amesos2::Status::numSolve_

private

Number of solves.

Referenced by getNumSolve().

last_phase_

EPhase Amesos2::Status::last_phase_

private

The last phase of computation that was performed by the owning solver object.

Referenced by numericFactorizationDone(), preOrderingDone(), and symbolicFactorizationDone().

lu_nnz_

size_t Amesos2::Status::lu_nnz_

private

The number of non-zeros in the factors.

Referenced by getNnzLU(), and Amesos2::SolverCore< Amesos2::Basker, Matrix, Vector >::setNnzLU().

---

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

• Amesos2_Status.hpp