MatrixScaleBase Class Reference

#include <dgeequ.h>

Inheritance diagram for MatrixScaleBase:

Collaboration diagram for MatrixScaleBase:

Public Member Functions
	MatrixScaleBase (const SolutionManager::ScaleOpt &scale)
virtual	~MatrixScaleBase ()
VectorHandler &	ScaleRightHandSide (VectorHandler &bVH) const
VectorHandler &	ScaleSolution (VectorHandler &xVH) const
std::ostream &	Report (std::ostream &os) const
const std::vector< doublereal > &	GetRowScale () const
const std::vector< doublereal > &	GetColScale () const
bool	bGetInitialized () const

Protected Member Functions
MatrixHandler::Norm_t	GetCondNumNorm () const
virtual std::ostream &	vReport (std::ostream &os) const =0
void	Prepare (const MatrixHandler &mh, integer &nrows, integer &ncols)
void	PrepareRows (const MatrixHandler &mh, integer &nrows)
void	PrepareCols (const MatrixHandler &mh, integer &ncols)
bool	bReport () const

Protected Attributes
std::vector< doublereal >	rowScale
std::vector< doublereal >	colScale
doublereal	dCondBefore
doublereal	dCondAfter
const unsigned	uFlags
bool	bOK

Static Private Member Functions
static VectorHandler &	ScaleVector (VectorHandler &v, const std::vector< doublereal > &s)

Detailed Description

Definition at line 49 of file dgeequ.h.

Constructor & Destructor Documentation

MatrixScaleBase::MatrixScaleBase ( const SolutionManager::ScaleOpt &  scale )

explicit

Definition at line 38 of file dgeequ.cc.

:dCondBefore(-1.),
 dCondAfter(-1.),
 uFlags(scale.uFlags),
 bOK(true)
{

}

MatrixScaleBase::~MatrixScaleBase ( )

virtual

Definition at line 47 of file dgeequ.cc.

{

}

Member Function Documentation

bool MatrixScaleBase::bGetInitialized ( ) const

inline

Definition at line 59 of file dgeequ.h.

References colScale, and rowScale.

Referenced by NaiveSparseSolutionManager::ScaleMatrixAndRightHandSide().

{ return !(rowScale.empty() && colScale.empty()); } // Allow row only or column only scaling

bool MatrixScaleBase::bReport ( ) const

inlineprotected

Definition at line 249 of file dgeequ.h.

References SolutionManager::SCALEF_VERBOSE, SolutionManager::SCALEF_WARN, and uFlags.

{
        return uFlags & (SolutionManager::SCALEF_WARN | SolutionManager::SCALEF_VERBOSE);
}

const std::vector<doublereal>& MatrixScaleBase::GetColScale ( ) const

inline

Definition at line 58 of file dgeequ.h.

References colScale.

Referenced by ReportMatScale().

{ return colScale; }

MatrixHandler::Norm_t MatrixScaleBase::GetCondNumNorm ( ) const

inlineprotected

Definition at line 234 of file dgeequ.h.

References ASSERT, MBDYN_EXCEPT_ARGS, MatrixHandler::NORM_1, MatrixHandler::NORM_INF, SolutionManager::SCALEF_COND_NUM, SolutionManager::SCALEF_COND_NUM_1, SolutionManager::SCALEF_COND_NUM_INF, and uFlags.

{
        switch (uFlags & SolutionManager::SCALEF_COND_NUM) {
        case SolutionManager::SCALEF_COND_NUM_1:
                return MatrixHandler::NORM_1;

        case SolutionManager::SCALEF_COND_NUM_INF:
                return MatrixHandler::NORM_INF;

        default:
                ASSERT(0);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }
}

const std::vector<doublereal>& MatrixScaleBase::GetRowScale ( ) const

inline

Definition at line 57 of file dgeequ.h.

References rowScale.

Referenced by ReportMatScale().

{ return rowScale; }

void MatrixScaleBase::Prepare ( const MatrixHandler &  mh, integer &  nrows, integer &  ncols  )

inlineprotected

Definition at line 254 of file dgeequ.h.

References PrepareCols(), and PrepareRows().

Referenced by LapackMatrixScale< T >::ComputeScaleFactors().

{
        PrepareRows(mh, nrows);
        PrepareCols(mh, ncols);
}

Here is the call graph for this function:

void MatrixScaleBase::PrepareCols ( const MatrixHandler &  mh, integer &  ncols  )

protected

Definition at line 104 of file dgeequ.cc.

References colScale, MatrixHandler::iGetNumCols(), and MBDYN_EXCEPT_ARGS.

Referenced by ColSumMatrixScale< T >::ComputeScaleFactors(), ColMaxMatrixScale< T >::ComputeScaleFactors(), and Prepare().

{
        ncols = mh.iGetNumCols();

        if (ncols <= 0) {
                // error
                throw ErrGeneric(MBDYN_EXCEPT_ARGS,
                        "invalid null or negative column number");
        }

        if (colScale.empty()) {
                colScale.resize(ncols, 0.);
        } else {
                if (colScale.size() != unsigned(ncols)) {
                        // error
                        throw ErrGeneric(MBDYN_EXCEPT_ARGS,
                                "column number mismatch");
                }
                colScale.assign(ncols, 0.);
        }
}

Here is the call graph for this function:

void MatrixScaleBase::PrepareRows ( const MatrixHandler &  mh, integer &  nrows  )

protected

Definition at line 82 of file dgeequ.cc.

References MatrixHandler::iGetNumRows(), MBDYN_EXCEPT_ARGS, and rowScale.

Referenced by RowSumMatrixScale< T >::ComputeScaleFactors(), RowMaxMatrixScale< T >::ComputeScaleFactors(), and Prepare().

{
        nrows = mh.iGetNumRows();

        if (nrows <= 0) {
                // error
                throw ErrGeneric(MBDYN_EXCEPT_ARGS,
                        "invalid null or negative row number");
        }

        if (rowScale.empty()) {
                rowScale.resize(nrows, 0.);
        } else {
                if (rowScale.size() != unsigned(nrows)) {
                        // error
                        throw ErrGeneric(MBDYN_EXCEPT_ARGS,
                                "row number mismatch");
                }
                rowScale.assign(nrows, 0.);
        }
}

Here is the call graph for this function:

std::ostream & MatrixScaleBase::Report

(

std::ostream &

os

)

const

Definition at line 52 of file dgeequ.cc.

References bOK, dCondAfter, dCondBefore, SolutionManager::SCALEF_COND_NUM, SolutionManager::SCALEF_VERBOSE, SolutionManager::SCALEF_WARN, uFlags, and vReport().

Referenced by ReportMatScale(), and NaiveSparseSolutionManager::ScaleMatrixAndRightHandSide().

{
        if ((uFlags & SolutionManager::SCALEF_COND_NUM)
                        && dCondBefore > 0 && dCondAfter > 0) {
                os << "cond: (" << dCondBefore << ") " << dCondAfter << std::endl;
        }

        if ((uFlags & SolutionManager::SCALEF_VERBOSE)
                || (!bOK && (uFlags & SolutionManager::SCALEF_WARN))) {
                vReport(os);
        }

        return os;
}

Here is the call graph for this function:

VectorHandler & MatrixScaleBase::ScaleRightHandSide ( VectorHandler &  bVH ) const

inline

Definition at line 216 of file dgeequ.h.

References rowScale, and ScaleVector().

Referenced by NaiveSparseSolutionManager::ScaleMatrixAndRightHandSide().

{
        if (!rowScale.empty()) {
                ScaleVector(bVH, rowScale);
        }

        return bVH;
}

Here is the call graph for this function:

VectorHandler & MatrixScaleBase::ScaleSolution ( VectorHandler &  xVH ) const

inline

Definition at line 225 of file dgeequ.h.

References colScale, and ScaleVector().

Referenced by NaiveSparseSolutionManager::ScaleSolution().

{
        if (!colScale.empty()) {
                ScaleVector(xVH, colScale);
        }

        return xVH;
}

Here is the call graph for this function:

VectorHandler & MatrixScaleBase::ScaleVector ( VectorHandler &  v, const std::vector< doublereal > &  s  )

staticprivate

Definition at line 68 of file dgeequ.cc.

References ASSERT, VectorHandler::iGetSize(), and MBDYN_EXCEPT_ARGS.

Referenced by ScaleRightHandSide(), and ScaleSolution().

{
        if (static_cast<size_t>(v.iGetSize()) != s.size()) {
                ASSERT(0);
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        for (int i = 0; i < v.iGetSize(); ++i) {
                v(i + 1) *= s[i];
        }

        return v;
}

Here is the call graph for this function:

virtual std::ostream& MatrixScaleBase::vReport ( std::ostream &  os ) const

protectedpure virtual

Implemented in RowMaxColMaxMatrixScale< T >, IterativeMatrixScale< T >, LapackMatrixScale< T >, ColMaxMatrixScale< T >, ColSumMatrixScale< T >, RowMaxMatrixScale< T >, and RowSumMatrixScale< T >.

Referenced by Report().

Member Data Documentation

bool MatrixScaleBase::bOK

protected

Definition at line 71 of file dgeequ.h.

Referenced by Report(), IterativeMatrixScale< T >::vReport(), and RowMaxColMaxMatrixScale< T >::vReport().

std::vector<doublereal> MatrixScaleBase::colScale

protected

Definition at line 68 of file dgeequ.h.

Referenced by bGetInitialized(), GetColScale(), PrepareCols(), and ScaleSolution().

doublereal MatrixScaleBase::dCondAfter

mutableprotected

Definition at line 69 of file dgeequ.h.

Referenced by Report().

doublereal MatrixScaleBase::dCondBefore

mutableprotected

Definition at line 69 of file dgeequ.h.

Referenced by Report().

std::vector<doublereal> MatrixScaleBase::rowScale

protected

Definition at line 68 of file dgeequ.h.

Referenced by bGetInitialized(), GetRowScale(), PrepareRows(), and ScaleRightHandSide().

const unsigned MatrixScaleBase::uFlags

protected

Definition at line 70 of file dgeequ.h.

Referenced by bReport(), GetCondNumNorm(), and Report().

---

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

• dgeequ.h
• dgeequ.cc